fix: multiple twenty orm issues & show an example of use (#5439)

This PR is fixing some issues and adding enhancement in TwentyORM:

- [x] Composite fields in nested relations are not formatted properly
- [x] Passing operators like `Any` in `where` condition is breaking the
query
- [x] Ability to auto load workspace-entities based on a regex path

I've also introduced an example of use for `CalendarEventService`:


https://github.com/twentyhq/twenty/pull/5439/files#diff-3a7dffc0dea57345d10e70c648e911f98fe237248bcea124dafa9c8deb1db748R15
This commit is contained in:
Jérémy M
2024-05-20 11:01:47 +02:00
committed by GitHub
parent 81e8f49033
commit 8b5f79ddbf
147 changed files with 1108 additions and 1101 deletions

View File

@ -3,11 +3,11 @@ import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/i
import { ACTIVITY_TARGET_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 { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
import { ActivityObjectMetadata } from 'src/modules/activity/standard-objects/activity.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 { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-object.decorator';
import { ActivityWorkspaceEntity } from 'src/modules/activity/standard-objects/activity.workspace-entity';
import { CompanyWorkspaceEntity } from 'src/modules/company/standard-objects/company.workspace-entity';
import { OpportunityWorkspaceEntity } from 'src/modules/opportunity/standard-objects/opportunity.workspace-entity';
import { PersonWorkspaceEntity } from 'src/modules/person/standard-objects/person.workspace-entity';
import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.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 { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-is-nullable.decorator';
@ -26,7 +26,7 @@ import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity
})
@WorkspaceIsSystem()
@WorkspaceIsNotAuditLogged()
export class ActivityTargetObjectMetadata extends BaseWorkspaceEntity {
export class ActivityTargetWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.activity,
type: RelationMetadataType.MANY_TO_ONE,
@ -34,11 +34,11 @@ export class ActivityTargetObjectMetadata extends BaseWorkspaceEntity {
description: 'ActivityTarget activity',
icon: 'IconNotes',
joinColumn: 'activityId',
inverseSideTarget: () => ActivityObjectMetadata,
inverseSideTarget: () => ActivityWorkspaceEntity,
inverseSideFieldKey: 'activityTargets',
})
@WorkspaceIsNullable()
activity: Relation<ActivityObjectMetadata>;
activity: Relation<ActivityWorkspaceEntity>;
@WorkspaceRelation({
standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.person,
@ -47,11 +47,11 @@ export class ActivityTargetObjectMetadata extends BaseWorkspaceEntity {
description: 'ActivityTarget person',
icon: 'IconUser',
joinColumn: 'personId',
inverseSideTarget: () => PersonObjectMetadata,
inverseSideTarget: () => PersonWorkspaceEntity,
inverseSideFieldKey: 'activityTargets',
})
@WorkspaceIsNullable()
person: Relation<PersonObjectMetadata>;
person: Relation<PersonWorkspaceEntity>;
@WorkspaceRelation({
standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.company,
@ -60,11 +60,11 @@ export class ActivityTargetObjectMetadata extends BaseWorkspaceEntity {
description: 'ActivityTarget company',
icon: 'IconBuildingSkyscraper',
joinColumn: 'companyId',
inverseSideTarget: () => CompanyObjectMetadata,
inverseSideTarget: () => CompanyWorkspaceEntity,
inverseSideFieldKey: 'activityTargets',
})
@WorkspaceIsNullable()
company: Relation<CompanyObjectMetadata>;
company: Relation<CompanyWorkspaceEntity>;
@WorkspaceRelation({
standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.opportunity,
@ -73,11 +73,11 @@ export class ActivityTargetObjectMetadata extends BaseWorkspaceEntity {
description: 'ActivityTarget opportunity',
icon: 'IconTargetArrow',
joinColumn: 'opportunityId',
inverseSideTarget: () => OpportunityObjectMetadata,
inverseSideTarget: () => OpportunityWorkspaceEntity,
inverseSideFieldKey: 'activityTargets',
})
@WorkspaceIsNullable()
opportunity: Relation<OpportunityObjectMetadata>;
opportunity: Relation<OpportunityWorkspaceEntity>;
@WorkspaceDynamicRelation({
type: RelationMetadataType.MANY_TO_ONE,

View File

@ -7,11 +7,11 @@ import {
} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
import { 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 { ActivityTargetObjectMetadata } from 'src/modules/activity/standard-objects/activity-target.object-metadata';
import { AttachmentObjectMetadata } from 'src/modules/attachment/standard-objects/attachment.object-metadata';
import { CommentObjectMetadata } from 'src/modules/activity/standard-objects/comment.object-metadata';
import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-object.decorator';
import { ActivityTargetWorkspaceEntity } from 'src/modules/activity/standard-objects/activity-target.workspace-entity';
import { AttachmentWorkspaceEntity } from 'src/modules/attachment/standard-objects/attachment.workspace-entity';
import { CommentWorkspaceEntity } from 'src/modules/activity/standard-objects/comment.workspace-entity';
import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity';
import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator';
import { WorkspaceIsNotAuditLogged } from 'src/engine/twenty-orm/decorators/workspace-is-not-audit-logged.decorator';
import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
@ -29,7 +29,7 @@ import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity
})
@WorkspaceIsNotAuditLogged()
@WorkspaceIsSystem()
export class ActivityObjectMetadata extends BaseWorkspaceEntity {
export class ActivityWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceField({
standardId: ACTIVITY_STANDARD_FIELD_IDS.title,
type: FieldMetadataType.TEXT,
@ -94,11 +94,11 @@ export class ActivityObjectMetadata extends BaseWorkspaceEntity {
description: 'Activity targets',
icon: 'IconCheckbox',
type: RelationMetadataType.ONE_TO_MANY,
inverseSideTarget: () => ActivityTargetObjectMetadata,
inverseSideTarget: () => ActivityTargetWorkspaceEntity,
onDelete: RelationOnDeleteAction.SET_NULL,
})
@WorkspaceIsNullable()
activityTargets: Relation<ActivityTargetObjectMetadata[]>;
activityTargets: Relation<ActivityTargetWorkspaceEntity[]>;
@WorkspaceRelation({
standardId: ACTIVITY_STANDARD_FIELD_IDS.attachments,
@ -106,11 +106,11 @@ export class ActivityObjectMetadata extends BaseWorkspaceEntity {
description: 'Activity attachments',
icon: 'IconFileImport',
type: RelationMetadataType.ONE_TO_MANY,
inverseSideTarget: () => AttachmentObjectMetadata,
inverseSideTarget: () => AttachmentWorkspaceEntity,
onDelete: RelationOnDeleteAction.SET_NULL,
})
@WorkspaceIsNullable()
attachments: Relation<AttachmentObjectMetadata[]>;
attachments: Relation<AttachmentWorkspaceEntity[]>;
@WorkspaceRelation({
standardId: ACTIVITY_STANDARD_FIELD_IDS.comments,
@ -118,11 +118,11 @@ export class ActivityObjectMetadata extends BaseWorkspaceEntity {
description: 'Activity comments',
icon: 'IconComment',
type: RelationMetadataType.ONE_TO_MANY,
inverseSideTarget: () => CommentObjectMetadata,
inverseSideTarget: () => CommentWorkspaceEntity,
onDelete: RelationOnDeleteAction.CASCADE,
})
@WorkspaceIsNullable()
comments: Relation<CommentObjectMetadata[]>;
comments: Relation<CommentWorkspaceEntity[]>;
@WorkspaceRelation({
standardId: ACTIVITY_STANDARD_FIELD_IDS.author,
@ -130,13 +130,13 @@ export class ActivityObjectMetadata extends BaseWorkspaceEntity {
description: 'Activity author',
icon: 'IconUserCircle',
type: RelationMetadataType.MANY_TO_ONE,
inverseSideTarget: () => WorkspaceMemberObjectMetadata,
inverseSideTarget: () => WorkspaceMemberWorkspaceEntity,
inverseSideFieldKey: 'authoredActivities',
onDelete: RelationOnDeleteAction.SET_NULL,
joinColumn: 'authorId',
})
@WorkspaceIsNullable()
author: Relation<WorkspaceMemberObjectMetadata>;
author: Relation<WorkspaceMemberWorkspaceEntity>;
@WorkspaceRelation({
standardId: ACTIVITY_STANDARD_FIELD_IDS.assignee,
@ -144,11 +144,11 @@ export class ActivityObjectMetadata extends BaseWorkspaceEntity {
description: 'Activity assignee',
icon: 'IconUserCircle',
type: RelationMetadataType.MANY_TO_ONE,
inverseSideTarget: () => WorkspaceMemberObjectMetadata,
inverseSideTarget: () => WorkspaceMemberWorkspaceEntity,
inverseSideFieldKey: 'assignedActivities',
onDelete: RelationOnDeleteAction.SET_NULL,
joinColumn: 'assigneeId',
})
@WorkspaceIsNullable()
assignee: Relation<WorkspaceMemberObjectMetadata>;
assignee: Relation<WorkspaceMemberWorkspaceEntity>;
}

View File

@ -3,9 +3,9 @@ import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/i
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { COMMENT_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 { ActivityObjectMetadata } from 'src/modules/activity/standard-objects/activity.object-metadata';
import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-object.decorator';
import { ActivityWorkspaceEntity } from 'src/modules/activity/standard-objects/activity.workspace-entity';
import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity';
import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.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';
@ -23,7 +23,7 @@ import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity
})
@WorkspaceIsSystem()
@WorkspaceIsNotAuditLogged()
export class CommentObjectMetadata extends BaseWorkspaceEntity {
export class CommentWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceField({
standardId: COMMENT_STANDARD_FIELD_IDS.body,
type: FieldMetadataType.TEXT,
@ -40,10 +40,10 @@ export class CommentObjectMetadata extends BaseWorkspaceEntity {
description: 'Comment author',
icon: 'IconCircleUser',
joinColumn: 'authorId',
inverseSideTarget: () => WorkspaceMemberObjectMetadata,
inverseSideTarget: () => WorkspaceMemberWorkspaceEntity,
inverseSideFieldKey: 'authoredComments',
})
author: Relation<WorkspaceMemberObjectMetadata>;
author: Relation<WorkspaceMemberWorkspaceEntity>;
@WorkspaceRelation({
standardId: COMMENT_STANDARD_FIELD_IDS.activity,
@ -52,8 +52,8 @@ export class CommentObjectMetadata extends BaseWorkspaceEntity {
description: 'Comment activity',
icon: 'IconNotes',
joinColumn: 'activityId',
inverseSideTarget: () => ActivityObjectMetadata,
inverseSideTarget: () => ActivityWorkspaceEntity,
inverseSideFieldKey: 'comments',
})
activity: Relation<ActivityObjectMetadata>;
activity: Relation<ActivityWorkspaceEntity>;
}