Skip to content

The open alternative to Salesforce, designed for AI.

Add inherent related record paths and declare the standard ones (#29292)

Charles Bochetd205a7d6d71a
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
index 49ca48a7131..293e1c390a4 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
@@ -1706,6 +1706,7 @@ input CreateRecordExportInput {
input CreateRelatedRecordPathInput {
firstFieldMetadataId: UUID
+ isInherent: Boolean
objectMetadataId: UUID
secondFieldMetadataId: UUID
thirdFieldMetadataId: UUID
@@ -4328,6 +4329,7 @@ input RecordTargetInput {
type RelatedRecordPath {
firstFieldMetadataId: UUID!
id: UUID!
+ isInherent: Boolean!
objectMetadataId: UUID!
secondFieldMetadataId: UUID
thirdFieldMetadataId: UUID
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.ts b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
index 679295f0f81..cc35e179b27 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
@@ -3209,6 +3209,7 @@ export interface RecordTableConfiguration {
export interface RelatedRecordPath {
firstFieldMetadataId: Scalars['UUID']
id: Scalars['UUID']
+ isInherent: Scalars['Boolean']
objectMetadataId: Scalars['UUID']
secondFieldMetadataId?: Scalars['UUID']
thirdFieldMetadataId?: Scalars['UUID']
@@ -5694,7 +5695,7 @@ export interface CreatePageLayoutWidgetInput {configuration: Scalars['JSON'],obj
export interface CreateRecordExportInput {fieldMetadataIds: Scalars['UUID'][],filter?: (Scalars['JSON'] | null),objectMetadataId: Scalars['UUID'],orderBy?: (Scalars['JSON'] | null)}
-export interface CreateRelatedRecordPathInput {firstFieldMetadataId?: (Scalars['UUID'] | null),objectMetadataId?: (Scalars['UUID'] | null),secondFieldMetadataId?: (Scalars['UUID'] | null),thirdFieldMetadataId?: (Scalars['UUID'] | null)}
+export interface CreateRelatedRecordPathInput {firstFieldMetadataId?: (Scalars['UUID'] | null),isInherent?: (Scalars['Boolean'] | null),objectMetadataId?: (Scalars['UUID'] | null),secondFieldMetadataId?: (Scalars['UUID'] | null),thirdFieldMetadataId?: (Scalars['UUID'] | null)}
export interface CreateRoleInput {canAccessAllAgentChatChannels?: (Scalars['Boolean'] | null),canAccessAllTools?: (Scalars['Boolean'] | null),canBeAssignedToAgents?: (Scalars['Boolean'] | null),canBeAssignedToApiKeys?: (Scalars['Boolean'] | null),canBeAssignedToUsers?: (Scalars['Boolean'] | null),canDestroyAllObjectRecords?: (Scalars['Boolean'] | null),canReadAllObjectRecords?: (Scalars['Boolean'] | null),canSoftDeleteAllObjectRecords?: (Scalars['Boolean'] | null),canUpdateAllObjectRecords?: (Scalars['Boolean'] | null),canUpdateAllSettings?: (Scalars['Boolean'] | null),description?: (Scalars['String'] | null),icon?: (Scalars['String'] | null),id?: (Scalars['String'] | null),label: Scalars['String']}
@@ -7790,6 +7791,7 @@ export interface RecordTargetInput {objectMetadataId: Scalars['UUID'],recordId:
export interface RelatedRecordPathGenqlSelection{
firstFieldMetadataId?: boolean | number
id?: boolean | number
+ isInherent?: boolean | number
objectMetadataId?: boolean | number
secondFieldMetadataId?: boolean | number
thirdFieldMetadataId?: boolean | number
diff --git a/packages/twenty-client-sdk/src/metadata/generated/types.ts b/packages/twenty-client-sdk/src/metadata/generated/types.ts
index e6b52f3c078..900d0ad3eca 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/types.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/types.ts
@@ -3803,6 +3803,9 @@ export default {
"firstFieldMetadataId": [
529
],
+ "isInherent": [
+ 4
+ ],
"objectMetadataId": [
529
],
@@ -11882,6 +11885,9 @@ export default {
"id": [
529
],
+ "isInherent": [
+ 4
+ ],
"objectMetadataId": [
529
],
diff --git a/packages/twenty-front/src/generated-metadata/schema.ts b/packages/twenty-front/src/generated-metadata/schema.ts
index 3e2c1da093d..8bd3d077bfb 100644
--- a/packages/twenty-front/src/generated-metadata/schema.ts
+++ b/packages/twenty-front/src/generated-metadata/schema.ts
@@ -1828,6 +1828,7 @@ export type CreateRecordExportInput = {
export type CreateRelatedRecordPathInput = {
firstFieldMetadataId?: InputMaybe<Scalars['UUID']['input']>;
+ isInherent?: InputMaybe<Scalars['Boolean']['input']>;
objectMetadataId?: InputMaybe<Scalars['UUID']['input']>;
secondFieldMetadataId?: InputMaybe<Scalars['UUID']['input']>;
thirdFieldMetadataId?: InputMaybe<Scalars['UUID']['input']>;
@@ -6568,6 +6569,7 @@ export type RelatedRecordPath = {
__typename?: 'RelatedRecordPath';
firstFieldMetadataId: Scalars['UUID']['output'];
id: Scalars['UUID']['output'];
+ isInherent: Scalars['Boolean']['output'];
objectMetadataId: Scalars['UUID']['output'];
secondFieldMetadataId?: Maybe<Scalars['UUID']['output']>;
thirdFieldMetadataId?: Maybe<Scalars['UUID']['output']>;
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-instance-command-fast-1793375358574-add-related-record-path-is-inherent.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-instance-command-fast-1793375358574-add-related-record-path-is-inherent.ts
new file mode 100644
index 00000000000..405b688240f
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-instance-command-fast-1793375358574-add-related-record-path-is-inherent.ts
@@ -0,0 +1,15 @@
+import { QueryRunner } from 'typeorm';
+
+import { RegisteredInstanceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-instance-command.decorator';
+import { FastInstanceCommand } from 'src/engine/core-modules/upgrade/interfaces/fast-instance-command.interface';
+
+@RegisteredInstanceCommand('2.55.0', 1793375358574)
+export class AddRelatedRecordPathIsInherentFastInstanceCommand implements FastInstanceCommand {
+ public async up(queryRunner: QueryRunner): Promise<void> {
+ await queryRunner.query('ALTER TABLE "core"."relatedRecordPath" ADD "isInherent" boolean NOT NULL DEFAULT false');
+ }
+
+ public async down(queryRunner: QueryRunner): Promise<void> {
+ await queryRunner.query('ALTER TABLE "core"."relatedRecordPath" DROP COLUMN "isInherent"');
+ }
+}
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-upgrade-version-command.module.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-upgrade-version-command.module.ts
index 3715a6701a8..320aa53d0cc 100644
--- a/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-upgrade-version-command.module.ts
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-upgrade-version-command.module.ts
@@ -2,6 +2,7 @@ import { Module } from '@nestjs/common';
import { WorkspaceIteratorModule } from 'src/database/commands/command-runners/workspace-iterator.module';
import { BackfillWebhookAdminRoleCommand } from 'src/database/commands/upgrade-version-command/2-55/2-55-workspace-command-1793369399691-backfill-webhook-admin-role.command';
+import { AddStandardRelatedRecordPathsCommand } from 'src/database/commands/upgrade-version-command/2-55/2-55-workspace-command-1793375369182-add-standard-related-record-paths.command';
import { ApplicationModule } from 'src/engine/core-modules/application/application.module';
import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache.module';
import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace-migration/workspace-migration.module';
@@ -13,6 +14,9 @@ import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace
WorkspaceIteratorModule,
WorkspaceMigrationModule,
],
- providers: [BackfillWebhookAdminRoleCommand],
+ providers: [
+ BackfillWebhookAdminRoleCommand,
+ AddStandardRelatedRecordPathsCommand,
+ ],
})
export class V2_55_UpgradeVersionCommandModule {}
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-workspace-command-1793375369182-add-standard-related-record-paths.command.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-workspace-command-1793375369182-add-standard-related-record-paths.command.ts
new file mode 100644
index 00000000000..0dfd742616f
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/2-55-workspace-command-1793375369182-add-standard-related-record-paths.command.ts
@@ -0,0 +1,167 @@
+import { Command } from 'nest-commander';
+import { TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER } from 'twenty-shared/application';
+import { isDefined } from 'twenty-shared/utils';
+import { v4 } from 'uuid';
+
+import { ProvisionedWorkspaceCommandRunner } from 'src/database/commands/command-runners/provisioned-workspace.command-runner';
+import { WorkspaceIteratorService } from 'src/database/commands/command-runners/workspace-iterator.service';
+import { type RunOnWorkspaceArgs } from 'src/database/commands/command-runners/workspace.command-runner';
+import { ApplicationService } from 'src/engine/core-modules/application/application.service';
+import { type FlatRelatedRecordPath } from 'src/engine/metadata-modules/flat-related-record-path/types/flat-related-record-path.type';
+import { getRelatedRecordPathFieldMetadataUniversalIdentifiers } from 'src/engine/metadata-modules/related-record-path/utils/get-related-record-path-field-metadata-universal-identifiers.util';
+import { RegisteredWorkspaceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-workspace-command.decorator';
+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
+import { computeTwentyStandardApplicationAllFlatEntityMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/twenty-standard-application-all-flat-entity-maps.constant';
+import { WorkspaceMigrationBuilderException } from 'src/engine/workspace-manager/workspace-migration/exceptions/workspace-migration-builder-exception';
+import { WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service';
+
+const getHopsKey = (
+ hops: Parameters<
+ typeof getRelatedRecordPathFieldMetadataUniversalIdentifiers
+ >[0],
+) => getRelatedRecordPathFieldMetadataUniversalIdentifiers(hops).join(':');
+
+@RegisteredWorkspaceCommand('2.55.0', 1793375369182)
+@Command({
+ name: 'upgrade:2-55:add-standard-related-record-paths',
+ description:
+ 'Add the standard related record paths and align the inherent flag of matching ones',
+})
+export class AddStandardRelatedRecordPathsCommand extends ProvisionedWorkspaceCommandRunner {
+ constructor(
+ protected readonly workspaceIteratorService: WorkspaceIteratorService,
+ private readonly applicationService: ApplicationService,
+ private readonly workspaceCacheService: WorkspaceCacheService,
+ private readonly workspaceMigrationValidateBuildAndRunService: WorkspaceMigrationValidateBuildAndRunService,
+ ) {
+ super(workspaceIteratorService);
+ }
+
+ private standardFlatRelatedRecordPaths: FlatRelatedRecordPath[] | undefined;
+
+ // The standard paths do not depend on the workspace, so they are built once per run.
+ private getStandardFlatRelatedRecordPaths(): FlatRelatedRecordPath[] {
+ this.standardFlatRelatedRecordPaths ??= Object.values(
+ computeTwentyStandardApplicationAllFlatEntityMaps({
+ now: new Date().toISOString(),
+ workspaceId: v4(),
+ twentyStandardApplicationId: v4(),
+ }).allFlatEntityMaps.flatRelatedRecordPathMaps.byUniversalIdentifier,
+ ).filter(isDefined);
+
+ return this.standardFlatRelatedRecordPaths;
+ }
+
+ override async runOnWorkspace({
+ workspaceId,
+ options,
+ }: RunOnWorkspaceArgs): Promise<void> {
+ const { flatFieldMetadataMaps, flatRelatedRecordPathMaps } =
+ await this.workspaceCacheService.getOrRecompute(workspaceId, [
+ 'flatFieldMetadataMaps',
+ 'flatRelatedRecordPathMaps',
+ ]);
+ const { twentyStandardFlatApplication } =
+ await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
+ { workspaceId },
+ );
+
+ const existingFlatRelatedRecordPathByHopsKey = new Map(
+ Object.values(flatRelatedRecordPathMaps.byUniversalIdentifier)
+ .filter(isDefined)
+ .map((flatRelatedRecordPath) => [
+ getHopsKey(flatRelatedRecordPath),
+ flatRelatedRecordPath,
+ ]),
+ );
+
+ const flatRelatedRecordPathsToCreate: FlatRelatedRecordPath[] = [];
+ const flatRelatedRecordPathsToUpdate: FlatRelatedRecordPath[] = [];
+
+ for (const standardFlatRelatedRecordPath of this.getStandardFlatRelatedRecordPaths()) {
+ const existingFlatRelatedRecordPath =
+ existingFlatRelatedRecordPathByHopsKey.get(
+ getHopsKey(standardFlatRelatedRecordPath),
+ );
+
+ const shouldAlignInherentFlag =
+ isDefined(existingFlatRelatedRecordPath) &&
+ existingFlatRelatedRecordPath.applicationUniversalIdentifier ===
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER &&
+ existingFlatRelatedRecordPath.isInherent !==
+ standardFlatRelatedRecordPath.isInherent;
+
+ if (shouldAlignInherentFlag) {
+ flatRelatedRecordPathsToUpdate.push({
+ ...existingFlatRelatedRecordPath,
+ isInherent: standardFlatRelatedRecordPath.isInherent,
+ });
+ }
+
+ if (isDefined(existingFlatRelatedRecordPath)) {
+ continue;
+ }
+
+ // Older workspaces may lack some standard objects or have deactivated their relations.
+ const hasEveryActiveField =
+ getRelatedRecordPathFieldMetadataUniversalIdentifiers(
+ standardFlatRelatedRecordPath,
+ ).every((fieldMetadataUniversalIdentifier) => {
+ const flatFieldMetadata =
+ flatFieldMetadataMaps.byUniversalIdentifier[
+ fieldMetadataUniversalIdentifier
+ ];
+
+ return isDefined(flatFieldMetadata) && flatFieldMetadata.isActive;
+ });
+
+ if (hasEveryActiveField) {
+ flatRelatedRecordPathsToCreate.push({
+ ...standardFlatRelatedRecordPath,
+ id: v4(),
+ workspaceId,
+ applicationId: twentyStandardFlatApplication.id,
+ });
+ }
+ }
+
+ if (
+ flatRelatedRecordPathsToCreate.length === 0 &&
+ flatRelatedRecordPathsToUpdate.length === 0
+ ) {
+ return;
+ }
+
+ this.logger.log(
+ `${options.dryRun ? '[DRY RUN] ' : ''}Workspace ${workspaceId}: creating ${flatRelatedRecordPathsToCreate.length} and updating ${flatRelatedRecordPathsToUpdate.length} standard related record path(s)`,
+ );
+
+ if (options.dryRun) {
+ return;
+ }
+
+ const result =
+ await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunLegacyWorkspaceMigration(
+ {
+ workspaceId,
+ isSystemBuild: true,
+ applicationUniversalIdentifier:
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ allFlatEntityOperationByMetadataName: {
+ relatedRecordPath: {
+ flatEntityToCreate: flatRelatedRecordPathsToCreate,
+ flatEntityToDelete: [],
+ flatEntityToUpdate: flatRelatedRecordPathsToUpdate,
+ },
+ },
+ },
+ );
+
+ if (result.status === 'fail') {
+ throw new WorkspaceMigrationBuilderException(
+ result,
+ `Failed to add standard related record paths for workspace ${workspaceId}`,
+ );
+ }
+ }
+}
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/add-related-record-path-is-inherent-upgrade-command-name.constant.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/add-related-record-path-is-inherent-upgrade-command-name.constant.ts
new file mode 100644
index 00000000000..3e8323deecc
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-55/add-related-record-path-is-inherent-upgrade-command-name.constant.ts
@@ -0,0 +1,2 @@
+export const ADD_RELATED_RECORD_PATH_IS_INHERENT_UPGRADE_COMMAND_NAME =
+ '2.55.0_AddRelatedRecordPathIsInherentFastInstanceCommand_1793375358574';
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/instance-commands.constant.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/instance-commands.constant.ts
index e440f63dba3..5e65c687dc9 100644
--- a/packages/twenty-server/src/database/commands/upgrade-version-command/instance-commands.constant.ts
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/instance-commands.constant.ts
@@ -274,6 +274,7 @@ import { AddAccessTokenExpiresAtToConnectedAccountFastInstanceCommand } from 'sr
import { AddWebhookIdToRoleTargetFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-55/2-55-instance-command-fast-1793369399690-add-webhook-id-to-role-target';
import { AddWorkspaceIframeMediaPermissionsFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-55/2-55-instance-command-fast-1793371022948-add-workspace-iframe-media-permissions';
import { RenameWorkspaceAllowedIframeOriginsToAllowedEmbeddingOriginsFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-55/2-55-instance-command-fast-1793371022971-rename-workspace-allowed-iframe-origins-to-allowed-embedding-origins';
+import { AddRelatedRecordPathIsInherentFastInstanceCommand } from 'src/database/commands/upgrade-version-command/2-55/2-55-instance-command-fast-1793375358574-add-related-record-path-is-inherent';
export const INSTANCE_COMMANDS = [
AddViewFieldGroupIdIndexOnViewFieldFastInstanceCommand,
@@ -550,4 +551,5 @@ export const INSTANCE_COMMANDS = [
AddWebhookIdToRoleTargetFastInstanceCommand,
AddWorkspaceIframeMediaPermissionsFastInstanceCommand,
RenameWorkspaceAllowedIframeOriginsToAllowedEmbeddingOriginsFastInstanceCommand,
+ AddRelatedRecordPathIsInherentFastInstanceCommand,
];
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/__tests__/__snapshots__/all-universal-flat-entity-properties-to-compare-and-stringify.constant.spec.ts.snap b/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/__tests__/__snapshots__/all-universal-flat-entity-properties-to-compare-and-stringify.constant.spec.ts.snap
index 29cc9514e73..b833265ace2 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/__tests__/__snapshots__/all-universal-flat-entity-properties-to-compare-and-stringify.constant.spec.ts.snap
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/__tests__/__snapshots__/all-universal-flat-entity-properties-to-compare-and-stringify.constant.spec.ts.snap
@@ -328,6 +328,7 @@ exports[`ALL_UNIVERSAL_FLAT_ENTITY_PROPERTIES_TO_COMPARE_AND_STRINGIFY should ma
"firstFieldMetadataUniversalIdentifier",
"secondFieldMetadataUniversalIdentifier",
"thirdFieldMetadataUniversalIdentifier",
+ "isInherent",
],
"propertiesToStringify": [],
},
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts b/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts
index d85cbb1abd7..555ee02a23c 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts
@@ -2225,6 +2225,11 @@ export const ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME = {
toStringify: false,
universalProperty: 'thirdFieldMetadataUniversalIdentifier',
},
+ isInherent: {
+ toCompare: true,
+ toStringify: false,
+ universalProperty: undefined,
+ },
createdAt: {
toCompare: false,
toStringify: false,
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-related-record-path/utils/from-create-related-record-path-input-to-flat-related-record-path-to-create-or-throw.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-related-record-path/utils/from-create-related-record-path-input-to-flat-related-record-path-to-create-or-throw.util.ts
index 14ade9bc28b..a316abf9e05 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-related-record-path/utils/from-create-related-record-path-input-to-flat-related-record-path-to-create-or-throw.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-related-record-path/utils/from-create-related-record-path-input-to-flat-related-record-path-to-create-or-throw.util.ts
@@ -22,6 +22,7 @@ export const fromCreateRelatedRecordPathInputToFlatRelatedRecordPathToCreateOrTh
| 'firstFieldMetadataId'
| 'secondFieldMetadataId'
| 'thirdFieldMetadataId'
+ | 'isInherent'
>;
workspaceId: string;
flatApplication: Pick<FlatApplication, 'id' | 'universalIdentifier'>;
@@ -56,6 +57,7 @@ export const fromCreateRelatedRecordPathInputToFlatRelatedRecordPathToCreateOrTh
applicationUniversalIdentifier: flatApplication.universalIdentifier,
...foreignKeyValues,
...relationUniversalIdentifiers,
+ isInherent: createRelatedRecordPathInput.isInherent ?? false,
createdAt: now,
updatedAt: now,
};
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-related-record-path/utils/from-flat-related-record-path-to-related-record-path-dto.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-related-record-path/utils/from-flat-related-record-path-to-related-record-path-dto.util.ts
index 8a66a7746cd..2aa060c23d8 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-related-record-path/utils/from-flat-related-record-path-to-related-record-path-dto.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-related-record-path/utils/from-flat-related-record-path-to-related-record-path-dto.util.ts
@@ -11,4 +11,5 @@ export const fromFlatRelatedRecordPathToRelatedRecordPathDto = (
firstFieldMetadataId: flatRelatedRecordPath.firstFieldMetadataId,
secondFieldMetadataId: flatRelatedRecordPath.secondFieldMetadataId,
thirdFieldMetadataId: flatRelatedRecordPath.thirdFieldMetadataId,
+ isInherent: flatRelatedRecordPath.isInherent,
});
diff --git a/packages/twenty-server/src/engine/metadata-modules/related-record-path/dtos/create-related-record-path.input.ts b/packages/twenty-server/src/engine/metadata-modules/related-record-path/dtos/create-related-record-path.input.ts
index 0deafb50713..d10ac38774b 100644
--- a/packages/twenty-server/src/engine/metadata-modules/related-record-path/dtos/create-related-record-path.input.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/related-record-path/dtos/create-related-record-path.input.ts
@@ -2,7 +2,7 @@
import { Field, InputType } from '@nestjs/graphql';
-import { IsNotEmpty, IsOptional, IsUUID } from 'class-validator';
+import { IsBoolean, IsNotEmpty, IsOptional, IsUUID } from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
@@ -27,4 +27,9 @@ export class CreateRelatedRecordPathInput {
@IsOptional()
@Field(() => UUIDScalarType, { nullable: true })
thirdFieldMetadataId?: string | null;
+
+ @IsBoolean()
+ @IsOptional()
+ @Field(() => Boolean, { nullable: true })
+ isInherent?: boolean | null;
}
diff --git a/packages/twenty-server/src/engine/metadata-modules/related-record-path/dtos/related-record-path.dto.ts b/packages/twenty-server/src/engine/metadata-modules/related-record-path/dtos/related-record-path.dto.ts
index c3c12548948..c300175765f 100644
--- a/packages/twenty-server/src/engine/metadata-modules/related-record-path/dtos/related-record-path.dto.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/related-record-path/dtos/related-record-path.dto.ts
@@ -20,4 +20,7 @@ export class RelatedRecordPathDTO {
@Field(() => UUIDScalarType, { nullable: true })
thirdFieldMetadataId: string | null;
+
+ @Field(() => Boolean)
+ isInherent: boolean;
}
diff --git a/packages/twenty-server/src/engine/metadata-modules/related-record-path/entities/related-record-path.entity.ts b/packages/twenty-server/src/engine/metadata-modules/related-record-path/entities/related-record-path.entity.ts
index e20e57ed3a1..27f950518b2 100644
--- a/packages/twenty-server/src/engine/metadata-modules/related-record-path/entities/related-record-path.entity.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/related-record-path/entities/related-record-path.entity.ts
@@ -13,6 +13,7 @@ import {
} from 'typeorm';
import { ADD_RELATED_RECORD_PATH_TABLE_UPGRADE_COMMAND_NAME } from 'src/database/commands/upgrade-version-command/2-54/add-related-record-path-table-upgrade-command-name.constant';
+import { ADD_RELATED_RECORD_PATH_IS_INHERENT_UPGRADE_COMMAND_NAME } from 'src/database/commands/upgrade-version-command/2-55/add-related-record-path-is-inherent-upgrade-command-name.constant';
import { WasIntroducedInUpgrade } from 'src/engine/core-modules/upgrade/decorators/was-introduced-in-upgrade.decorator';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
@@ -87,6 +88,14 @@ export class RelatedRecordPathEntity
@JoinColumn({ name: 'thirdFieldMetadataId' })
thirdFieldMetadata: Relation<FieldMetadataEntity> | null;
+ // Inherent paths apply however the source record became readable; others only when access starts on it.
+ @Column({ nullable: false, type: 'boolean', default: false })
+ @WasIntroducedInUpgrade({
+ upgradeCommandName:
+ ADD_RELATED_RECORD_PATH_IS_INHERENT_UPGRADE_COMMAND_NAME,
+ })
+ isInherent: boolean;
+
@CreateDateColumn({ type: 'timestamptz' })
createdAt: Date;
diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/constants/standard-related-record-paths.constant.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/constants/standard-related-record-paths.constant.ts
new file mode 100644
index 00000000000..05c1af04881
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/constants/standard-related-record-paths.constant.ts
@@ -0,0 +1,107 @@
+/* @license Enterprise */
+
+import { type AllStandardObjectFieldName } from 'src/engine/workspace-manager/twenty-standard-application/types/all-standard-object-field-name.type';
+import { type AllStandardObjectName } from 'src/engine/workspace-manager/twenty-standard-application/types/all-standard-object-name.type';
+
+export type StandardRelatedRecordPath = {
+ [O in AllStandardObjectName]: {
+ objectName: O;
+ fieldNames:
+ | [AllStandardObjectFieldName<O>]
+ | [AllStandardObjectFieldName<O>, string]
+ | [AllStandardObjectFieldName<O>, string, string];
+ isInherent: boolean;
+ };
+}[AllStandardObjectName];
+
+export const STANDARD_RELATED_RECORD_PATHS: StandardRelatedRecordPath[] = [
+ {
+ objectName: 'agentChatThread',
+ fieldNames: ['attachments'],
+ isInherent: true,
+ },
+ { objectName: 'company', fieldNames: ['attachments'], isInherent: true },
+ { objectName: 'dashboard', fieldNames: ['attachments'], isInherent: true },
+ { objectName: 'note', fieldNames: ['attachments'], isInherent: true },
+ { objectName: 'opportunity', fieldNames: ['attachments'], isInherent: true },
+ { objectName: 'person', fieldNames: ['attachments'], isInherent: true },
+ { objectName: 'task', fieldNames: ['attachments'], isInherent: true },
+ { objectName: 'workflow', fieldNames: ['attachments'], isInherent: true },
+ {
+ objectName: 'company',
+ fieldNames: ['timelineActivities'],
+ isInherent: true,
+ },
+ {
+ objectName: 'dashboard',
+ fieldNames: ['timelineActivities'],
+ isInherent: true,
+ },
+ {
+ objectName: 'messageCampaign',
+ fieldNames: ['timelineActivities'],
+ isInherent: true,
+ },
+ {
+ objectName: 'messageList',
+ fieldNames: ['timelineActivities'],
+ isInherent: true,
+ },
+ { objectName: 'note', fieldNames: ['timelineActivities'], isInherent: true },
+ {
+ objectName: 'opportunity',
+ fieldNames: ['timelineActivities'],
+ isInherent: true,
+ },
+ {
+ objectName: 'person',
+ fieldNames: ['timelineActivities'],
+ isInherent: true,
+ },
+ { objectName: 'task', fieldNames: ['timelineActivities'], isInherent: true },
+ {
+ objectName: 'workflow',
+ fieldNames: ['timelineActivities'],
+ isInherent: true,
+ },
+ {
+ objectName: 'workflowRun',
+ fieldNames: ['timelineActivities'],
+ isInherent: true,
+ },
+ {
+ objectName: 'workflowVersion',
+ fieldNames: ['timelineActivities'],
+ isInherent: true,
+ },
+ {
+ objectName: 'company',
+ fieldNames: ['noteTargets', 'note'],
+ isInherent: false,
+ },
+ {
+ objectName: 'company',
+ fieldNames: ['taskTargets', 'task'],
+ isInherent: false,
+ },
+ {
+ objectName: 'opportunity',
+ fieldNames: ['noteTargets', 'note'],
+ isInherent: false,
+ },
+ {
+ objectName: 'opportunity',
+ fieldNames: ['taskTargets', 'task'],
+ isInherent: false,
+ },
+ {
+ objectName: 'person',
+ fieldNames: ['noteTargets', 'note'],
+ isInherent: false,
+ },
+ {
+ objectName: 'person',
+ fieldNames: ['taskTargets', 'task'],
+ isInherent: false,
+ },
+];
diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/constants/twenty-standard-all-metadata-name.constant.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/constants/twenty-standard-all-metadata-name.constant.ts
index c5db2aece39..c0b8d2bbecb 100644
--- a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/constants/twenty-standard-all-metadata-name.constant.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/constants/twenty-standard-all-metadata-name.constant.ts
@@ -21,4 +21,5 @@ export const TWENTY_STANDARD_ALL_METADATA_NAME = [
'commandMenuItem',
'timelineActivityType',
'agentChatChannel',
+ 'relatedRecordPath',
] as const satisfies AllMetadataName[];
diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/__tests__/__snapshots__/standard-related-record-paths.spec.ts.snap b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/__tests__/__snapshots__/standard-related-record-paths.spec.ts.snap
new file mode 100644
index 00000000000..af1403b5c05
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/__tests__/__snapshots__/standard-related-record-paths.spec.ts.snap
@@ -0,0 +1,31 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Standard related record paths declares the standard paths and their inherent flag 1`] = `
+[
+ "agentChatThread.attachments inherent",
+ "company.attachments inherent",
+ "company.noteTargets.note regular",
+ "company.taskTargets.task regular",
+ "company.timelineActivities inherent",
+ "dashboard.attachments inherent",
+ "dashboard.timelineActivities inherent",
+ "messageCampaign.timelineActivities inherent",
+ "messageList.timelineActivities inherent",
+ "note.attachments inherent",
+ "note.timelineActivities inherent",
+ "opportunity.attachments inherent",
+ "opportunity.noteTargets.note regular",
+ "opportunity.taskTargets.task regular",
+ "opportunity.timelineActivities inherent",
+ "person.attachments inherent",
+ "person.noteTargets.note regular",
+ "person.taskTargets.task regular",
+ "person.timelineActivities inherent",
+ "task.attachments inherent",
+ "task.timelineActivities inherent",
+ "workflow.attachments inherent",
+ "workflow.timelineActivities inherent",
+ "workflowRun.timelineActivities inherent",
+ "workflowVersion.timelineActivities inherent",
+]
+`;
diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/__tests__/standard-related-record-paths.spec.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/__tests__/standard-related-record-paths.spec.ts
new file mode 100644
index 00000000000..c75c8b7d532
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/__tests__/standard-related-record-paths.spec.ts
@@ -0,0 +1,60 @@
+/* @license Enterprise */
+
+import { isDefined } from 'twenty-shared/utils';
+
+import { getRelatedRecordPathFieldMetadataUniversalIdentifiers } from 'src/engine/metadata-modules/related-record-path/utils/get-related-record-path-field-metadata-universal-identifiers.util';
+import { computeTwentyStandardApplicationAllFlatEntityMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/twenty-standard-application-all-flat-entity-maps.constant';
+
+const WORKSPACE_ID = '20202020-1111-4111-8111-111111111111';
+const TWENTY_STANDARD_APPLICATION_ID = '20202020-2222-4222-8222-222222222222';
+const NOW = '2024-01-01T00:00:00.000Z';
+
+const computeStandardFlatEntityMaps = () =>
+ computeTwentyStandardApplicationAllFlatEntityMaps({
+ now: NOW,
+ workspaceId: WORKSPACE_ID,
+ twentyStandardApplicationId: TWENTY_STANDARD_APPLICATION_ID,
+ }).allFlatEntityMaps;
+
+describe('Standard related record paths', () => {
+ const {
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ flatRelatedRecordPathMaps,
+ } = computeStandardFlatEntityMaps();
+
+ it('declares the standard paths and their inherent flag', () => {
+ const describedPaths = Object.values(
+ flatRelatedRecordPathMaps.byUniversalIdentifier,
+ )
+ .filter(isDefined)
+ .map((flatRelatedRecordPath) => {
+ const objectName =
+ flatObjectMetadataMaps.byUniversalIdentifier[
+ flatRelatedRecordPath.objectMetadataUniversalIdentifier
+ ]?.nameSingular;
+ const fieldNames =
+ getRelatedRecordPathFieldMetadataUniversalIdentifiers(
+ flatRelatedRecordPath,
+ ).map(
+ (universalIdentifier) =>
+ flatFieldMetadataMaps.byUniversalIdentifier[universalIdentifier]
+ ?.name,
+ );
+
+ return `${[objectName, ...fieldNames].join('.')} ${flatRelatedRecordPath.isInherent ? 'inherent' : 'regular'}`;
+ })
+ .sort();
+
+ expect(describedPaths).toMatchSnapshot();
+ });
+
+ it('keeps the same universal identifiers across computations', () => {
+ expect(
+ Object.keys(
+ computeStandardFlatEntityMaps().flatRelatedRecordPathMaps
+ .byUniversalIdentifier,
+ ),
+ ).toEqual(Object.keys(flatRelatedRecordPathMaps.byUniversalIdentifier));
+ });
+});
diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/related-record-path/build-standard-flat-related-record-path-maps.util.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/related-record-path/build-standard-flat-related-record-path-maps.util.ts
new file mode 100644
index 00000000000..0dd1f856bf3
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/related-record-path/build-standard-flat-related-record-path-maps.util.ts
@@ -0,0 +1,144 @@
+/* @license Enterprise */
+
+import { getRelatedRecordPathUniversalIdentifier } from 'twenty-shared/application';
+import { STANDARD_OBJECTS } from 'twenty-shared/metadata';
+import { isDefined } from 'twenty-shared/utils';
+import { v4 } from 'uuid';
+
+import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
+import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
+import { addFlatEntityToFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/add-flat-entity-to-flat-entity-maps-or-throw.util';
+import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
+import {
+ RelatedRecordPathException,
+ RelatedRecordPathExceptionCode,
+} from 'src/engine/metadata-modules/related-record-path/related-record-path.exception';
+import { type FlatRelatedRecordPath } from 'src/engine/metadata-modules/flat-related-record-path/types/flat-related-record-path.type';
+import {
+ STANDARD_RELATED_RECORD_PATHS,
+ type StandardRelatedRecordPath,
+} from 'src/engine/workspace-manager/twenty-standard-application/constants/standard-related-record-paths.constant';
+import { TWENTY_STANDARD_APPLICATION } from 'src/engine/workspace-manager/twenty-standard-application/constants/twenty-standard-applications';
+import { type StandardObjectMetadataRelatedEntityIds } from 'src/engine/workspace-manager/twenty-standard-application/utils/get-standard-object-metadata-related-entity-ids.util';
+
+type StandardRelatedRecordPathHop = {
+ fieldMetadataId: string;
+ fieldMetadataUniversalIdentifier: string;
+};
+
+const getFieldKey = ({
+ objectMetadataUniversalIdentifier,
+ name,
+}: {
+ objectMetadataUniversalIdentifier: string | null;
+ name: string;
+}) => `${objectMetadataUniversalIdentifier}:${name}`;
+
+const resolveStandardRelatedRecordPathHopsOrThrow = ({
+ standardRelatedRecordPath: { objectName, fieldNames },
+ flatFieldMetadataByFieldKey,
+}: {
+ standardRelatedRecordPath: StandardRelatedRecordPath;
+ flatFieldMetadataByFieldKey: Map<string, FlatFieldMetadata>;
+}): StandardRelatedRecordPathHop[] => {
+ let currentObjectMetadataUniversalIdentifier: string | null =
+ STANDARD_OBJECTS[objectName].universalIdentifier;
+
+ return fieldNames.map((fieldName) => {
+ const flatFieldMetadata = flatFieldMetadataByFieldKey.get(
+ getFieldKey({
+ objectMetadataUniversalIdentifier:
+ currentObjectMetadataUniversalIdentifier,
+ name: fieldName,
+ }),
+ );
+
+ if (!isDefined(flatFieldMetadata)) {
+ throw new RelatedRecordPathException(
+ `Standard related record path ${objectName}.${fieldNames.join('.')} does not resolve at ${fieldName}`,
+ RelatedRecordPathExceptionCode.INVALID_RELATED_RECORD_PATH_INPUT,
+ );
+ }
+
+ currentObjectMetadataUniversalIdentifier =
+ flatFieldMetadata.relationTargetObjectMetadataUniversalIdentifier;
+
+ return {
+ fieldMetadataId: flatFieldMetadata.id,
+ fieldMetadataUniversalIdentifier: flatFieldMetadata.universalIdentifier,
+ };
+ });
+};
+
+export const buildStandardFlatRelatedRecordPathMaps = ({
+ now,
+ workspaceId,
+ twentyStandardApplicationId,
+ standardObjectMetadataRelatedEntityIds,
+ dependencyFlatEntityMaps: { flatFieldMetadataMaps },
+}: {
+ now: string;
+ workspaceId: string;
+ twentyStandardApplicationId: string;
+ standardObjectMetadataRelatedEntityIds: StandardObjectMetadataRelatedEntityIds;
+ dependencyFlatEntityMaps: {
+ flatFieldMetadataMaps: FlatEntityMaps<FlatFieldMetadata>;
+ };
+}): FlatEntityMaps<FlatRelatedRecordPath> => {
+ let flatRelatedRecordPathMaps = createEmptyFlatEntityMaps();
+ const flatFieldMetadataByFieldKey = new Map(
+ Object.values(flatFieldMetadataMaps.byUniversalIdentifier)
+ .filter(isDefined)
+ .map((flatFieldMetadata) => [
+ getFieldKey(flatFieldMetadata),
+ flatFieldMetadata,
+ ]),
+ );
+
+ for (const standardRelatedRecordPath of STANDARD_RELATED_RECORD_PATHS) {
+ const [firstHop, secondHop, thirdHop] =
+ resolveStandardRelatedRecordPathHopsOrThrow({
+ standardRelatedRecordPath,
+ flatFieldMetadataByFieldKey,
+ });
+
+ flatRelatedRecordPathMaps = addFlatEntityToFlatEntityMapsOrThrow({
+ flatEntity: {
+ id: v4(),
+ universalIdentifier: getRelatedRecordPathUniversalIdentifier({
+ applicationUniversalIdentifier:
+ TWENTY_STANDARD_APPLICATION.universalIdentifier,
+ fieldMetadataUniversalIdentifiers: [firstHop, secondHop, thirdHop]
+ .filter(isDefined)
+ .map((hop) => hop.fieldMetadataUniversalIdentifier),
+ }),
+ objectMetadataId:
+ standardObjectMetadataRelatedEntityIds[
+ standardRelatedRecordPath.objectName
+ ].id,
+ objectMetadataUniversalIdentifier:
+ STANDARD_OBJECTS[standardRelatedRecordPath.objectName]
+ .universalIdentifier,
+ firstFieldMetadataId: firstHop.fieldMetadataId,
+ firstFieldMetadataUniversalIdentifier:
+ firstHop.fieldMetadataUniversalIdentifier,
+ secondFieldMetadataId: secondHop?.fieldMetadataId ?? null,
+ secondFieldMetadataUniversalIdentifier:
+ secondHop?.fieldMetadataUniversalIdentifier ?? null,
+ thirdFieldMetadataId: thirdHop?.fieldMetadataId ?? null,
+ thirdFieldMetadataUniversalIdentifier:
+ thirdHop?.fieldMetadataUniversalIdentifier ?? null,
+ isInherent: standardRelatedRecordPath.isInherent,
+ workspaceId,
+ applicationId: twentyStandardApplicationId,
+ applicationUniversalIdentifier:
+ TWENTY_STANDARD_APPLICATION.universalIdentifier,
+ createdAt: now,
+ updatedAt: now,
+ },
+ flatEntityMaps: flatRelatedRecordPathMaps,
+ });
+ }
+
+ return flatRelatedRecordPathMaps;
+};
diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/twenty-standard-application-all-flat-entity-maps.constant.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/twenty-standard-application-all-flat-entity-maps.constant.ts
index eb7c123c4fc..72605e58821 100644
--- a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/twenty-standard-application-all-flat-entity-maps.constant.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/twenty-standard-application-all-flat-entity-maps.constant.ts
@@ -19,6 +19,7 @@ import { buildStandardFlatPageLayoutWidgetMetadataMaps } from 'src/engine/worksp
import { addFlatEntityToFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/add-flat-entity-to-flat-entity-maps-or-throw.util';
import { computeStandardRecordFormFlatEntities } from 'src/engine/workspace-manager/twenty-standard-application/utils/page-layout/compute-standard-record-form-flat-entities.util';
import { buildStandardFlatPageLayoutMetadataMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/page-layout/build-standard-flat-page-layout-metadata-maps.util';
+import { buildStandardFlatRelatedRecordPathMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/related-record-path/build-standard-flat-related-record-path-maps.util';
import { buildStandardFlatPermissionFlagMetadataMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/permission-flag/build-standard-flat-permission-flag-metadata-maps.util';
import { buildStandardFlatRoleMetadataMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/role-metadata/build-standard-flat-role-metadata-maps.util';
import { buildStandardFlatSearchFieldMetadataMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/search-field-metadata/build-standard-flat-search-field-metadata-maps.util';
@@ -277,6 +278,16 @@ export const computeTwentyStandardApplicationAllFlatEntityMaps = ({
twentyStandardApplicationId,
});
+ const flatRelatedRecordPathMaps = buildStandardFlatRelatedRecordPathMaps({
+ now,
+ workspaceId,
+ twentyStandardApplicationId,
+ standardObjectMetadataRelatedEntityIds,
+ dependencyFlatEntityMaps: {
+ flatFieldMetadataMaps,
+ },
+ });
+
const allFlatEntityMaps: TwentyStandardAllFlatEntityMaps = {
flatViewFieldMaps,
flatViewFieldGroupMaps,
@@ -298,6 +309,7 @@ export const computeTwentyStandardApplicationAllFlatEntityMaps = ({
flatCommandMenuItemMaps,
flatTimelineActivityTypeMaps,
flatAgentChatChannelMaps,
+ flatRelatedRecordPathMaps,
};
const idByUniversalIdentifierByMetadataName: IdByUniversalIdentifierByMetadataName =
diff --git a/packages/twenty-server/test/integration/metadata/suites/related-record-path/related-record-path-metadata.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/related-record-path/related-record-path-metadata.integration-spec.ts
index 47618634eea..06b5df935b9 100644
--- a/packages/twenty-server/test/integration/metadata/suites/related-record-path/related-record-path-metadata.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/related-record-path/related-record-path-metadata.integration-spec.ts
@@ -90,6 +90,7 @@ describe('Related record path metadata', () => {
const createPath = async (hops: {
firstFieldMetadataId: string;
secondFieldMetadataId?: string;
+ isInherent?: boolean;
}) => {
const response = await createRelatedRecordPath({
objectMetadataId: projectObjectMetadataId,
@@ -231,6 +232,7 @@ describe('Related record path metadata', () => {
firstFieldMetadataId: projectTasksFieldMetadataId,
secondFieldMetadataId: taskAssigneeFieldMetadataId,
thirdFieldMetadataId: null,
+ isInherent: false,
});
expect(await findPathIds()).toContain(createdPath.id);
@@ -242,6 +244,20 @@ describe('Related record path metadata', () => {
expect(await findPathIds()).not.toContain(createdPath.id);
});
+ it('should create an inherent path', async () => {
+ const response = await createPath({
+ firstFieldMetadataId: projectTasksFieldMetadataId,
+ isInherent: true,
+ });
+
+ expect(response.body.errors).toBeUndefined();
+ expect(response.body.data.createRelatedRecordPath.isInherent).toBe(true);
+
+ await deleteRelatedRecordPath(
+ response.body.data.createRelatedRecordPath.id,
+ );
+ });
+
it('should reject a path that already exists', async () => {
const firstResponse = await createPath({
firstFieldMetadataId: projectTasksFieldMetadataId,
diff --git a/packages/twenty-server/test/integration/metadata/suites/related-record-path/utils/create-related-record-path-query-factory.util.ts b/packages/twenty-server/test/integration/metadata/suites/related-record-path/utils/create-related-record-path-query-factory.util.ts
index bbbe2a54d0a..ddb70a96a9a 100644
--- a/packages/twenty-server/test/integration/metadata/suites/related-record-path/utils/create-related-record-path-query-factory.util.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/related-record-path/utils/create-related-record-path-query-factory.util.ts
@@ -9,6 +9,7 @@ export type CreateRelatedRecordPathFactoryInput = {
firstFieldMetadataId: string;
secondFieldMetadataId?: string;
thirdFieldMetadataId?: string;
+ isInherent?: boolean;
};
export const createRelatedRecordPathQueryFactory = ({
diff --git a/packages/twenty-server/test/integration/metadata/suites/related-record-path/utils/related-record-path-gql-fields.constant.ts b/packages/twenty-server/test/integration/metadata/suites/related-record-path/utils/related-record-path-gql-fields.constant.ts
index 76b0c85d3d5..bc43f703256 100644
--- a/packages/twenty-server/test/integration/metadata/suites/related-record-path/utils/related-record-path-gql-fields.constant.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/related-record-path/utils/related-record-path-gql-fields.constant.ts
@@ -6,6 +6,7 @@ export const RELATED_RECORD_PATH_GQL_FIELDS = `
firstFieldMetadataId
secondFieldMetadataId
thirdFieldMetadataId
+ isInherent
`;
export type RelatedRecordPathResponse = {
@@ -14,4 +15,5 @@ export type RelatedRecordPathResponse = {
firstFieldMetadataId: string;
secondFieldMetadataId: string | null;
thirdFieldMetadataId: string | null;
+ isInherent: boolean;
};
diff --git a/packages/twenty-server/test/integration/upgrade/suites/2-55-workspace-command-1793375369182-add-standard-related-record-paths.integration-spec.ts b/packages/twenty-server/test/integration/upgrade/suites/2-55-workspace-command-1793375369182-add-standard-related-record-paths.integration-spec.ts
new file mode 100644
index 00000000000..9775beb05f4
--- /dev/null
+++ b/packages/twenty-server/test/integration/upgrade/suites/2-55-workspace-command-1793375369182-add-standard-related-record-paths.integration-spec.ts
@@ -0,0 +1,132 @@
+import { TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER } from 'twenty-shared/application';
+import { isDefined } from 'twenty-shared/utils';
+
+import { jestExpectToBeDefined } from 'test/utils/jest-expect-to-be-defined.util.test';
+import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
+
+import { type AddStandardRelatedRecordPathsCommand } from 'src/database/commands/upgrade-version-command/2-55/2-55-workspace-command-1793375369182-add-standard-related-record-paths.command';
+import { type WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
+import { SEED_APPLE_WORKSPACE_ID } from 'src/engine/workspace-manager/dev-seeder/core/constants/seeder-workspaces.constant';
+import { STANDARD_RELATED_RECORD_PATHS } from 'src/engine/workspace-manager/twenty-standard-application/constants/standard-related-record-paths.constant';
+import { type WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service';
+
+const RUN_ON_WORKSPACE_ARGS = {
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ options: {},
+ index: 0,
+ total: 1,
+};
+
+describe('2-55 workspace command - add standard related record paths (integration)', () => {
+ let command: AddStandardRelatedRecordPathsCommand;
+ let workspaceCacheService: WorkspaceCacheService;
+ let workspaceMigrationValidateBuildAndRunService: WorkspaceMigrationValidateBuildAndRunService;
+
+ const findStandardFlatRelatedRecordPaths = async () => {
+ const { flatRelatedRecordPathMaps } =
+ await workspaceCacheService.getOrRecompute(SEED_APPLE_WORKSPACE_ID, [
+ 'flatRelatedRecordPathMaps',
+ ]);
+
+ return Object.values(flatRelatedRecordPathMaps.byUniversalIdentifier)
+ .filter(isDefined)
+ .filter(
+ ({ applicationUniversalIdentifier }) =>
+ applicationUniversalIdentifier ===
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ );
+ };
+
+ beforeAll(async () => {
+ command = getAppProviderByClassName<AddStandardRelatedRecordPathsCommand>(
+ 'AddStandardRelatedRecordPathsCommand',
+ );
+ workspaceCacheService = getAppProviderByClassName<WorkspaceCacheService>(
+ 'WorkspaceCacheService',
+ );
+ workspaceMigrationValidateBuildAndRunService =
+ getAppProviderByClassName<WorkspaceMigrationValidateBuildAndRunService>(
+ 'WorkspaceMigrationValidateBuildAndRunService',
+ );
+
+ const result =
+ await workspaceMigrationValidateBuildAndRunService.validateBuildAndRunLegacyWorkspaceMigration(
+ {
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ isSystemBuild: true,
+ applicationUniversalIdentifier:
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ allFlatEntityOperationByMetadataName: {
+ relatedRecordPath: {
+ flatEntityToCreate: [],
+ flatEntityToDelete: await findStandardFlatRelatedRecordPaths(),
+ flatEntityToUpdate: [],
+ },
+ },
+ },
+ );
+
+ expect(result.status).toBe('success');
+ });
+
+ afterAll(async () => {
+ await command.runOnWorkspace(RUN_ON_WORKSPACE_ARGS);
+ });
+
+ it('leaves the paths absent on a dry run', async () => {
+ await command.runOnWorkspace({
+ ...RUN_ON_WORKSPACE_ARGS,
+ options: { dryRun: true },
+ });
+
+ expect(await findStandardFlatRelatedRecordPaths()).toHaveLength(0);
+ });
+
+ it('adds every standard path once', async () => {
+ await command.runOnWorkspace(RUN_ON_WORKSPACE_ARGS);
+ await command.runOnWorkspace(RUN_ON_WORKSPACE_ARGS);
+
+ expect(await findStandardFlatRelatedRecordPaths()).toHaveLength(
+ STANDARD_RELATED_RECORD_PATHS.length,
+ );
+ });
+
+ it('restores the inherent flag of an existing standard path', async () => {
+ const inherentFlatRelatedRecordPath = (
+ await findStandardFlatRelatedRecordPaths()
+ ).find(({ isInherent }) => isInherent);
+
+ jestExpectToBeDefined(inherentFlatRelatedRecordPath);
+
+ const result =
+ await workspaceMigrationValidateBuildAndRunService.validateBuildAndRunLegacyWorkspaceMigration(
+ {
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ isSystemBuild: true,
+ applicationUniversalIdentifier:
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ allFlatEntityOperationByMetadataName: {
+ relatedRecordPath: {
+ flatEntityToCreate: [],
+ flatEntityToDelete: [],
+ flatEntityToUpdate: [
+ { ...inherentFlatRelatedRecordPath, isInherent: false },
+ ],
+ },
+ },
+ },
+ );
+
+ expect(result.status).toBe('success');
+
+ await command.runOnWorkspace(RUN_ON_WORKSPACE_ARGS);
+
+ expect(
+ (await findStandardFlatRelatedRecordPaths()).find(
+ ({ universalIdentifier }) =>
+ universalIdentifier ===
+ inherentFlatRelatedRecordPath.universalIdentifier,
+ )?.isInherent,
+ ).toBe(true);
+ });
+});
diff --git a/packages/twenty-shared/src/application/deterministic-identifier/__tests__/get-related-record-path-universal-identifier.util.spec.ts b/packages/twenty-shared/src/application/deterministic-identifier/__tests__/get-related-record-path-universal-identifier.util.spec.ts
new file mode 100644
index 00000000000..00d5eb836f4
--- /dev/null
+++ b/packages/twenty-shared/src/application/deterministic-identifier/__tests__/get-related-record-path-universal-identifier.util.spec.ts
@@ -0,0 +1,25 @@
+import { getRelatedRecordPathUniversalIdentifier } from '@/application/deterministic-identifier/get-related-record-path-universal-identifier.util';
+
+const APPLICATION_UNIVERSAL_IDENTIFIER = '11111111-1111-4111-8111-111111111111';
+const FIRST_FIELD = '33333333-3333-4333-8333-333333333333';
+const SECOND_FIELD = '44444444-4444-4444-8444-444444444444';
+
+describe('getRelatedRecordPathUniversalIdentifier', () => {
+ it('derives a deterministic id from the ordered hop fields', () => {
+ expect(
+ getRelatedRecordPathUniversalIdentifier({
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ fieldMetadataUniversalIdentifiers: [FIRST_FIELD, SECOND_FIELD],
+ }),
+ ).toBe('34000440-31a0-5e67-ae24-68a024fc1124');
+ });
+
+ it('depends on the hop order', () => {
+ expect(
+ getRelatedRecordPathUniversalIdentifier({
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ fieldMetadataUniversalIdentifiers: [SECOND_FIELD, FIRST_FIELD],
+ }),
+ ).not.toBe('34000440-31a0-5e67-ae24-68a024fc1124');
+ });
+});
diff --git a/packages/twenty-shared/src/application/deterministic-identifier/get-related-record-path-universal-identifier.util.ts b/packages/twenty-shared/src/application/deterministic-identifier/get-related-record-path-universal-identifier.util.ts
new file mode 100644
index 00000000000..23a7be2da08
--- /dev/null
+++ b/packages/twenty-shared/src/application/deterministic-identifier/get-related-record-path-universal-identifier.util.ts
@@ -0,0 +1,14 @@
+import { computeDeterministicUuid } from '@/application/deterministic-identifier/compute-deterministic-uuid.util';
+
+export const getRelatedRecordPathUniversalIdentifier = ({
+ applicationUniversalIdentifier,
+ fieldMetadataUniversalIdentifiers,
+}: {
+ applicationUniversalIdentifier: string;
+ fieldMetadataUniversalIdentifiers: string[];
+}): string =>
+ computeDeterministicUuid({
+ entityNamespace: 'relatedRecordPath',
+ value: fieldMetadataUniversalIdentifiers.join(':'),
+ applicationUniversalIdentifier,
+ });
diff --git a/packages/twenty-shared/src/application/index.ts b/packages/twenty-shared/src/application/index.ts
index 0f7f3734ac8..37b3b37095f 100644
--- a/packages/twenty-shared/src/application/index.ts
+++ b/packages/twenty-shared/src/application/index.ts
@@ -130,6 +130,7 @@ export { getObjectPermissionUniversalIdentifier } from './deterministic-identifi
export { getObjectUniversalIdentifier } from './deterministic-identifier/get-object-universal-identifier.util';
export { getPageLayoutUniversalIdentifier } from './deterministic-identifier/get-page-layout-universal-identifier.util';
export { getPermissionFlagUniversalIdentifier } from './deterministic-identifier/get-permission-flag-universal-identifier.util';
+export { getRelatedRecordPathUniversalIdentifier } from './deterministic-identifier/get-related-record-path-universal-identifier.util';
export { getRolePermissionFlagUniversalIdentifier } from './deterministic-identifier/get-role-permission-flag-universal-identifier.util';
export { getRoleTargetUniversalIdentifier } from './deterministic-identifier/get-role-target-universal-identifier.util';
export { getRoleUniversalIdentifier } from './deterministic-identifier/get-role-universal-identifier.util';