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

FIX: added exception filter to catch unhandled errors

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/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

@@ -6,6 +6,7 @@ import {
   HttpCode,
   HttpStatus,
   Inject,
+  UseFilters,
 } from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
 import {
@@ -22,8 +23,10 @@ import {
 
 import { AuthClientService } from './auth.service';
 import { DadosferaLogger } from 'dadosfera-logs';
+import { GrpcToHttpExceptionFilter } from '../../error/grpc-to-http-exception.filter';
 
 @ApiTags('Auth')
+@UseFilters(new GrpcToHttpExceptionFilter())
 @Controller('auth')
 export class AuthController {
   logger: any;

src/modules/auth/auth.service.ts

@@ -1,35 +1,23 @@
 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;
@@ -52,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 }),
     );
   }
@@ -68,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 }),
     );
   }
@@ -80,7 +66,7 @@ export class AuthClientService implements OnModuleInit {
   }: AuthChangePasswordRequest) {
     this.logger.info('ChangePassword');
 
-    return grpcHandler<AuthChangePasswordResponse>(
+    return lastValueFrom(
       this.authService.AuthChangePassword({
         accessToken,
         oldPassword,
@@ -92,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({
@@ -103,7 +87,7 @@ export class AuthClientService implements OnModuleInit {
   }: AuthVerifyResetPasswordCodeRequest) {
     this.logger.info('verifyResetPasswordCode');
 
-    return grpcHandler<AuthVerifyResetPasswordCodeResponse>(
+    return lastValueFrom(
       this.authService.AuthVerifyResetPasswordCode({ username, code }),
     );
   }
@@ -115,7 +99,7 @@ export class AuthClientService implements OnModuleInit {
   }: AuthConfirmResetPasswordRequest) {
     this.logger.info('confirmResetPassword');
 
-    return grpcHandler<AuthConfirmResetPasswordResponse>(
+    return lastValueFrom(
       this.authService.AuthConfirmResetPassword({
         username,
         code,
@@ -127,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 }),
     );
   }
@@ -135,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 }),
     );
   }
@@ -143,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.service.ts

@@ -5,15 +5,12 @@ import {
   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 {
-  Empty,
-  InjectPermissionsRequest,
-} from 'protospack-v2/dist/lib/Duc/interfaces/messages';
+import { InjectPermissionsRequest } from 'protospack-v2/dist/lib/Duc/interfaces/messages';
 import { DadosferaLogger } from 'dadosfera-logs';
-import grpcHandler from '../../utils/grpcHandler';
 import { Permissions } from '../../authentication/permissions.enum';
 import ErrorBuilder from '../../utils/ErrorBuilder';
 
@@ -66,7 +63,7 @@ export class PermissionsClientService
   async injectPermissions({ permissions }: InjectPermissionsRequest) {
     this.logger.info('InjectPermissions');
 
-    return grpcHandler<Empty>(
+    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);
-  });
-}