init common exception handling

Author: etiennejouan

packages/twenty-server/src/engine/api/common/common-query-runners/common-find-one-query-runner.service.ts

@@ -11,12 +11,12 @@ import { WorkspaceQueryRunnerOptions } from 'src/engine/api/graphql/workspace-qu
 import { FindOneResolverArgs } from 'src/engine/api/graphql/workspace-resolver-builder/interfaces/workspace-resolvers-builder.interface';
 
 import { CommonBaseQueryRunnerService } from 'src/engine/api/common/common-query-runners/common-base-query-runner.service';
+import {
+  CommonQueryRunnerException,
+  CommonQueryRunnerExceptionCode,
+} from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
 import { CommonBaseQueryRunnerContext } from 'src/engine/api/common/types/common-base-query-runner-context.type';
 import { FindOneQueryArgs } from 'src/engine/api/common/types/common-query-args.type';
-import {
-  GraphqlQueryRunnerException,
-  GraphqlQueryRunnerExceptionCode,
-} from 'src/engine/api/graphql/graphql-query-runner/errors/graphql-query-runner.exception';
 import { GraphqlQueryParser } from 'src/engine/api/graphql/graphql-query-runner/graphql-query-parsers/graphql-query.parser';
 import { ObjectRecordsToGraphqlConnectionHelper } from 'src/engine/api/graphql/graphql-query-runner/helpers/object-records-to-graphql-connection.helper';
 import { buildColumnsToSelect } from 'src/engine/api/graphql/graphql-query-runner/utils/build-columns-to-select';
@@ -74,9 +74,9 @@ export class CommonFindOneQueryRunnerService extends CommonBaseQueryRunnerServic
 
     if (!objectRecord) {
       //TODO : Refacto-common - Exception handler should be Common
-      throw new GraphqlQueryRunnerException(
+      throw new CommonQueryRunnerException(
         'Record not found',
-        GraphqlQueryRunnerExceptionCode.RECORD_NOT_FOUND,
+        CommonQueryRunnerExceptionCode.RECORD_NOT_FOUND,
       );
     }
 

packages/twenty-server/src/engine/api/common/common-query-runners/errors/common-query-runner.exception.ts

@@ -0,0 +1,7 @@
+import { CustomException } from 'src/utils/custom-exception';
+
+export class CommonQueryRunnerException extends CustomException<CommonQueryRunnerExceptionCode> {}
+
+export enum CommonQueryRunnerExceptionCode {
+  RECORD_NOT_FOUND = 'RECORD_NOT_FOUND',
+}

packages/twenty-server/src/engine/api/common/common-query-runners/utils/common-query-runner-to-graphql-api-exception-handler.util.ts

@@ -0,0 +1,16 @@
+import {
+  CommonQueryRunnerExceptionCode,
+  type CommonQueryRunnerException,
+} from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
+import { NotFoundError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
+
+export const commonQueryRunnerToGraphqlApiExceptionHandler = (
+  error: CommonQueryRunnerException,
+) => {
+  switch (error.code) {
+    case CommonQueryRunnerExceptionCode.RECORD_NOT_FOUND:
+      throw new NotFoundError(error);
+    default:
+      throw error;
+  }
+};

packages/twenty-server/src/engine/api/common/common-query-runners/utils/common-query-runner-to-rest-api-exception-handler.util.ts

@@ -0,0 +1,17 @@
+import { BadRequestException } from '@nestjs/common';
+
+import {
+  CommonQueryRunnerExceptionCode,
+  type CommonQueryRunnerException,
+} from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
+
+export const commonQueryRunnerToRestApiExceptionHandler = (
+  error: CommonQueryRunnerException,
+) => {
+  switch (error.code) {
+    case CommonQueryRunnerExceptionCode.RECORD_NOT_FOUND:
+      throw new BadRequestException('Record not found');
+    default:
+      throw error;
+  }
+};

packages/twenty-server/src/engine/api/graphql/graphql-query-runner/interfaces/base-resolver-service.ts

@@ -28,6 +28,7 @@ import { workspaceQueryRunnerGraphqlApiExceptionHandler } from 'src/engine/api/g
 import { WorkspaceQueryHookService } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/workspace-query-hook.service';
 import { ApiKeyRoleService } from 'src/engine/core-modules/api-key/api-key-role.service';
 import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
+import { WorkspaceNotFoundDefaultError } from 'src/engine/core-modules/workspace/workspace.exception';
 import { type PermissionFlagType } from 'src/engine/metadata-modules/permissions/constants/permission-flag-type.constants';
 import {
   PermissionsException,
@@ -39,7 +40,6 @@ import { UserRoleService } from 'src/engine/metadata-modules/user-role/user-role
 import { type WorkspaceDataSource } from 'src/engine/twenty-orm/datasource/workspace.datasource';
 import { type WorkspaceRepository } from 'src/engine/twenty-orm/repository/workspace.repository';
 import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
-import { WorkspaceNotFoundDefaultError } from 'src/engine/core-modules/workspace/workspace.exception';
 
 export type GraphqlQueryResolverExecutionArgs<Input extends ResolverArgs> = {
   args: Input;

packages/twenty-server/src/engine/api/graphql/graphql-query-runner/resolvers/graphql-query-find-one-resolver.service.ts

@@ -1,3 +1,4 @@
+//TODO : Refacto-common - To delete
 import { Injectable } from '@nestjs/common';
 
 import { QUERY_MAX_RECORDS } from 'twenty-shared/constants';

packages/twenty-server/src/engine/api/graphql/workspace-query-runner/utils/workspace-query-runner-graphql-api-exception-handler.util.ts

@@ -1,5 +1,7 @@
 import { type QueryFailedError } from 'typeorm';
 
+import { CommonQueryRunnerException } from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
+import { commonQueryRunnerToGraphqlApiExceptionHandler } from 'src/engine/api/common/common-query-runners/utils/common-query-runner-to-graphql-api-exception-handler.util';
 import { GraphqlQueryRunnerException } from 'src/engine/api/graphql/graphql-query-runner/errors/graphql-query-runner.exception';
 import { graphqlQueryRunnerExceptionHandler } from 'src/engine/api/graphql/workspace-query-runner/utils/graphql-query-runner-exception-handler.util';
 import { workspaceExceptionHandler } from 'src/engine/api/graphql/workspace-query-runner/utils/workspace-exception-handler.util';
@@ -34,6 +36,8 @@ export const workspaceQueryRunnerGraphqlApiExceptionHandler = (
       return graphqlQueryRunnerExceptionHandler(error);
     case error instanceof TwentyORMException:
       return twentyORMGraphqlApiExceptionHandler(error);
+    case error instanceof CommonQueryRunnerException:
+      return commonQueryRunnerToGraphqlApiExceptionHandler(error);
     case error instanceof AuthException:
       return authGraphqlApiExceptionHandler(error);
     case error instanceof ApiKeyException:

packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-find-one.handler.ts

@@ -8,6 +8,7 @@ import { RestApiBaseHandler } from 'src/engine/api/rest/core/interfaces/rest-api
 import { CommonFindOneQueryRunnerService } from 'src/engine/api/common/common-query-runners/common-find-one-query-runner.service';
 import { CommonQueryNames } from 'src/engine/api/common/types/common-query-args.type';
 import { parseCorePath } from 'src/engine/api/rest/core/query-builder/utils/path-parsers/parse-core-path.utils';
+import { workspaceQueryRunnerRestApiExceptionHandler } from 'src/engine/api/rest/utils/workspace-query-runner-rest-api-exception-handler.util';
 
 @Injectable()
 export class RestApiFindOneHandler extends RestApiBaseHandler {
@@ -18,24 +19,25 @@ export class RestApiFindOneHandler extends RestApiBaseHandler {
   }
 
   async handle(request: Request) {
-    const { args, options } =
-      await this.buildCommonArgsAndOptionsFromRestRequest(request);
+    try {
+      const { args, options } =
+        await this.buildCommonArgsAndOptionsFromRestRequest(request);
 
-    const record = await this.commonFindOneQueryRunnerService.execute(
-      args,
-      options,
-      CommonQueryNames.findOne,
-    );
+      const record = await this.commonFindOneQueryRunnerService.execute(
+        args,
+        options,
+        CommonQueryNames.findOne,
+      );
 
-    if (!isDefined(record)) {
-      throw new BadRequestException('Record not found');
+      return this.formatResult({
+        operation: CommonQueryNames.findOne,
+        objectNameSingular:
+          options.objectMetadataItemWithFieldMaps.nameSingular,
+        data: record,
+      });
+    } catch (error) {
+      workspaceQueryRunnerRestApiExceptionHandler(error);
     }
-
-    return this.formatResult({
-      operation: CommonQueryNames.findOne,
-      objectNameSingular: options.objectMetadataItemWithFieldMaps.nameSingular,
-      data: record,
-    });
   }
 
   private async buildCommonArgsAndOptionsFromRestRequest(request: Request) {

packages/twenty-server/src/engine/api/rest/core/interfaces/rest-api-base.handler.ts

@@ -101,7 +101,7 @@ export abstract class RestApiBaseHandler {
 
   protected abstract handle(
     request: Request,
-  ): Promise<FormatResult | { data: FormatResult[] }>;
+  ): Promise<FormatResult | { data: FormatResult[] } | undefined>;
 
   public async getRepositoryAndMetadataOrFail(request: Request) {
     const { workspace, apiKey, userWorkspaceId } = request;

packages/twenty-server/src/engine/api/rest/utils/workspace-query-runner-rest-api-exception-handler.util.ts

@@ -0,0 +1,19 @@
+import { type QueryFailedError } from 'typeorm';
+
+import { CommonQueryRunnerException } from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
+import { commonQueryRunnerToRestApiExceptionHandler } from 'src/engine/api/common/common-query-runners/utils/common-query-runner-to-rest-api-exception-handler.util';
+
+interface QueryFailedErrorWithCode extends QueryFailedError {
+  code: string;
+}
+
+export const workspaceQueryRunnerRestApiExceptionHandler = (
+  error: QueryFailedErrorWithCode,
+) => {
+  switch (true) {
+    case error instanceof CommonQueryRunnerException:
+      return commonQueryRunnerToRestApiExceptionHandler(error);
+    default:
+      throw error;
+  }
+};