fix(json-api-nestjs-microorm): add format for mikroorm error

klerick · klerick · commit c1cafc223c75 · 2025-06-23T11:33:41.000+02:00
diff --git a/libs/json-api/json-api-nestjs-microorm/src/lib/micro-orm-json-api.module.ts b/libs/json-api/json-api-nestjs-microorm/src/lib/micro-orm-json-api.module.ts
@@ -4,6 +4,7 @@ import {
   PrepareParams,
   MODULE_OPTIONS_TOKEN,
   NestProvider,
+  ErrorFormatService,
 } from '@klerick/json-api-nestjs';
 import { MicroOrmParam } from './type';
 
@@ -18,7 +19,7 @@ import {
   CheckRelationNameFactory,
   FindOneRowEntityFactory,
 } from './factory';
-import { MicroOrmUtilService } from './service/micro-orm-util.service';
+import { MicroOrmUtilService, MikroOrmFormatErrorService } from './service';
 
 export class MicroOrmJsonApiModule {
   static forRoot(options: PrepareParams<MicroOrmParam>): DynamicModule {
@@ -40,6 +41,10 @@ export class MicroOrmJsonApiModule {
       CurrentEntityMetadata(),
       RunInTransactionFactory(),
       EntityPropsMap(options.entities),
+      {
+        provide: ErrorFormatService,
+        useClass: MikroOrmFormatErrorService,
+      },
     ];
 
     const currentImport = [
diff --git a/libs/json-api/json-api-nestjs-microorm/src/lib/service/index.ts b/libs/json-api/json-api-nestjs-microorm/src/lib/service/index.ts
@@ -1 +1,3 @@
 export * from './microorm-service';
+export * from './mikro-orm-format.error.service';
+export * from './micro-orm-util.service';
diff --git a/libs/json-api/json-api-nestjs-microorm/src/lib/service/mikro-orm-format.error.service.ts b/libs/json-api/json-api-nestjs-microorm/src/lib/service/mikro-orm-format.error.service.ts
@@ -0,0 +1,117 @@
+import {
+  ErrorFormatService,
+  ValidateQueryError,
+  PrepareParams,
+  MODULE_OPTIONS_TOKEN,
+} from '@klerick/json-api-nestjs';
+import {
+  BadRequestException,
+  ConflictException,
+  HttpException,
+  Inject,
+  HttpExceptionOptions,
+} from '@nestjs/common';
+
+import {
+  DriverException,
+  EntityManager,
+  UniqueConstraintViolationException,
+  ValidationError,
+} from '@mikro-orm/core';
+
+import { CURRENT_ENTITY_MANAGER_TOKEN } from '../constants';
+
+const duplicateItems = (
+  errorText: string,
+  options: HttpExceptionOptions,
+  detail?: string
+) => {
+  errorText = 'Duplicate value';
+  if (detail) {
+    const matches = detail.match(/(?<=\().+?(?=\))/gm);
+    if (matches) {
+      errorText = `Duplicate value in the "${matches[0]}"`;
+    }
+  }
+
+  const error: ValidateQueryError = {
+    code: 'invalid_arguments',
+    message: errorText,
+    path: ['data', 'attributes'],
+  };
+
+  return new ConflictException([error], options);
+};
+
+export class MikroOrmFormatErrorService extends ErrorFormatService {
+  @Inject(CURRENT_ENTITY_MANAGER_TOKEN) em!: EntityManager;
+  @Inject(MODULE_OPTIONS_TOKEN)
+  private mainConfig!: PrepareParams;
+
+  private errorMsg = 'Internal Server Error';
+
+  override formatError(error: unknown): HttpException {
+    try {
+      if (error instanceof ValidationError) {
+        return this.formatValidationError(error);
+      }
+      if (error instanceof DriverException) {
+        return this.prepareDataBaseError(error);
+      }
+      return super.formatError(error);
+    } catch (error) {
+      return super.formatError(error);
+    }
+  }
+
+  private formatValidationError(error: ValidationError) {
+    const { message } = error;
+
+    const entity = error.getEntity();
+    const errorObject: ValidateQueryError = {
+      code: 'invalid_arguments',
+      message: message.split('\n').at(0) || message,
+      path: [],
+    };
+    if (entity) {
+      errorObject['path'] = ['data', 'attributes'];
+    }
+
+    const descriptionOrOptions: HttpExceptionOptions = this.mainConfig.options
+      .debug
+      ? { cause: error }
+      : {};
+
+    return new BadRequestException([errorObject], descriptionOrOptions);
+  }
+
+  private prepareDataBaseError(error: DriverException) {
+    if (
+      !this.em
+        .getPlatform()
+        .getConfig()
+        .getDriver()
+        .constructor.name.startsWith('Postgre')
+    ) {
+      return super.formatError(error);
+    }
+
+    const { errorCode, errorMsg, detail, table } = {
+      errorCode: error.code,
+      errorMsg: error.message,
+      detail: Reflect.get(error, 'detail') as string,
+      table: Reflect.get(error, 'table') as string,
+    };
+    const descriptionOrOptions: HttpExceptionOptions = this.mainConfig.options
+      .debug
+      ? { cause: error }
+      : {};
+
+    switch (error.constructor) {
+      case UniqueConstraintViolationException:
+        return duplicateItems(errorMsg, descriptionOrOptions, detail);
+      default:
+        return super.formatError(error);
+    }
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`export * from './microorm-service';`
	`2`	`+export * from './mikro-orm-format.error.service';`
	`3`	`+export * from './micro-orm-util.service';`