Optimize metadata queries (#7013)

In this PR: 1. Refactor guards to avoid duplicated queries: WorkspaceAuthGuard and UserAuthGuard only check for existence of workspace and user in the request without querying the database
2024-09-13 19:11:32 +02:00
parent cf8b1161cc
commit 523df5398a
132 changed files with 818 additions and 6372 deletions
--- a/packages/twenty-server/src/engine/metadata-modules/relation-metadata/dtos/relation-metadata.dto.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/relation-metadata/dtos/relation-metadata.dto.ts
@ -1,11 +1,10 @@
 import {
-  ObjectType,
  Field,
  HideField,
+  ObjectType,
  registerEnumType,
 } from '@nestjs/graphql';

-import { CreateDateColumn, UpdateDateColumn } from 'typeorm';
 import {
  Authorize,
  BeforeDeleteOne,
@ -13,11 +12,12 @@ import {
  QueryOptions,
  Relation,
 } from '@ptc-org/nestjs-query-graphql';
+import { CreateDateColumn, UpdateDateColumn } from 'typeorm';

-import { ObjectMetadataDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-metadata.dto';
-import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
-import { BeforeDeleteOneRelation } from 'src/engine/metadata-modules/relation-metadata/hooks/before-delete-one-relation.hook';
 import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
+import { ObjectMetadataDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-metadata.dto';
+import { BeforeDeleteOneRelation } from 'src/engine/metadata-modules/relation-metadata/hooks/before-delete-one-relation.hook';
+import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';

 registerEnumType(RelationMetadataType, {
  name: 'RelationMetadataType',
@ -27,7 +27,7 @@ registerEnumType(RelationMetadataType, {
@ObjectType('relation')
@Authorize({
  authorize: (context: any) => ({
-    workspaceId: { eq: context?.req?.user?.workspace?.id },
+    workspaceId: { eq: context?.req?.workspace?.id },
  }),
 })
@QueryOptions({
--- a/packages/twenty-server/src/engine/metadata-modules/relation-metadata/hooks/before-create-one-relation.hook.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/relation-metadata/hooks/before-create-one-relation.hook.ts
@ -15,7 +15,7 @@ export class BeforeCreateOneRelation<T extends CreateRelationInput>
    instance: CreateOneInputType<T>,
    context: any,
  ): Promise<CreateOneInputType<T>> {
-    const workspaceId = context?.req?.user?.workspace?.id;
+    const workspaceId = context?.req?.workspace?.id;

    if (!workspaceId) {
      throw new UnauthorizedException();
--- a/packages/twenty-server/src/engine/metadata-modules/relation-metadata/hooks/before-delete-one-relation.hook.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/relation-metadata/hooks/before-delete-one-relation.hook.ts
@ -19,7 +19,7 @@ export class BeforeDeleteOneRelation implements BeforeDeleteOneHook {
    instance: DeleteOneInputType,
    context: any,
  ): Promise<DeleteOneInputType> {
-    const workspaceId = context?.req?.user?.workspace?.id;
+    const workspaceId = context?.req?.workspace?.id;

    if (!workspaceId) {
      throw new UnauthorizedException();
--- a/packages/twenty-server/src/engine/metadata-modules/relation-metadata/relation-metadata.module.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/relation-metadata/relation-metadata.module.ts
@ -6,7 +6,7 @@ import {
 } from '@ptc-org/nestjs-query-graphql';
 import { NestjsQueryTypeOrmModule } from '@ptc-org/nestjs-query-typeorm';

-import { JwtAuthGuard } from 'src/engine/guards/jwt.auth.guard';
+import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
 import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
 import { FieldMetadataModule } from 'src/engine/metadata-modules/field-metadata/field-metadata.module';
 import { ObjectMetadataModule } from 'src/engine/metadata-modules/object-metadata/object-metadata.module';
@ -14,6 +14,7 @@ import { RelationMetadataGraphqlApiExceptionInterceptor } from 'src/engine/metad
 import { RelationMetadataResolver } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.resolver';
 import { WorkspaceMetadataVersionModule } from 'src/engine/metadata-modules/workspace-metadata-version/workspace-metadata-version.module';
 import { WorkspaceMigrationModule } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.module';
+import { WorkspaceCacheStorageModule } from 'src/engine/workspace-cache-storage/workspace-cache-storage.module';
 import { WorkspaceMigrationRunnerModule } from 'src/engine/workspace-manager/workspace-migration-runner/workspace-migration-runner.module';

 import { RelationMetadataEntity } from './relation-metadata.entity';
@ -34,6 +35,7 @@ import { RelationMetadataDTO } from './dtos/relation-metadata.dto';
        FieldMetadataModule,
        WorkspaceMigrationRunnerModule,
        WorkspaceMigrationModule,
+        WorkspaceCacheStorageModule,
        WorkspaceMetadataVersionModule,
      ],
      services: [RelationMetadataService],
@ -47,7 +49,7 @@ import { RelationMetadataDTO } from './dtos/relation-metadata.dto';
          create: { many: { disabled: true } },
          update: { disabled: true },
          delete: { disabled: true },
-          guards: [JwtAuthGuard],
+          guards: [WorkspaceAuthGuard],
          interceptors: [RelationMetadataGraphqlApiExceptionInterceptor],
        },
      ],
--- a/packages/twenty-server/src/engine/metadata-modules/relation-metadata/relation-metadata.resolver.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/relation-metadata/relation-metadata.resolver.ts
@ -1,15 +1,15 @@
 import { UseGuards } from '@nestjs/common';
 import { Args, Mutation, Resolver } from '@nestjs/graphql';

-import { JwtAuthGuard } from 'src/engine/guards/jwt.auth.guard';
-import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
-import { RelationMetadataService } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.service';
 import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
-import { RelationMetadataDTO } from 'src/engine/metadata-modules/relation-metadata/dtos/relation-metadata.dto';
+import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
+import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
 import { DeleteOneRelationInput } from 'src/engine/metadata-modules/relation-metadata/dtos/delete-relation.input';
+import { RelationMetadataDTO } from 'src/engine/metadata-modules/relation-metadata/dtos/relation-metadata.dto';
+import { RelationMetadataService } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.service';
 import { relationMetadataGraphqlApiExceptionHandler } from 'src/engine/metadata-modules/relation-metadata/utils/relation-metadata-graphql-api-exception-handler.util';

-@UseGuards(JwtAuthGuard)
+@UseGuards(WorkspaceAuthGuard)
@Resolver()
 export class RelationMetadataResolver {
  constructor(
--- a/packages/twenty-server/src/engine/metadata-modules/relation-metadata/relation-metadata.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/relation-metadata/relation-metadata.service.ts
@ -6,6 +6,8 @@ import camelCase from 'lodash.camelcase';
 import { FindOneOptions, In, Repository } from 'typeorm';
 import { v4 as uuidV4 } from 'uuid';

+import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
+
 import {
  FieldMetadataEntity,
  FieldMetadataType,
@ -30,6 +32,7 @@ import {
 } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
 import { WorkspaceMigrationService } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.service';
 import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';
+import { WorkspaceCacheStorageService } from 'src/engine/workspace-cache-storage/workspace-cache-storage.service';
 import { WorkspaceMigrationRunnerService } from 'src/engine/workspace-manager/workspace-migration-runner/workspace-migration-runner.service';

 import {
@ -50,6 +53,7 @@ export class RelationMetadataService extends TypeOrmQueryService<RelationMetadat
    private readonly workspaceMigrationService: WorkspaceMigrationService,
    private readonly workspaceMigrationRunnerService: WorkspaceMigrationRunnerService,
    private readonly workspaceMetadataVersionService: WorkspaceMetadataVersionService,
+    private readonly workspaceCacheStorageService: WorkspaceCacheStorageService,
  ) {
    super(relationMetadataRepository);
  }
@ -411,43 +415,73 @@ export class RelationMetadataService extends TypeOrmQueryService<RelationMetadat
  }

  async findManyRelationMetadataByFieldMetadataIds(
-    fieldMetadataIds: string[],
+    fieldMetadataItems: Array<
+      Pick<FieldMetadataInterface, 'id' | 'type' | 'objectMetadataId'>
+    >,
+    workspaceId: string,
  ): Promise<(RelationMetadataEntity | NotFoundException)[]> {
-    const relationMetadataCollection =
-      await this.relationMetadataRepository.find({
-        where: [
-          {
-            fromFieldMetadataId: In(fieldMetadataIds),
-          },
-          {
-            toFieldMetadataId: In(fieldMetadataIds),
-          },
-        ],
-        relations: [
-          'fromObjectMetadata',
-          'toObjectMetadata',
-          'fromFieldMetadata',
-          'toFieldMetadata',
-        ],
-      });
+    const metadataVersion =
+      await this.workspaceCacheStorageService.getMetadataVersion(workspaceId);

-    const mappedResult = fieldMetadataIds.map((fieldMetadataId) => {
-      const foundRelationMetadataItem = relationMetadataCollection.find(
-        (relationMetadataItem) =>
-          relationMetadataItem.fromFieldMetadataId === fieldMetadataId ||
-          relationMetadataItem.toFieldMetadataId === fieldMetadataId,
+    if (!metadataVersion) {
+      throw new NotFoundException(
+        `Metadata version not found for workspace ${workspaceId}`,
+      );
+    }
+
+    const objectMetadataMap =
+      await this.workspaceCacheStorageService.getObjectMetadataMap(
+        workspaceId,
+        metadataVersion,
      );

-      return (
-        foundRelationMetadataItem ??
-        // TODO: return a relation metadata not found exception
-        new NotFoundException(
-          `RelationMetadata with fieldMetadataId ${fieldMetadataId} not found`,
-        )
+    if (!objectMetadataMap) {
+      throw new NotFoundException(
+        `Object metadata map not found for workspace ${workspaceId} and metadata version ${metadataVersion}`,
      );
+    }
+
+    const mappedResult = fieldMetadataItems.map((fieldMetadataItem) => {
+      const objectMetadata =
+        objectMetadataMap[fieldMetadataItem.objectMetadataId];
+
+      const fieldMetadata = objectMetadata.fields[fieldMetadataItem.id];
+
+      const relationMetadata =
+        fieldMetadata.fromRelationMetadata ?? fieldMetadata.toRelationMetadata;
+
+      if (!relationMetadata) {
+        return new NotFoundException(
+          `From object metadata not found for relation ${fieldMetadata?.id}`,
+        );
+      }
+
+      const fromObjectMetadata =
+        objectMetadataMap[relationMetadata.fromObjectMetadataId];
+
+      const toObjectMetadata =
+        objectMetadataMap[relationMetadata.toObjectMetadataId];
+
+      const fromFieldMetadata =
+        objectMetadataMap[fromObjectMetadata.id].fields[
+          relationMetadata.fromFieldMetadataId
+        ];
+
+      const toFieldMetadata =
+        objectMetadataMap[toObjectMetadata.id].fields[
+          relationMetadata.toFieldMetadataId
+        ];
+
+      return {
+        ...relationMetadata,
+        fromObjectMetadata,
+        toObjectMetadata,
+        fromFieldMetadata,
+        toFieldMetadata,
+      };
    });

-    return mappedResult;
+    return mappedResult as (RelationMetadataEntity | NotFoundException)[];
  }

  private async deleteRelationWorkspaceCustomMigration(