The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix(server): rebuild the foreign key when a relation's onDelete changes from unset (#27472)
JotaDuo537f1f308451
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/2-49-upgrade-version-command.module.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/2-49-upgrade-version-command.module.tsindex 66d72f93215..0edef8d2ed3 100644--- a/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/2-49-upgrade-version-command.module.ts+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/2-49-upgrade-version-command.module.ts@@ -2,9 +2,11 @@ import { Module } from '@nestjs/common';import { WorkspaceIteratorModule } from 'src/database/commands/command-runners/workspace-iterator.module';import { AddCalendarEventSharingIndexesCommand } from 'src/database/commands/upgrade-version-command/2-49/2-49-workspace-command-1792153151454-add-calendar-event-sharing-indexes.command';+import { RepairRelationForeignKeyOnDeleteCommand } from 'src/database/commands/upgrade-version-command/2-49/2-49-workspace-command-1792167273000-repair-relation-foreign-key-on-delete.command';import { StripDerivedRecordFilterPropertiesCommand } from 'src/database/commands/upgrade-version-command/2-49/2-49-workspace-command-1792153804491-strip-derived-record-filter-properties.command';import { DeleteMorphRelationTargetReferencesCommand } from 'src/database/commands/upgrade-version-command/2-49/2-49-workspace-command-1792154485777-delete-morph-relation-target-references.command';import { ApplicationModule } from 'src/engine/core-modules/application/application.module';+import { WorkspaceSchemaManagerModule } from 'src/engine/twenty-orm/workspace-schema-manager/workspace-schema-manager.module';import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache.module';import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace-migration/workspace-migration.module';@@ -14,11 +16,13 @@ import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspaceWorkspaceCacheModule,WorkspaceIteratorModule,WorkspaceMigrationModule,+ WorkspaceSchemaManagerModule,],providers: [AddCalendarEventSharingIndexesCommand,StripDerivedRecordFilterPropertiesCommand,DeleteMorphRelationTargetReferencesCommand,+ RepairRelationForeignKeyOnDeleteCommand,],})export class V2_49_UpgradeVersionCommandModule {}diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/2-49-workspace-command-1792167273000-repair-relation-foreign-key-on-delete.command.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/2-49-workspace-command-1792167273000-repair-relation-foreign-key-on-delete.command.tsnew file mode 100644index 00000000000..d0b66b3d3de--- /dev/null+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/2-49-workspace-command-1792167273000-repair-relation-foreign-key-on-delete.command.ts@@ -0,0 +1,192 @@+import { Command } from 'nest-commander';+import { RelationType } from 'twenty-shared/types';+import { isDefined } from 'twenty-shared/utils';++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 { computeExpectedForeignKeyOnDelete } from 'src/database/commands/upgrade-version-command/2-49/utils/compute-expected-foreign-key-on-delete.util';+import { findWorkspaceForeignKeyOnDeleteRules } from 'src/database/commands/upgrade-version-command/2-49/utils/find-workspace-foreign-key-on-delete-rules.util';+import { RegisteredWorkspaceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-workspace-command.decorator';+import { computeMorphOrRelationFieldJoinColumnName } from 'src/engine/metadata-modules/field-metadata/utils/compute-morph-or-relation-field-join-column-name.util';+import { findFlatEntityByIdInFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps.util';+import { isMorphOrRelationFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-morph-or-relation-flat-field-metadata.util';+import { WorkspaceSchemaManagerService } from 'src/engine/twenty-orm/workspace-schema-manager/workspace-schema-manager.service';+import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';+import { getWorkspaceSchemaName } from 'src/engine/workspace-datasource/utils/get-workspace-schema-name.util';++@RegisteredWorkspaceCommand('2.49.0', 1792167273000)+@Command({+ name: 'upgrade:2-49:repair-relation-foreign-key-on-delete',+ description:+ 'Recreate MANY_TO_ONE relation foreign keys whose ON DELETE rule does not match the field onDelete setting',+})+export class RepairRelationForeignKeyOnDeleteCommand extends ProvisionedWorkspaceCommandRunner {+ constructor(+ protected readonly workspaceIteratorService: WorkspaceIteratorService,+ private readonly workspaceCacheService: WorkspaceCacheService,+ private readonly workspaceSchemaManagerService: WorkspaceSchemaManagerService,+ ) {+ super(workspaceIteratorService);+ }++ override async runOnWorkspace(args: RunOnWorkspaceArgs): Promise<void> {+ await this.up(args);+ }++ async up({+ workspaceId,+ dataSource,+ options,+ }: RunOnWorkspaceArgs): Promise<void> {+ if (!isDefined(dataSource)) {+ this.logger.log(`No data source for workspace ${workspaceId}, skipping`);++ return;+ }++ const { flatFieldMetadataMaps, flatObjectMetadataMaps } =+ await this.workspaceCacheService.getOrRecompute(workspaceId, [+ 'flatFieldMetadataMaps',+ 'flatObjectMetadataMaps',+ ]);++ const relations = Object.values(flatFieldMetadataMaps.byUniversalIdentifier)+ .filter(isDefined)+ .filter(isMorphOrRelationFlatFieldMetadata)+ .filter(+ (flatFieldMetadata) =>+ flatFieldMetadata.settings?.relationType === RelationType.MANY_TO_ONE,+ )+ .map((flatFieldMetadata) => {+ const sourceFlatObjectMetadata = findFlatEntityByIdInFlatEntityMaps({+ flatEntityId: flatFieldMetadata.objectMetadataId,+ flatEntityMaps: flatObjectMetadataMaps,+ });+ const targetFlatObjectMetadata = isDefined(+ flatFieldMetadata.relationTargetObjectMetadataId,+ )+ ? findFlatEntityByIdInFlatEntityMaps({+ flatEntityId: flatFieldMetadata.relationTargetObjectMetadataId,+ flatEntityMaps: flatObjectMetadataMaps,+ })+ : undefined;++ if (+ !isDefined(sourceFlatObjectMetadata) ||+ !isDefined(targetFlatObjectMetadata)+ ) {+ return undefined;+ }++ return {+ tableName: computeObjectTargetTable(sourceFlatObjectMetadata),+ columnName: computeMorphOrRelationFieldJoinColumnName({+ name: flatFieldMetadata.name,+ }),+ referencedTableName: computeObjectTargetTable(+ targetFlatObjectMetadata,+ ),+ expectedOnDelete: computeExpectedForeignKeyOnDelete({+ onDelete: flatFieldMetadata.settings?.onDelete,+ }),+ };+ })+ .filter(isDefined);++ if (relations.length === 0) {+ return;+ }++ const schemaName = getWorkspaceSchemaName(workspaceId);+ const queryRunner = dataSource.createQueryRunner();++ await queryRunner.connect();++ try {+ const foreignKeyRules = await findWorkspaceForeignKeyOnDeleteRules({+ queryRunner,+ schemaName,+ tableNames: [+ ...new Set(relations.map((relation) => relation.tableName)),+ ],+ });++ let repairedCount = 0;++ for (const {+ tableName,+ columnName,+ referencedTableName,+ expectedOnDelete,+ } of relations) {+ const foreignKeyRule = foreignKeyRules.get(`${tableName}.${columnName}`);++ if (+ !isDefined(foreignKeyRule) ||+ foreignKeyRule.onDeleteCode === expectedOnDelete.onDeleteCode+ ) {+ continue;+ }++ if (options.dryRun) {+ this.logger.log(+ `[DRY RUN] Would set ON DELETE ${expectedOnDelete.sqlAction} on ${schemaName}.${tableName}.${columnName} in workspace ${workspaceId}`,+ );++ continue;+ }++ await queryRunner.startTransaction();++ try {+ await this.workspaceSchemaManagerService.foreignKeyManager.dropForeignKey(+ {+ queryRunner,+ schemaName,+ tableName,+ foreignKeyName: foreignKeyRule.constraintName,+ },+ );++ await this.workspaceSchemaManagerService.foreignKeyManager.createForeignKey(+ {+ queryRunner,+ schemaName,+ foreignKey: {+ tableName,+ columnName,+ referencedTableName,+ referencedColumnName: 'id',+ onDelete: expectedOnDelete.sqlAction,+ },+ },+ );++ await queryRunner.commitTransaction();+ } catch (error) {+ await queryRunner.rollbackTransaction();++ throw error;+ }++ repairedCount++;+ }++ if (repairedCount > 0) {+ this.logger.log(+ `Repaired ${repairedCount} relation foreign key(s) in workspace ${workspaceId}`,+ );+ }+ } finally {+ await queryRunner.release();+ }+ }++ async down({ workspaceId }: RunOnWorkspaceArgs): Promise<void> {+ this.logger.log(+ `Nothing to revert for workspace ${workspaceId}: the replaced foreign keys did not match their field metadata`,+ );+ }+}diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/utils/compute-expected-foreign-key-on-delete.util.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/utils/compute-expected-foreign-key-on-delete.util.tsnew file mode 100644index 00000000000..457427ab368--- /dev/null+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/utils/compute-expected-foreign-key-on-delete.util.ts@@ -0,0 +1,32 @@+import { RelationOnDeleteAction } from 'twenty-shared/types';++type ForeignKeyOnDelete = {+ sqlAction: 'CASCADE' | 'SET NULL' | 'RESTRICT' | 'NO ACTION';+ onDeleteCode: string;+};++const FOREIGN_KEY_ON_DELETE_BY_ACTION: Record<+ RelationOnDeleteAction,+ ForeignKeyOnDelete+> = {+ [RelationOnDeleteAction.CASCADE]: { sqlAction: 'CASCADE', onDeleteCode: 'c' },+ [RelationOnDeleteAction.SET_NULL]: {+ sqlAction: 'SET NULL',+ onDeleteCode: 'n',+ },+ [RelationOnDeleteAction.RESTRICT]: {+ sqlAction: 'RESTRICT',+ onDeleteCode: 'r',+ },+ [RelationOnDeleteAction.NO_ACTION]: {+ sqlAction: 'NO ACTION',+ onDeleteCode: 'a',+ },+};++export const computeExpectedForeignKeyOnDelete = ({+ onDelete,+}: {+ onDelete: RelationOnDeleteAction | undefined;+}): ForeignKeyOnDelete =>+ FOREIGN_KEY_ON_DELETE_BY_ACTION[onDelete ?? RelationOnDeleteAction.CASCADE];diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/utils/find-workspace-foreign-key-on-delete-rules.util.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/utils/find-workspace-foreign-key-on-delete-rules.util.tsnew file mode 100644index 00000000000..b31a95b6938--- /dev/null+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-49/utils/find-workspace-foreign-key-on-delete-rules.util.ts@@ -0,0 +1,48 @@+import { type QueryRunner } from 'typeorm';++export type WorkspaceForeignKeyOnDeleteRule = {+ constraintName: string;+ onDeleteCode: string;+};++export const findWorkspaceForeignKeyOnDeleteRules = async ({+ queryRunner,+ schemaName,+ tableNames,+}: {+ queryRunner: QueryRunner;+ schemaName: string;+ tableNames: string[];+}): Promise<Map<string, WorkspaceForeignKeyOnDeleteRule>> => {+ if (tableNames.length === 0) {+ return new Map();+ }++ const rows: {+ table_name: string;+ column_name: string;+ constraint_name: string;+ on_delete_code: string;+ }[] = await queryRunner.query(+ `SELECT t.relname AS table_name,+ a.attname AS column_name,+ c.conname AS constraint_name,+ c.confdeltype AS on_delete_code+ FROM pg_namespace n+ JOIN pg_class t ON t.relnamespace = n.oid+ JOIN pg_constraint c ON c.conrelid = t.oid+ JOIN pg_attribute a ON a.attrelid = t.oid AND a.attnum = c.conkey[1]+ WHERE n.nspname = $1+ AND t.relname = ANY ($2)+ AND c.contype = 'f'+ AND array_length(c.conkey, 1) = 1`,+ [schemaName, tableNames],+ );++ return new Map(+ rows.map((row) => [+ `${row.table_name}.${row.column_name}`,+ { constraintName: row.constraint_name, onDeleteCode: row.on_delete_code },+ ]),+ );+};diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/update-field-action-handler.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/update-field-action-handler.service.tsindex 754e88b5ee5..7520603707f 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/update-field-action-handler.service.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/update-field-action-handler.service.ts@@ -31,12 +31,12 @@ import { computeObjectTargetTable } from 'src/engine/utils/compute-object-targetimport { isMorphOrRelationFieldMetadataType } from 'src/engine/utils/is-morph-or-relation-field-metadata-type.util';import { UniversalFlatEntityUpdate } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-entity-update.type';import { resolveUniversalUpdateRelationIdentifiersToIds } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/utils/resolve-universal-update-relation-identifiers-to-ids.util';-import { convertOnDeleteActionToOnDelete } from 'src/engine/workspace-manager/workspace-migration/utils/convert-on-delete-action-to-on-delete.util';import {FlatUpdateFieldAction,UniversalUpdateFieldAction,} from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/field/types/workspace-migration-field-action.type';import { serializeDefaultValue } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/utils/serialize-default-value.util';+import { computeForeignKeyOnDelete } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/compute-foreign-key-on-delete.util';import { fromUniversalSettingsToFlatFieldMetadataSettings } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/from-universal-settings-to-flat-field-metadata-settings.util';import {WorkspaceMigrationActionExecutionException,@@ -289,12 +289,14 @@ export class UpdateFieldActionHandlerService extends WorkspaceMigrationRunnerActoptimisticFlatFieldMetadata.settings?.relationType ===RelationType.MANY_TO_ONE;- if (- isManyToOne &&- isDefined(fromSettings?.onDelete) &&- isDefined(toSettings?.onDelete) &&- toSettings.onDelete !== fromSettings.onDelete- ) {+ const fromForeignKeyOnDelete = computeForeignKeyOnDelete({+ onDelete: fromSettings?.onDelete,+ });+ const toForeignKeyOnDelete = computeForeignKeyOnDelete({+ onDelete: toSettings?.onDelete,+ });++ if (isManyToOne && toForeignKeyOnDelete !== fromForeignKeyOnDelete) {const joinColumnName = computeMorphOrRelationFieldJoinColumnName({name: optimisticFlatFieldMetadata.name,});@@ -344,9 +346,7 @@ export class UpdateFieldActionHandlerService extends WorkspaceMigrationRunnerActcolumnName: joinColumnName,referencedTableName,referencedColumnName: 'id',- onDelete:- convertOnDeleteActionToOnDelete(toSettings.onDelete) ??- 'CASCADE',+ onDelete: toForeignKeyOnDelete,},},);diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/build-many-to-one-foreign-key-definition.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/build-many-to-one-foreign-key-definition.util.tsindex c4700cdfcea..0c5826d0a3d 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/build-many-to-one-foreign-key-definition.util.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/build-many-to-one-foreign-key-definition.util.ts@@ -5,7 +5,7 @@ import { type MorphOrRelationFieldMetadataType } from 'src/engine/metadata-modulimport { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';import { type WorkspaceSchemaForeignKeyDefinition } from 'src/engine/twenty-orm/workspace-schema-manager/types/workspace-schema-foreign-key-definition.type';import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';-import { convertOnDeleteActionToOnDelete } from 'src/engine/workspace-manager/workspace-migration/utils/convert-on-delete-action-to-on-delete.util';+import { computeForeignKeyOnDelete } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/compute-foreign-key-on-delete.util';export const buildManyToOneForeignKeyDefinition = ({flatFieldMetadata,@@ -27,7 +27,7 @@ export const buildManyToOneForeignKeyDefinition = ({}),),referencedColumnName: 'id',- onDelete:- convertOnDeleteActionToOnDelete(flatFieldMetadata.settings?.onDelete) ??- 'CASCADE',+ onDelete: computeForeignKeyOnDelete({+ onDelete: flatFieldMetadata.settings?.onDelete,+ }),});diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/compute-foreign-key-on-delete.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/compute-foreign-key-on-delete.util.tsnew file mode 100644index 00000000000..737c3a0c585--- /dev/null+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/compute-foreign-key-on-delete.util.ts@@ -0,0 +1,9 @@+import { type RelationOnDeleteAction } from 'twenty-shared/types';++import { convertOnDeleteActionToOnDelete } from 'src/engine/workspace-manager/workspace-migration/utils/convert-on-delete-action-to-on-delete.util';++export const computeForeignKeyOnDelete = ({+ onDelete,+}: {+ onDelete: RelationOnDeleteAction | undefined;+}) => convertOnDeleteActionToOnDelete(onDelete) ?? 'CASCADE';