Skip to content

The open alternative to Salesforce, designed for AI.

fix(server): migrate legacy IS_NOT_NULL workflow filter operand to IS_NOT_EMPTY (#24808)

Charles Bochet282ce2409de6
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/2-36-upgrade-version-command.module.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/2-36-upgrade-version-command.module.ts
new file mode 100644
index 00000000000..a9d7cef7d57
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/2-36-upgrade-version-command.module.ts
@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+
+import { WorkspaceIteratorModule } from 'src/database/commands/command-runners/workspace-iterator.module';
+import { RewriteIsNotNullWorkflowFilterOperandsCommand } from 'src/database/commands/upgrade-version-command/2-36/2-36-workspace-command-1787700000000-rewrite-is-not-null-workflow-filter-operands.command';
+import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache.module';
+
+@Module({
+ imports: [WorkspaceIteratorModule, WorkspaceCacheModule],
+ providers: [RewriteIsNotNullWorkflowFilterOperandsCommand],
+})
+export class V2_36_UpgradeVersionCommandModule {}
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/2-36-workspace-command-1787700000000-rewrite-is-not-null-workflow-filter-operands.command.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/2-36-workspace-command-1787700000000-rewrite-is-not-null-workflow-filter-operands.command.ts
new file mode 100644
index 00000000000..f65c7f65150
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/2-36-workspace-command-1787700000000-rewrite-is-not-null-workflow-filter-operands.command.ts
@@ -0,0 +1,175 @@
+import { Command } from 'nest-commander';
+import { STANDARD_OBJECTS } from 'twenty-shared/metadata';
+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 { rewriteIsNotNullFilterOperands } from 'src/database/commands/upgrade-version-command/2-36/utils/rewrite-is-not-null-filter-operands.util';
+import { RegisteredWorkspaceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-workspace-command.decorator';
+import { findFlatEntityByUniversalIdentifier } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-universal-identifier.util';
+import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
+import { WorkspaceOrmManager } from 'src/engine/twenty-orm/workspace-orm.manager';
+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
+import { type UniversalFlatEntityMaps } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-entity-maps.type';
+import { type WorkflowAutomatedTriggerWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-automated-trigger.workspace-entity';
+import { type WorkflowVersionWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
+
+@RegisteredWorkspaceCommand('2.36.0', 1787700000000)
+@Command({
+ name: 'upgrade:2-36:rewrite-is-not-null-workflow-filter-operands',
+ description:
+ 'Rewrite the legacy IS_NOT_NULL filter operand to IS_NOT_EMPTY in workflow if-else/filter steps and database-event trigger filters, which otherwise throws at runtime',
+})
+export class RewriteIsNotNullWorkflowFilterOperandsCommand extends ProvisionedWorkspaceCommandRunner {
+ constructor(
+ protected readonly workspaceIteratorService: WorkspaceIteratorService,
+ private readonly workspaceOrmManager: WorkspaceOrmManager,
+ private readonly workspaceCacheService: WorkspaceCacheService,
+ ) {
+ super(workspaceIteratorService);
+ }
+
+ override async runOnWorkspace({
+ workspaceId,
+ options,
+ }: RunOnWorkspaceArgs): Promise<void> {
+ const isDryRun = options.dryRun ?? false;
+
+ const { flatObjectMetadataMaps } =
+ await this.workspaceCacheService.getOrRecompute(workspaceId, [
+ 'flatObjectMetadataMaps',
+ ]);
+
+ await this.rewriteWorkflowVersions({
+ workspaceId,
+ flatObjectMetadataMaps,
+ isDryRun,
+ });
+
+ await this.rewriteAutomatedTriggers({
+ workspaceId,
+ flatObjectMetadataMaps,
+ isDryRun,
+ });
+ }
+
+ private async rewriteWorkflowVersions({
+ workspaceId,
+ flatObjectMetadataMaps,
+ isDryRun,
+ }: {
+ workspaceId: string;
+ flatObjectMetadataMaps: UniversalFlatEntityMaps<FlatObjectMetadata>;
+ isDryRun: boolean;
+ }): Promise<void> {
+ const workflowVersionObject =
+ findFlatEntityByUniversalIdentifier<FlatObjectMetadata>({
+ flatEntityMaps: flatObjectMetadataMaps,
+ universalIdentifier: STANDARD_OBJECTS.workflowVersion.universalIdentifier,
+ });
+
+ if (!isDefined(workflowVersionObject)) {
+ return;
+ }
+
+ const workflowVersionRepository =
+ await this.workspaceOrmManager.getRepository<WorkflowVersionWorkspaceEntity>(
+ 'workflowVersion',
+ { shouldBypassPermissionChecks: true },
+ );
+
+ const allVersions = await workflowVersionRepository.find();
+
+ let updatedCount = 0;
+
+ for (const version of allVersions) {
+ const migratedSteps = rewriteIsNotNullFilterOperands(version.steps);
+ const migratedTrigger = rewriteIsNotNullFilterOperands(version.trigger);
+
+ if (!migratedSteps.changed && !migratedTrigger.changed) {
+ continue;
+ }
+
+ updatedCount++;
+
+ if (isDryRun) {
+ continue;
+ }
+
+ await workflowVersionRepository.update(version.id, {
+ ...(migratedSteps.changed ? { steps: migratedSteps.value } : {}),
+ ...(migratedTrigger.changed ? { trigger: migratedTrigger.value } : {}),
+ });
+ }
+
+ if (updatedCount > 0) {
+ this.logger.log(
+ `${isDryRun ? '[DRY RUN] ' : ''}Rewrote IS_NOT_NULL operands in ${updatedCount} workflow version(s) for workspace ${workspaceId}`,
+ );
+ }
+ }
+
+ private async rewriteAutomatedTriggers({
+ workspaceId,
+ flatObjectMetadataMaps,
+ isDryRun,
+ }: {
+ workspaceId: string;
+ flatObjectMetadataMaps: UniversalFlatEntityMaps<FlatObjectMetadata>;
+ isDryRun: boolean;
+ }): Promise<void> {
+ const automatedTriggerObject =
+ findFlatEntityByUniversalIdentifier<FlatObjectMetadata>({
+ flatEntityMaps: flatObjectMetadataMaps,
+ universalIdentifier:
+ STANDARD_OBJECTS.workflowAutomatedTrigger.universalIdentifier,
+ });
+
+ if (!isDefined(automatedTriggerObject)) {
+ return;
+ }
+
+ const automatedTriggerRepository =
+ await this.workspaceOrmManager.getRepository<WorkflowAutomatedTriggerWorkspaceEntity>(
+ 'workflowAutomatedTrigger',
+ { shouldBypassPermissionChecks: true },
+ );
+
+ const allTriggers = await automatedTriggerRepository.find();
+
+ let updatedCount = 0;
+
+ for (const trigger of allTriggers) {
+ const migratedSettings = rewriteIsNotNullFilterOperands(trigger.settings);
+
+ if (!migratedSettings.changed) {
+ continue;
+ }
+
+ updatedCount++;
+
+ if (isDryRun) {
+ continue;
+ }
+
+ await automatedTriggerRepository.update(trigger.id, {
+ settings: migratedSettings.value,
+ });
+ }
+
+ if (updatedCount === 0) {
+ return;
+ }
+
+ if (!isDryRun) {
+ await this.workspaceCacheService.invalidateAndRecompute(workspaceId, [
+ 'workflowAutomatedTriggerMaps',
+ ]);
+ }
+
+ this.logger.log(
+ `${isDryRun ? '[DRY RUN] ' : ''}Rewrote IS_NOT_NULL operands in ${updatedCount} automated trigger(s) for workspace ${workspaceId}`,
+ );
+ }
+}
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/utils/__tests__/rewrite-is-not-null-filter-operands.util.spec.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/utils/__tests__/rewrite-is-not-null-filter-operands.util.spec.ts
new file mode 100644
index 00000000000..2772390fd8d
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/utils/__tests__/rewrite-is-not-null-filter-operands.util.spec.ts
@@ -0,0 +1,95 @@
+import { rewriteIsNotNullFilterOperands } from 'src/database/commands/upgrade-version-command/2-36/utils/rewrite-is-not-null-filter-operands.util';
+
+describe('rewriteIsNotNullFilterOperands', () => {
+ it('rewrites IS_NOT_NULL operand to IS_NOT_EMPTY inside stepFilters', () => {
+ const steps = [
+ {
+ type: 'IF_ELSE',
+ settings: {
+ input: {
+ stepFilters: [
+ { id: 'a', type: 'UUID', operand: 'IS_NOT_NULL', value: '' },
+ ],
+ },
+ },
+ },
+ ];
+
+ const { value, changed } = rewriteIsNotNullFilterOperands(steps);
+
+ expect(changed).toBe(true);
+ expect(value[0].settings.input.stepFilters[0].operand).toBe('IS_NOT_EMPTY');
+ });
+
+ it('rewrites the deprecated isNotNull operand to IS_NOT_EMPTY', () => {
+ const { value, changed } = rewriteIsNotNullFilterOperands({
+ stepFilters: [{ operand: 'isNotNull' }],
+ });
+
+ expect(changed).toBe(true);
+ expect(value.stepFilters[0].operand).toBe('IS_NOT_EMPTY');
+ });
+
+ it('rewrites operands in trigger filter settings', () => {
+ const trigger = {
+ type: 'DATABASE_EVENT',
+ settings: {
+ eventName: 'company.updated',
+ filter: {
+ stepFilters: [{ operand: 'IS_NOT_NULL' }],
+ stepFilterGroups: [],
+ },
+ },
+ };
+
+ const { value, changed } = rewriteIsNotNullFilterOperands(trigger);
+
+ expect(changed).toBe(true);
+ expect(value.settings.filter.stepFilters[0].operand).toBe('IS_NOT_EMPTY');
+ });
+
+ it('leaves other operands untouched', () => {
+ const steps = [
+ { settings: { input: { stepFilters: [{ operand: 'IS_NOT_EMPTY' }] } } },
+ { settings: { input: { stepFilters: [{ operand: 'IS' }] } } },
+ ];
+
+ const { value, changed } = rewriteIsNotNullFilterOperands(steps);
+
+ expect(changed).toBe(false);
+ expect(value).toBe(steps);
+ });
+
+ it('does not touch a filter value that merely contains the operand string', () => {
+ const { value, changed } = rewriteIsNotNullFilterOperands({
+ stepFilters: [{ operand: 'CONTAINS', value: 'IS_NOT_NULL' }],
+ });
+
+ expect(changed).toBe(false);
+ expect(value.stepFilters[0].value).toBe('IS_NOT_NULL');
+ });
+
+ it('is idempotent', () => {
+ const input = { stepFilters: [{ operand: 'IS_NOT_NULL' }] };
+
+ const firstPass = rewriteIsNotNullFilterOperands(input);
+ const secondPass = rewriteIsNotNullFilterOperands(firstPass.value);
+
+ expect(firstPass.changed).toBe(true);
+ expect(secondPass.changed).toBe(false);
+ expect(secondPass.value).toEqual({
+ stepFilters: [{ operand: 'IS_NOT_EMPTY' }],
+ });
+ });
+
+ it('returns null/undefined unchanged', () => {
+ expect(rewriteIsNotNullFilterOperands(null)).toEqual({
+ value: null,
+ changed: false,
+ });
+ expect(rewriteIsNotNullFilterOperands(undefined)).toEqual({
+ value: undefined,
+ changed: false,
+ });
+ });
+});
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/utils/rewrite-is-not-null-filter-operands.util.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/utils/rewrite-is-not-null-filter-operands.util.ts
new file mode 100644
index 00000000000..cb616c54241
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-36/utils/rewrite-is-not-null-filter-operands.util.ts
@@ -0,0 +1,30 @@
+import { isDefined } from 'twenty-shared/utils';
+
+const LEGACY_NOT_NULL_OPERAND_FRAGMENTS = [
+ '"operand":"IS_NOT_NULL"',
+ '"operand":"isNotNull"',
+];
+
+const IS_NOT_EMPTY_OPERAND_FRAGMENT = '"operand":"IS_NOT_EMPTY"';
+
+export const rewriteIsNotNullFilterOperands = <TValue>(
+ value: TValue,
+): { value: TValue; changed: boolean } => {
+ if (!isDefined(value)) {
+ return { value, changed: false };
+ }
+
+ const serialized = JSON.stringify(value);
+
+ const rewritten = LEGACY_NOT_NULL_OPERAND_FRAGMENTS.reduce(
+ (accumulator, fragment) =>
+ accumulator.split(fragment).join(IS_NOT_EMPTY_OPERAND_FRAGMENT),
+ serialized,
+ );
+
+ if (rewritten === serialized) {
+ return { value, changed: false };
+ }
+
+ return { value: JSON.parse(rewritten) as TValue, changed: true };
+};
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.ts
index 714dca52567..30882a227f6 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
@@ -28,6 +28,7 @@ import { V2_32_UpgradeVersionCommandModule } from 'src/database/commands/upgrade
import { V2_33_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-33/2-33-upgrade-version-command.module';
import { V2_34_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-34/2-34-upgrade-version-command.module';
import { V2_35_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-35/2-35-upgrade-version-command.module';
+import { V2_36_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-36/2-36-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';
@@ -69,6 +70,7 @@ import { V2_9_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-
V2_33_UpgradeVersionCommandModule,
V2_34_UpgradeVersionCommandModule,
V2_35_UpgradeVersionCommandModule,
+ V2_36_UpgradeVersionCommandModule,
],
})
export class WorkspaceCommandProviderModule {}