Add exceptions for metadata modules (#6070)

Class exception for each metadata module + handler to map on graphql
error

TODO left :
- find a way to call handler on auto-resolvers nestjs query (probably
interceptors)
- discuss what should be done for pre-hooks errors
- discuss what should be done for Unauthorized exception

packages/twenty-server/src/engine/metadata-modules/object-metadata/utils/assert-mutation-not-on-remote-object.util.ts

@@ -1,11 +1,17 @@
-import { BadRequestException } from '@nestjs/common';
-
 import { ObjectMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/object-metadata.interface';
 
+import {
+  ObjectMetadataException,
+  ObjectMetadataExceptionCode,
+} from 'src/engine/metadata-modules/object-metadata/object-metadata.exception';
+
 export const assertMutationNotOnRemoteObject = (
   objectMetadataItem: ObjectMetadataInterface,
 ) => {
   if (objectMetadataItem.isRemote) {
-    throw new BadRequestException('Remote objects are read-only');
+    throw new ObjectMetadataException(
+      'Remote objects are read-only',
+      ObjectMetadataExceptionCode.OBJECT_MUTATION_NOT_ALLOWED,
+    );
   }
 };

packages/twenty-server/src/engine/metadata-modules/object-metadata/utils/object-metadata-graphql-api-exception-handler.util.ts

@@ -0,0 +1,30 @@
+import {
+  ObjectMetadataException,
+  ObjectMetadataExceptionCode,
+} from 'src/engine/metadata-modules/object-metadata/object-metadata.exception';
+import {
+  UserInputError,
+  ForbiddenError,
+  ConflictError,
+  InternalServerError,
+  NotFoundError,
+} from 'src/engine/utils/graphql-errors.util';
+
+export const objectMetadataGraphqlApiExceptionHandler = (error: Error) => {
+  if (error instanceof ObjectMetadataException) {
+    switch (error.code) {
+      case ObjectMetadataExceptionCode.OBJECT_METADATA_NOT_FOUND:
+        throw new NotFoundError(error.message);
+      case ObjectMetadataExceptionCode.INVALID_OBJECT_INPUT:
+        throw new UserInputError(error.message);
+      case ObjectMetadataExceptionCode.OBJECT_MUTATION_NOT_ALLOWED:
+        throw new ForbiddenError(error.message);
+      case ObjectMetadataExceptionCode.OBJECT_ALREADY_EXISTS:
+        throw new ConflictError(error.message);
+      default:
+        throw new InternalServerError(error.message);
+    }
+  }
+
+  throw error;
+};

packages/twenty-server/src/engine/metadata-modules/object-metadata/utils/validate-object-metadata-input.util.ts

@@ -1,9 +1,13 @@
-import { BadRequestException, ForbiddenException } from '@nestjs/common';
-
-import { InvalidStringException } from 'src/engine/metadata-modules/errors/InvalidStringException';
 import { CreateObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/create-object.input';
 import { UpdateObjectPayload } from 'src/engine/metadata-modules/object-metadata/dtos/update-object.input';
-import { validateMetadataName } from 'src/engine/metadata-modules/utils/validate-metadata-name.utils';
+import {
+  ObjectMetadataException,
+  ObjectMetadataExceptionCode,
+} from 'src/engine/metadata-modules/object-metadata/object-metadata.exception';
+import {
+  validateMetadataName,
+  InvalidStringException,
+} from 'src/engine/metadata-modules/utils/validate-metadata-name.utils';
 import { camelCase } from 'src/utils/camel-case';
 
 const coreObjectNames = [
@@ -55,7 +59,10 @@ export const validateObjectMetadataInputOrThrow = <
 const validateNameIsNotReservedKeywordOrThrow = (name?: string) => {
   if (name) {
     if (reservedKeywords.includes(name)) {
-      throw new ForbiddenException(`The name "${name}" is not available`);
+      throw new ObjectMetadataException(
+        `The name "${name}" is not available`,
+        ObjectMetadataExceptionCode.INVALID_OBJECT_INPUT,
+      );
     }
   }
 };
@@ -63,7 +70,10 @@ const validateNameIsNotReservedKeywordOrThrow = (name?: string) => {
 const validateNameCamelCasedOrThrow = (name?: string) => {
   if (name) {
     if (name !== camelCase(name)) {
-      throw new ForbiddenException(`Name should be in camelCase: ${name}`);
+      throw new ObjectMetadataException(
+        `Name should be in camelCase: ${name}`,
+        ObjectMetadataExceptionCode.INVALID_OBJECT_INPUT,
+      );
     }
   }
 };
@@ -75,8 +85,9 @@ const validateNameCharactersOrThrow = (name?: string) => {
     }
   } catch (error) {
     if (error instanceof InvalidStringException) {
-      throw new BadRequestException(
+      throw new ObjectMetadataException(
         `Characters used in name "${name}" are not supported`,
+        ObjectMetadataExceptionCode.INVALID_OBJECT_INPUT,
       );
     } else {
       throw error;