feature: add general error response format

Author: VMihalov

generators/auth/templates/mongodb/jwt/src/_main.ts

@@ -5,19 +5,35 @@ import { NestFactory } from '@nestjs/core';
 import { ValidationPipe, ValidationError } from '@nestjs/common';
 import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
 import { ConfigService } from '@nestjs/config';
-import ValidationExceptions from './exceptions/validation.exceptions';
 
 import AppModule from './modules/app/app.module';
 
-import AllExceptionsFilter from './filters/all-exceptions.filter';
+import ValidationExceptions from './exceptions/validation.exceptions';
+
+import {
+ BadRequestExceptionFilter,
+ UnauthorizedExceptionFilter,
+ ForbiddenExceptionFilter,
+ ValidationExceptionsFilter,
+ NotFoundExceptionFilter,
+ AllExceptionsFilter,
+} from './filters';
 
 async function bootstrap() {
  const app = await NestFactory.create(AppModule);
 
  app.useGlobalPipes(new ValidationPipe({
  exceptionFactory: (errors: ValidationError[]) => new ValidationExceptions(errors),
  }));
- app.useGlobalFilters(new AllExceptionsFilter());
+
+ app.useGlobalFilters(
+ new AllExceptionsFilter(),
+ new UnauthorizedExceptionFilter(),
+ new ForbiddenExceptionFilter(),
+ new BadRequestExceptionFilter(),
+ new NotFoundExceptionFilter(),
+ new ValidationExceptionsFilter(),
+ );
 
  const configService = app.get(ConfigService);
  const port = configService.get<number>('SERVER_POR') || 3000;

generators/auth/templates/mongodb/jwt/src/exceptions/validation.exceptions.ts

@@ -2,16 +2,12 @@ import { BadRequestException, ValidationError } from '@nestjs/common';
 
 function transform(errors: ValidationError[]) {
  return errors.map((error) => {
- return {
- detail: `${error.property} validation error`,
- source: { pointer: `data/attributes/${error.property}` },
- meta: error.constraints ? Object.values(error.constraints) : null,
- };
+ return Object.values(error.constraints) ?? [];
  });
 }
 
 export default class ValidationExceptions extends BadRequestException {
  constructor(public validationErrors: ValidationError[]) {
- super({ errorType: 'ValidationError', errors: transform(validationErrors) });
+ super({ error: 'ValidationError', messages: transform(validationErrors).flat() });
  }
 }

generators/auth/templates/mongodb/jwt/src/filters/all-exceptions.filter.ts

@@ -1,13 +1,16 @@
+import { Response as ExpressResponse } from 'express';
 import {
- ArgumentsHost, Catch, ExceptionFilter, HttpStatus,
+ ArgumentsHost,
+ Catch,
+ ExceptionFilter,
+ HttpStatus,
 } from '@nestjs/common';
-import { Response as ExpressResponse } from 'express';
-import { ExceptionResponse } from '@interfaces/exception-response.interface';
 import { HttpArgumentsHost } from '@nestjs/common/interfaces';
-import { Error } from 'jsonapi-serializer';
+
+import { ExceptionResponse } from '@interfaces/exception-response.interface';
 
 @Catch()
-export default class AllExceptionsFilter implements ExceptionFilter {
+export class AllExceptionsFilter implements ExceptionFilter {
  catch(exception: any, host: ArgumentsHost) {
  const ctx: HttpArgumentsHost = host.switchToHttp();
  const res = ctx.getResponse<ExpressResponse>();
@@ -21,24 +24,25 @@ export default class AllExceptionsFilter implements ExceptionFilter {
  };
 
  if (exception.code === mongodbCodes.bulkWriteError) {
- return res.status(HttpStatus.CONFLICT).json(
- new Error({
- source: { pointer: '/data/attributes/email' },
- title: 'Duplicate key',
- detail: exception.message,
- }),
- );
+ return res.status(HttpStatus.CONFLICT).json({
+ error: 'Duplicate key',
+ message: exception.message,
+ });
  }
 
- if (exception.response?.errorType === 'ValidationError') {
- return res.status(HttpStatus.BAD_REQUEST).json(
- new Error(exceptionResponse ? exceptionResponse.errors : {}),
- );
+ const errorBody = {
+ error: exception.name,
+ message: exception.message,
+ };
+
+ if (exceptionResponse) {
+ if (Array.isArray(exceptionResponse.message)) {
+ Reflect.set(errorBody, 'messages', exceptionResponse.message);
+ } else {
+ Reflect.set(errorBody, 'message', exceptionResponse.message);
+ }
  }
 
- return res.status(status).json(new Error({
- title: exceptionResponse?.error,
- detail: exception?.message,
- }));
+ return res.status(status).json(errorBody);
  }
 }

generators/auth/templates/mongodb/jwt/src/filters/bad-request-exception.filter.ts

@@ -0,0 +1,33 @@
+import { Response as ExpressResponse } from 'express';
+import {
+ ArgumentsHost,
+ Catch,
+ ExceptionFilter,
+ HttpStatus,
+ BadRequestException,
+} from '@nestjs/common';
+import { HttpArgumentsHost } from '@nestjs/common/interfaces';
+
+import { ExceptionResponse } from '@interfaces/exception-response.interface';
+
+@Catch(BadRequestException)
+export class BadRequestExceptionFilter implements ExceptionFilter {
+ catch(exception: any, host: ArgumentsHost) {
+ const ctx: HttpArgumentsHost = host.switchToHttp();
+ const res = ctx.getResponse<ExpressResponse>();
+
+ const exceptionResponse: ExceptionResponse = exception.getResponse() as ExceptionResponse;
+
+ const errorBody = {
+ error: exception.name,
+ };
+
+ if (Array.isArray(exceptionResponse.message)) {
+ Reflect.set(errorBody, 'messages', exceptionResponse.message);
+ } else {
+ Reflect.set(errorBody, 'message', exceptionResponse.message);
+ }
+
+ return res.status(HttpStatus.BAD_REQUEST).json(errorBody);
+ }
+}

generators/auth/templates/mongodb/jwt/src/filters/forbidden-exception.filter.ts

@@ -0,0 +1,33 @@
+import { Response as ExpressResponse } from 'express';
+import {
+ ArgumentsHost,
+ Catch,
+ ExceptionFilter,
+ HttpStatus,
+ ForbiddenException,
+} from '@nestjs/common';
+import { HttpArgumentsHost } from '@nestjs/common/interfaces';
+
+import { ExceptionResponse } from '@interfaces/exception-response.interface';
+
+@Catch(ForbiddenException)
+export class ForbiddenExceptionFilter implements ExceptionFilter {
+ catch(exception: any, host: ArgumentsHost) {
+ const ctx: HttpArgumentsHost = host.switchToHttp();
+ const res = ctx.getResponse<ExpressResponse>();
+
+ const exceptionResponse: ExceptionResponse = exception.getResponse() as ExceptionResponse;
+
+ const errorBody = {
+ error: exception.name,
+ };
+
+ if (Array.isArray(exceptionResponse.message)) {
+ Reflect.set(errorBody, 'messages', exceptionResponse.message);
+ } else {
+ Reflect.set(errorBody, 'message', exceptionResponse.message);
+ }
+
+ return res.status(HttpStatus.FORBIDDEN).json(errorBody);
+ }
+}

generators/auth/templates/mongodb/jwt/src/filters/index.ts

@@ -0,0 +1,6 @@
+export * from './all-exceptions.filter';
+export * from './bad-request-exception.filter';
+export * from './forbidden-exception.filter';
+export * from './not-found-exception.filter';
+export * from './unauthorized-exception.filter';
+export * from './validation-exceptions.filter';

generators/auth/templates/mongodb/jwt/src/filters/not-found-exception.filter.ts

@@ -0,0 +1,33 @@
+import { Response as ExpressResponse } from 'express';
+import {
+ ArgumentsHost,
+ Catch,
+ ExceptionFilter,
+ HttpStatus,
+ NotFoundException,
+} from '@nestjs/common';
+import { HttpArgumentsHost } from '@nestjs/common/interfaces';
+
+import { ExceptionResponse } from '@interfaces/exception-response.interface';
+
+@Catch(NotFoundException)
+export class NotFoundExceptionFilter implements ExceptionFilter {
+ catch(exception: any, host: ArgumentsHost) {
+ const ctx: HttpArgumentsHost = host.switchToHttp();
+ const res = ctx.getResponse<ExpressResponse>();
+
+ const exceptionResponse: ExceptionResponse = exception.getResponse() as ExceptionResponse;
+
+ const errorBody = {
+ error: exception.name,
+ };
+
+ if (Array.isArray(exceptionResponse.message)) {
+ Reflect.set(errorBody, 'messages', exceptionResponse.message);
+ } else {
+ Reflect.set(errorBody, 'message', exceptionResponse.message);
+ }
+
+ return res.status(HttpStatus.NOT_FOUND).json(errorBody);
+ }
+}

generators/auth/templates/mongodb/jwt/src/filters/unauthorized-exception.filter.ts

@@ -0,0 +1,33 @@
+import { Response as ExpressResponse } from 'express';
+import {
+ ArgumentsHost,
+ Catch,
+ ExceptionFilter,
+ HttpStatus,
+ UnauthorizedException,
+} from '@nestjs/common';
+import { HttpArgumentsHost } from '@nestjs/common/interfaces';
+
+import { ExceptionResponse } from '@interfaces/exception-response.interface';
+
+@Catch(UnauthorizedException)
+export class UnauthorizedExceptionFilter implements ExceptionFilter {
+ catch(exception: any, host: ArgumentsHost) {
+ const ctx: HttpArgumentsHost = host.switchToHttp();
+ const res = ctx.getResponse<ExpressResponse>();
+
+ const exceptionResponse: ExceptionResponse = exception.getResponse() as ExceptionResponse;
+
+ const errorBody = {
+ error: exception.name,
+ };
+
+ if (Array.isArray(exceptionResponse.message)) {
+ Reflect.set(errorBody, 'messages', exceptionResponse.message);
+ } else {
+ Reflect.set(errorBody, 'message', exceptionResponse.message);
+ }
+
+ return res.status(HttpStatus.UNAUTHORIZED).json(errorBody);
+ }
+}

generators/auth/templates/mongodb/jwt/src/filters/validation-exceptions.filter.ts

@@ -0,0 +1,26 @@
+import { Response as ExpressResponse } from 'express';
+import {
+ ArgumentsHost,
+ Catch,
+ ExceptionFilter,
+ HttpStatus,
+} from '@nestjs/common';
+import { HttpArgumentsHost } from '@nestjs/common/interfaces';
+
+import { ExceptionResponse } from '@interfaces/exception-response.interface';
+import ValidationExceptions from '@exceptions/validation.exceptions';
+
+@Catch(ValidationExceptions)
+export class ValidationExceptionsFilter implements ExceptionFilter {
+ catch(exception: any, host: ArgumentsHost) {
+ const ctx: HttpArgumentsHost = host.switchToHttp();
+ const res = ctx.getResponse<ExpressResponse>();
+
+ const exceptionResponse: ExceptionResponse = exception.getResponse() as ExceptionResponse;
+
+ return res.status(HttpStatus.BAD_REQUEST).json({
+ error: exception.name,
+ messages: exceptionResponse.messages,
+ });
+ }
+}

generators/auth/templates/mongodb/jwt/src/interfaces/exception-response.interface.ts

@@ -1,13 +1,9 @@
-import { JSONAPIErrorOptions } from 'jsonapi-serializer';
-
 export interface ExceptionResponse {
- readonly message: unknown;
-
  readonly statusCode: number;
 
  readonly error: string;
 
- readonly errorType: string;
+ readonly message: unknown;
 
- readonly errors: JSONAPIErrorOptions[];
+ readonly messages: unknown[];
 }