compute selected fields before common

Author: etiennejouan

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

@@ -1,6 +1,5 @@
 import { Inject, Injectable } from '@nestjs/common';
 
-import { ObjectsPermissions } from 'twenty-shared/types';
 import { isDefined } from 'twenty-shared/utils';
 
 import { WorkspaceAuthContext } from 'src/engine/api/common/interfaces/workspace-auth-context.interface';
@@ -9,13 +8,8 @@ import { type IConnection } from 'src/engine/api/graphql/workspace-query-runner/
 import { type IEdge } from 'src/engine/api/graphql/workspace-query-runner/interfaces/edge.interface';
 
 import { CommonSelectedFieldsHandler } from 'src/engine/api/common/common-args-handlers/common-query-selected-fields/common-selected-fields.handler';
-import {
-  CommonQueryNames,
-  RawSelectedFields,
-} from 'src/engine/api/common/types/common-query-args.type';
-import { CommonSelectedFieldsResult } from 'src/engine/api/common/types/common-selected-fields-result.type';
+import { CommonQueryNames } from 'src/engine/api/common/types/common-query-args.type';
 import { OBJECTS_WITH_SETTINGS_PERMISSIONS_REQUIREMENTS } from 'src/engine/api/graphql/graphql-query-runner/constants/objects-with-settings-permissions-requirements';
-import { GraphqlQueryParser } from 'src/engine/api/graphql/graphql-query-runner/graphql-query-parsers/graphql-query.parser';
 import { ProcessNestedRelationsHelper } from 'src/engine/api/graphql/graphql-query-runner/helpers/process-nested-relations.helper';
 import { QueryResultGettersFactory } from 'src/engine/api/graphql/workspace-query-runner/factories/query-result-getters/query-result-getters.factory';
 import { QueryRunnerArgsFactory } from 'src/engine/api/graphql/workspace-query-runner/factories/query-runner-args.factory';
@@ -85,8 +79,10 @@ export abstract class CommonBaseQueryRunnerService<
         workspaceId: workspace.id,
       });
 
-    const { roleId, objectsPermissions } =
-      await this.getRoleIdAndObjectsPermissions(authContext, workspace.id);
+    const { roleId } = await this.getRoleIdAndObjectsPermissions(
+      authContext,
+      workspace.id,
+    );
 
     const repository = workspaceDataSource.getRepository(
       objectMetadataItemWithFieldMaps.nameSingular,
@@ -101,43 +97,9 @@ export abstract class CommonBaseQueryRunnerService<
       isExecutedByApiKey: isDefined(authContext.apiKey),
       roleId,
       shouldBypassPermissionChecks: false,
-      objectsPermissions,
     };
   }
 
-  public async computeSelectedFields({
-    rawSelectedFields,
-    objectMetadataItemWithFieldMaps,
-    objectMetadataMaps,
-    objectsPermissions,
-  }: {
-    rawSelectedFields: RawSelectedFields;
-    objectMetadataItemWithFieldMaps: ObjectMetadataItemWithFieldMaps;
-    objectMetadataMaps: ObjectMetadataMaps;
-    objectsPermissions: ObjectsPermissions;
-  }): Promise<CommonSelectedFieldsResult> {
-    if (isDefined(rawSelectedFields.graphqlSelectedFields)) {
-      const graphqlQueryParser = new GraphqlQueryParser(
-        objectMetadataItemWithFieldMaps,
-        objectMetadataMaps,
-      );
-
-      //TODO : Refacto-common - QueryParser should be moved to selected fields handler
-      return graphqlQueryParser.parseSelectedFields(
-        objectMetadataItemWithFieldMaps,
-        rawSelectedFields.graphqlSelectedFields,
-        objectMetadataMaps,
-      );
-    }
-
-    return this.selectedFieldsHandler.computeFromDepth({
-      objectsPermissions,
-      objectMetadataMaps,
-      objectMetadataMapItem: objectMetadataItemWithFieldMaps,
-      depth: rawSelectedFields.depth,
-    });
-  }
-
   public async enrichResultsWithGettersAndHooks({
     results,
     operationName,

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

@@ -1,6 +1,7 @@
 import { Injectable } from '@nestjs/common';
 
 import { QUERY_MAX_RECORDS } from 'twenty-shared/constants';
+import { isDefined } from 'twenty-shared/utils';
 import { FindOptionsRelations, ObjectLiteral } from 'typeorm';
 
 import { WorkspaceAuthContext } from 'src/engine/api/common/interfaces/workspace-auth-context.interface';
@@ -17,7 +18,6 @@ import {
 import {
   CommonQueryNames,
   FindOneQueryArgs,
-  RawSelectedFields,
 } from 'src/engine/api/common/types/common-query-args.type';
 import { isWorkspaceAuthContext } from 'src/engine/api/common/utils/is-workspace-auth-context.util';
 import { GraphqlQueryParser } from 'src/engine/api/graphql/graphql-query-runner/graphql-query-parsers/graphql-query.parser';
@@ -30,13 +30,11 @@ import { ObjectMetadataMaps } from 'src/engine/metadata-modules/types/object-met
 @Injectable()
 export class CommonFindOneQueryRunnerService extends CommonBaseQueryRunnerService<ObjectRecord> {
   async run({
-    rawSelectedFields,
     args,
     authContext: toValidateAuthContext,
     objectMetadataMaps,
     objectMetadataItemWithFieldMaps,
   }: {
-    rawSelectedFields: RawSelectedFields;
     args: FindOneQueryArgs;
     authContext: AuthContext;
     objectMetadataMaps: ObjectMetadataMaps;
@@ -56,19 +54,11 @@ export class CommonFindOneQueryRunnerService extends CommonBaseQueryRunnerServic
       repository,
       roleId,
       shouldBypassPermissionChecks,
-      objectsPermissions,
     } = await this.prepareQueryRunnerContext({
       authContext,
       objectMetadataItemWithFieldMaps,
     });
 
-    const selectedFieldsResult = await this.computeSelectedFields({
-      rawSelectedFields,
-      objectMetadataItemWithFieldMaps,
-      objectMetadataMaps,
-      objectsPermissions,
-    });
-
     const processedArgs = await this.processQueryArgs({
       authContext,
       objectMetadataItemWithFieldMaps,
@@ -107,8 +97,8 @@ export class CommonFindOneQueryRunnerService extends CommonBaseQueryRunnerServic
     );
 
     const columnsToSelect = buildColumnsToSelect({
-      select: selectedFieldsResult.select,
-      relations: selectedFieldsResult.relations,
+      select: args.selectedFieldsResult.select,
+      relations: args.selectedFieldsResult.relations,
       objectMetadataItemWithFieldMaps,
       objectMetadataMaps,
     });
@@ -128,13 +118,13 @@ export class CommonFindOneQueryRunnerService extends CommonBaseQueryRunnerServic
 
     const objectRecords = [objectRecord] as ObjectRecord[];
 
-    if (selectedFieldsResult.relations) {
+    if (isDefined(args.selectedFieldsResult.relations)) {
       await this.processNestedRelationsHelper.processNestedRelations({
         objectMetadataMaps,
         parentObjectMetadataItem: objectMetadataItemWithFieldMaps,
         parentObjectRecords: objectRecords,
         //TODO : Refacto-common - To fix when switching processNestedRelationsHelper to Common
-        relations: selectedFieldsResult.relations as Record<
+        relations: args.selectedFieldsResult.relations as Record<
           string,
           FindOptionsRelations<ObjectLiteral>
         >,
@@ -143,7 +133,7 @@ export class CommonFindOneQueryRunnerService extends CommonBaseQueryRunnerServic
         workspaceDataSource,
         roleId,
         shouldBypassPermissionChecks,
-        selectedFields: selectedFieldsResult.select,
+        selectedFields: args.selectedFieldsResult.select,
       });
     }
 
@@ -176,14 +166,16 @@ export class CommonFindOneQueryRunnerService extends CommonBaseQueryRunnerServic
     args: FindOneQueryArgs;
   }): Promise<FindOneQueryArgs> {
     const hookedArgs =
-      await this.workspaceQueryHookService.executePreQueryHooks(
+      (await this.workspaceQueryHookService.executePreQueryHooks(
         authContext,
         objectMetadataItemWithFieldMaps.nameSingular,
         CommonQueryNames.findOne,
         args,
-      );
+        //TODO : Refacto-common - To fix when updating workspaceQueryHookService, removing gql typing dependency
+      )) as FindOneQueryArgs;
 
     return {
+      ...hookedArgs,
       filter: this.queryRunnerArgsFactory.overrideFilterByFieldMetadata(
         hookedArgs.filter,
         objectMetadataItemWithFieldMaps,

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

@@ -13,7 +13,7 @@ import {
 
 export const commonQueryRunnerToRestApiExceptionHandler = (
   error: CommonQueryRunnerException,
-) => {
+): never => {
   switch (error.code) {
     case CommonQueryRunnerExceptionCode.INVALID_QUERY_INPUT:
       throw new BadRequestException(error.message);

packages/twenty-server/src/engine/api/common/types/common-query-args.type.ts

@@ -1,17 +1,13 @@
 import { type ObjectRecordFilter } from 'src/engine/api/graphql/workspace-query-builder/interfaces/object-record.interface';
 
-import { type Depth } from 'src/engine/api/rest/input-factories/depth-input.factory';
+import { type CommonSelectedFieldsResult } from 'src/engine/api/common/types/common-selected-fields-result.type';
 
 export enum CommonQueryNames {
   findOne = 'findOne',
 }
 
-export type RawSelectedFields = {
-  graphqlSelectedFields?: Record<string, boolean>;
-  depth?: Depth;
-};
-
 export interface FindOneQueryArgs {
+  selectedFieldsResult: CommonSelectedFieldsResult;
   filter?: ObjectRecordFilter;
 }
 

packages/twenty-server/src/engine/api/graphql/workspace-resolver-builder/factories/find-one-resolver.factory.ts

@@ -10,6 +10,7 @@ import {
 import { WorkspaceSchemaBuilderContext } from 'src/engine/api/graphql/workspace-schema-builder/interfaces/workspace-schema-builder-context.interface';
 
 import { CommonFindOneQueryRunnerService } from 'src/engine/api/common/common-query-runners/common-find-one-query-runner.service';
+import { GraphqlQueryParser } from 'src/engine/api/graphql/graphql-query-runner/graphql-query-parsers/graphql-query.parser';
 import { workspaceQueryRunnerGraphqlApiExceptionHandler } from 'src/engine/api/graphql/workspace-query-runner/utils/workspace-query-runner-graphql-api-exception-handler.util';
 import { RESOLVER_METHOD_NAMES } from 'src/engine/api/graphql/workspace-resolver-builder/constants/resolver-method-names';
 
@@ -29,12 +30,20 @@ export class FindOneResolverFactory
     const internalContext = context;
 
     return async (_source, args, _context, info) => {
-      const selectedFields = graphqlFields(info);
-
       try {
+        const graphqlQueryParser = new GraphqlQueryParser(
+          internalContext.objectMetadataItemWithFieldMaps,
+          internalContext.objectMetadataMaps,
+        );
+
+        const selectedFieldsResult = graphqlQueryParser.parseSelectedFields(
+          internalContext.objectMetadataItemWithFieldMaps,
+          graphqlFields(info),
+          internalContext.objectMetadataMaps,
+        );
+
         return await this.commonFindOneQueryRunnerService.run({
-          rawSelectedFields: { graphqlSelectedFields: selectedFields },
-          args,
+          args: { ...args, selectedFieldsResult },
           authContext: internalContext.authContext,
           objectMetadataMaps: internalContext.objectMetadataMaps,
           objectMetadataItemWithFieldMaps:

packages/twenty-server/src/engine/api/rest/core/controllers/rest-api-core.controller.ts

@@ -14,10 +14,9 @@ import {
 
 import { Response } from 'express';
 
-import { AuthenticatedRequest } from 'src/engine/api/rest/core/interfaces/authenticated-request.interface';
-
 import { RestApiCoreService } from 'src/engine/api/rest/core/services/rest-api-core.service';
 import { RestApiExceptionFilter } from 'src/engine/api/rest/rest-api-exception.filter';
+import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
 import { JwtAuthGuard } from 'src/engine/guards/jwt-auth.guard';
 import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
 
@@ -33,6 +32,9 @@ export class RestApiCoreController {
     @Req() request: AuthenticatedRequest,
     @Res() res: Response,
   ) {
+    this.logger.log(
+      `[REST API] Processing BATCH request to ${request.path} on workspace ${request.workspaceId}`,
+    );
     const result = await this.restApiCoreService.createMany(request);
 
     res.status(200).send(result);
@@ -43,6 +45,9 @@ export class RestApiCoreController {
     @Req() request: AuthenticatedRequest,
     @Res() res: Response,
   ) {
+    this.logger.log(
+      `[REST API] Processing DUPLICATES request to ${request.path} on workspace ${request.workspaceId}`,
+    );
     const result = await this.restApiCoreService.findDuplicates(request);
 
     res.status(200).send(result);
@@ -53,6 +58,9 @@ export class RestApiCoreController {
     @Req() request: AuthenticatedRequest,
     @Res() res: Response,
   ) {
+    this.logger.log(
+      `[REST API] Processing POST request to ${request.path} on workspace ${request.workspaceId}`,
+    );
     const result = await this.restApiCoreService.createOne(request);
 
     res.status(201).send(result);
@@ -63,6 +71,9 @@ export class RestApiCoreController {
     @Req() request: AuthenticatedRequest,
     @Res() res: Response,
   ) {
+    this.logger.log(
+      `[REST API] Processing GET request to ${request.path} on workspace ${request.workspaceId}`,
+    );
     const result = await this.restApiCoreService.get(request);
 
     res.status(200).send(result);
@@ -73,6 +84,9 @@ export class RestApiCoreController {
     @Req() request: AuthenticatedRequest,
     @Res() res: Response,
   ) {
+    this.logger.log(
+      `[REST API] Processing DELETE request to ${request.path} on workspace ${request.workspaceId}`,
+    );
     const result = await this.restApiCoreService.delete(request);
 
     res.status(200).send(result);
@@ -83,6 +97,9 @@ export class RestApiCoreController {
     @Req() request: AuthenticatedRequest,
     @Res() res: Response,
   ) {
+    this.logger.log(
+      `[REST API] Processing PATCH request to ${request.path} on workspace ${request.workspaceId}`,
+    );
     const result = await this.restApiCoreService.update(request);
 
     res.status(200).send(result);
@@ -96,6 +113,9 @@ export class RestApiCoreController {
     @Req() request: AuthenticatedRequest,
     @Res() res: Response,
   ) {
+    this.logger.log(
+      `[REST API] Processing PUT request to ${request.path} on workspace ${request.workspaceId}`,
+    );
     const result = await this.restApiCoreService.update(request);
 
     res.status(200).send(result);

packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-create-many.handler.ts

@@ -4,17 +4,17 @@ import {
   InternalServerErrorException,
 } from '@nestjs/common';
 
-import { Request } from 'express';
 import isEmpty from 'lodash.isempty';
 import { isDefined } from 'twenty-shared/utils';
 
 import { RestApiBaseHandler } from 'src/engine/api/rest/core/interfaces/rest-api-base.handler';
 
+import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
 import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
 
 @Injectable()
 export class RestApiCreateManyHandler extends RestApiBaseHandler {
-  async handle(request: Request) {
+  async handle(request: AuthenticatedRequest) {
     const { objectMetadata, repository, restrictedFields } =
       await this.getRepositoryAndMetadataOrFail(request);
 

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

@@ -4,17 +4,17 @@ import {
   InternalServerErrorException,
 } from '@nestjs/common';
 
-import { Request } from 'express';
 import isEmpty from 'lodash.isempty';
 import { isDefined } from 'twenty-shared/utils';
 
 import { RestApiBaseHandler } from 'src/engine/api/rest/core/interfaces/rest-api-base.handler';
 
+import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
 import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
 
 @Injectable()
 export class RestApiCreateOneHandler extends RestApiBaseHandler {
-  async handle(request: Request) {
+  async handle(request: AuthenticatedRequest) {
     const { objectMetadata, repository, restrictedFields } =
       await this.getRepositoryAndMetadataOrFail(request);
 

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

@@ -1,15 +1,14 @@
 import { BadRequestException, Injectable } from '@nestjs/common';
 
-import { Request } from 'express';
-
 import { RestApiBaseHandler } from 'src/engine/api/rest/core/interfaces/rest-api-base.handler';
 
 import { parseCorePath } from 'src/engine/api/rest/core/query-builder/utils/path-parsers/parse-core-path.utils';
+import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
 import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
 
 @Injectable()
 export class RestApiDeleteOneHandler extends RestApiBaseHandler {
-  async handle(request: Request) {
+  async handle(request: AuthenticatedRequest) {
     const { id: recordId } = parseCorePath(request);
 
     if (!recordId) {

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

@@ -10,11 +10,12 @@ import {
   RestApiBaseHandler,
 } from 'src/engine/api/rest/core/interfaces/rest-api-base.handler';
 
+import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
 import { buildDuplicateConditions } from 'src/engine/api/utils/build-duplicate-conditions.utils';
 
 @Injectable()
 export class RestApiFindDuplicatesHandler extends RestApiBaseHandler {
-  async handle(request: Request) {
+  async handle(request: AuthenticatedRequest) {
     this.validate(request);
 
     const {