Revert "fix(orchestrator): remove default pagination on v2 endpoints (#1983)"

This reverts commit 5e30274.

Author: rgolangh

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

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

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

@@ -1,4 +1,8 @@
 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.test.ts

@@ -5,7 +5,12 @@ describe('buildPagination()', () => {
     const mockRequest: any = {
       body: {},
     };
-    expect(buildPagination(mockRequest)).toEqual({});
+    expect(buildPagination(mockRequest)).toEqual({
+      limit: 10,
+      offset: 0,
+      order: 'ASC',
+      sortField: undefined,
+    });
   });
   it('should build the correct pagination obj when partial query parameters are passed', () => {
     const mockRequest: any = {
@@ -16,9 +21,9 @@ describe('buildPagination()', () => {
       },
     };
     expect(buildPagination(mockRequest)).toEqual({
-      limit: undefined,
-      offset: undefined,
-      order: undefined,
+      limit: 10,
+      offset: 0,
+      order: 'ASC',
       sortField: 'lastUpdated',
     });
   });
@@ -50,9 +55,9 @@ describe('buildPagination()', () => {
       },
     };
     expect(buildPagination(mockRequest)).toEqual({
-      limit: undefined,
-      offset: undefined,
-      order: undefined,
+      limit: 10,
+      offset: 0,
+      order: 'ASC',
       sortField: undefined,
     });
   });

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

@@ -1,6 +1,11 @@
 import { Request } from 'express-serve-static-core';
 
-import { PaginationInfoDTO } from '@janus-idp/backstage-plugin-orchestrator-common';
+import {
+  DEFAULT_PAGE_NUMBER,
+  DEFAULT_PAGE_SIZE,
+  DEFAULT_SORT_FIELD,
+  DEFAULT_SORT_ORDER,
+} from '../service/constants';
 
 export interface Pagination {
   offset?: number;
@@ -10,33 +15,18 @@ export interface Pagination {
 }
 
 export function buildPagination(req: Request): Pagination {
-  const pagination: Pagination = {
-    limit: undefined,
-    offset: undefined,
-    order: undefined,
-    sortField: undefined,
+  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,
   };
-
-  if (!req.body?.paginationInfo) {
-    return pagination;
-  }
-  const { offset, pageSize, orderBy, orderDirection } = req.body
-    .paginationInfo as PaginationInfoDTO;
-
-  if (!isNaN(Number(offset))) {
-    pagination.offset = Number(offset);
-  }
-
-  if (!isNaN(Number(pageSize))) {
-    pagination.limit = Number(pageSize);
-  }
-
-  if (orderBy) {
-    pagination.sortField = String(orderBy);
-  }
-
-  if (orderDirection) {
-    pagination.order = String(orderDirection).toUpperCase();
-  }
-  return pagination;
 }