chore: upgrade nestjs to v7 AB#23108

rodekruis · Aug 14, 2023 · 22c8991 · 22c8991
1 parent 45e5d55
commit 22c8991
Show file tree

Hide file tree

Showing 13 changed files with 1,162 additions and 2,499 deletions.
diff --git a/services/API-service/package-lock.json b/services/API-service/package-lock.json
diff --git a/services/API-service/package.json b/services/API-service/package.json
@@ -24,17 +24,16 @@
   },
   "private": true,
   "dependencies": {
-    "@godaddy/terminus": "^4.6.0",
-    "@nestjs/common": "^6.11.11",
-    "@nestjs/core": "^6.11.11",
-    "@nestjs/microservices": "^6.11.11",
-    "@nestjs/platform-express": "^6.11.11",
+    "@nestjs/common": "^7.6.18",
+    "@nestjs/core": "^7.6.18",
+    "@nestjs/microservices": "^7.6.18",
+    "@nestjs/platform-express": "^7.6.18",
     "@nestjs/schedule": "^0.4.3",
-    "@nestjs/swagger": "^4.7.12",
-    "@nestjs/terminus": "^6.5.6",
-    "@nestjs/testing": "^6.11.11",
+    "@nestjs/swagger": "^4.8.2",
+    "@nestjs/terminus": "^7.2.0",
+    "@nestjs/testing": "^7.6.18",
     "@nestjs/typeorm": "^7.1.5",
-    "@nestjs/websockets": "^6.11.11",
+    "@nestjs/websockets": "^7.6.18",
     "@typescript-eslint/eslint-plugin": "^2.34.0",
     "@typescript-eslint/parser": "^2.34.0",
     "class-transformer": "^0.3.1",

diff --git a/services/API-service/src/api/admin-area-data/admin-area-data.controller.ts b/services/API-service/src/api/admin-area-data/admin-area-data.controller.ts
@@ -24,6 +24,7 @@ import { AdminDataReturnDto } from '../admin-area-dynamic-data/dto/admin-data-re
 import { UserRole } from '../user/user-role.enum';
 import { AdminAreaDataService } from './admin-area-data.service';
 import { UploadAdminAreaDataJsonDto } from './dto/upload-admin-area-data.dto';
+import { FILE_UPLOAD_API_FORMAT } from '../../shared/file-upload-api-format';
 
 @ApiBearerAuth()
 @UseGuards(RolesGuard)
@@ -50,17 +51,7 @@ export class AdminAreaDataController {
   })
   @Post('upload/csv')
   @ApiConsumes('multipart/form-data')
-  @ApiBody({
-    schema: {
-      type: 'object',
-      properties: {
-        file: {
-          type: 'string',
-          format: 'binary',
-        },
-      },
-    },
-  })
+  @ApiBody(FILE_UPLOAD_API_FORMAT)
   @UseInterceptors(FileInterceptor('file'))
   public async uploadCsv(@UploadedFile() adminAreaData): Promise<void> {
     await this.adminAreaDataService.uploadCsv(adminAreaData);

diff --git a/services/API-service/src/api/admin-area-dynamic-data/admin-area-dynamic-data.controller.ts b/services/API-service/src/api/admin-area-dynamic-data/admin-area-dynamic-data.controller.ts
@@ -20,6 +20,7 @@ import { FileInterceptor } from '@nestjs/platform-express';
 import { Roles } from '../../roles.decorator';
 import { UserRole } from '../user/user-role.enum';
 import { Query } from '@nestjs/common/decorators';
+import { FILE_UPLOAD_API_FORMAT } from '../../shared/file-upload-api-format';
 
 @ApiBearerAuth()
 @UseGuards(RolesGuard)
@@ -109,17 +110,7 @@ export class AdminAreaDynamicDataController {
       'Upload raster file (.tif) such as a disaster-extent for given disaster-type (used by IBF-pipelines)',
   })
   @ApiConsumes('multipart/form-data')
-  @ApiBody({
-    schema: {
-      type: 'object',
-      properties: {
-        file: {
-          type: 'string',
-          format: 'binary',
-        },
-      },
-    },
-  })
+  @ApiBody(FILE_UPLOAD_API_FORMAT)
   @ApiParam({ name: 'disasterType', required: true, type: 'string' })
   @ApiResponse({
     status: 201,

diff --git a/services/API-service/src/api/event/event.controller.ts b/services/API-service/src/api/event/event.controller.ts
@@ -37,6 +37,7 @@ import { UserDecorator } from '../user/user.decorator';
 import { FileInterceptor } from '@nestjs/platform-express';
 import stream from 'stream';
 import { Response } from 'express-serve-static-core';
+import { IMAGE_UPLOAD_API_FORMAT } from '../../shared/file-upload-api-format';
 
 @ApiBearerAuth()
 @ApiTags('event')
@@ -221,17 +222,7 @@ export class EventController {
   @ApiParam({ name: 'disasterType', required: true, type: 'string' })
   @ApiParam({ name: 'eventName', required: false, type: 'string' })
   @ApiConsumes('multipart/form-data')
-  @ApiBody({
-    schema: {
-      type: 'object',
-      properties: {
-        image: {
-          type: 'string',
-          format: 'binary',
-        },
-      },
-    },
-  })
+  @ApiBody(IMAGE_UPLOAD_API_FORMAT)
   @ApiResponse({ status: 200, description: 'Post event map image' })
   @Post('/event-map-image/:countryCodeISO3/:disasterType/:eventName')
   @UseInterceptors(FileInterceptor('image'))

diff --git a/services/API-service/src/api/glofas-station/glofas-station.controller.ts b/services/API-service/src/api/glofas-station/glofas-station.controller.ts
@@ -26,6 +26,7 @@ import { UploadTriggerPerStationDto } from './dto/upload-trigger-per-station';
 import { GlofasStationForecastEntity } from './glofas-station-forecast.entity';
 import { GlofasStationEntity } from './glofas-station.entity';
 import { GlofasStationService } from './glofas-station.service';
+import { FILE_UPLOAD_API_FORMAT } from '../../shared/file-upload-api-format';
 
 @ApiBearerAuth()
 @UseGuards(RolesGuard)
@@ -111,17 +112,7 @@ export class GlofasStationController {
   @ApiParam({ name: 'countryCodeISO3', required: true, type: 'string' })
   @Post('upload-csv/:countryCodeISO3')
   @ApiConsumes('multipart/form-data')
-  @ApiBody({
-    schema: {
-      type: 'object',
-      properties: {
-        file: {
-          type: 'string',
-          format: 'binary',
-        },
-      },
-    },
-  })
+  @ApiBody(FILE_UPLOAD_API_FORMAT)
   @UseInterceptors(FileInterceptor('file'))
   public async uploadCsv(
     @UploadedFile() glofasStationData,

diff --git a/services/API-service/src/api/lines-data/lines-data.controller.ts b/services/API-service/src/api/lines-data/lines-data.controller.ts
@@ -22,6 +22,7 @@ import { RolesGuard } from '../../roles.guard';
 import { UserRole } from '../user/user-role.enum';
 import { LinesDataService } from './lines-data.service';
 import { UploadLinesExposureStatusDto } from './dto/upload-asset-exposure-status.dto';
+import { FILE_UPLOAD_API_FORMAT } from '../../shared/file-upload-api-format';
 
 @ApiBearerAuth()
 @ApiTags('lines-data')
@@ -47,17 +48,7 @@ export class LinesDataController {
   @ApiParam({ name: 'countryCodeISO3', required: true, type: 'string' })
   @Post('upload-csv/:linesDataCategory/:countryCodeISO3')
   @ApiConsumes('multipart/form-data')
-  @ApiBody({
-    schema: {
-      type: 'object',
-      properties: {
-        file: {
-          type: 'string',
-          format: 'binary',
-        },
-      },
-    },
-  })
+  @ApiBody(FILE_UPLOAD_API_FORMAT)
   @UseInterceptors(FileInterceptor('file'))
   public async uploadCsv(
     @UploadedFile() linesDataData,

diff --git a/services/API-service/src/api/point-data/point-data.controller.ts b/services/API-service/src/api/point-data/point-data.controller.ts
@@ -27,6 +27,7 @@ import { GeoJson } from '../../shared/geo.model';
 import { UserRole } from '../user/user-role.enum';
 import { PointDataService } from './point-data.service';
 import { UploadAssetExposureStatusDto } from './dto/upload-asset-exposure-status.dto';
+import { FILE_UPLOAD_API_FORMAT } from '../../shared/file-upload-api-format';
 
 @ApiBearerAuth()
 @ApiTags('point-data')
@@ -75,17 +76,7 @@ export class PointDataController {
   @ApiParam({ name: 'countryCodeISO3', required: true, type: 'string' })
   @Post('upload-csv/:pointDataCategory/:countryCodeISO3')
   @ApiConsumes('multipart/form-data')
-  @ApiBody({
-    schema: {
-      type: 'object',
-      properties: {
-        file: {
-          type: 'string',
-          format: 'binary',
-        },
-      },
-    },
-  })
+  @ApiBody(FILE_UPLOAD_API_FORMAT)
   @UseInterceptors(FileInterceptor('file'))
   public async uploadCsv(
     @UploadedFile() pointDataData,

diff --git a/services/API-service/src/api/user/user.decorator.ts b/services/API-service/src/api/user/user.decorator.ts
@@ -1,10 +1,11 @@
-import { createParamDecorator } from '@nestjs/common';
+import { ExecutionContext, createParamDecorator } from '@nestjs/common';
 import * as jwt from 'jsonwebtoken';
 import { User } from './user.model';
 
 export const UserDecorator = createParamDecorator(
-  (data, req): User => {
+  (data, ctx: ExecutionContext): User => {
     // if route is protected, there is a user set in auth.middleware
+    const req = ctx.switchToHttp().getRequest();
     if (!!req.user) {
       return !!data ? req.user[data] : req.user;
     }

diff --git a/services/API-service/src/config.ts b/services/API-service/src/config.ts
@@ -1,6 +1,6 @@
 export const DEBUG = ['production', 'test'].indexOf(process.env.NODE_ENV) < 0;
 export const PORT = 3000;
-export const SCHEME = DEBUG ? 'http' : 'https';
+export const SCHEME = DEBUG ? 'http://' : 'https://';
 
 // Configure Internal and External API URL's
 // ---------------------------------------------------------------------------

diff --git a/services/API-service/src/health.module.ts b/services/API-service/src/health.module.ts
@@ -1,37 +1,24 @@
-import { Module } from '@nestjs/common';
+import { Controller, Get, Module } from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
 import {
   HealthIndicatorResult,
   TerminusModule,
-  TerminusModuleOptions,
   TypeOrmHealthIndicator,
 } from '@nestjs/terminus';
-import { TypeOrmModule } from '@nestjs/typeorm';
 
-const getTerminusOptions = (
-  db: TypeOrmHealthIndicator,
-): TerminusModuleOptions => ({
-  endpoints: [
-    {
-      url: '/health',
-      // All the indicator which will be checked when requesting /health
-      healthIndicators: [
-        // Set the timeout for a response to 300ms
-        async (): Promise<HealthIndicatorResult> =>
-          db.pingCheck('database', { timeout: 300 }),
-      ],
-    },
-  ],
-});
+@ApiTags('-- check API --')
+@Controller('health')
+export class HealthController {
+  @ApiOperation({ summary: 'Check database connection' })
+  @Get()
+  healthCheck(db: TypeOrmHealthIndicator) {
+    async (): Promise<HealthIndicatorResult> =>
+      db.pingCheck('database', { timeout: 300 });
+  }
+}
 
 @Module({
-  imports: [
-    // Make sure TypeOrmModule is available in the module context
-    TypeOrmModule.forRoot(),
-    TerminusModule.forRootAsync({
-      // Inject the TypeOrmHealthIndicator provided by nestjs/terminus
-      inject: [TypeOrmHealthIndicator],
-      useFactory: getTerminusOptions,
-    }),
-  ],
+  controllers: [HealthController],
+  imports: [TerminusModule],
 })
 export class HealthModule {}
diff --git a/services/API-service/src/main.ts b/services/API-service/src/main.ts
@@ -7,7 +7,7 @@ import {
   SwaggerDocumentOptions,
   SwaggerCustomOptions,
 } from '@nestjs/swagger';
-import { ValidationPipe } from '@nestjs/common';
+import { BadRequestException, ValidationPipe } from '@nestjs/common';
 import * as bodyParser from 'body-parser';
 
 async function bootstrap(): Promise<void> {
@@ -26,7 +26,7 @@ async function bootstrap(): Promise<void> {
     .setTitle(apiDocumentationTitle)
     .setDescription(apiDocumentationDescription)
     .setVersion(apiVersion)
-    .addServer(`${SCHEME}://`)
+    .addServer(SCHEME)
     .addBearerAuth()
     .build();
   const swaggerDocumentOptions: SwaggerDocumentOptions = {
@@ -52,7 +52,11 @@ async function bootstrap(): Promise<void> {
     swaggerDocumentOptions,
   );
   SwaggerModule.setup('/docs', app, document, swaggerCustomOptions);
-  app.useGlobalPipes(new ValidationPipe());
+  app.useGlobalPipes(
+    new ValidationPipe({
+      exceptionFactory: errors => new BadRequestException(errors),
+    }),
+  );
   app.use(bodyParser.json({ limit: '25mb' }));
   app.use(
     bodyParser.urlencoded({

diff --git a/services/API-service/src/shared/file-upload-api-format.ts b/services/API-service/src/shared/file-upload-api-format.ts
@@ -0,0 +1,23 @@
+export const FILE_UPLOAD_API_FORMAT = {
+  schema: {
+    type: 'object',
+    properties: {
+      file: {
+        type: 'string',
+        format: 'binary',
+      },
+    },
+  },
+};
+
+export const IMAGE_UPLOAD_API_FORMAT = {
+  schema: {
+    type: 'object',
+    properties: {
+      image: {
+        type: 'string',
+        format: 'binary',
+      },
+    },
+  },
+};