SIMSBIOHUB-893: Add Default Pagination & Increase Max Limit (#348)

mauberti-bc · web-flow · commit 4fa68632f0ff · 2026-03-04T14:02:43.000-08:00
* default pagination

* cleanup

* fix tests

* remove unnecessary assertion

* remove redundant ensureCompletePaginationOptions calls

* remove ensurePagination from makePagiationResponse

* change pagination max to 200
diff --git a/api/src/openapi/schemas/pagination.ts b/api/src/openapi/schemas/pagination.ts
@@ -12,7 +12,8 @@ export const paginationRequestQueryParamSchema: OpenAPIV3.ParameterObject[] = [
     schema: {
       type: 'integer',
       minimum: 1,
-      description: 'The current page number to be fetched'
+      default: 1,
+      description: 'The current page number to be fetched. Defaults to 1 when omitted.'
     }
   },
   {
@@ -22,8 +23,9 @@ export const paginationRequestQueryParamSchema: OpenAPIV3.ParameterObject[] = [
     schema: {
       type: 'integer',
       minimum: 1,
-      maximum: 100,
-      description: 'The number of records to show per page'
+      maximum: 200,
+      default: 25,
+      description: 'The number of records to show per page. Defaults to 25 when omitted.'
     }
   },
   {
@@ -63,7 +65,7 @@ export const paginationRequestBodySchema: OpenAPIV3.SchemaObject = {
     limit: {
       type: 'integer',
       minimum: 1,
-      maximum: 100,
+      maximum: 200,
       default: 25,
       description: 'The number of records to return per page'
     },
diff --git a/api/src/paths/administrative/policies/index.ts b/api/src/paths/administrative/policies/index.ts
@@ -13,11 +13,7 @@ import {
 import { authorizeRequestHandler } from '../../../request-handlers/security/authorization';
 import { PolicyService } from '../../../services/access-policy/policy-service';
 import { getLogger } from '../../../utils/logger';
-import {
-  ensureCompletePaginationOptions,
-  makePaginationOptionsFromRequest,
-  makePaginationResponse
-} from '../../../utils/pagination';
+import { makePaginationOptionsFromRequest, makePaginationResponse } from '../../../utils/pagination';
 
 const defaultLog = getLogger('paths/administrative/policies');
 
@@ -84,7 +80,7 @@ export function getPolicies(): RequestHandler {
       const filters = { search };
       const pagination = makePaginationOptionsFromRequest(req);
       const [policies, count] = await Promise.all([
-        policyService.getPoliciesWithStatements(filters, ensureCompletePaginationOptions(pagination)),
+        policyService.getPoliciesWithStatements(filters, pagination),
         policyService.getPoliciesCount(filters)
       ]);
 
diff --git a/api/src/paths/administrative/team-policies/index.ts b/api/src/paths/administrative/team-policies/index.ts
@@ -13,11 +13,7 @@ import {
 import { authorizeRequestHandler } from '../../../request-handlers/security/authorization';
 import { TeamPolicyService } from '../../../services/access-policy/team-policy-service';
 import { getLogger } from '../../../utils/logger';
-import {
-  ensureCompletePaginationOptions,
-  makePaginationOptionsFromRequest,
-  makePaginationResponse
-} from '../../../utils/pagination';
+import { makePaginationOptionsFromRequest, makePaginationResponse } from '../../../utils/pagination';
 
 const defaultLog = getLogger('paths/administrative/team-policies');
 
@@ -83,7 +79,7 @@ export function getTeamPolicies(): RequestHandler {
       const filters = { search };
       const pagination = makePaginationOptionsFromRequest(req);
       const [teamPolicies, count] = await Promise.all([
-        teamPolicyService.getAllTeamPolicies(filters, ensureCompletePaginationOptions(pagination)),
+        teamPolicyService.getAllTeamPolicies(filters, pagination),
         teamPolicyService.getAllTeamPoliciesCount(filters)
       ]);
 
diff --git a/api/src/paths/administrative/teams/index.ts b/api/src/paths/administrative/teams/index.ts
@@ -9,11 +9,7 @@ import { CreateTeamRequestSchema, TeamSchema, TeamsListResponseSchema } from '..
 import { authorizeRequestHandler } from '../../../request-handlers/security/authorization';
 import { TeamService } from '../../../services/access-policy/team-service';
 import { getLogger } from '../../../utils/logger';
-import {
-  ensureCompletePaginationOptions,
-  makePaginationOptionsFromRequest,
-  makePaginationResponse
-} from '../../../utils/pagination';
+import { makePaginationOptionsFromRequest, makePaginationResponse } from '../../../utils/pagination';
 
 const defaultLog = getLogger('paths/administrative/teams');
 
@@ -74,7 +70,7 @@ export function getTeams(): RequestHandler {
       const pagination = makePaginationOptionsFromRequest(req);
 
       const [teams, count] = await Promise.all([
-        teamService.getTeams(filters, ensureCompletePaginationOptions(pagination)),
+        teamService.getTeams(filters, pagination),
         teamService.getTeamsCount(filters)
       ]);
 
diff --git a/api/src/paths/administrative/teams/{teamId}/member/index.ts b/api/src/paths/administrative/teams/{teamId}/member/index.ts
@@ -13,11 +13,7 @@ import {
 import { authorizeRequestHandler } from '../../../../../request-handlers/security/authorization';
 import { TeamMemberService } from '../../../../../services/access-policy/team-member-service';
 import { getLogger } from '../../../../../utils/logger';
-import {
-  ensureCompletePaginationOptions,
-  makePaginationOptionsFromRequest,
-  makePaginationResponse
-} from '../../../../../utils/pagination';
+import { makePaginationOptionsFromRequest, makePaginationResponse } from '../../../../../utils/pagination';
 
 const defaultLog = getLogger('paths/administrative/teams/{teamId}/member');
 
@@ -77,7 +73,7 @@ export function getTeamMembers(): RequestHandler {
       const teamMemberService = new TeamMemberService(connection);
 
       const [members, count] = await Promise.all([
-        teamMemberService.getTeamMembersWithUsers(teamId, ensureCompletePaginationOptions(pagination)),
+        teamMemberService.getTeamMembersWithUsers(teamId, pagination),
         teamMemberService.getTeamMembersWithUsersCount(teamId)
       ]);
       await connection.commit();
diff --git a/api/src/paths/search/feature/index.test.ts b/api/src/paths/search/feature/index.test.ts
@@ -311,7 +311,7 @@ describe('searchFeatures', () => {
       features: mockResults,
       pagination: {
         total: 1,
-        per_page: 1,
+        per_page: 25,
         current_page: 1,
         last_page: 1,
         sort: undefined,
diff --git a/api/src/paths/search/feature/index.ts b/api/src/paths/search/feature/index.ts
@@ -9,11 +9,7 @@ import {
 import { SearchFeatureService } from '../../../services/search-feature-service';
 import { ISearchFeaturesFilters } from '../../../services/search-feature-service.interface';
 import { getLogger } from '../../../utils/logger';
-import {
-  ensureCompletePaginationOptions,
-  makePaginationOptionsFromBody,
-  makePaginationResponse
-} from '../../../utils/pagination';
+import { makePaginationOptionsFromBody, makePaginationResponse } from '../../../utils/pagination';
 
 const defaultLog = getLogger('paths/search/feature');
 
@@ -53,7 +49,7 @@ export function searchFeatures(): RequestHandler {
       const pagination = makePaginationOptionsFromBody(req);
 
       const [features, count] = await Promise.all([
-        service.searchFeatures(filters, ensureCompletePaginationOptions(pagination)),
+        service.searchFeatures(filters, pagination),
         service.getSearchFeaturesCount(filters)
       ]);
       await connection.commit();
diff --git a/api/src/paths/search/index.test.ts b/api/src/paths/search/index.test.ts
@@ -5,7 +5,6 @@ import sinonChai from 'sinon-chai';
 import * as db from '../../database/db';
 import { SearchService } from '../../services/search-service';
 import { SearchResponseWithCounts } from '../../services/search-service.interface';
-import { ensureCompletePaginationOptions } from '../../utils/pagination';
 import { getMockDBConnection, getRequestHandlerMocks } from '../../__mocks__/db';
 import * as search from './index';
 
@@ -31,7 +30,7 @@ describe('search', () => {
     taxonomy: { data: [], total: 0 }
   };
 
-  const defaultPaginationNumbers = { page: 1, limit: 2 };
+  const defaultPaginationNumbers = { page: 1, limit: 2, sort: undefined, order: undefined };
 
   afterEach(() => {
     sinon.restore();
@@ -56,7 +55,7 @@ describe('search', () => {
 
     expect(mockSearch).to.have.been.calledOnceWith(
       { keyword: 'moose habitat', feature_type_name: undefined },
-      ensureCompletePaginationOptions(defaultPaginationNumbers)
+      defaultPaginationNumbers
     );
 
     expect(mockRes.statusValue).to.equal(200);
@@ -82,15 +81,15 @@ describe('search', () => {
 
     expect(mockSearch).to.have.been.calledOnceWith(
       { keyword: 'moose', feature_type_name: 'dataset' },
-      ensureCompletePaginationOptions(defaultPaginationNumbers)
+      defaultPaginationNumbers
     );
 
     expect(mockRes.statusValue).to.equal(200);
     expect(mockRes.jsonValue).to.eql(mockResultsWithData);
   });
 
   it('should return search results with custom pagination', async () => {
-    const customNumbers = { page: 2, limit: 5 };
+    const customNumbers = { page: 2, limit: 5, sort: undefined, order: undefined };
     const dbConnectionObj = getMockDBConnection({
       open: sinon.stub().resolves(),
       commit: sinon.stub().resolves(),
@@ -109,7 +108,7 @@ describe('search', () => {
 
     expect(mockSearch).to.have.been.calledOnceWith(
       { keyword: 'wildlife', feature_type_name: undefined },
-      ensureCompletePaginationOptions(customNumbers)
+      customNumbers
     );
 
     expect(mockRes.statusValue).to.equal(200);
@@ -135,7 +134,7 @@ describe('search', () => {
 
     expect(mockSearch).to.have.been.calledOnceWith(
       { keyword: '', feature_type_name: undefined },
-      ensureCompletePaginationOptions(defaultPaginationNumbers)
+      defaultPaginationNumbers
     );
 
     expect(mockRes.statusValue).to.equal(200);
diff --git a/api/src/paths/search/index.ts b/api/src/paths/search/index.ts
@@ -7,7 +7,7 @@ import { searchAllResponseSchema } from '../../openapi/schemas/search/search-all
 import { SearchService } from '../../services/search-service';
 import { SearchParams } from '../../services/search-service.interface';
 import { getLogger } from '../../utils/logger';
-import { ensureCompletePaginationOptions, makePaginationOptionsFromRequest } from '../../utils/pagination';
+import { makePaginationOptionsFromRequest } from '../../utils/pagination';
 
 const defaultLog = getLogger('paths/search/index');
 
@@ -63,7 +63,7 @@ export function searchAll(): RequestHandler {
       const filters = parseQueryParams(req);
       const paginationOptions = makePaginationOptionsFromRequest(req);
 
-      const result = await searchService.search(filters, ensureCompletePaginationOptions(paginationOptions));
+      const result = await searchService.search(filters, paginationOptions);
 
       await connection.commit();
 
diff --git a/api/src/paths/search/property/index.test.ts b/api/src/paths/search/property/index.test.ts
@@ -203,7 +203,7 @@ describe('searchProperties', () => {
       properties: mockResultsWithData,
       pagination: {
         total: 2,
-        per_page: 2,
+        per_page: 25,
         current_page: 1,
         last_page: 1,
         sort: undefined,
diff --git a/api/src/paths/search/property/index.ts b/api/src/paths/search/property/index.ts
@@ -9,11 +9,7 @@ import {
 import { PropertySearchService } from '../../../services/property-search-service';
 import { ISearchPropertyFilters } from '../../../services/property-search-service.interface';
 import { getLogger } from '../../../utils/logger';
-import {
-  ensureCompletePaginationOptions,
-  makePaginationOptionsFromBody,
-  makePaginationResponse
-} from '../../../utils/pagination';
+import { makePaginationOptionsFromBody, makePaginationResponse } from '../../../utils/pagination';
 
 const defaultLog = getLogger('paths/search/property');
 
@@ -53,7 +49,7 @@ export function searchProperties(): RequestHandler {
       const pagination = makePaginationOptionsFromBody(req);
 
       const [properties, count] = await Promise.all([
-        service.searchProperty(filters, ensureCompletePaginationOptions(pagination)),
+        service.searchProperty(filters, pagination),
         service.getSearchPropertyCount(filters)
       ]);
       await connection.commit();
diff --git a/api/src/paths/submission/{submissionId}/features/index.ts b/api/src/paths/submission/{submissionId}/features/index.ts
@@ -7,11 +7,7 @@ import { paginationRequestQueryParamSchema, paginationResponseSchema } from '../
 import { authorizeRequestHandler } from '../../../../request-handlers/security/authorization';
 import { SubmissionService } from '../../../../services/submission-service';
 import { getLogger } from '../../../../utils/logger';
-import {
-  ensureCompletePaginationOptions,
-  makePaginationOptionsFromRequest,
-  makePaginationResponse
-} from '../../../../utils/pagination';
+import { makePaginationOptionsFromRequest, makePaginationResponse } from '../../../../utils/pagination';
 
 const defaultLog = getLogger('paths/submission/{submissionId}');
 
@@ -110,7 +106,7 @@ export function getSubmissionFeatures(): RequestHandler {
 
       // Service method must support pagination options
       const [features, count] = await Promise.all([
-        submissionService.getSubmissionFeatures(submissionId, ensureCompletePaginationOptions(paginationOptions)),
+        submissionService.getSubmissionFeatures(submissionId, paginationOptions),
         submissionService.getSubmissionFeaturesCount(submissionId)
       ]);
 
diff --git a/api/src/services/cart-submission-feature-service.ts b/api/src/services/cart-submission-feature-service.ts
@@ -1,7 +1,7 @@
 import { IDBConnection } from '../database/db';
 import { CartFeatureListResponse, CartSubmissionFeature } from '../models/cart';
 import { CartSubmissionFeatureRepository } from '../repositories/cart-submission-feature-repository';
-import { ensureCompletePaginationOptions, makePaginationResponse } from '../utils/pagination';
+import { makePaginationResponse } from '../utils/pagination';
 import { ApiPaginationOptions } from '../zod-schema/pagination';
 import { PolicyService } from './access-policy/policy-service';
 import { DBService } from './db-service';
@@ -109,16 +109,16 @@ export class CartSubmissionFeatureService extends DBService {
    * Returns cart features and pagination payload in the same shape used by cart feature endpoints.
    *
    * @param {string} cartId - The ID of the cart
-   * @param {Partial<ApiPaginationOptions>} pagination - Requested pagination parameters
+   * @param {ApiPaginationOptions} pagination - Requested pagination parameters
    * @return {Promise<CartFeatureListResponse>}
    * @memberof CartSubmissionFeatureService
    */
   async getPaginatedCartFeaturesResponse(
     cartId: string,
-    pagination: Partial<ApiPaginationOptions>
+    pagination: ApiPaginationOptions
   ): Promise<CartFeatureListResponse> {
     const [features, count] = await Promise.all([
-      this.getCartSubmissionFeatures(cartId, ensureCompletePaginationOptions(pagination)),
+      this.getCartSubmissionFeatures(cartId, pagination),
       this.getCartSubmissionFeatureCount(cartId)
     ]);
 
diff --git a/api/src/utils/pagination.test.ts b/api/src/utils/pagination.test.ts
diff --git a/api/src/utils/pagination.ts b/api/src/utils/pagination.ts
