Skip to content

The open alternative to Salesforce, designed for AI.

Let callers run deferred workspace migration actions in process (#29066)

Charles Bochet60c6ddf99203
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/services/field-metadata.service.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/services/field-metadata.service.ts
index 16e352274f7..2b9bd0da15e 100644
--- a/packages/twenty-server/src/engine/metadata-modules/field-metadata/services/field-metadata.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/field-metadata/services/field-metadata.service.ts
@@ -211,11 +211,13 @@ export class FieldMetadataService {
workspaceId,
isSystemBuild = false,
ownerFlatApplication,
+ shouldDeferActions,
}: {
updateFieldInput: Omit<UpdateFieldInput, 'workspaceId'>;
workspaceId: string;
isSystemBuild?: boolean;
ownerFlatApplication?: FlatApplication;
+ shouldDeferActions?: boolean;
}): Promise<FlatFieldMetadata> {
const { workspaceCustomFlatApplication } =
await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
@@ -303,6 +305,7 @@ export class FieldMetadataService {
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
+ shouldDeferActions,
allFlatEntityOperationByMetadataName: {
fieldMetadata: {
flatEntityToCreate: flatFieldMetadatasToCreate,
@@ -368,11 +371,13 @@ export class FieldMetadataService {
workspaceId,
ownerFlatApplication,
isSystemBuild = false,
+ shouldDeferActions,
}: {
createFieldInputs: Omit<CreateFieldInput, 'workspaceId'>[];
workspaceId: string;
ownerFlatApplication?: FlatApplication;
isSystemBuild?: boolean;
+ shouldDeferActions?: boolean;
}): Promise<FlatFieldMetadata[]> {
if (createFieldInputs.length === 0) {
return [];
@@ -431,6 +436,7 @@ export class FieldMetadataService {
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
+ shouldDeferActions,
allFlatEntityOperationByMetadataName: {
fieldMetadata: {
flatEntityToCreate: flatFieldMetadatasToCreate,
diff --git a/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts b/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts
index b386bb6e957..9540f8dbe0c 100644
--- a/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts
@@ -502,10 +502,12 @@ export class ObjectMetadataService {
createObjectInput,
workspaceId,
ownerFlatApplication,
+ shouldDeferActions,
}: {
createObjectInput: CreateObjectInput;
workspaceId: string;
ownerFlatApplication?: FlatApplication;
+ shouldDeferActions?: boolean;
}): Promise<FlatObjectMetadata> {
const { workspaceCustomFlatApplication } =
await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
@@ -546,6 +548,7 @@ export class ObjectMetadataService {
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
+ shouldDeferActions,
allFlatEntityOperationByMetadataName: {
objectMetadata: {
flatEntityToCreate: [flatObjectMetadataToCreate],
diff --git a/packages/twenty-server/src/engine/workspace-manager/dev-seeder/metadata/services/dev-seeder-metadata.service.ts b/packages/twenty-server/src/engine/workspace-manager/dev-seeder/metadata/services/dev-seeder-metadata.service.ts
index b8d84e13d09..00c6e74f690 100644
--- a/packages/twenty-server/src/engine/workspace-manager/dev-seeder/metadata/services/dev-seeder-metadata.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/dev-seeder/metadata/services/dev-seeder-metadata.service.ts
@@ -229,6 +229,7 @@ export class DevSeederMetadataService {
objectMetadataSeed: ObjectMetadataSeed;
}): Promise<void> {
await this.objectMetadataService.createOneObject({
+ shouldDeferActions: false,
createObjectInput: objectMetadataSeed,
workspaceId,
});
@@ -259,6 +260,7 @@ export class DevSeederMetadataService {
}));
await this.fieldMetadataService.createManyFields({
+ shouldDeferActions: false,
createFieldInputs,
workspaceId,
});
@@ -355,6 +357,7 @@ export class DevSeederMetadataService {
);
await this.fieldMetadataService.updateOneField({
+ shouldDeferActions: false,
workspaceId,
updateFieldInput: {
id: fieldId,
@@ -421,6 +424,7 @@ export class DevSeederMetadataService {
}));
await this.fieldMetadataService.createManyFields({
+ shouldDeferActions: false,
createFieldInputs,
workspaceId,
});
@@ -446,6 +450,7 @@ export class DevSeederMetadataService {
}
await this.fieldMetadataService.createManyFields({
+ shouldDeferActions: false,
createFieldInputs: [
{
type: FieldMetadataType.RELATION,
diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/services/twenty-standard-application.service.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/services/twenty-standard-application.service.ts
index 223fe2186d7..bc7a6e2a544 100644
--- a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/services/twenty-standard-application.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/services/twenty-standard-application.service.ts
@@ -94,6 +94,8 @@ export class TwentyStandardApplicationService {
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigrationFromTo(
{
+ // Workspace creation and seeding chain migrations right after this sync.
+ shouldDeferActions: false,
buildOptions: {
isSystemBuild: true,
inferDeletionFromMissingEntities: true,
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service.ts
index 4b54b6804d7..682dc4a4a42 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service.ts
@@ -42,6 +42,7 @@ type ValidateBuildAndRunWorkspaceMigrationFromMatriceArgs = {
isSystemBuild?: boolean;
applicationUniversalIdentifier: string;
dryRun?: boolean;
+ shouldDeferActions?: boolean;
};
type ValidateBuildAndRunWorkspaceMigrationFromRecordArgs = {
@@ -51,6 +52,7 @@ type ValidateBuildAndRunWorkspaceMigrationFromRecordArgs = {
applicationUniversalIdentifier: string;
idByUniversalIdentifierByMetadataName?: IdByUniversalIdentifierByMetadataName;
dryRun?: boolean;
+ shouldDeferActions?: boolean;
};
type ValidateBuildAndRunWorkspaceMigrationFromRecordInternalArgs =
@@ -67,6 +69,7 @@ type ComputeAndRunWorkspaceMigrationFromResolvedOperationsArgs = {
applicationUniversalIdentifier: string;
providedIdByUniversalIdentifierByMetadataName?: IdByUniversalIdentifierByMetadataName;
dryRun?: boolean;
+ shouldDeferActions?: boolean;
} & FlatEntityMapsBundle;
@Injectable()
@@ -92,6 +95,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
args: WorkspaceMigrationOrchestratorBuildArgs & {
idByUniversalIdentifierByMetadataName?: IdByUniversalIdentifierByMetadataName;
dryRun?: boolean;
+ shouldDeferActions?: boolean;
},
): Promise<
| WorkspaceMigrationOrchestratorFailedResult
@@ -99,8 +103,12 @@ export class WorkspaceMigrationValidateBuildAndRunService {
hasSchemaMetadataChanged: boolean;
})
> {
- const { idByUniversalIdentifierByMetadataName, dryRun, ...buildArgs } =
- args;
+ const {
+ idByUniversalIdentifierByMetadataName,
+ dryRun,
+ shouldDeferActions,
+ ...buildArgs
+ } = args;
const buildStart = performance.now();
const validateAndBuildResult =
@@ -190,6 +198,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
await this.workspaceMigrationRunnerService.run({
workspaceId: args.workspaceId,
workspaceMigration,
+ shouldDeferActions,
});
const runMs = performance.now() - runStart;
@@ -216,6 +225,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
isSystemBuild = false,
applicationUniversalIdentifier,
dryRun,
+ shouldDeferActions,
}: ValidateBuildAndRunWorkspaceMigrationFromMatriceArgs): Promise<
| WorkspaceMigrationOrchestratorFailedResult
| (WorkspaceMigrationOrchestratorSuccessfulResult & {
@@ -231,6 +241,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
isSystemBuild,
applicationUniversalIdentifier,
dryRun,
+ shouldDeferActions,
});
}
@@ -261,6 +272,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
isSystemBuild = false,
applicationUniversalIdentifier,
dryRun,
+ shouldDeferActions,
}: ValidateBuildAndRunWorkspaceMigrationFromMatriceArgs): Promise<
| WorkspaceMigrationOrchestratorFailedResult
| (WorkspaceMigrationOrchestratorSuccessfulResult & {
@@ -276,6 +288,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
isSystemBuild,
applicationUniversalIdentifier,
dryRun,
+ shouldDeferActions,
skipSideEffectExpandEngine: true,
});
}
@@ -287,6 +300,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
applicationUniversalIdentifier,
idByUniversalIdentifierByMetadataName,
dryRun,
+ shouldDeferActions,
skipSideEffectExpandEngine,
}: ValidateBuildAndRunWorkspaceMigrationFromRecordInternalArgs): Promise<
| WorkspaceMigrationOrchestratorFailedResult
@@ -340,6 +354,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
providedIdByUniversalIdentifierByMetadataName:
idByUniversalIdentifierByMetadataName,
dryRun,
+ shouldDeferActions,
flatApplicationMaps,
allRelatedFlatEntityMaps,
allMetadataNameCacheToCompute,
@@ -353,6 +368,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
applicationUniversalIdentifier,
providedIdByUniversalIdentifierByMetadataName,
dryRun,
+ shouldDeferActions,
flatApplicationMaps,
allRelatedFlatEntityMaps,
allMetadataNameCacheToCompute,
@@ -407,6 +423,7 @@ export class WorkspaceMigrationValidateBuildAndRunService {
idByUniversalIdentifierByMetadataName:
mergedIdByUniversalIdentifierByMetadataName,
dryRun,
+ shouldDeferActions,
});
}
}
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/__tests__/get-deferred-foreign-key-validation.util.spec.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/__tests__/get-deferred-foreign-key-validation.util.spec.ts
index 675f6606adc..33449c2519b 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/__tests__/get-deferred-foreign-key-validation.util.spec.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/__tests__/get-deferred-foreign-key-validation.util.spec.ts
@@ -1,18 +1,10 @@
-import {
- FeatureFlagKey,
- FieldMetadataType,
- RelationType,
-} from 'twenty-shared/types';
+import { FieldMetadataType, RelationType } from 'twenty-shared/types';
import { getFlatFieldMetadataMock } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/get-flat-field-metadata.mock';
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { type FlatCreateFieldAction } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/field/types/workspace-migration-field-action.type';
import { getDeferredForeignKeyValidation } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/get-deferred-foreign-key-validation.util';
-const FEATURE_FLAGS_ON = {
- [FeatureFlagKey.IS_DEFERRED_WORKSPACE_MIGRATION_ACTIONS_ENABLED]: true,
-};
-
const buildField = (
overrides: Partial<FlatFieldMetadata> = {},
): FlatFieldMetadata =>
@@ -42,7 +34,7 @@ describe('getDeferredForeignKeyValidation', () => {
expect(
getDeferredForeignKeyValidation({
flatAction: buildAction(flatEntity),
- featureFlagsMap: FEATURE_FLAGS_ON,
+ shouldDeferActions: true,
}),
).toEqual({
name: 'validate_foreignKey',
@@ -61,16 +53,16 @@ describe('getDeferredForeignKeyValidation', () => {
expect(
getDeferredForeignKeyValidation({
flatAction: buildAction(oneToManySide, manyToOneSide),
- featureFlagsMap: FEATURE_FLAGS_ON,
+ shouldDeferActions: true,
})?.payload.fieldMetadataId,
).toBe(manyToOneSide.id);
});
- it('should defer nothing when the flag is off', () => {
+ it('should defer nothing when actions run in process', () => {
expect(
getDeferredForeignKeyValidation({
flatAction: buildAction(buildField()),
- featureFlagsMap: {},
+ shouldDeferActions: false,
}),
).toBeUndefined();
});
@@ -86,7 +78,7 @@ describe('getDeferredForeignKeyValidation', () => {
settings: null,
}),
),
- featureFlagsMap: FEATURE_FLAGS_ON,
+ shouldDeferActions: true,
}),
).toBeUndefined();
});
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/get-deferred-foreign-key-validation.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/get-deferred-foreign-key-validation.util.ts
index 7daae85ef20..e09a384b9b0 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/get-deferred-foreign-key-validation.util.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/field/services/utils/get-deferred-foreign-key-validation.util.ts
@@ -1,28 +1,23 @@
-import { FeatureFlagKey, RelationType } from 'twenty-shared/types';
+import { RelationType } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
-import { type FeatureFlagMap } from 'src/engine/core-modules/feature-flag/interfaces/feature-flag-map.interface';
import { isMorphOrRelationFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-morph-or-relation-flat-field-metadata.util';
import { type FlatCreateFieldAction } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/field/types/workspace-migration-field-action.type';
import { type DeferredWorkspaceMigrationActionPayload } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/types/deferred-workspace-migration-action.type';
export const getDeferredForeignKeyValidation = ({
flatAction,
- featureFlagsMap,
+ shouldDeferActions,
}: {
flatAction: FlatCreateFieldAction;
- featureFlagsMap?: Partial<FeatureFlagMap>;
+ shouldDeferActions?: boolean;
}):
| {
name: 'validate_foreignKey';
payload: DeferredWorkspaceMigrationActionPayload<'validate_foreignKey'>;
}
| undefined => {
- if (
- !featureFlagsMap?.[
- FeatureFlagKey.IS_DEFERRED_WORKSPACE_MIGRATION_ACTIONS_ENABLED
- ]
- ) {
+ if (!shouldDeferActions) {
return undefined;
}
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/index/services/create-index-action-handler.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/index/services/create-index-action-handler.service.ts
index 8772750e6a0..988dfc27ce7 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/index/services/create-index-action-handler.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/index/services/create-index-action-handler.service.ts
@@ -1,6 +1,5 @@
import { Injectable } from '@nestjs/common';
-import { FeatureFlagKey } from 'twenty-shared/types';
import { v4 } from 'uuid';
import { WorkspaceMigrationRunnerActionHandler } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/interfaces/workspace-migration-runner-action-handler-service.interface';
@@ -115,15 +114,11 @@ export class CreateIndexActionHandlerService extends WorkspaceMigrationRunnerAct
}
private shouldDeferIndexCreation({
- featureFlagsMap,
+ shouldDeferActions,
allFlatEntityMaps: { flatFieldMetadataMaps },
flatAction: { flatEntity: flatIndexMetadata },
}: WorkspaceMigrationActionRunnerContext<FlatCreateIndexAction>): boolean {
- if (
- !featureFlagsMap?.[
- FeatureFlagKey.IS_DEFERRED_WORKSPACE_MIGRATION_ACTIONS_ENABLED
- ]
- ) {
+ if (!shouldDeferActions) {
return false;
}
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts
index c8a17fef8b4..a22f4f41bc2 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts
@@ -178,6 +178,7 @@ export class WorkspaceMigrationRunnerService {
run = async (args: {
workspaceMigration: WorkspaceMigration;
workspaceId: string;
+ shouldDeferActions?: boolean;
}): Promise<{
allFlatEntityMaps: AllFlatEntityMaps;
metadataEvents: MetadataEvent[];
@@ -239,9 +240,11 @@ export class WorkspaceMigrationRunnerService {
private executeRun = async ({
workspaceMigration: { actions, applicationUniversalIdentifier },
workspaceId,
+ shouldDeferActions: shouldDeferActionsByCaller = true,
}: {
workspaceMigration: WorkspaceMigration;
workspaceId: string;
+ shouldDeferActions?: boolean;
}): Promise<{
allFlatEntityMaps: AllFlatEntityMaps;
metadataEvents: MetadataEvent[];
@@ -365,10 +368,10 @@ export class WorkspaceMigrationRunnerService {
const featureFlagsMap =
await this.featureFlagService.getWorkspaceFeatureFlagsMap(workspaceId);
- const shouldPersistDeferredActions =
+ const shouldDeferActions =
featureFlagsMap[
FeatureFlagKey.IS_DEFERRED_WORKSPACE_MIGRATION_ACTIONS_ENABLED
- ];
+ ] && shouldDeferActionsByCaller;
this.logger.perfTime('Runner', 'Transaction execution');
@@ -406,7 +409,7 @@ export class WorkspaceMigrationRunnerService {
preallocatedIdByUniversalIdentifierByMetadataName,
getSearchFieldMetadatasByTsVectorFieldId:
searchFieldMetadatasByTsVectorFieldIdAccessor.get,
- featureFlagsMap,
+ shouldDeferActions,
},
},
);
@@ -440,7 +443,7 @@ export class WorkspaceMigrationRunnerService {
allDeferredActions.push(...deferredActions);
}
- if (shouldPersistDeferredActions) {
+ if (shouldDeferActions) {
await this.deferredWorkspaceMigrationActionRunnerService.persist({
deferredActions: allDeferredActions,
workspaceId,
@@ -592,7 +595,7 @@ export class WorkspaceMigrationRunnerService {
await this.deferredWorkspaceMigrationActionRunnerService.dispatchAfterCommit(
{
deferredActions: allDeferredActions,
- hasPersistedDeferredActions: shouldPersistDeferredActions,
+ hasPersistedDeferredActions: shouldDeferActions,
workspaceId,
applicationUniversalIdentifier,
allFlatEntityMaps,
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/types/workspace-migration-action-runner-args.type.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/types/workspace-migration-action-runner-args.type.ts
index 235b3155a9a..20bc1ee7175 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/types/workspace-migration-action-runner-args.type.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/types/workspace-migration-action-runner-args.type.ts
@@ -1,7 +1,5 @@
import { type QueryRunner } from 'typeorm';
-import { type FeatureFlagMap } from 'src/engine/core-modules/feature-flag/interfaces/feature-flag-map.interface';
-
import { type FlatApplication } from 'src/engine/core-modules/application/types/flat-application.type';
import { type AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-maps.type';
import { type FlatSearchFieldMetadata } from 'src/engine/metadata-modules/flat-search-field-metadata/types/flat-search-field-metadata.type';
@@ -23,7 +21,7 @@ export type WorkspaceMigrationActionRunnerArgs<
getSearchFieldMetadatasByTsVectorFieldId?: (
tsVectorFieldMetadataId: string,
) => FlatSearchFieldMetadata[];
- featureFlagsMap?: FeatureFlagMap;
+ shouldDeferActions?: boolean;
};
export type WorkspaceMigrationActionRunnerContext<