The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Declare note and task targets as junction relations (#24340)
Félix Malfait9242938fffd3
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-33/2-33-upgrade-version-command.module.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-33/2-33-upgrade-version-command.module.tsnew file mode 100644index 00000000000..6523c7c7ee9--- /dev/null+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-33/2-33-upgrade-version-command.module.ts@@ -0,0 +1,19 @@+import { Module } from '@nestjs/common';+import { TypeOrmModule } from '@nestjs/typeorm';++import { WorkspaceIteratorModule } from 'src/database/commands/command-runners/workspace-iterator.module';+import { BackfillActivityTargetsJunctionTargetCommand } from 'src/database/commands/upgrade-version-command/2-33/2-33-workspace-command-1787123540000-backfill-activity-targets-junction-target.command';+import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';+import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache.module';+import { WorkspaceMigrationRunnerModule } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/workspace-migration-runner.module';++@Module({+ imports: [+ TypeOrmModule.forFeature([FieldMetadataEntity]),+ WorkspaceCacheModule,+ WorkspaceIteratorModule,+ WorkspaceMigrationRunnerModule,+ ],+ providers: [BackfillActivityTargetsJunctionTargetCommand],+})+export class V2_33_UpgradeVersionCommandModule {}diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-33/2-33-workspace-command-1787123540000-backfill-activity-targets-junction-target.command.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-33/2-33-workspace-command-1787123540000-backfill-activity-targets-junction-target.command.tsnew file mode 100644index 00000000000..aa7c3dea8ef--- /dev/null+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-33/2-33-workspace-command-1787123540000-backfill-activity-targets-junction-target.command.ts@@ -0,0 +1,292 @@+import { InjectRepository } from '@nestjs/typeorm';++import { Command } from 'nest-commander';+import { STANDARD_OBJECTS } from 'twenty-shared/metadata';+import { FieldMetadataType, RelationType } from 'twenty-shared/types';+import { isDefined } from 'twenty-shared/utils';+import { Repository } from 'typeorm';++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 { invalidateFieldMetadataCache } from 'src/database/commands/upgrade-version-command/utils/invalidate-field-metadata-cache.util';+import { RegisteredWorkspaceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-workspace-command.decorator';+import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';+import { isFieldMetadataSettingsOfType } from 'src/engine/metadata-modules/field-metadata/utils/is-field-metadata-settings-of-type.util';+import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';+import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';+import { WorkspaceMigrationRunnerService } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service';++// The junction target points at one member of the target morph. Consumers expand+// the whole morph group from it, so any member identifies the polymorphic edge.+const ACTIVITY_JUNCTIONS = [+ {+ label: 'note.noteTargets',+ junctionRelationFieldUniversalIdentifier:+ STANDARD_OBJECTS.note.fields.noteTargets.universalIdentifier,+ junctionTargetFieldUniversalIdentifier:+ STANDARD_OBJECTS.noteTarget.fields.targetPerson.universalIdentifier,+ },+ {+ label: 'task.taskTargets',+ junctionRelationFieldUniversalIdentifier:+ STANDARD_OBJECTS.task.fields.taskTargets.universalIdentifier,+ junctionTargetFieldUniversalIdentifier:+ STANDARD_OBJECTS.taskTarget.fields.targetPerson.universalIdentifier,+ },+] as const;++type ActivityJunction = (typeof ACTIVITY_JUNCTIONS)[number];++type ResolvedBackfill = {+ label: string;+ junctionRelationFieldMetadataId: string;+ junctionTargetFieldMetadataId: string;+};++@RegisteredWorkspaceCommand('2.33.0', 1787123540000)+@Command({+ name: 'upgrade:2-33:backfill-activity-targets-junction-target',+ description:+ 'Backfill the junction target field id on note.noteTargets and task.taskTargets for workspaces provisioned before it was declared, so activity targets are recognised as junction relations.',+})+export class BackfillActivityTargetsJunctionTargetCommand extends ProvisionedWorkspaceCommandRunner {+ constructor(+ protected readonly workspaceIteratorService: WorkspaceIteratorService,+ private readonly workspaceCacheService: WorkspaceCacheService,+ private readonly workspaceMigrationRunnerService: WorkspaceMigrationRunnerService,+ @InjectRepository(FieldMetadataEntity)+ private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,+ ) {+ super(workspaceIteratorService);+ }++ override async runOnWorkspace({+ workspaceId,+ options,+ }: RunOnWorkspaceArgs): Promise<void> {+ const isDryRun = options.dryRun ?? false;++ const { flatFieldMetadataMaps } =+ await this.workspaceCacheService.getOrRecompute(workspaceId, [+ 'flatFieldMetadataMaps',+ ]);++ const backfills = ACTIVITY_JUNCTIONS.map((activityJunction) =>+ this.resolveBackfill({+ activityJunction,+ flatFieldMetadataMaps,+ workspaceId,+ }),+ ).filter(isDefined);++ if (backfills.length === 0) {+ return;+ }++ this.logger.log(+ `${isDryRun ? '[DRY RUN] ' : ''}Backfilling ${backfills+ .map(({ label }) => label)+ .join(', ')} junction target for workspace ${workspaceId}`,+ );++ if (isDryRun) {+ return;+ }++ const updatedFieldMetadataIds = await this.applyBackfills({+ backfills,+ workspaceId,+ });++ if (updatedFieldMetadataIds.length === 0) {+ this.logger.warn(+ `No activity junction field was updated for workspace ${workspaceId}, its metadata changed since the cache was computed`,+ );++ return;+ }++ await invalidateFieldMetadataCache({+ workspaceId,+ workspaceMigrationRunnerService: this.workspaceMigrationRunnerService,+ });+ }++ // Both activity junctions are written together so an interrupted upgrade never+ // leaves notes migrated and tasks not, which would be invisible until a rerun.+ private async applyBackfills({+ backfills,+ workspaceId,+ }: {+ backfills: ResolvedBackfill[];+ workspaceId: string;+ }): Promise<string[]> {+ return this.fieldMetadataRepository.manager.transaction(+ async (entityManager) => {+ const fieldMetadataRepository =+ entityManager.getRepository(FieldMetadataEntity);+ const updatedFieldMetadataIds: string[] = [];++ for (const {+ label,+ junctionRelationFieldMetadataId,+ junctionTargetFieldMetadataId,+ } of backfills) {+ // Re-read under the transaction: the cache the resolution ran against+ // can lag the row, and settings is overwritten as a whole document.+ const fieldMetadata = await fieldMetadataRepository.findOne({+ where: { id: junctionRelationFieldMetadataId, workspaceId },+ lock: { mode: 'pessimistic_write' },+ });++ if (+ !isDefined(fieldMetadata) ||+ !isFieldMetadataSettingsOfType(+ fieldMetadata.settings,+ FieldMetadataType.RELATION,+ ) ||+ fieldMetadata.settings.relationType !== RelationType.ONE_TO_MANY+ ) {+ this.logger.warn(+ `${label} is no longer a one to many relation for workspace ${workspaceId}, skipping`,+ );++ continue;+ }++ await fieldMetadataRepository.update(+ { id: junctionRelationFieldMetadataId, workspaceId },+ {+ settings: {+ ...fieldMetadata.settings,+ junctionTargetFieldId: junctionTargetFieldMetadataId,+ },+ },+ );++ updatedFieldMetadataIds.push(junctionRelationFieldMetadataId);+ }++ return updatedFieldMetadataIds;+ },+ );+ }++ // Mirrors validateJunctionTargetSettings so the backfill can never write a+ // setting the metadata layer would have rejected on a normal field update.+ private resolveBackfill({+ activityJunction,+ flatFieldMetadataMaps,+ workspaceId,+ }: {+ activityJunction: ActivityJunction;+ flatFieldMetadataMaps: FlatEntityMaps<FlatFieldMetadata>;+ workspaceId: string;+ }): ResolvedBackfill | undefined {+ const {+ label,+ junctionRelationFieldUniversalIdentifier,+ junctionTargetFieldUniversalIdentifier,+ } = activityJunction;++ const junctionRelationFlatFieldMetadata =+ flatFieldMetadataMaps.byUniversalIdentifier[+ junctionRelationFieldUniversalIdentifier+ ];++ if (!isDefined(junctionRelationFlatFieldMetadata)) {+ this.logger.log(+ `No ${label} field for workspace ${workspaceId}, skipping`,+ );++ return undefined;+ }++ const junctionRelationSettings = junctionRelationFlatFieldMetadata.settings;++ if (+ !isFieldMetadataSettingsOfType(+ junctionRelationSettings,+ FieldMetadataType.RELATION,+ ) ||+ junctionRelationSettings.relationType !== RelationType.ONE_TO_MANY+ ) {+ this.logger.warn(+ `${label} is not a one to many relation for workspace ${workspaceId}, skipping`,+ );++ return undefined;+ }++ const junctionTargetFlatFieldMetadata =+ flatFieldMetadataMaps.byUniversalIdentifier[+ junctionTargetFieldUniversalIdentifier+ ];++ if (!isDefined(junctionTargetFlatFieldMetadata)) {+ this.logger.warn(+ `No junction target field for ${label} in workspace ${workspaceId}, skipping`,+ );++ return undefined;+ }++ if (+ junctionTargetFlatFieldMetadata.objectMetadataId !==+ junctionRelationFlatFieldMetadata.relationTargetObjectMetadataId+ ) {+ this.logger.warn(+ `Junction target field for ${label} is not on the junction object in workspace ${workspaceId}, skipping`,+ );++ return undefined;+ }++ const junctionTargetSettings = junctionTargetFlatFieldMetadata.settings;+ const isMorphTarget =+ junctionTargetFlatFieldMetadata.type === FieldMetadataType.MORPH_RELATION;++ if (+ !isMorphTarget &&+ (!isFieldMetadataSettingsOfType(+ junctionTargetSettings,+ FieldMetadataType.RELATION,+ ) ||+ junctionTargetSettings.relationType !== RelationType.MANY_TO_ONE)+ ) {+ this.logger.warn(+ `Junction target field for ${label} is not a many to one relation in workspace ${workspaceId}, skipping`,+ );++ return undefined;+ }++ const currentJunctionTargetFieldId =+ junctionRelationSettings.junctionTargetFieldId;++ // A dangling id is repaired: it resolves to nothing, so leaving it in place+ // keeps the junction unusable while looking configured.+ if (+ isDefined(currentJunctionTargetFieldId) &&+ isDefined(+ flatFieldMetadataMaps.universalIdentifierById[+ currentJunctionTargetFieldId+ ],+ )+ ) {+ this.logger.log(+ `${label} junction target already set for workspace ${workspaceId}, skipping`,+ );++ return undefined;+ }++ return {+ label,+ junctionRelationFieldMetadataId: junctionRelationFlatFieldMetadata.id,+ junctionTargetFieldMetadataId: junctionTargetFlatFieldMetadata.id,+ };+ }+}diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/utils/invalidate-field-metadata-cache.util.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/utils/invalidate-field-metadata-cache.util.tsnew file mode 100644index 00000000000..48c2b229651--- /dev/null+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/utils/invalidate-field-metadata-cache.util.ts@@ -0,0 +1,26 @@+import { getMetadataFlatEntityMapsKey } from 'src/engine/metadata-modules/flat-entity/utils/get-metadata-flat-entity-maps-key.util';+import { getMetadataRelatedMetadataNames } from 'src/engine/metadata-modules/flat-entity/utils/get-metadata-related-metadata-names.util';+import { getMetadataSerializedRelationNames } from 'src/engine/metadata-modules/flat-entity/utils/get-metadata-serialized-relation-names.util';+import { type WorkspaceMigrationRunnerService } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service';++export const invalidateFieldMetadataCache = async ({+ workspaceId,+ workspaceMigrationRunnerService,+}: {+ workspaceId: string;+ workspaceMigrationRunnerService: WorkspaceMigrationRunnerService;+}): Promise<void> => {+ const fieldMetadataRelatedNames = [+ 'fieldMetadata',+ ...getMetadataRelatedMetadataNames('fieldMetadata'),+ ...getMetadataSerializedRelationNames('fieldMetadata'),+ 'index',+ ] as const;++ await workspaceMigrationRunnerService.invalidateCache({+ allFlatEntityMapsKeys: [+ ...new Set(fieldMetadataRelatedNames.map(getMetadataFlatEntityMapsKey)),+ ],+ workspaceId,+ });+};diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/workspace-command-provider.module.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/workspace-command-provider.module.tsindex efa4ebf763f..d501686907e 100644--- a/packages/twenty-server/src/database/commands/upgrade-version-command/workspace-command-provider.module.ts+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/workspace-command-provider.module.ts@@ -25,6 +25,7 @@ import { V2_28_UpgradeVersionCommandModule } from 'src/database/commands/upgradeimport { V2_3_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-3/2-3-upgrade-version-command.module';import { V2_31_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-31/2-31-upgrade-version-command.module';import { V2_32_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-32/2-32-upgrade-version-command.module';+import { V2_33_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-33/2-33-upgrade-version-command.module';import { V2_4_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-4/2-4-upgrade-version-command.module';import { V2_5_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-5/2-5-upgrade-version-command.module';import { V2_7_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-7/2-7-upgrade-version-command.module';@@ -63,6 +64,7 @@ import { V2_9_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-V2_28_UpgradeVersionCommandModule,V2_31_UpgradeVersionCommandModule,V2_32_UpgradeVersionCommandModule,+ V2_33_UpgradeVersionCommandModule,],})export class WorkspaceCommandProviderModule {}diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/field-metadata/compute-note-standard-flat-field-metadata.util.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/field-metadata/compute-note-standard-flat-field-metadata.util.tsindex fb2c27b5e17..d93def2c7db 100644--- a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/field-metadata/compute-note-standard-flat-field-metadata.util.ts+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/field-metadata/compute-note-standard-flat-field-metadata.util.ts@@ -1,5 +1,6 @@import { msg } from '@lingui/core/macro';import { i18nLabel } from 'src/engine/workspace-manager/twenty-standard-application/utils/i18n-label.util';+import { STANDARD_OBJECTS } from 'twenty-shared/metadata';import {DateDisplayFormat,FieldMetadataType,@@ -242,6 +243,8 @@ export const buildNoteStandardFlatFieldMetadatas = ({settings: {relationType: RelationType.ONE_TO_MANY,},+ junctionTargetFieldUniversalIdentifier:+ STANDARD_OBJECTS.noteTarget.fields.targetPerson.universalIdentifier,},standardObjectMetadataRelatedEntityIds,dependencyFlatEntityMaps,diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/field-metadata/compute-task-standard-flat-field-metadata.util.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/field-metadata/compute-task-standard-flat-field-metadata.util.tsindex 5465b72138a..7cd2dbd1376 100644--- a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/field-metadata/compute-task-standard-flat-field-metadata.util.ts+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/field-metadata/compute-task-standard-flat-field-metadata.util.ts@@ -1,5 +1,6 @@import { msg } from '@lingui/core/macro';import { i18nLabel } from 'src/engine/workspace-manager/twenty-standard-application/utils/i18n-label.util';+import { STANDARD_OBJECTS } from 'twenty-shared/metadata';import {DateDisplayFormat,FieldMetadataType,@@ -299,6 +300,8 @@ export const buildTaskStandardFlatFieldMetadatas = ({settings: {relationType: RelationType.ONE_TO_MANY,},+ junctionTargetFieldUniversalIdentifier:+ STANDARD_OBJECTS.taskTarget.fields.targetPerson.universalIdentifier,},standardObjectMetadataRelatedEntityIds,dependencyFlatEntityMaps,