feat(web): remove deployment unpaginated

dyrector-io · Dec 3, 2024 · 11bfeb2 · 11bfeb2
1 parent cec5c5a
commit 11bfeb2
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 40 deletions.
diff --git a/web/crux/src/app/deploy/deploy.dto.ts b/web/crux/src/app/deploy/deploy.dto.ts
@@ -33,19 +33,7 @@ export type DeploymentStatusDto = (typeof DEPLOYMENT_STATUS_VALUES)[number]
 
 export type EnvironmentToConfigBundleNameMap = Record<string, string>
 
-export class DeploymentQueryDto {
-  @IsOptional()
-  @IsInt()
-  @Type(() => Number)
-  @ApiProperty()
-  readonly skip?: number
-
-  @IsOptional()
-  @IsInt()
-  @Type(() => Number)
-  @ApiProperty()
-  readonly take?: number
-
+export class DeploymentQueryDto extends PaginationQuery {
   @IsOptional()
   @IsString()
   @Type(() => String)

diff --git a/web/crux/src/app/deploy/deploy.http.controller.ts b/web/crux/src/app/deploy/deploy.http.controller.ts
@@ -88,25 +88,13 @@ export default class DeployHttpController {
       'Get the list of deployments. Request needs to include `teamSlug` in URL. Query could include `skip` and `take` to paginate. A deployment should include `id`, `prefix`, `status`, `note`, `audit` log details, project `name`, `id`, `type`, version `name`, `type`, `id`, and node `name`, `id`, `type`.',
     summary: 'Fetch the list of deployments.',
   })
-  @ApiExtraModels(DeploymentDto, DeploymentListDto)
-  @ApiOkResponse({
-    schema: {
-      anyOf: refs(DeploymentDto, DeploymentListDto),
-    },
-    description: 'List of deployments.',
-  })
+  @ApiOkResponse({ type: DeploymentQueryDto, description: 'Paginated list of deployments.' })
   @ApiForbiddenResponse({ description: 'Unauthorized request for deployments.' })
   async getDeployments(
     @TeamSlug() teamSlug: string,
     @Query() query: DeploymentQueryDto,
-  ): Promise<DeploymentDto[] | DeploymentListDto> {
-    const page = await this.service.getDeployments(teamSlug, query)
-    if (!!query.skip || !!query.take) {
-      return page
-    }
-
-    // NOTE(@robot9706): If no pagination parameters are present return the items only to be backward compatible
-    return page.items
+  ): Promise<DeploymentListDto> {
+    return await this.service.getDeployments(teamSlug, query)
   }
 
   @Get(ROUTE_DEPLOYMENT_ID)

diff --git a/web/crux/src/app/deploy/deploy.service.ts b/web/crux/src/app/deploy/deploy.service.ts
@@ -814,8 +814,8 @@ export default class DeployService {
           },
         },
       },
-      nodeId: query?.nodeId,
-      status: query?.status ? this.mapper.statusDtoToDb(query.status) : undefined,
+      nodeId: query.nodeId,
+      status: query.status ? this.mapper.statusDtoToDb(query.status) : undefined,
     }
 
     if (query.configBundleId) {
@@ -876,8 +876,8 @@ export default class DeployService {
         orderBy: {
           createdAt: 'desc',
         },
-        skip: query?.skip,
-        take: query?.take,
+        skip: query.skip,
+        take: query.take,
         include: {
           version: {
             select: {

diff --git a/web/crux/src/app/node/node.http.controller.ts b/web/crux/src/app/node/node.http.controller.ts
@@ -27,7 +27,7 @@ import {
 import { Identity } from '@ory/kratos-client'
 import UuidParams from 'src/decorators/api-params.decorator'
 import { CreatedResponse, CreatedWithLocation } from '../../interceptors/created-with-location.decorator'
-import { DeploymentDto } from '../deploy/deploy.dto'
+import { DeploymentDto, DeploymentListDto } from '../deploy/deploy.dto'
 import DeployService from '../deploy/deploy.service'
 import { DisableAuth, IdentityFromRequest } from '../token/jwt-auth.guard'
 import NodeTeamAccessGuard from './guards/node.team-access.http.guard'
@@ -46,6 +46,7 @@ import NodeService from './node.service'
 import DeleteNodeValidationPipe from './pipes/node.delete.pipe'
 import NodeGenerateScriptValidationPipe from './pipes/node.generate-script.pipe'
 import NodeGetScriptValidationPipe from './pipes/node.get-script.pipe'
+import { PaginationQuery } from 'src/shared/dtos/paginating'
 
 @Controller(`${ROUTE_TEAM_SLUG}/${ROUTE_NODES}`)
 @ApiTags(ROUTE_NODES)
@@ -265,17 +266,15 @@ export default class NodeHttpController {
     summary: 'Fetch the list of deployments.',
   })
   @ApiOkResponse({
-    type: DeploymentDto,
-    isArray: true,
-    description: 'List of deployments.',
+    type: DeploymentListDto,
+    description: 'Paginated list of deployments.',
   })
   @ApiForbiddenResponse({ description: 'Unauthorized request for deployments.' })
-  async getDeployments(@TeamSlug() teamSlug: string, @NodeId() nodeId: string): Promise<DeploymentDto[]> {
-    const paged = await this.deployService.getDeployments(teamSlug, {
+  async getDeployments(@TeamSlug() teamSlug: string, @NodeId() nodeId: string, @Query() query: PaginationQuery): Promise<DeploymentListDto> {
+    return await this.deployService.getDeployments(teamSlug, {
+      ...query,
       nodeId,
     })
-
-    return paged.items
   }
 
   @Post(`${ROUTE_NODE_ID}/kick`)