Remove default pagination on v2 endpoints

If the user doesn't set pagination info, then retrieve all
the information without pagination

Signed-off-by: Gloria Ciavarrini <[email protected]>

Author: gciavarrini

plugins/orchestrator-backend/src/pagination.test.ts

@@ -6,9 +6,9 @@ describe('buildPagination()', () => {
       query: {},
     };
     expect(buildPagination(mockRequest)).toEqual({
-      limit: 10,
-      offset: 0,
-      order: 'ASC',
+      limit: undefined,
+      offset: undefined,
+      order: undefined,
       sortField: undefined,
     });
   });
@@ -19,9 +19,9 @@ describe('buildPagination()', () => {
       },
     };
     expect(buildPagination(mockRequest)).toEqual({
-      limit: 10,
-      offset: 0,
-      order: 'ASC',
+      limit: undefined,
+      offset: undefined,
+      order: undefined,
       sortField: 'lastUpdated',
     });
   });
@@ -49,9 +49,9 @@ describe('buildPagination()', () => {
       },
     };
     expect(buildPagination(mockRequest)).toEqual({
-      limit: 10,
-      offset: 0,
-      order: 'ASC',
+      limit: undefined,
+      offset: undefined,
+      order: undefined,
       sortField: undefined,
     });
   });

plugins/orchestrator-backend/src/service/api/v2.test.ts

@@ -119,8 +119,8 @@ describe('getWorkflowOverview', () => {
         mapToWorkflowOverviewDTO(item),
       ),
       paginationInfo: {
-        page: 0,
-        pageSize: 10,
+        page: undefined,
+        pageSize: undefined,
         totalCount: mockOverviewsV1.items.length,
       },
     });

plugins/orchestrator-backend/src/service/constants.ts

@@ -1,8 +1,4 @@
 export const WORKFLOW_DATA_KEY = 'workflowdata';
 
 export const INTERNAL_SERVER_ERROR_MESSAGE = 'internal server error';
-export const DEFAULT_PAGE_NUMBER = 0;
-export const DEFAULT_PAGE_SIZE = 10;
-export const DEFAULT_SORT_FIELD = undefined;
-export const DEFAULT_SORT_ORDER = 'ASC';
 export const FETCH_PROCESS_INSTANCES_SORT_FIELD = 'start';

plugins/orchestrator-backend/src/types/pagination.ts

@@ -1,12 +1,5 @@
 import { Request } from 'express-serve-static-core';
 
-import {
-  DEFAULT_PAGE_NUMBER,
-  DEFAULT_PAGE_SIZE,
-  DEFAULT_SORT_FIELD,
-  DEFAULT_SORT_ORDER,
-} from '../service/constants';
-
 export interface Pagination {
   offset?: number;
   limit?: number;
@@ -15,18 +8,23 @@ export interface Pagination {
 }
 
 export function buildPagination(req: Request): Pagination {
-  return {
-    offset: isNaN(req.query.page as any)
-      ? DEFAULT_PAGE_NUMBER
-      : Number(req.query.page),
-    limit: isNaN(req.query.pageSize as any)
-      ? DEFAULT_PAGE_SIZE
-      : Number(req.query.pageSize),
-    sortField: req.query.orderBy
-      ? String(req.query.orderBy)
-      : DEFAULT_SORT_FIELD,
-    order: req.query.orderDirection
-      ? String(req.query.orderDirection)
-      : DEFAULT_SORT_ORDER,
-  };
+  const pagination: Pagination = {};
+
+  if (!isNaN(Number(req.query.page))) {
+    pagination.offset = Number(req.query.page);
+  }
+
+  if (!isNaN(Number(req.query.pageSize))) {
+    pagination.limit = Number(req.query.pageSize);
+  }
+
+  if (req.query.orderBy) {
+    pagination.sortField = String(req.query.orderBy);
+  }
+
+  if (req.query.orderDirection) {
+    pagination.order = String(req.query.orderDirection);
+  }
+
+  return pagination;
 }

plugins/orchestrator-common/src/generated/.METADATA.sha1

@@ -1 +1 @@
-a6f1ec3718385945b49150694189881ac506b364
+af8bd8d631e1bde0b2776e64aae8adbc2bc332ce

plugins/orchestrator-common/src/generated/api/definition.ts

@@ -330,21 +330,16 @@ components:
       properties:
         pageSize:
           type: number
-          minimum: 10
         page:
           type: number
-          default: 0
         totalCount:
           type: number
-          minimum: 0
         orderDirection:
           enum:
             - ASC
             - DESC
-          default: ASC
         orderBy:
           type: string
-          minimum: 0
       additionalProperties: false
     WorkflowFormatDTO:
       type: string