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>
2024-05-15 16:58:47 +02:00
parent 6898c1e4d8
commit f0383e3147
81 changed files with 1721 additions and 2060 deletions
--- a/packages/twenty-server/src/modules/timeline/standard-objects/audit-log.object-metadata.ts
+++ b/packages/twenty-server/src/modules/timeline/standard-objects/audit-log.object-metadata.ts
@ -3,14 +3,16 @@ import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/i
 import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
 import { AUDIT_LOGS_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
-import { FieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator';
-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 { ObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/object-metadata.decorator';
-import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
 import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
+import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-object.decorator';
+import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
+import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
+import { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-is-nullable.decorator';
+import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator';
+import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';

-@ObjectMetadata({
+@WorkspaceEntity({
  standardId: STANDARD_OBJECT_IDS.auditLog,
  namePlural: 'auditLogs',
  labelSingular: 'Audit Log',
@ -18,9 +20,9 @@ import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/stan
  description: 'An audit log of actions performed in the system',
  icon: 'IconIconTimelineEvent',
 })
-@IsSystem()
-export class AuditLogObjectMetadata extends BaseObjectMetadata {
-  @FieldMetadata({
+@WorkspaceIsSystem()
+export class AuditLogObjectMetadata extends BaseWorkspaceEntity {
+  @WorkspaceField({
    standardId: AUDIT_LOGS_STANDARD_FIELD_IDS.name,
    type: FieldMetadataType.TEXT,
    label: 'Event name',
@ -29,17 +31,17 @@ export class AuditLogObjectMetadata extends BaseObjectMetadata {
  })
  name: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: AUDIT_LOGS_STANDARD_FIELD_IDS.properties,
    type: FieldMetadataType.RAW_JSON,
    label: 'Event details',
    description: 'Json value for event details',
    icon: 'IconListDetails',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  properties: JSON;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: AUDIT_LOGS_STANDARD_FIELD_IDS.context,
    type: FieldMetadataType.RAW_JSON,
    label: 'Event context',
@ -47,10 +49,10 @@ export class AuditLogObjectMetadata extends BaseObjectMetadata {
      'Json object to provide context (user, device, workspace, etc.)',
    icon: 'IconListDetails',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  context: JSON;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: AUDIT_LOGS_STANDARD_FIELD_IDS.objectName,
    type: FieldMetadataType.TEXT,
    label: 'Object name',
@ -59,7 +61,7 @@ export class AuditLogObjectMetadata extends BaseObjectMetadata {
  })
  objectName: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: AUDIT_LOGS_STANDARD_FIELD_IDS.objectName,
    type: FieldMetadataType.TEXT,
    label: 'Object name',
@ -68,24 +70,26 @@ export class AuditLogObjectMetadata extends BaseObjectMetadata {
  })
  objectMetadataId: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: AUDIT_LOGS_STANDARD_FIELD_IDS.recordId,
    type: FieldMetadataType.UUID,
    label: 'Object id',
    description: 'Event name/type',
    icon: 'IconAbc',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  recordId: string;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: AUDIT_LOGS_STANDARD_FIELD_IDS.workspaceMember,
-    type: FieldMetadataType.RELATION,
+    type: RelationMetadataType.MANY_TO_ONE,
    label: 'Workspace Member',
    description: 'Event workspace member',
    icon: 'IconCircleUser',
    joinColumn: 'workspaceMemberId',
+    inverseSideTarget: () => WorkspaceMemberObjectMetadata,
+    inverseSideFieldKey: 'auditLogs',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  workspaceMember: Relation<WorkspaceMemberObjectMetadata>;
 }
--- a/packages/twenty-server/src/modules/timeline/standard-objects/behavioral-event.object-metadata.ts
+++ b/packages/twenty-server/src/modules/timeline/standard-objects/behavioral-event.object-metadata.ts
@ -1,15 +1,15 @@
 import { FeatureFlagKeys } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
 import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
+import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
+import { WorkspaceGate } from 'src/engine/twenty-orm/decorators/workspace-gate.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 { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-object.decorator';
 import { BEHAVIORAL_EVENT_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
-import { FieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator';
-import { Gate } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/gate.decorator';
-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 { ObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/object-metadata.decorator';
-import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';

-@ObjectMetadata({
+@WorkspaceEntity({
  standardId: STANDARD_OBJECT_IDS.behavioralEvent,
  namePlural: 'behavioralEvents',
  labelSingular: 'Behavioral Event',
@ -17,11 +17,11 @@ import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-
  description: 'An event related to user behavior',
  icon: 'IconIconTimelineEvent',
 })
-@IsSystem()
-@Gate({
+@WorkspaceIsSystem()
+@WorkspaceGate({
  featureFlag: FeatureFlagKeys.IsEventObjectEnabled,
 })
-export class BehavioralEventObjectMetadata extends BaseObjectMetadata {
+export class BehavioralEventObjectMetadata extends BaseWorkspaceEntity {
  /** 
   * 
   * Common in Segment, Rudderstack, etc.
@ -29,7 +29,7 @@ export class BehavioralEventObjectMetadata extends BaseObjectMetadata {
   * But doesn't feel that useful. 
   * Let's try living without it.
   * 
-  @FieldMetadata({
+  @WorkspaceField({
    standardId: behavioralEventStandardFieldIds.type,
    type: FieldMetadataType.TEXT,
    label: 'Event type',
@ -39,7 +39,7 @@ export class BehavioralEventObjectMetadata extends BaseObjectMetadata {
  type: string;
  */

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.name,
    type: FieldMetadataType.TEXT,
    label: 'Event name',
@ -48,17 +48,17 @@ export class BehavioralEventObjectMetadata extends BaseObjectMetadata {
  })
  name: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.properties,
    type: FieldMetadataType.RAW_JSON,
    label: 'Event details',
    description: 'Json value for event details',
    icon: 'IconListDetails',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  properties: JSON;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.context,
    type: FieldMetadataType.RAW_JSON,
    label: 'Event context',
@ -66,10 +66,10 @@ export class BehavioralEventObjectMetadata extends BaseObjectMetadata {
      'Json object to provide context (user, device, workspace, etc.)',
    icon: 'IconListDetails',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  context: JSON;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.objectName,
    type: FieldMetadataType.TEXT,
    label: 'Object name',
@ -78,13 +78,13 @@ export class BehavioralEventObjectMetadata extends BaseObjectMetadata {
  })
  objectName: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.recordId,
    type: FieldMetadataType.UUID,
    label: 'Object id',
    description: 'Event name/type',
    icon: 'IconAbc',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  recordId: string;
 }
--- a/packages/twenty-server/src/modules/timeline/standard-objects/timeline-activity.object-metadata.ts
+++ b/packages/twenty-server/src/modules/timeline/standard-objects/timeline-activity.object-metadata.ts
@ -3,20 +3,22 @@ import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/i
 import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
 import { TIMELINE_ACTIVITY_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
-import { DynamicRelationFieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/dynamic-field-metadata.interface';
-import { FieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator';
-import { IsNotAuditLogged } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-not-audit-logged.decorator';
-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 { ObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/object-metadata.decorator';
-import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
 import { CompanyObjectMetadata } from 'src/modules/company/standard-objects/company.object-metadata';
 import { OpportunityObjectMetadata } from 'src/modules/opportunity/standard-objects/opportunity.object-metadata';
 import { PersonObjectMetadata } from 'src/modules/person/standard-objects/person.object-metadata';
 import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
-import { CustomObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/custom-objects/custom.object-metadata';
+import { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
+import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-object.decorator';
+import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
+import { WorkspaceIsNotAuditLogged } from 'src/engine/twenty-orm/decorators/workspace-is-not-audit-logged.decorator';
+import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
+import { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-is-nullable.decorator';
+import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator';
+import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
+import { WorkspaceDynamicRelation } from 'src/engine/twenty-orm/decorators/workspace-dynamic-relation.decorator';

-@ObjectMetadata({
+@WorkspaceEntity({
  standardId: STANDARD_OBJECT_IDS.timelineActivity,
  namePlural: 'timelineActivities',
  labelSingular: 'Timeline Activity',
@ -24,10 +26,10 @@ import { CustomObjectMetadata } from 'src/engine/workspace-manager/workspace-syn
  description: 'Aggregated / filtered event to be displayed on the timeline',
  icon: 'IconIconTimelineEvent',
 })
-@IsSystem()
-@IsNotAuditLogged()
-export class TimelineActivityObjectMetadata extends BaseObjectMetadata {
-  @FieldMetadata({
+@WorkspaceIsSystem()
+@WorkspaceIsNotAuditLogged()
+export class TimelineActivityObjectMetadata extends BaseWorkspaceEntity {
+  @WorkspaceField({
    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.happensAt,
    type: FieldMetadataType.DATE_TIME,
    label: 'Creation date',
@ -37,7 +39,7 @@ export class TimelineActivityObjectMetadata extends BaseObjectMetadata {
  })
  happensAt: Date;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.name,
    type: FieldMetadataType.TEXT,
    label: 'Event name',
@ -46,73 +48,18 @@ export class TimelineActivityObjectMetadata extends BaseObjectMetadata {
  })
  name: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.properties,
    type: FieldMetadataType.RAW_JSON,
    label: 'Event details',
    description: 'Json value for event details',
    icon: 'IconListDetails',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  properties: JSON;

-  // Who made the action
-  @FieldMetadata({
-    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.workspaceMember,
-    type: FieldMetadataType.RELATION,
-    label: 'Workspace Member',
-    description: 'Event workspace member',
-    icon: 'IconCircleUser',
-    joinColumn: 'workspaceMemberId',
-  })
-  @IsNullable()
-  workspaceMember: Relation<WorkspaceMemberObjectMetadata>;
-
-  @FieldMetadata({
-    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.person,
-    type: FieldMetadataType.RELATION,
-    label: 'Person',
-    description: 'Event person',
-    icon: 'IconUser',
-    joinColumn: 'personId',
-  })
-  @IsNullable()
-  person: Relation<PersonObjectMetadata>;
-
-  @FieldMetadata({
-    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.company,
-    type: FieldMetadataType.RELATION,
-    label: 'Company',
-    description: 'Event company',
-    icon: 'IconBuildingSkyscraper',
-    joinColumn: 'companyId',
-  })
-  @IsNullable()
-  company: Relation<CompanyObjectMetadata>;
-
-  @FieldMetadata({
-    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.opportunity,
-    type: FieldMetadataType.RELATION,
-    label: 'Opportunity',
-    description: 'Events opportunity',
-    icon: 'IconTargetArrow',
-    joinColumn: 'opportunityId',
-  })
-  @IsNullable()
-  opportunity: Relation<OpportunityObjectMetadata>;
-
-  @DynamicRelationFieldMetadata((oppositeObjectMetadata) => ({
-    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.custom,
-    name: oppositeObjectMetadata.nameSingular,
-    label: oppositeObjectMetadata.labelSingular,
-    description: `Event ${oppositeObjectMetadata.labelSingular}`,
-    joinColumn: `${oppositeObjectMetadata.nameSingular}Id`,
-    icon: 'IconTimeline',
-  }))
-  custom: Relation<CustomObjectMetadata>;
-
  // Special objects that don't have their own timeline and are 'link' to the main object
-  @FieldMetadata({
+  @WorkspaceField({
    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.linkedRecordCachedName,
    type: FieldMetadataType.TEXT,
    label: 'Linked Record cached name',
@ -121,23 +68,91 @@ export class TimelineActivityObjectMetadata extends BaseObjectMetadata {
  })
  linkedRecordCachedName: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.linkedRecordId,
    type: FieldMetadataType.UUID,
    label: 'Linked Record id',
    description: 'Linked Record id',
    icon: 'IconAbc',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  linkedRecordId: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.linkedObjectMetadataId,
    type: FieldMetadataType.UUID,
    label: 'Linked Object Metadata Id',
    description: 'inked Object Metadata Id',
    icon: 'IconAbc',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  linkedObjectMetadataId: string;
+
+  // Who made the action
+  @WorkspaceRelation({
+    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.workspaceMember,
+    type: RelationMetadataType.MANY_TO_ONE,
+    label: 'Workspace Member',
+    description: 'Event workspace member',
+    icon: 'IconCircleUser',
+    joinColumn: 'workspaceMemberId',
+    inverseSideTarget: () => WorkspaceMemberObjectMetadata,
+    inverseSideFieldKey: 'timelineActivities',
+  })
+  @WorkspaceIsNullable()
+  workspaceMember: Relation<WorkspaceMemberObjectMetadata>;
+
+  @WorkspaceRelation({
+    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.person,
+    type: RelationMetadataType.MANY_TO_ONE,
+    label: 'Person',
+    description: 'Event person',
+    icon: 'IconUser',
+    joinColumn: 'personId',
+    inverseSideTarget: () => PersonObjectMetadata,
+    inverseSideFieldKey: 'timelineActivities',
+  })
+  @WorkspaceIsNullable()
+  person: Relation<PersonObjectMetadata>;
+
+  @WorkspaceRelation({
+    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.company,
+    type: RelationMetadataType.MANY_TO_ONE,
+    label: 'Company',
+    description: 'Event company',
+    icon: 'IconBuildingSkyscraper',
+    joinColumn: 'companyId',
+    inverseSideTarget: () => CompanyObjectMetadata,
+    inverseSideFieldKey: 'timelineActivities',
+  })
+  @WorkspaceIsNullable()
+  company: Relation<CompanyObjectMetadata>;
+
+  @WorkspaceRelation({
+    standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.opportunity,
+    type: RelationMetadataType.MANY_TO_ONE,
+    label: 'Opportunity',
+    description: 'Event opportunity',
+    icon: 'IconTargetArrow',
+    joinColumn: 'opportunityId',
+    inverseSideTarget: () => OpportunityObjectMetadata,
+    inverseSideFieldKey: 'timelineActivities',
+  })
+  @WorkspaceIsNullable()
+  opportunity: Relation<OpportunityObjectMetadata>;
+
+  @WorkspaceDynamicRelation({
+    type: RelationMetadataType.MANY_TO_ONE,
+    argsFactory: (oppositeObjectMetadata) => ({
+      standardId: TIMELINE_ACTIVITY_STANDARD_FIELD_IDS.custom,
+      name: oppositeObjectMetadata.nameSingular,
+      label: oppositeObjectMetadata.labelSingular,
+      description: `Event ${oppositeObjectMetadata.labelSingular}`,
+      joinColumn: `${oppositeObjectMetadata.nameSingular}Id`,
+      icon: 'IconTimeline',
+    }),
+    inverseSideTarget: () => CustomWorkspaceEntity,
+    inverseSideFieldKey: 'timelineActivities',
+  })
+  custom: Relation<CustomWorkspaceEntity>;
 }