Merge pull request #119 from dadosfera/fix/error-handling

FIX: added exception filter to catch unhandled errors

.eslintrc.js

@@ -6,6 +6,7 @@ module.exports = {
   },
   plugins: ['@typescript-eslint/eslint-plugin'],
   extends: [
+    'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:prettier/recommended',
   ],

package-lock.json

@@ -36,7 +36,7 @@
         "passport-hubspot-oauth2": "^1.0.3",
         "passport-mailchimp": "^1.1.0",
         "protospack": "2.5.1",
-        "protospack-v2": "1.1.1",
+        "protospack-v2": "3.0.0",
         "reflect-metadata": "^0.1.13",
         "rimraf": "^3.0.2",
         "rxjs": "^7.5.5",
@@ -8997,9 +8997,9 @@
       }
     },
     "node_modules/protospack-v2": {
-      "version": "1.1.1",
-      "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com:443/npm/dadosfera-npm/protospack-v2/-/protospack-v2-1.1.1.tgz",
-      "integrity": "sha512-BqIJSORaqauAT9kF4/cP/uJNCyoT3KxkVkamd7SWARMxnywFB/mpYJg/VDGcyvVOAU4IOLyjnXkrvRuylE0Q2w==",
+      "version": "3.0.0",
+      "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com:443/npm/dadosfera-npm/protospack-v2/-/protospack-v2-3.0.0.tgz",
+      "integrity": "sha512-GEFbf8+vVaq/lA28K4nFf7bOSlghQJn/aeVnrYzh4YJUaa1+ccNz3uQs9p5OGbfjt2u/fFE5rHGEBUtueAA8KA==",
       "dependencies": {
         "rxjs": "^7.5.5",
         "ts-proto": "^1.112.2"
@@ -17198,9 +17198,9 @@
       }
     },
     "protospack-v2": {
-      "version": "1.1.1",
-      "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com:443/npm/dadosfera-npm/protospack-v2/-/protospack-v2-1.1.1.tgz",
-      "integrity": "sha512-BqIJSORaqauAT9kF4/cP/uJNCyoT3KxkVkamd7SWARMxnywFB/mpYJg/VDGcyvVOAU4IOLyjnXkrvRuylE0Q2w==",
+      "version": "3.0.0",
+      "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com:443/npm/dadosfera-npm/protospack-v2/-/protospack-v2-3.0.0.tgz",
+      "integrity": "sha512-GEFbf8+vVaq/lA28K4nFf7bOSlghQJn/aeVnrYzh4YJUaa1+ccNz3uQs9p5OGbfjt2u/fFE5rHGEBUtueAA8KA==",
       "requires": {
         "rxjs": "^7.5.5",
         "ts-proto": "^1.112.2"

package.json

@@ -51,7 +51,7 @@
     "passport-hubspot-oauth2": "^1.0.3",
     "passport-mailchimp": "^1.1.0",
     "protospack": "2.5.1",
-    "protospack-v2": "1.1.1",
+    "protospack-v2": "3.0.0",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.2",
     "rxjs": "^7.5.5",

src/app.module.ts

@@ -7,7 +7,6 @@ import { InputsController } from './modules/inputs/inputs.controller';
 import { TransformationsController } from './modules/transformations/transformations.controller';
 import { OutputsController } from './modules/outputs/outputs.controllers';
 import { PipelinesController } from './modules/pipelines/pipelines.controller';
-import { AuthController } from './modules/auth/auth.controller';
 import { HealthController } from './modules/health/health.controller';
 
 import { InputsService } from './modules/inputs/inputs.service';
@@ -16,16 +15,15 @@ import { OutputsService } from './modules/outputs/outputs.service';
 import { PipelinesService } from './modules/pipelines/pipelines.service';
 import { HealthService } from './modules/health/health.service';
 
-import { AuthClientService } from './clients/auth/client.service';
+import { AuthModule } from './modules/auth/auth.module';
 import { InputsClientService } from './clients/inputs/client.service';
 import { TransformationsClientService } from './clients/transformations/client.service';
 import { OutputsClientService } from './clients/outputs/client.service';
 import { PipelinesClientService } from './clients/pipelines/client.service';
-import { PermissionsClientService } from './clients/permissions/client.service';
+import { PermissionsModule } from './modules/permissions/permissions.module';
 
 import { OutputsClientConfiguration } from './clients/outputs/client.config';
 import { TransformationsClientConfiguration } from './clients/transformations/client.config';
-import { DucClient } from './clients/duc/client.config';
 import { InputsClientConfiguration } from './clients/inputs/client.config';
 import { PipelinesClientConfiguration } from './clients/pipelines/client.config';
 import { CatalogController } from './modules/catalog/catalog.controller';
@@ -43,7 +41,6 @@ import { ConnectorClientConfiguration } from './clients/connector/client.config'
 import { ConnectorController } from './modules/connector/connector.controller';
 import { ConnectorClientService } from './clients/connector/client.service';
 
-const ducClient = new DucClient();
 const inputClient = new InputsClientConfiguration();
 const outputClient = new OutputsClientConfiguration();
 const pipelineClient = new PipelinesClientConfiguration();
@@ -56,7 +53,6 @@ const connectorClient = new ConnectorClientConfiguration();
     TransformationsController,
     OutputsController,
     PipelinesController,
-    AuthController,
     HealthController,
     CatalogController,
     OauthController,
@@ -75,8 +71,6 @@ const connectorClient = new ConnectorClientConfiguration();
     TransformationsClientService,
     OutputsClientService,
     PipelinesClientService,
-    AuthClientService,
-    PermissionsClientService,
     CatalogService,
     HubspotStrategy,
     FacebookStrategy,
@@ -92,6 +86,8 @@ const connectorClient = new ConnectorClientConfiguration();
     ConfigModule.forRoot({
       isGlobal: true,
     }),
+    AuthModule,
+    PermissionsModule,
 
     ClientsModule.register([
       {
@@ -106,10 +102,6 @@ const connectorClient = new ConnectorClientConfiguration();
         name: 'OUTPUTS_PACKAGE',
         ...outputClient.config(),
       },
-      {
-        name: 'DUC_PACKAGE',
-        ...ducClient.config(),
-      },
       {
         name: 'PIPELINES_PACKAGE',
         ...pipelineClient.config(),

src/authentication/authentication.guard.spec.ts

@@ -14,7 +14,7 @@ import {
 } from './authentication.decorator';
 import { AuthenticationGuard } from './authentication.guard';
 import { Permissions } from './permissions.enum';
-import { AuthClientService } from '../clients/auth/client.service';
+import { AuthClientService } from '../modules/auth/auth.service';
 
 import ErrorCodes from '../utils/errorCodes';
 

src/authentication/authentication.guard.ts

@@ -10,7 +10,7 @@ import { Reflector } from '@nestjs/core';
 import assert from 'assert';
 import jwt from 'jsonwebtoken';
 import { DadosferaLogger } from 'dadosfera-logs';
-import { AuthClientService } from '../clients/auth/client.service';
+import { AuthClientService } from '../modules/auth/auth.service';
 import {
   AuthenticationFunction,
   AUTH_FUNCTION_KEY,

src/authentication/user.decorator.spec.ts

@@ -7,7 +7,7 @@ import jwt from 'jsonwebtoken';
 import { Controller, Get } from '@nestjs/common';
 import { DadosferaLogger } from 'dadosfera-logs';
 import { AuthenticationGuard } from './authentication.guard';
-import { AuthClientService } from '../clients/auth/client.service';
+import { AuthClientService } from '../modules/auth/auth.service';
 
 import ErrorCodes from '../utils/errorCodes';
 import { User } from './user.decorator';

src/clients/permissions/client.service.ts

@@ -1,39 +0,0 @@
-import { OnModuleInit, Inject } from '@nestjs/common';
-import { ClientGrpc } from '@nestjs/microservices';
-
-import { ProtoServices } from 'protospack-v2/dist/lib/Duc';
-import { PermissionsProtoService as PermissionsServiceInterface } from 'protospack-v2/dist/lib/Duc/interfaces/write-service';
-import {
-  Empty,
-  InjectPermissionsRequest,
-} from 'protospack-v2/dist/lib/Duc/interfaces/messages';
-import { DadosferaLogger } from 'dadosfera-logs';
-import grpcHandler from '../../utils/grpcHandler';
-
-export class PermissionsClientService implements OnModuleInit {
-  logger: any;
-
-  private permissionsService: PermissionsServiceInterface;
-  constructor(
-    @Inject(DadosferaLogger)
-    dadosferaLogger: DadosferaLogger,
-    @Inject('DUC_PACKAGE') private readonly grpcClient: ClientGrpc,
-  ) {
-    this.logger = dadosferaLogger.logger;
-  }
-
-  onModuleInit() {
-    this.permissionsService =
-      this.grpcClient.getService<PermissionsServiceInterface>(
-        ProtoServices.PermissionsProtoService,
-      );
-  }
-
-  async injectPermissions({ permissions }: InjectPermissionsRequest) {
-    this.logger.info('InjectPermissions');
-
-    return grpcHandler<Empty>(
-      this.permissionsService.InjectPermissions({ permissions }),
-    );
-  }
-}

src/error/grpc-to-http-exception.filter.ts

@@ -0,0 +1,22 @@
+import { ExceptionFilter, Catch, ArgumentsHost } from '@nestjs/common';
+import { Response } from 'express';
+
+import ErrorBuilder from '../utils/ErrorBuilder';
+
+@Catch(Error)
+export class GrpcToHttpExceptionFilter implements ExceptionFilter {
+  catch(exception: any, host: ArgumentsHost) {
+    const ctx = host.switchToHttp();
+    const response = ctx.getResponse<Response>();
+
+    // return this exception directly if is already of type ErrorBuilder,
+    // else transform it using the ErrorBuilder
+    const err =
+      exception.constructor.name === ErrorBuilder.name
+        ? exception
+        : new ErrorBuilder(exception.details);
+
+    const { statusCode } = err.response;
+    return response.status(statusCode).json(err.response);
+  }
+}

src/main.ts

@@ -1,20 +1,17 @@
-import 'elastic-apm-node/start';
+if (process.env.ENV !== 'local') require('elastic-apm-node/start');
 import { NestFactory } from '@nestjs/core';
 import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
-import { writeFileSync } from 'fs';
 import helmet from 'helmet';
 import { DadosferaLogger } from 'dadosfera-logs';
 
 import documentEmpty from '../swagger_empty.json';
 
 import { AppModule } from './app.module';
-
 async function bootstrap() {
   DadosferaLogger.setupLogger({
     serviceName: 'maestro',
     serviceEnvironment: process.env.ENV,
   });
-
   const logger = new DadosferaLogger().logger;
 
   const orginalWinstonLog = logger.log.bind(logger);

src/modules/auth/auth.controller.ts

@@ -5,8 +5,8 @@ import {
   Post,
   HttpCode,
   HttpStatus,
-  OnApplicationBootstrap,
   Inject,
+  UseFilters,
 } from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
 import {
@@ -21,50 +21,24 @@ import {
   AuthVerifyTotpMfaRequest,
 } from 'protospack-v2/dist/lib/Duc/interfaces/messages';
 
-import { AuthClientService } from '../../clients/auth/client.service';
-import { PermissionsClientService } from '../../clients/permissions/client.service';
-import { Permissions } from '../../authentication/permissions.enum';
+import { AuthClientService } from './auth.service';
 import { DadosferaLogger } from 'dadosfera-logs';
-import ErrorBuilder from '../../utils/ErrorBuilder';
+import { GrpcToHttpExceptionFilter } from '../../error/grpc-to-http-exception.filter';
 
 @ApiTags('Auth')
+@UseFilters(new GrpcToHttpExceptionFilter())
 @Controller('auth')
-export class AuthController implements OnApplicationBootstrap {
+export class AuthController {
   logger: any;
 
   constructor(
     @Inject(DadosferaLogger)
     dadosferaLogger: DadosferaLogger,
     private authClient: AuthClientService,
-    private permissionsClient: PermissionsClientService,
   ) {
     this.logger = dadosferaLogger.logger;
   }
 
-  // internally used to send permissions to duc on microservice startup
-  async onApplicationBootstrap() {
-    this.logger.info('sending permissions to DUC...');
-
-    const permissions = Object.values(Permissions).flatMap((namespace) =>
-      Object.values(namespace),
-    );
-
-    return this.permissionsClient
-      .injectPermissions({ permissions })
-      .catch((err: ErrorBuilder) => {
-        if (
-          err.code === 'No connection established' &&
-          process.env.LOCAL_ENV === 'true'
-        ) {
-          return this.logger.info(
-            "couldn't connect to DUC. suppresing in local env",
-          );
-        }
-
-        throw err;
-      });
-  }
-
   @Post('sign-in')
   @HttpCode(HttpStatus.OK)
   async signIn(@Body() { username, password, totp }: AuthSignInRequest) {

src/modules/auth/auth.module.ts

@@ -0,0 +1,24 @@
+import { Module } from '@nestjs/common';
+import { ClientsModule } from '@nestjs/microservices';
+import { DadosferaLogger } from 'dadosfera-logs';
+
+import { AuthController } from './auth.controller';
+import { AuthClientService } from './auth.service';
+
+import { DucClient } from '../../clients/duc/client.config';
+const ducClient = new DucClient();
+
+@Module({
+  imports: [
+    ClientsModule.register([
+      {
+        name: 'DUC_PACKAGE',
+        ...ducClient.config(),
+      },
+    ]),
+  ],
+  controllers: [AuthController],
+  providers: [AuthClientService, DadosferaLogger],
+  exports: [AuthClientService],
+})
+export class AuthModule {}

src/modules/auth/auth.service.ts

@@ -1,35 +1,24 @@
-import { OnModuleInit, Inject } from '@nestjs/common';
+import { OnModuleInit, Inject, Injectable } from '@nestjs/common';
 import { ClientGrpc } from '@nestjs/microservices';
 import { DadosferaLogger } from 'dadosfera-logs';
+import { lastValueFrom } from 'rxjs';
 
 import { ProtoServices } from 'protospack-v2/dist/lib/Duc';
 import { AuthProtoService as AuthServiceInterface } from 'protospack-v2/dist/lib/Duc/interfaces/write-service';
 import {
-  AuthGetPublicKeysResponse,
   AuthSignInRequest,
-  AuthSignInResponse,
   AuthRefreshAccessTokenRequest,
-  AuthRefreshAccessTokenResponse,
   AuthEnableTotpMfaRequest,
-  AuthEnableTotpMfaResponse,
   AuthDisableTotpMfaRequest,
-  AuthDisableTotpMfaResponse,
   AuthDismissTotpMfaRequest,
-  AuthDismissTotpMfaResponse,
   AuthVerifyTotpMfaRequest,
-  AuthVerifyTotpMfaResponse,
   AuthChangePasswordRequest,
-  AuthChangePasswordResponse,
   AuthResetPasswordRequest,
-  AuthResetPasswordResponse,
   AuthVerifyResetPasswordCodeRequest,
-  AuthVerifyResetPasswordCodeResponse,
   AuthConfirmResetPasswordRequest,
-  AuthConfirmResetPasswordResponse,
 } from 'protospack-v2/dist/lib/Duc/interfaces/messages';
 
-import grpcHandler from '../../utils/grpcHandler';
-
+@Injectable()
 export class AuthClientService implements OnModuleInit {
   logger: any;
 
@@ -51,15 +40,13 @@ export class AuthClientService implements OnModuleInit {
   async getPublicKeys() {
     this.logger.info('GetPublicKeys');
 
-    return grpcHandler<AuthGetPublicKeysResponse>(
-      this.authService.AuthGetPublicKeys({}),
-    );
+    return lastValueFrom(this.authService.AuthGetPublicKeys({}));
   }
 
   async signIn({ username, password, totp }: AuthSignInRequest) {
     this.logger.info('SignIn');
 
-    return grpcHandler<AuthSignInResponse>(
+    return lastValueFrom(
       this.authService.AuthSignIn({ username, password, totp }),
     );
   }
@@ -67,7 +54,7 @@ export class AuthClientService implements OnModuleInit {
   async refreshAccessToken({ refreshToken }: AuthRefreshAccessTokenRequest) {
     this.logger.info('RefreshAccessToken');
 
-    return grpcHandler<AuthRefreshAccessTokenResponse>(
+    return lastValueFrom(
       this.authService.AuthRefreshAccessToken({ refreshToken }),
     );
   }
@@ -79,7 +66,7 @@ export class AuthClientService implements OnModuleInit {
   }: AuthChangePasswordRequest) {
     this.logger.info('ChangePassword');
 
-    return grpcHandler<AuthChangePasswordResponse>(
+    return lastValueFrom(
       this.authService.AuthChangePassword({
         accessToken,
         oldPassword,
@@ -91,9 +78,7 @@ export class AuthClientService implements OnModuleInit {
   async resetPassword({ username }: AuthResetPasswordRequest) {
     this.logger.info('resetPassword');
 
-    return grpcHandler<AuthResetPasswordResponse>(
-      this.authService.AuthResetPassword({ username }),
-    );
+    return lastValueFrom(this.authService.AuthResetPassword({ username }));
   }
 
   async verifyResetPasswordCode({
@@ -102,7 +87,7 @@ export class AuthClientService implements OnModuleInit {
   }: AuthVerifyResetPasswordCodeRequest) {
     this.logger.info('verifyResetPasswordCode');
 
-    return grpcHandler<AuthVerifyResetPasswordCodeResponse>(
+    return lastValueFrom(
       this.authService.AuthVerifyResetPasswordCode({ username, code }),
     );
   }
@@ -114,7 +99,7 @@ export class AuthClientService implements OnModuleInit {
   }: AuthConfirmResetPasswordRequest) {
     this.logger.info('confirmResetPassword');
 
-    return grpcHandler<AuthConfirmResetPasswordResponse>(
+    return lastValueFrom(
       this.authService.AuthConfirmResetPassword({
         username,
         code,
@@ -126,7 +111,7 @@ export class AuthClientService implements OnModuleInit {
   async enableTotpMFA({ accessToken, password }: AuthEnableTotpMfaRequest) {
     this.logger.info('enableTotpMFA');
 
-    return grpcHandler<AuthEnableTotpMfaResponse>(
+    return lastValueFrom(
       this.authService.AuthEnableTotpMfa({ accessToken, password }),
     );
   }
@@ -134,7 +119,7 @@ export class AuthClientService implements OnModuleInit {
   async disableTotpMFA({ accessToken, password }: AuthDisableTotpMfaRequest) {
     this.logger.info('disableTotpMFA');
 
-    return grpcHandler<AuthDisableTotpMfaResponse>(
+    return lastValueFrom(
       this.authService.AuthDisableTotpMfa({ accessToken, password }),
     );
   }
@@ -142,15 +127,13 @@ export class AuthClientService implements OnModuleInit {
   async dismissTotpMFA({ accessToken }: AuthDismissTotpMfaRequest) {
     this.logger.info('dismissTotpMFA');
 
-    return grpcHandler<AuthDismissTotpMfaResponse>(
-      this.authService.AuthDismissTotpMfa({ accessToken }),
-    );
+    return lastValueFrom(this.authService.AuthDismissTotpMfa({ accessToken }));
   }
 
   async verifyTotp({ accessToken, totp }: AuthVerifyTotpMfaRequest) {
     this.logger.info('disableTotpMFA');
 
-    return grpcHandler<AuthVerifyTotpMfaResponse>(
+    return lastValueFrom(
       this.authService.AuthVerifyTotpMfa({ accessToken, totp }),
     );
   }

src/modules/permissions/permissions.module.ts

@@ -0,0 +1,21 @@
+import { Module } from '@nestjs/common';
+import { ClientsModule } from '@nestjs/microservices';
+import { DadosferaLogger } from 'dadosfera-logs';
+
+import { PermissionsClientService } from './permissions.service';
+
+import { DucClient } from '../../clients/duc/client.config';
+const ducClient = new DucClient();
+
+@Module({
+  imports: [
+    ClientsModule.register([
+      {
+        name: 'DUC_PACKAGE',
+        ...ducClient.config(),
+      },
+    ]),
+  ],
+  providers: [PermissionsClientService, DadosferaLogger],
+})
+export class PermissionsModule {}

src/modules/permissions/permissions.service.ts

@@ -0,0 +1,70 @@
+import {
+  OnApplicationBootstrap,
+  OnModuleInit,
+  Inject,
+  Injectable,
+} from '@nestjs/common';
+import { ClientGrpc } from '@nestjs/microservices';
+import { lastValueFrom } from 'rxjs';
+
+import { ProtoServices } from 'protospack-v2/dist/lib/Duc';
+import { PermissionsProtoService as PermissionsServiceInterface } from 'protospack-v2/dist/lib/Duc/interfaces/write-service';
+import { InjectPermissionsRequest } from 'protospack-v2/dist/lib/Duc/interfaces/messages';
+import { DadosferaLogger } from 'dadosfera-logs';
+import { Permissions } from '../../authentication/permissions.enum';
+import ErrorBuilder from '../../utils/ErrorBuilder';
+
+@Injectable()
+export class PermissionsClientService
+  implements OnModuleInit, OnApplicationBootstrap
+{
+  logger: any;
+
+  private permissionsService: PermissionsServiceInterface;
+  constructor(
+    @Inject(DadosferaLogger)
+    dadosferaLogger: DadosferaLogger,
+    @Inject('DUC_PACKAGE') private readonly grpcClient: ClientGrpc,
+  ) {
+    this.logger = dadosferaLogger.logger;
+  }
+
+  onModuleInit() {
+    this.permissionsService =
+      this.grpcClient.getService<PermissionsServiceInterface>(
+        ProtoServices.PermissionsProtoService,
+      );
+  }
+
+  // internally used to send permissions to duc on microservice startup
+  async onApplicationBootstrap() {
+    this.logger.info('sending permissions to DUC...');
+
+    const permissions = Object.values(Permissions).flatMap((namespace) =>
+      Object.values(namespace),
+    );
+
+    return this.injectPermissions({
+      permissions,
+    }).catch((err: ErrorBuilder) => {
+      if (
+        err.code === 'No connection established' &&
+        process.env.LOCAL_ENV === 'true'
+      ) {
+        return this.logger.info(
+          "couldn't connect to DUC. suppresing in local env",
+        );
+      }
+
+      throw err;
+    });
+  }
+
+  async injectPermissions({ permissions }: InjectPermissionsRequest) {
+    this.logger.info('InjectPermissions');
+
+    return lastValueFrom(
+      this.permissionsService.InjectPermissions({ permissions }),
+    );
+  }
+}

src/utils/ErrorBuilder.ts

@@ -3,7 +3,7 @@ import { RpcException } from '@nestjs/microservices';
 
 import ErrorCodes from './errorCodes';
 
-function enrichErrorCode(code: string) {
+export function EnrichErrorCode(code: string) {
   switch (code) {
     case ErrorCodes.AUTH.WRONG_CREDENTIALS:
       return {
@@ -138,7 +138,7 @@ export default class ErrorBuilder extends HttpException {
       logger.log(code);
     }
 
-    const { statusCode, message, error, code: rCode } = enrichErrorCode(code);
+    const { statusCode, message, error, code: rCode } = EnrichErrorCode(code);
     super({ statusCode, message, error, code: rCode }, statusCode);
     this.code = code;
   }

src/utils/grpcHandler.ts

@@ -1,19 +0,0 @@
-import { Logger } from '@nestjs/common';
-import { RpcException } from '@nestjs/microservices';
-import { from } from 'rxjs';
-
-import ErrorBuilder from './ErrorBuilder';
-
-const logger = new Logger();
-
-export default async function grpcHandler<T>(method: Promise<T>) {
-  return new Promise<T>((resolve, reject) => {
-    from(method).subscribe({
-      next: resolve,
-      error: reject,
-      complete: () => logger.log('done'),
-    });
-  }).catch((err: RpcException) => {
-    throw new ErrorBuilder(err);
-  });
-}