feat: new relation sync-metadata, twenty-orm, create/update (#10217)

Fix
https://github.com/twentyhq/core-team-issues/issues/330#issue-2827026606
and
https://github.com/twentyhq/core-team-issues/issues/327#issue-2827001814

What this PR does when `isNewRelationEnabled` is set to `true`:
- [x] Drop the creation of the  foreign key as a `FieldMetadata`
- [x] Stop creating `RelationMetadata`
- [x] Properly fill `FieldMetadata` of type `RELATION` during the sync
command
- [x] Use new relation settings in TwentyORM
- [x] Properly create `FieldMetadata` relations when we create a new
object
- [x] Handle `database:reset` with new relations

---------

Co-authored-by: Charles Bochet <charles@twenty.com>
Co-authored-by: Charles Bochet <charlesBochet@users.noreply.github.com>
This commit is contained in:
Jérémy M
2025-04-22 19:01:39 +02:00
committed by GitHub
parent de1489aabb
commit cc29c25176
160 changed files with 3247 additions and 711 deletions

View File

@ -1,9 +1,9 @@
import { msg } from '@lingui/core/macro';
import { FieldMetadataType } from 'twenty-shared/types';
import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/relation.interface';
import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator';
import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
@ -39,7 +39,7 @@ export class WorkflowEventListenerWorkspaceEntity extends BaseWorkspaceEntity {
// Relations
@WorkspaceRelation({
standardId: WORKFLOW_EVENT_LISTENER_STANDARD_FIELD_IDS.workflow,
type: RelationMetadataType.MANY_TO_ONE,
type: RelationType.MANY_TO_ONE,
label: msg`Workflow`,
description: msg`WorkflowEventListener workflow`,
icon: 'IconSettingsAutomation',

View File

@ -1,13 +1,11 @@
import { msg } from '@lingui/core/macro';
import { FieldMetadataType } from 'twenty-shared/types';
import { RelationOnDeleteAction } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-on-delete-action.interface';
import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/relation.interface';
import { ActorMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type';
import {
RelationMetadataType,
RelationOnDeleteAction,
} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator';
import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
@ -165,7 +163,7 @@ export class WorkflowRunWorkspaceEntity extends BaseWorkspaceEntity {
// Relations
@WorkspaceRelation({
standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.workflowVersion,
type: RelationMetadataType.MANY_TO_ONE,
type: RelationType.MANY_TO_ONE,
label: msg`Workflow version`,
description: msg`Workflow version linked to the run.`,
icon: 'IconVersions',
@ -179,7 +177,7 @@ export class WorkflowRunWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.workflow,
type: RelationMetadataType.MANY_TO_ONE,
type: RelationType.MANY_TO_ONE,
label: msg`Workflow`,
description: msg`Workflow linked to the run.`,
icon: 'IconSettingsAutomation',
@ -193,7 +191,7 @@ export class WorkflowRunWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.favorites,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Favorites`,
description: msg`Favorites linked to the workflow run`,
icon: 'IconHeart',
@ -205,7 +203,7 @@ export class WorkflowRunWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.timelineActivities,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Timeline Activities`,
description: msg`Timeline activities linked to the run`,
inverseSideTarget: () => TimelineActivityWorkspaceEntity,

View File

@ -1,13 +1,11 @@
import { msg } from '@lingui/core/macro';
import { FieldMetadataType } from 'twenty-shared/types';
import { RelationOnDeleteAction } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-on-delete-action.interface';
import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/relation.interface';
import { FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import {
RelationMetadataType,
RelationOnDeleteAction,
} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator';
import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
@ -123,7 +121,7 @@ export class WorkflowVersionWorkspaceEntity extends BaseWorkspaceEntity {
// Relations
@WorkspaceRelation({
standardId: WORKFLOW_VERSION_STANDARD_FIELD_IDS.workflow,
type: RelationMetadataType.MANY_TO_ONE,
type: RelationType.MANY_TO_ONE,
label: msg`Workflow`,
description: msg`WorkflowVersion workflow`,
icon: 'IconSettingsAutomation',
@ -138,7 +136,7 @@ export class WorkflowVersionWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_VERSION_STANDARD_FIELD_IDS.runs,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Runs`,
description: msg`Workflow runs linked to the version.`,
icon: 'IconRun',
@ -150,7 +148,7 @@ export class WorkflowVersionWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_VERSION_STANDARD_FIELD_IDS.favorites,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Favorites`,
description: msg`Favorites linked to the workflow version`,
icon: 'IconHeart',
@ -162,7 +160,7 @@ export class WorkflowVersionWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_VERSION_STANDARD_FIELD_IDS.timelineActivities,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Timeline Activities`,
description: msg`Timeline activities linked to the version`,
inverseSideTarget: () => TimelineActivityWorkspaceEntity,

View File

@ -1,14 +1,12 @@
import { msg } from '@lingui/core/macro';
import { FieldMetadataType } from 'twenty-shared/types';
import { RelationOnDeleteAction } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-on-delete-action.interface';
import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/relation.interface';
import { ActorMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type';
import { FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import {
RelationMetadataType,
RelationOnDeleteAction,
} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator';
import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
@ -106,7 +104,7 @@ export class WorkflowWorkspaceEntity extends BaseWorkspaceEntity {
// Relations
@WorkspaceRelation({
standardId: WORKFLOW_STANDARD_FIELD_IDS.versions,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Versions`,
description: msg`Workflow versions linked to the workflow.`,
icon: 'IconVersions',
@ -117,7 +115,7 @@ export class WorkflowWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_STANDARD_FIELD_IDS.runs,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Runs`,
description: msg`Workflow runs linked to the workflow.`,
icon: 'IconRun',
@ -128,7 +126,7 @@ export class WorkflowWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_STANDARD_FIELD_IDS.eventListeners,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Event Listeners`,
description: msg`Workflow event listeners linked to the workflow.`,
inverseSideTarget: () => WorkflowEventListenerWorkspaceEntity,
@ -139,7 +137,7 @@ export class WorkflowWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_STANDARD_FIELD_IDS.favorites,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Favorites`,
description: msg`Favorites linked to the workflow`,
icon: 'IconHeart',
@ -151,7 +149,7 @@ export class WorkflowWorkspaceEntity extends BaseWorkspaceEntity {
@WorkspaceRelation({
standardId: WORKFLOW_STANDARD_FIELD_IDS.timelineActivities,
type: RelationMetadataType.ONE_TO_MANY,
type: RelationType.ONE_TO_MANY,
label: msg`Timeline Activities`,
description: msg`Timeline activities linked to the workflow`,
inverseSideTarget: () => TimelineActivityWorkspaceEntity,

View File

@ -12,6 +12,7 @@ import { WorkflowExecutor } from 'src/modules/workflow/workflow-executor/interfa
import { QUERY_MAX_RECORDS } from 'src/engine/api/graphql/graphql-query-runner/constants/query-max-records.constant';
import { GraphqlQueryParser } from 'src/engine/api/graphql/graphql-query-runner/graphql-query-parsers/graphql-query.parser';
import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
import { ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
import { ObjectMetadataMaps } from 'src/engine/metadata-modules/types/object-metadata-maps';
@ -86,6 +87,7 @@ export class FindRecordsWorkflowAction implements WorkflowExecutor {
const graphqlQueryParser = new GraphqlQueryParser(
objectMetadataItemWithFieldsMaps.fieldsByName,
objectMetadataItemWithFieldsMaps.fieldsByJoinColumnName,
objectMetadataMaps,
featureFlagMaps,
);
@ -120,6 +122,11 @@ export class FindRecordsWorkflowAction implements WorkflowExecutor {
repository: WorkspaceRepository<T>,
graphqlQueryParser: GraphqlQueryParser,
) {
const isNewRelationEnabled = await this.featureFlagService.isFeatureEnabled(
FeatureFlagKey.IsNewRelationEnabled,
objectMetadataItemWithFieldsMaps.workspaceId,
);
const queryBuilder = repository.createQueryBuilder(
workflowActionInput.objectName,
);
@ -150,6 +157,7 @@ export class FindRecordsWorkflowAction implements WorkflowExecutor {
nonFormattedObjectRecords,
objectMetadataItemWithFieldsMaps,
objectMetadataMaps,
isNewRelationEnabled,
);
}