[BREAKING CHANGE] harden call recording failure handling (#22062)

<!-- This is an auto-generated description by cubic. -->
<a
href="https://cubic.dev/pr/twentyhq/twenty/pull/22062?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="Review in cubic"
src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a>
<!-- End of auto-generated description by cubic. -->
This commit is contained in:
nitin
2026-06-24 18:38:26 +05:30
committed by GitHub
parent 0df83eceb2
commit 73e9374ef8
33 changed files with 743 additions and 71 deletions
@@ -2,6 +2,7 @@ import { Module } from '@nestjs/common';
import { WorkspaceIteratorModule } from 'src/database/commands/command-runners/workspace-iterator.module';
import { BackfillSearchFieldMetadataCommand } from 'src/database/commands/upgrade-version-command/2-16/2-16-workspace-command-1799100000000-backfill-search-field-metadata.command';
import { SyncCallRecordingStatusCommand } from 'src/database/commands/upgrade-version-command/2-16/2-16-workspace-command-1799100001000-sync-call-recording-status.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: [BackfillSearchFieldMetadataCommand],
providers: [
BackfillSearchFieldMetadataCommand,
SyncCallRecordingStatusCommand,
],
})
export class V2_16_UpgradeVersionCommandModule {}
@@ -0,0 +1,154 @@
import { Command } from 'nest-commander';
import { STANDARD_OBJECTS } from 'twenty-shared/metadata';
import { FieldMetadataType } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { ActiveOrSuspendedWorkspaceCommandRunner } from 'src/database/commands/command-runners/active-or-suspended-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 { RegisteredWorkspaceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-workspace-command.decorator';
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 { WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service';
const CALL_RECORDING_STATUS_FIELD_UNIVERSAL_IDENTIFIER =
STANDARD_OBJECTS.callRecording.fields.status.universalIdentifier;
const CALL_RECORDING_OBJECT_UNIVERSAL_IDENTIFIER =
STANDARD_OBJECTS.callRecording.universalIdentifier;
const LEGACY_FAILED_STATUS = 'FAILED_UNKNOWN';
const FAILED_STATUS = 'FAILED';
@RegisteredWorkspaceCommand('2.16.0', 1799100001000)
@Command({
name: 'upgrade:2-16:sync-call-recording-status',
description:
'Sync CallRecording status metadata from FAILED_UNKNOWN to FAILED in existing workspaces',
})
export class SyncCallRecordingStatusCommand extends ActiveOrSuspendedWorkspaceCommandRunner {
constructor(
protected readonly workspaceIteratorService: WorkspaceIteratorService,
private readonly applicationService: ApplicationService,
private readonly workspaceCacheService: WorkspaceCacheService,
private readonly workspaceMigrationValidateBuildAndRunService: WorkspaceMigrationValidateBuildAndRunService,
) {
super(workspaceIteratorService);
}
override async runOnWorkspace({
workspaceId,
options,
}: RunOnWorkspaceArgs): Promise<void> {
const isDryRun = options.dryRun ?? false;
const { flatFieldMetadataMaps, flatObjectMetadataMaps } =
await this.workspaceCacheService.getOrRecompute(workspaceId, [
'flatFieldMetadataMaps',
'flatObjectMetadataMaps',
]);
const callRecordingObject =
flatObjectMetadataMaps.byUniversalIdentifier[
CALL_RECORDING_OBJECT_UNIVERSAL_IDENTIFIER
];
if (!isDefined(callRecordingObject)) {
this.logger.log(
`CallRecording object metadata does not exist for workspace ${workspaceId}, skipping`,
);
return;
}
const statusField =
flatFieldMetadataMaps.byUniversalIdentifier[
CALL_RECORDING_STATUS_FIELD_UNIVERSAL_IDENTIFIER
];
if (!isDefined(statusField)) {
this.logger.log(
`CallRecording status field metadata does not exist for workspace ${workspaceId}, skipping`,
);
return;
}
if (statusField.type !== FieldMetadataType.SELECT) {
throw new Error(
`CallRecording status metadata is not a SELECT field for workspace ${workspaceId}`,
);
}
const selectStatusField =
statusField as FlatFieldMetadata<FieldMetadataType.SELECT>;
const optionsWithFailedStatus = (selectStatusField.options ?? []).map(
(option) =>
option.value === LEGACY_FAILED_STATUS
? { ...option, value: FAILED_STATUS }
: option,
);
const hasLegacyFailedStatus = optionsWithFailedStatus.some(
(option, index) =>
option.value !== selectStatusField.options?.[index]?.value,
);
if (!hasLegacyFailedStatus) {
this.logger.log(
`CallRecording status metadata already synced for workspace ${workspaceId}, skipping`,
);
return;
}
this.logger.log(
`${isDryRun ? '[DRY RUN] ' : ''}Syncing CallRecording status metadata from ${LEGACY_FAILED_STATUS} to ${FAILED_STATUS} for workspace ${workspaceId}`,
);
if (isDryRun) {
return;
}
const { twentyStandardFlatApplication } =
await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
{ workspaceId },
);
const updatedStatusField: FlatFieldMetadata<FieldMetadataType.SELECT> = {
...selectStatusField,
options: optionsWithFailedStatus,
updatedAt: new Date().toISOString(),
};
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
isSystemBuild: true,
applicationUniversalIdentifier:
twentyStandardFlatApplication.universalIdentifier,
workspaceId,
allFlatEntityOperationByMetadataName: {
fieldMetadata: {
flatEntityToCreate: [],
flatEntityToDelete: [],
flatEntityToUpdate: [updatedStatusField],
},
},
},
);
if (validateAndBuildResult.status === 'fail') {
throw new Error(
`Failed to sync CallRecording status metadata for workspace ${workspaceId}: ${JSON.stringify(
validateAndBuildResult,
null,
2,
)}`,
);
}
this.logger.log(
`Synced CallRecording status metadata from ${LEGACY_FAILED_STATUS} to ${FAILED_STATUS} for workspace ${workspaceId}`,
);
}
}