feat: twenty orm sync (#5266)

This PR is updating all object metadata entities with the new decorators, and deleting the old ones. This way we can use the new TwentyORM with all the standard objects. --------- Co-authored-by: Weiko <corentin@twenty.com>
twentyhq · May 15, 2024 · f0383e3 · f0383e3
1 parent 6898c1e
commit f0383e3
Show file tree

Hide file tree

Showing 81 changed files with 1,686 additions and 2,025 deletions.
diff --git a/packages/twenty-server/src/app.module.ts b/packages/twenty-server/src/app.module.ts
@@ -7,7 +7,6 @@ import {
 import { ConfigModule } from '@nestjs/config';
 import { ServeStaticModule } from '@nestjs/serve-static';
 import { GraphQLModule } from '@nestjs/graphql';
-import { DevtoolsModule } from '@nestjs/devtools-integration';
 
 import { existsSync } from 'fs';
 import { join } from 'path';
@@ -20,7 +19,6 @@ import { CoreGraphQLApiModule } from 'src/engine/api/graphql/core-graphql-api.mo
 import { MetadataGraphQLApiModule } from 'src/engine/api/graphql/metadata-graphql-api.module';
 import { GraphQLConfigModule } from 'src/engine/api/graphql/graphql-config/graphql-config.module';
 import { GraphQLConfigService } from 'src/engine/api/graphql/graphql-config/graphql-config.service';
-import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
 import { WorkspaceCacheVersionModule } from 'src/engine/metadata-modules/workspace-cache-version/workspace-cache-version.module';
 import { GraphQLHydrateRequestFromTokenMiddleware } from 'src/engine/middlewares/graphql-hydrate-request-from-token.middleware';
 
@@ -30,13 +28,13 @@ import { IntegrationsModule } from './engine/integrations/integrations.module';
 @Module({
   imports: [
     // Nest.js devtools, use devtools.nestjs.com to debug
-    DevtoolsModule.registerAsync({
-      useFactory: (environmentService: EnvironmentService) => ({
-        http: environmentService.get('DEBUG_MODE'),
-        port: environmentService.get('DEBUG_PORT'),
-      }),
-      inject: [EnvironmentService],
-    }),
+    // DevtoolsModule.registerAsync({
+    //   useFactory: (environmentService: EnvironmentService) => ({
+    //     http: environmentService.get('DEBUG_MODE'),
+    //     port: environmentService.get('DEBUG_PORT'),
+    //   }),
+    //   inject: [EnvironmentService],
+    // }),
     ConfigModule.forRoot({
       isGlobal: true,
     }),

diff --git a/packages/twenty-server/src/engine/core-modules/core-engine.module.ts b/packages/twenty-server/src/engine/core-modules/core-engine.module.ts
@@ -11,9 +11,9 @@ import { TimelineCalendarEventModule } from 'src/engine/core-modules/calendar/ti
 import { BillingModule } from 'src/engine/core-modules/billing/billing.module';
 import { HealthModule } from 'src/engine/core-modules/health/health.module';
 
-import { ClientConfigModule } from './client-config/client-config.module';
-import { FileModule } from './file/file.module';
 import { AnalyticsModule } from './analytics/analytics.module';
+import { FileModule } from './file/file.module';
+import { ClientConfigModule } from './client-config/client-config.module';
 
 @Module({
   imports: [

diff --git a/...pace-object-tests/base.object-metadata.ts → ...ngine/twenty-orm/base.workspace-entity.ts b/...pace-object-tests/base.object-metadata.ts → ...ngine/twenty-orm/base.workspace-entity.ts
@@ -4,7 +4,7 @@ import { WorkspaceIsPimaryField } from 'src/engine/twenty-orm/decorators/workspa
 import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
 import { BASE_OBJECT_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 
-export abstract class BaseObjectMetadata {
+export abstract class BaseWorkspaceEntity {
   @WorkspaceField({
     standardId: BASE_OBJECT_STANDARD_FIELD_IDS.id,
     type: FieldMetadataType.UUID,
@@ -25,7 +25,6 @@ export abstract class BaseObjectMetadata {
     icon: 'IconCalendar',
     defaultValue: 'now',
   })
-  @WorkspaceIsSystem()
   createdAt: Date;
 
   @WorkspaceField({

diff --git a/.../custom-objects/custom.object-metadata.ts → ...ine/twenty-orm/custom.workspace-entity.ts b/.../custom-objects/custom.object-metadata.ts → ...ine/twenty-orm/custom.workspace-entity.ts
@@ -1,23 +1,23 @@
-import { BaseCustomObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/base-custom-object-metadata.decorator';
-import { FieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator';
 import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
-import { IsNullable } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-nullable.decorator';
-import { IsSystem } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-system.decorator';
-import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
 import {
   RelationMetadataType,
   RelationOnDeleteAction,
 } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
 import { ActivityTargetObjectMetadata } from 'src/modules/activity/standard-objects/activity-target.object-metadata';
-import { RelationMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/relation-metadata.decorator';
 import { FavoriteObjectMetadata } from 'src/modules/favorite/standard-objects/favorite.object-metadata';
 import { AttachmentObjectMetadata } from 'src/modules/attachment/standard-objects/attachment.object-metadata';
 import { CUSTOM_OBJECT_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { TimelineActivityObjectMetadata } from 'src/modules/timeline/standard-objects/timeline-activity.object-metadata';
+import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
+import { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-is-nullable.decorator';
+import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
+import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator';
+import { WorkspaceCustomObject } from 'src/engine/twenty-orm/decorators/workspace-custom-object.decorator';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
 
-@BaseCustomObjectMetadata()
-export class CustomObjectMetadata extends BaseObjectMetadata {
-  @FieldMetadata({
+@WorkspaceCustomObject()
+export class CustomWorkspaceEntity extends BaseWorkspaceEntity {
+  @WorkspaceField({
     standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.name,
     label: 'Name',
     description: 'Name',
@@ -27,81 +27,68 @@ export class CustomObjectMetadata extends BaseObjectMetadata {
   })
   name: string;
 
-  @FieldMetadata({
+  @WorkspaceField({
     standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.position,
     label: 'Position',
     description: 'Position',
     type: FieldMetadataType.POSITION,
     icon: 'IconHierarchy2',
   })
-  @IsNullable()
-  @IsSystem()
+  @WorkspaceIsNullable()
+  @WorkspaceIsSystem()
   position: number;
 
-  @FieldMetadata({
+  @WorkspaceRelation({
     standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.activityTargets,
-    type: FieldMetadataType.RELATION,
     label: 'Activities',
+    type: RelationMetadataType.ONE_TO_MANY,
     description: (objectMetadata) =>
       `Activities tied to the ${objectMetadata.labelSingular}`,
     icon: 'IconCheckbox',
-  })
-  @RelationMetadata({
-    type: RelationMetadataType.ONE_TO_MANY,
     inverseSideTarget: () => ActivityTargetObjectMetadata,
     onDelete: RelationOnDeleteAction.CASCADE,
   })
-  @IsNullable()
+  @WorkspaceIsNullable()
   activityTargets: ActivityTargetObjectMetadata[];
 
-  @FieldMetadata({
+  @WorkspaceRelation({
     standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.favorites,
-    type: FieldMetadataType.RELATION,
     label: 'Favorites',
+    type: RelationMetadataType.ONE_TO_MANY,
     description: (objectMetadata) =>
       `Favorites tied to the ${objectMetadata.labelSingular}`,
     icon: 'IconHeart',
-  })
-  @RelationMetadata({
-    type: RelationMetadataType.ONE_TO_MANY,
     inverseSideTarget: () => FavoriteObjectMetadata,
     onDelete: RelationOnDeleteAction.CASCADE,
   })
-  @IsNullable()
-  @IsSystem()
+  @WorkspaceIsNullable()
+  @WorkspaceIsSystem()
   favorites: FavoriteObjectMetadata[];
 
-  @FieldMetadata({
+  @WorkspaceRelation({
     standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.attachments,
-    type: FieldMetadataType.RELATION,
     label: 'Attachments',
+    type: RelationMetadataType.ONE_TO_MANY,
     description: (objectMetadata) =>
       `Attachments tied to the ${objectMetadata.labelSingular}`,
     icon: 'IconFileImport',
-  })
-  @RelationMetadata({
-    type: RelationMetadataType.ONE_TO_MANY,
     inverseSideTarget: () => AttachmentObjectMetadata,
     onDelete: RelationOnDeleteAction.CASCADE,
   })
-  @IsNullable()
+  @WorkspaceIsNullable()
   attachments: AttachmentObjectMetadata[];
 
-  @FieldMetadata({
+  @WorkspaceRelation({
     standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.timelineActivities,
-    type: FieldMetadataType.RELATION,
     label: 'Timeline Activities',
+    type: RelationMetadataType.ONE_TO_MANY,
     description: (objectMetadata) =>
       `Timeline Activities tied to the ${objectMetadata.labelSingular}`,
-
     icon: 'IconIconTimelineEvent',
-  })
-  @RelationMetadata({
-    type: RelationMetadataType.ONE_TO_MANY,
     inverseSideTarget: () => TimelineActivityObjectMetadata,
     onDelete: RelationOnDeleteAction.CASCADE,
   })
-  @IsNullable()
-  @IsSystem()
+  @WorkspaceIsNullable()
+  @WorkspaceIsSystem()
   timelineActivities: TimelineActivityObjectMetadata[];
 }
diff --git a/packages/twenty-server/src/engine/twenty-orm/decorators/workspace-custom-object.decorator.ts b/packages/twenty-server/src/engine/twenty-orm/decorators/workspace-custom-object.decorator.ts
@@ -0,0 +1,16 @@
+import { metadataArgsStorage } from 'src/engine/twenty-orm/storage/metadata-args.storage';
+import { TypedReflect } from 'src/utils/typed-reflect';
+
+export function WorkspaceCustomObject(): ClassDecorator {
+  return (target) => {
+    const gate = TypedReflect.getMetadata(
+      'workspace:gate-metadata-args',
+      target,
+    );
+
+    metadataArgsStorage.addExtendedEntities({
+      target,
+      gate,
+    });
+  };
+}
diff --git a/...es/twenty-server/src/engine/twenty-orm/decorators/workspace-dynamic-relation.decorator.ts b/...es/twenty-server/src/engine/twenty-orm/decorators/workspace-dynamic-relation.decorator.ts
@@ -0,0 +1,49 @@
+import { ObjectType } from 'typeorm';
+
+import { WorkspaceDynamicRelationMetadataArgsFactory } from 'src/engine/twenty-orm/interfaces/workspace-dynamic-relation-metadata-args.interface';
+
+import { TypedReflect } from 'src/utils/typed-reflect';
+import {
+  RelationMetadataType,
+  RelationOnDeleteAction,
+} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
+import { metadataArgsStorage } from 'src/engine/twenty-orm/storage/metadata-args.storage';
+
+interface WorkspaceBaseDynamicRelationOptions<TClass> {
+  type: RelationMetadataType;
+  argsFactory: WorkspaceDynamicRelationMetadataArgsFactory;
+  inverseSideTarget: () => ObjectType<TClass>;
+  inverseSideFieldKey?: keyof TClass;
+  onDelete?: RelationOnDeleteAction;
+}
+
+export function WorkspaceDynamicRelation<TClass extends object>(
+  args: WorkspaceBaseDynamicRelationOptions<TClass>,
+): PropertyDecorator {
+  return (target, propertyKey) => {
+    const isSystem =
+      TypedReflect.getMetadata(
+        'workspace:is-system-metadata-args',
+        target,
+        propertyKey.toString(),
+      ) ?? false;
+    const gate = TypedReflect.getMetadata(
+      'workspace:gate-metadata-args',
+      target,
+      propertyKey.toString(),
+    );
+
+    metadataArgsStorage.addDynamicRelations({
+      target: target.constructor,
+      argsFactory: args.argsFactory,
+      type: args.type,
+      inverseSideTarget: args.inverseSideTarget,
+      inverseSideFieldKey: args.inverseSideFieldKey as string | undefined,
+      onDelete: args.onDelete,
+      isSystem,
+      isNullable: true,
+      isPrimary: false,
+      gate,
+    });
+  };
+}
diff --git a/packages/twenty-server/src/engine/twenty-orm/decorators/workspace-field.decorator.ts b/packages/twenty-server/src/engine/twenty-orm/decorators/workspace-field.decorator.ts
@@ -5,6 +5,7 @@ import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/fi
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { metadataArgsStorage } from 'src/engine/twenty-orm/storage/metadata-args.storage';
 import { TypedReflect } from 'src/utils/typed-reflect';
+import { generateDefaultValue } from 'src/engine/metadata-modules/field-metadata/utils/generate-default-value';
 
 export interface WorkspaceFieldOptions<
   T extends FieldMetadataType | 'default',
@@ -15,44 +16,50 @@ export interface WorkspaceFieldOptions<
   description?: string | ((objectMetadata: ObjectMetadataEntity) => string);
   icon?: string;
   defaultValue?: FieldMetadataDefaultValue<T>;
-  joinColumn?: string;
   options?: FieldMetadataOptions<T>;
 }
 
 export function WorkspaceField<T extends FieldMetadataType>(
   options: WorkspaceFieldOptions<T>,
 ): PropertyDecorator {
   return (object, propertyKey) => {
-    const isPrimary = TypedReflect.getMetadata(
-      'workspace:is-primary-field-metadata-args',
-      object,
-      propertyKey.toString(),
-    );
-    const isNullable = TypedReflect.getMetadata(
-      'workspace:is-nullable-metadata-args',
-      object,
-      propertyKey.toString(),
-    );
-    const isSystem = TypedReflect.getMetadata(
-      'workspace:is-system-metadata-args',
-      object,
-      propertyKey.toString(),
-    );
+    const isPrimary =
+      TypedReflect.getMetadata(
+        'workspace:is-primary-field-metadata-args',
+        object,
+        propertyKey.toString(),
+      ) ?? false;
+    const isNullable =
+      TypedReflect.getMetadata(
+        'workspace:is-nullable-metadata-args',
+        object,
+        propertyKey.toString(),
+      ) ?? false;
+    const isSystem =
+      TypedReflect.getMetadata(
+        'workspace:is-system-metadata-args',
+        object,
+        propertyKey.toString(),
+      ) ?? false;
     const gate = TypedReflect.getMetadata(
       'workspace:gate-metadata-args',
       object,
       propertyKey.toString(),
     );
+    const defaultValue = (options.defaultValue ??
+      generateDefaultValue(
+        options.type,
+      )) as FieldMetadataDefaultValue<'default'> | null;
 
-    metadataArgsStorage.fields.push({
+    metadataArgsStorage.addFields({
       target: object.constructor,
       standardId: options.standardId,
       name: propertyKey.toString(),
       label: options.label,
       type: options.type,
       description: options.description,
       icon: options.icon,
-      defaultValue: options.defaultValue,
+      defaultValue,
       options: options.options,
       isPrimary,
       isNullable,

diff --git a/packages/twenty-server/src/engine/twenty-orm/decorators/workspace-object.decorator.ts b/packages/twenty-server/src/engine/twenty-orm/decorators/workspace-object.decorator.ts
@@ -2,7 +2,7 @@ import { metadataArgsStorage } from 'src/engine/twenty-orm/storage/metadata-args
 import { convertClassNameToObjectMetadataName } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/convert-class-to-object-metadata-name.util';
 import { TypedReflect } from 'src/utils/typed-reflect';
 
-interface WorkspaceObjectOptions {
+interface WorkspaceEntityOptions {
   standardId: string;
   namePlural: string;
   labelSingular: string;
@@ -11,26 +11,25 @@ interface WorkspaceObjectOptions {
   icon?: string;
 }
 
-export function WorkspaceObject(
-  options: WorkspaceObjectOptions,
+export function WorkspaceEntity(
+  options: WorkspaceEntityOptions,
 ): ClassDecorator {
   return (target) => {
     const isAuditLogged =
       TypedReflect.getMetadata(
         'workspace:is-audit-logged-metadata-args',
         target,
       ) ?? true;
-    const isSystem = TypedReflect.getMetadata(
-      'workspace:is-system-metadata-args',
-      target,
-    );
+    const isSystem =
+      TypedReflect.getMetadata('workspace:is-system-metadata-args', target) ??
+      false;
     const gate = TypedReflect.getMetadata(
       'workspace:gate-metadata-args',
       target,
     );
     const objectName = convertClassNameToObjectMetadataName(target.name);
 
-    metadataArgsStorage.objects.push({
+    metadataArgsStorage.addEntities({
       target,
       standardId: options.standardId,
       nameSingular: objectName,