Feat #120 - Get previous submissions paginated (#121)

* get submission by id

* retrieve submissions by category

* get submission by organization

* relocate submission unit tests

Author: leoraba

apps/server/swagger/parameters.yml

@@ -38,3 +38,17 @@ components:
           type: string
           enum: ['flat', 'compound']
         description: Optional query parameter to define the data format. Choose 'flat' for a simple, single-level collection of records, or 'compound' for a nested, schema-centric structure. The default value is 'flat'
+      OnlyActive:
+        description: Optional query parameter to filter results to include only active submissions. Default value is false
+        name: onlyActive
+        in: query
+        schema:
+          type: boolean
+        required: false
+      Organization:
+        description: Optional query parameter to filter results to include only submissions associated to an specific organization. By default, returns submissions from all organizations
+        name: organization
+        in: query
+        schema:
+          type: string
+        required: false

apps/server/swagger/schemas.yml

@@ -55,7 +55,7 @@ components:
             $ref: '#/components/responses/Error'
 
   schemas:
-    ActiveSubmissionResult:
+    SubmissionResult:
       type: object
       properties:
         id:
@@ -161,12 +161,26 @@ components:
           type: string
           description: User name who last updated the submission
 
-    ActiveSubmissionsSummaryResult:
-      type: array
-      items:
-        $ref: '#/components/schemas/ActiveSubmissionSummary'
+    SubmissionsSummaryResult:
+      type: object
+      properties:
+        pagination:
+          type: object
+          properties:
+            currentPage:
+              type: number
+            pageSize:
+              type: number
+            totalPages:
+              type: number
+            totalRecords:
+              type: number
+        records:
+          type: array
+          items:
+            $ref: '#/components/schemas/SubmissionSummary'
 
-    ActiveSubmissionSummary:
+    SubmissionSummary:
       type: object
       properties:
         id:
@@ -258,7 +272,7 @@ components:
           description: Name of user who last updated the submission
 
     ActiveSubmissionSummaryResult:
-      $ref: '#/components/schemas/ActiveSubmissionSummary'
+      $ref: '#/components/schemas/SubmissionSummary'
 
     BatchError:
       type: object

apps/server/swagger/submission-api.yml

@@ -2,7 +2,7 @@
 
 /submission/{submissionId}:
   get:
-    summary: Get active submission by ID
+    summary: Get submission by ID
     tags:
       - Submission
     parameters:
@@ -12,11 +12,11 @@
         required: true
     responses:
       200:
-        description: Active Submission
+        description: Submission details
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/ActiveSubmissionResult'
+              $ref: '#/components/schemas/SubmissionResult'
 
       401:
         $ref: '#/components/responses/UnauthorizedError'
@@ -42,7 +42,7 @@
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/ActiveSubmissionResult'
+              $ref: '#/components/schemas/SubmissionResult'
       400:
         $ref: '#/components/responses/BadRequest'
       401:
@@ -91,7 +91,7 @@
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/ActiveSubmissionResult'
+              $ref: '#/components/schemas/SubmissionResult'
       400:
         $ref: '#/components/responses/BadRequest'
       401:
@@ -107,18 +107,22 @@
 
 /submission/category/{categoryId}:
   get:
-    summary: Retrieve the Active Submissions for a category in this user session
+    summary: Retrieve the Submissions for a category in this user session
     tags:
       - Submission
     parameters:
       - $ref: '#/components/parameters/path/CategoryId'
+      - $ref: '#/components/parameters/query/Page'
+      - $ref: '#/components/parameters/query/PageSize'
+      - $ref: '#/components/parameters/query/OnlyActive'
+      - $ref: '#/components/parameters/query/Organization'
     responses:
       200:
-        description: Active Submissions
+        description: Submissions details
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/ActiveSubmissionsSummaryResult'
+              $ref: '#/components/schemas/SubmissionsSummaryResult'
 
       401:
         $ref: '#/components/responses/UnauthorizedError'
@@ -132,6 +136,7 @@
 /submission/category/{categoryId}/organization/{organization}:
   get:
     summary: Retrieve the Active Submission for a category and organization in this user session
+    deprecated: true
     tags:
       - Submission
     parameters:

packages/data-provider/src/controllers/submissionController.ts

@@ -9,12 +9,12 @@ import { validateRequest } from '../utils/requestValidation.js';
 import {
 	dataDeleteBySystemIdRequestSchema,
 	dataEditRequestSchema,
-	submissionActiveByIdRequestSchema,
 	submissionActiveByOrganizationRequestSchema,
-	submissionActiveyByCategoryRequestSchema,
+	submissionByIdRequestSchema,
 	submissionCommitRequestSchema,
 	submissionDeleteEntityNameRequestSchema,
 	submissionDeleteRequestSchema,
+	submissionsByCategoryRequestSchema,
 	uploadSubmissionRequestSchema,
 } from '../utils/schemas.js';
 import { BATCH_ERROR_TYPE, BatchError, SUBMISSION_ACTION_TYPE, SUPPORTED_FILE_EXTENSIONS } from '../utils/types.js';
@@ -23,6 +23,8 @@ const controller = (dependencies: BaseDependencies) => {
 	const service = submissionService(dependencies);
 	const dataService = submittedDataService(dependencies);
 	const { logger } = dependencies;
+	const defaultPage = 1;
+	const defaultPageSize = 20;
 	const LOG_MODULE = 'SUBMISSION_CONTROLLER';
 	return {
 		commit: validateRequest(submissionCommitRequestSchema, async (req, res, next) => {
@@ -162,29 +164,51 @@ const controller = (dependencies: BaseDependencies) => {
 				next(error);
 			}
 		}),
-		getActiveByCategory: validateRequest(submissionActiveyByCategoryRequestSchema, async (req, res, next) => {
+		getSubmissionsByCategory: validateRequest(submissionsByCategoryRequestSchema, async (req, res, next) => {
 			try {
 				const categoryId = Number(req.params.categoryId);
+				const onlyActive = req.query.onlyActive?.toLowerCase() === 'true';
+				const organization = req.query.organization;
+				const page = parseInt(String(req.query.page)) || defaultPage;
+				const pageSize = parseInt(String(req.query.pageSize)) || defaultPageSize;
 
-				logger.info(LOG_MODULE, `Request Active Submission categoryId '${categoryId}'`);
+				logger.info(
+					LOG_MODULE,
+					`Request Submission categoryId '${categoryId}'`,
+					`pagination params: page '${page}' pageSize '${pageSize}'`,
+					`onlyActive '${onlyActive}'`,
+					`organization '${organization}'`,
+				);
 
 				// TODO: get userName from auth
 				const userName = '';
 
-				const activeSubmissions = await service.getActiveSubmissionsByCategory({ categoryId, userName });
+				const submissionsResult = await service.getSubmissionsByCategory(
+					categoryId,
+					{ page, pageSize },
+					{ onlyActive, userName, organization },
+				);
 
-				if (!activeSubmissions || activeSubmissions.length === 0) {
-					throw new NotFound('Active Submission not found');
+				if (isEmpty(submissionsResult.result)) {
+					throw new NotFound('Submissions not found');
 				}
 
-				logger.info(LOG_MODULE, `Found '${activeSubmissions.length}' Active Submissions`);
+				const response = {
+					pagination: {
+						currentPage: page,
+						pageSize: pageSize,
+						totalPages: Math.ceil(submissionsResult.metadata.totalRecords / pageSize),
+						totalRecords: submissionsResult.metadata.totalRecords,
+					},
+					records: submissionsResult.result,
+				};
 
-				return res.status(200).send(activeSubmissions);
+				return res.status(200).send(response);
 			} catch (error) {
 				next(error);
 			}
 		}),
-		getActiveById: validateRequest(submissionActiveByIdRequestSchema, async (req, res, next) => {
+		getSubmissionById: validateRequest(submissionByIdRequestSchema, async (req, res, next) => {
 			try {
 				const submissionId = Number(req.params.submissionId);
 
@@ -193,13 +217,13 @@ const controller = (dependencies: BaseDependencies) => {
 				// TODO: get userName from auth
 				// const userName = '';
 
-				const activeSubmission = await service.getActiveSubmissionById(submissionId);
+				const submission = await service.getSubmissionById(submissionId);
 
-				if (isEmpty(activeSubmission)) {
-					throw new NotFound('Active Submission not found');
+				if (isEmpty(submission)) {
+					throw new NotFound('Submission not found');
 				}
 
-				return res.status(200).send(activeSubmission);
+				return res.status(200).send(submission);
 			} catch (error) {
 				next(error);
 			}