feat(procedure): 🚀 add pagination

Signed-off-by: Manuel Ruck <[email protected]>
demokratie-live · Sep 23, 2024 · de78ad3 · de78ad3
1 parent 9cf873d
commit de78ad3
Show file tree

Hide file tree

Showing 13 changed files with 286 additions and 142 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -25,5 +25,6 @@
   "[ignore]": {
     "editor.defaultFormatter": "foxundermoon.shell-format"
   },
-  "conventionalCommits.scopes": ["push-send-queued"]
+  "conventionalCommits.scopes": ["push-send-queued"],
+  "CodeGPT.apiKey": "OpenAI"
 }
diff --git a/bundestag.io/admin/src/app/list/past/page.tsx b/bundestag.io/admin/src/app/list/past/page.tsx
@@ -10,7 +10,7 @@ export default async function Page() {
   return (
     <>
       <h1>Past procedures</h1>
-      {data.map((procedure) => (
+      {data.procedures.map((procedure) => (
         <Entry
           key={procedure.id}
           title={procedure.title}
@@ -25,7 +25,7 @@ export default async function Page() {
   );
 }
 
-async function getData(): Promise<IProcedure[]> {
+async function getData(): Promise<{ procedures: IProcedure[]; count: number }> {
   const res = await fetch(`${process.env.PROCEDURES_SERVER_URL}/procedures/list/past`, {
     headers: {
       'Cache-Control': 'no-cache',

diff --git a/bundestag.io/admin/src/app/list/upcoming/page.tsx b/bundestag.io/admin/src/app/list/upcoming/page.tsx
@@ -10,7 +10,7 @@ export default async function Page() {
   return (
     <>
       <h1>Upcoming procedures</h1>
-      {data.map((procedure) => (
+      {data.procedures.map((procedure) => (
         <Entry
           key={procedure.id}
           title={procedure.title}
@@ -25,7 +25,7 @@ export default async function Page() {
   );
 }
 
-async function getData(): Promise<IProcedure[]> {
+async function getData(): Promise<{ procedures: IProcedure[]; count: number }> {
   const res = await fetch(`${process.env.PROCEDURES_SERVER_URL}/procedures/list/upcoming`, {
     headers: {
       'Cache-Control': 'no-cache',

diff --git a/services/procedures/bruno/environments/localhost.bru b/services/procedures/bruno/environments/localhost.bru
@@ -1,3 +1,3 @@
 vars {
-  url: http://localhost:3000
+  url: http://localhost:3006
 }
diff --git a/services/procedures/bruno/findAll.bru b/services/procedures/bruno/findAll.bru
@@ -11,6 +11,6 @@ get {
 }
 
 assert {
-  res.body.procedureId: isString 
+  res.body.procedures[0].procedureId: isString
   res.status: eq 200
 }
diff --git a/services/procedures/bruno/pastProcedures.bru b/services/procedures/bruno/pastProcedures.bru
@@ -5,12 +5,16 @@ meta {
 }
 
 get {
-  url: {{url}}/procedures/list/past
+  url: {{url}}/procedures/list/past?limit=2
   body: none
   auth: none
 }
 
+params:query {
+  limit: 2
+}
+
 assert {
-  res.body[0].procedureId: isString
+  res.body.count: gt 0
   res.status: eq 200
 }
diff --git a/services/procedures/bruno/upcomingProcedures.bru b/services/procedures/bruno/upcomingProcedures.bru
@@ -5,12 +5,17 @@ meta {
 }
 
 get {
-  url: {{url}}/procedures/list/upcoming
+  url: {{url}}/procedures/list/upcoming?limit=1&page=2
   body: none
   auth: none
 }
 
+params:query {
+  limit: 1
+  page: 2
+}
+
 assert {
-  res.body[0].procedureId: isString
+  res.body.procedures[0].procedureId: isString
   res.status: eq 200
 }
diff --git a/services/procedures/garden.yml b/services/procedures/garden.yml
@@ -32,7 +32,7 @@ spec:
         sourcePath: src
         mode: one-way
     overrides:
-      - command: [pnpm, --filter, procedures, run, garden:dev]
+      - command: [pnpm, --filter, procedures, run, dev]
   patchResources:
     - name: procedures
       kind: Deployment

diff --git a/services/procedures/src/decorators/pagination.ts b/services/procedures/src/decorators/pagination.ts
@@ -0,0 +1,14 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+
+export const Pagination = createParamDecorator(
+  (data: unknown, ctx: ExecutionContext) => {
+    const request = ctx.switchToHttp().getRequest();
+    const { page = 1, limit = 10 } = request.query;
+
+    // Ensure valid pagination values
+    const validPage = Math.max(1, parseInt(page));
+    const validLimit = Math.min(Math.max(1, parseInt(limit)), 100); // Max limit of 100
+
+    return { page: validPage, limit: validLimit };
+  },
+);
diff --git a/services/procedures/src/procedures/procedures.controller.spec.ts b/services/procedures/src/procedures/procedures.controller.spec.ts
@@ -1,7 +1,6 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { ProceduresController } from './procedures.controller';
 import { ProceduresService } from './procedures.service';
-import { IProcedure } from '@democracy-deutschland/bundestagio-common/dist/models/Procedure/schema';
 
 describe('ProceduresController', () => {
   let controller: ProceduresController;
@@ -10,36 +9,51 @@ describe('ProceduresController', () => {
     jest.Mocked<Partial<ProceduresService>>
   > = {
     findAll: jest.fn(
-      () =>
+      ({}: { page: number; limit: number }) =>
         ({
-          title: 'test',
-          id: 1,
-          procedureId: '123456',
-          type: '',
-          period: '',
-          importantDocuments: [],
-        }) as unknown as Promise<IProcedure & { _id: any }>,
+          procedures: [
+            {
+              title: 'test',
+              id: 1,
+              procedureId: '123456',
+              type: '',
+              period: '',
+              importantDocuments: [],
+            },
+          ],
+          count: 1,
+        }) as any,
     ),
     fetchUpcomingProcedures: jest.fn(
-      () =>
+      ({}: { page: number; limit: number }) =>
         ({
-          title: 'test',
-          id: 1,
-          procedureId: '123456',
-          type: '',
-          period: '',
-          importantDocuments: [],
+          procedures: [
+            {
+              title: 'test',
+              id: 1,
+              procedureId: '123456',
+              type: '',
+              period: '',
+              importantDocuments: [],
+            },
+          ],
+          count: 1,
         }) as any,
     ),
     fetchPastProcedures: jest.fn(
-      () =>
+      ({}: { page: number; limit: number }) =>
         ({
-          title: 'test',
-          id: 1,
-          procedureId: '123456',
-          type: '',
-          period: '',
-          importantDocuments: [],
+          procedures: [
+            {
+              title: 'test',
+              id: 1,
+              procedureId: '123456',
+              type: '',
+              period: '',
+              importantDocuments: [],
+            },
+          ],
+          count: 1,
         }) as any,
     ),
   };
@@ -60,35 +74,65 @@ describe('ProceduresController', () => {
   });
 
   it('should return an array of procedures', async () => {
-    expect(controller.findAll()).toStrictEqual({
-      title: 'test',
-      id: 1,
-      procedureId: '123456',
-      type: '',
-      period: '',
-      importantDocuments: [],
+    expect(
+      controller.findAll({
+        page: 1,
+        limit: 1,
+      }),
+    ).toStrictEqual({
+      procedures: [
+        {
+          title: 'test',
+          id: 1,
+          procedureId: '123456',
+          type: '',
+          period: '',
+          importantDocuments: [],
+        },
+      ],
+      count: 1,
     });
   });
 
   it('should return an array of upcoming procedures', async () => {
-    expect(controller.upcomingProcedures()).toStrictEqual({
-      title: 'test',
-      id: 1,
-      procedureId: '123456',
-      type: '',
-      period: '',
-      importantDocuments: [],
+    expect(
+      controller.upcomingProcedures({
+        page: 1,
+        limit: 1,
+      }),
+    ).toStrictEqual({
+      procedures: [
+        {
+          title: 'test',
+          id: 1,
+          procedureId: '123456',
+          type: '',
+          period: '',
+          importantDocuments: [],
+        },
+      ],
+      count: 1,
     });
   });
 
   it('should return an array of past procedures', async () => {
-    expect(controller.pastProcedures()).toStrictEqual({
-      title: 'test',
-      id: 1,
-      procedureId: '123456',
-      type: '',
-      period: '',
-      importantDocuments: [],
+    expect(
+      controller.pastProcedures({
+        page: 1,
+        limit: 1,
+      }),
+    ).toStrictEqual({
+      procedures: [
+        {
+          title: 'test',
+          id: 1,
+          procedureId: '123456',
+          type: '',
+          period: '',
+          importantDocuments: [],
+        },
+      ],
+      count: 1,
     });
   });
 });
diff --git a/services/procedures/src/procedures/procedures.controller.ts b/services/procedures/src/procedures/procedures.controller.ts
@@ -1,21 +1,33 @@
 import { Controller, Get } from '@nestjs/common';
 import { ProceduresService } from './procedures.service';
+import { Pagination } from '../decorators/pagination';
 
 @Controller('procedures')
 export class ProceduresController {
   constructor(private readonly proceduresService: ProceduresService) {}
   @Get()
-  findAll() {
-    return this.proceduresService.findAll();
+  findAll(@Pagination() pagination: { page: number; limit: number }) {
+    return this.proceduresService.findAll({
+      page: pagination.page,
+      limit: pagination.limit,
+    });
   }
 
   @Get('list/upcoming')
-  upcomingProcedures() {
-    return this.proceduresService.fetchUpcomingProcedures();
+  upcomingProcedures(
+    @Pagination() pagination: { page: number; limit: number },
+  ) {
+    return this.proceduresService.fetchUpcomingProcedures({
+      page: pagination.page,
+      limit: pagination.limit,
+    });
   }
 
   @Get('list/past')
-  pastProcedures() {
-    return this.proceduresService.fetchPastProcedures();
+  pastProcedures(@Pagination() pagination: { page: number; limit: number }) {
+    return this.proceduresService.fetchPastProcedures({
+      page: pagination.page,
+      limit: pagination.limit,
+    });
   }
 }