Skip to content

The open alternative to Salesforce, designed for AI.

Backfill standard permission flags in existing workspaces (#29046)

Félix Malfaitc74659729075
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/2-53-upgrade-version-command.module.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/2-53-upgrade-version-command.module.ts
index 5a0dcd6400a..0bc4947074b 100644
--- a/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/2-53-upgrade-version-command.module.ts
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/2-53-upgrade-version-command.module.ts
@@ -6,6 +6,7 @@ import { MoveApplicationAndSystemAccessToDisabledActionsCommand } from 'src/data
import { UngateMergeFromDuplicateCriteriaCommand } from 'src/database/commands/upgrade-version-command/2-53/2-53-workspace-command-1793180997766-ungate-merge-from-duplicate-criteria.command';
import { GateMergeCommandOnRecordPermissionsCommand } from 'src/database/commands/upgrade-version-command/2-53/2-53-workspace-command-1793183175063-gate-merge-command-on-record-permissions.command';
import { SyncWorkspaceMemberRecordPageCommand } from 'src/database/commands/upgrade-version-command/2-53/2-53-workspace-command-1793192231470-sync-workspace-member-record-page.command';
+import { BackfillStandardPermissionFlagsCommand } from 'src/database/commands/upgrade-version-command/2-53/2-53-workspace-command-1793198086907-backfill-standard-permission-flags.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';
@@ -23,6 +24,7 @@ import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace
UngateMergeFromDuplicateCriteriaCommand,
GateMergeCommandOnRecordPermissionsCommand,
SyncWorkspaceMemberRecordPageCommand,
+ BackfillStandardPermissionFlagsCommand,
],
})
export class V2_53_UpgradeVersionCommandModule {}
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/2-53-workspace-command-1793198086907-backfill-standard-permission-flags.command.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/2-53-workspace-command-1793198086907-backfill-standard-permission-flags.command.ts
new file mode 100644
index 00000000000..594af6ae4fe
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/2-53-workspace-command-1793198086907-backfill-standard-permission-flags.command.ts
@@ -0,0 +1,104 @@
+import { Command } from 'nest-commander';
+import { isNonEmptyArray } 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 { computeMissingStandardPermissionFlags } from 'src/database/commands/upgrade-version-command/2-53/utils/compute-missing-standard-permission-flags.util';
+import { ApplicationService } from 'src/engine/core-modules/application/application.service';
+import { RegisteredWorkspaceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-workspace-command.decorator';
+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
+import { buildStandardFlatPermissionFlagMetadataMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/permission-flag/build-standard-flat-permission-flag-metadata-maps.util';
+import { WorkspaceMigrationBuilderException } from 'src/engine/workspace-manager/workspace-migration/exceptions/workspace-migration-builder-exception';
+import { WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service';
+
+@RegisteredWorkspaceCommand('2.53.0', 1793198086907)
+@Command({
+ name: 'upgrade:2-53:backfill-standard-permission-flags',
+ description:
+ 'Create the standard permission flags an existing workspace lacks, such as CREATE_CALENDAR_EVENT_TOOL, which was added after the 2.6 backfill',
+})
+export class BackfillStandardPermissionFlagsCommand extends ProvisionedWorkspaceCommandRunner {
+ constructor(
+ protected readonly workspaceIteratorService: WorkspaceIteratorService,
+ private readonly applicationService: ApplicationService,
+ private readonly workspaceCacheService: WorkspaceCacheService,
+ private readonly workspaceMigrationValidateBuildAndRunService: WorkspaceMigrationValidateBuildAndRunService,
+ ) {
+ super(workspaceIteratorService);
+ }
+
+ override async runOnWorkspace(args: RunOnWorkspaceArgs): Promise<void> {
+ await this.up(args);
+ }
+
+ async up({ workspaceId, options }: RunOnWorkspaceArgs): Promise<void> {
+ const { twentyStandardFlatApplication } =
+ await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
+ { workspaceId },
+ );
+
+ const { flatPermissionFlagMaps } =
+ await this.workspaceCacheService.getOrRecompute(workspaceId, [
+ 'flatPermissionFlagMaps',
+ ]);
+
+ const { permissionFlagsToCreate, permissionFlagsSkippedForKeyClash } =
+ computeMissingStandardPermissionFlags({
+ standardFlatPermissionFlagMaps:
+ buildStandardFlatPermissionFlagMetadataMaps({
+ now: new Date().toISOString(),
+ workspaceId,
+ twentyStandardApplicationId: twentyStandardFlatApplication.id,
+ }),
+ existingFlatPermissionFlagMaps: flatPermissionFlagMaps,
+ });
+
+ if (isNonEmptyArray(permissionFlagsSkippedForKeyClash)) {
+ this.logger.warn(
+ `Workspace ${workspaceId}: another application already registered permission flag key(s) ${permissionFlagsSkippedForKeyClash.map((permissionFlag) => permissionFlag.key).join(', ')}; skipping the standard flag(s)`,
+ );
+ }
+
+ if (!isNonEmptyArray(permissionFlagsToCreate)) {
+ return;
+ }
+
+ this.logger.log(
+ `${options.dryRun ? '[DRY RUN] ' : ''}Workspace ${workspaceId}: creating standard permission flag(s) ${permissionFlagsToCreate.map((permissionFlag) => permissionFlag.key).join(', ')}`,
+ );
+
+ if (options.dryRun) {
+ return;
+ }
+
+ const result =
+ await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunLegacyWorkspaceMigration(
+ {
+ workspaceId,
+ isSystemBuild: true,
+ applicationUniversalIdentifier:
+ twentyStandardFlatApplication.universalIdentifier,
+ allFlatEntityOperationByMetadataName: {
+ permissionFlag: {
+ flatEntityToCreate: permissionFlagsToCreate,
+ flatEntityToDelete: [],
+ flatEntityToUpdate: [],
+ },
+ },
+ },
+ );
+
+ if (result.status === 'fail') {
+ throw new WorkspaceMigrationBuilderException(
+ result,
+ `Failed to backfill the standard permission flags for workspace ${workspaceId}`,
+ );
+ }
+ }
+
+ async down(_args: RunOnWorkspaceArgs): Promise<void> {
+ // The created rows cannot be told apart from older ones, and deleting a
+ // flag cascades to every role granted it since
+ }
+}
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/utils/__tests__/compute-missing-standard-permission-flags.util.spec.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/utils/__tests__/compute-missing-standard-permission-flags.util.spec.ts
new file mode 100644
index 00000000000..dabf500b489
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/utils/__tests__/compute-missing-standard-permission-flags.util.spec.ts
@@ -0,0 +1,131 @@
+import {
+ PermissionFlagType,
+ SystemPermissionFlag,
+} from 'twenty-shared/constants';
+import { isDefined } from 'twenty-shared/utils';
+
+import { computeMissingStandardPermissionFlags } from 'src/database/commands/upgrade-version-command/2-53/utils/compute-missing-standard-permission-flags.util';
+import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
+import { type FlatPermissionFlag } from 'src/engine/metadata-modules/flat-permission-flag/types/flat-permission-flag.type';
+import { buildStandardFlatPermissionFlagMetadataMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/permission-flag/build-standard-flat-permission-flag-metadata-maps.util';
+
+const WORKSPACE_ID = '20202020-0000-0000-0000-000000000001';
+const STANDARD_APPLICATION_ID = '20202020-0000-0000-0000-0000000000a1';
+const OTHER_APPLICATION_ID = '20202020-0000-0000-0000-0000000000b2';
+const NOW = '2026-10-27T12:00:00.000Z';
+
+const standardFlatPermissionFlagMaps =
+ buildStandardFlatPermissionFlagMetadataMaps({
+ now: NOW,
+ workspaceId: WORKSPACE_ID,
+ twentyStandardApplicationId: STANDARD_APPLICATION_ID,
+ });
+
+const standardFlatPermissionFlags = Object.values(
+ standardFlatPermissionFlagMaps.byUniversalIdentifier,
+).filter(isDefined);
+
+const toFlatPermissionFlagMaps = (
+ flatPermissionFlags: FlatPermissionFlag[],
+): FlatEntityMaps<FlatPermissionFlag> =>
+ ({
+ byUniversalIdentifier: Object.fromEntries(
+ flatPermissionFlags.map((flatPermissionFlag) => [
+ flatPermissionFlag.universalIdentifier,
+ { ...flatPermissionFlag, id: `existing-${flatPermissionFlag.key}` },
+ ]),
+ ),
+ }) as FlatEntityMaps<FlatPermissionFlag>;
+
+const withoutKeys = (keys: PermissionFlagType[]) =>
+ standardFlatPermissionFlags.filter(
+ (standardFlatPermissionFlag) =>
+ !keys.includes(standardFlatPermissionFlag.key as PermissionFlagType),
+ );
+
+describe('computeMissingStandardPermissionFlags', () => {
+ it('creates the standard flag a workspace created before it was added lacks', () => {
+ const { permissionFlagsToCreate, permissionFlagsSkippedForKeyClash } =
+ computeMissingStandardPermissionFlags({
+ standardFlatPermissionFlagMaps,
+ existingFlatPermissionFlagMaps: toFlatPermissionFlagMaps(
+ withoutKeys([PermissionFlagType.CREATE_CALENDAR_EVENT_TOOL]),
+ ),
+ });
+
+ expect(permissionFlagsToCreate).toEqual([
+ expect.objectContaining({
+ key: PermissionFlagType.CREATE_CALENDAR_EVENT_TOOL,
+ universalIdentifier: SystemPermissionFlag.CREATE_CALENDAR_EVENT_TOOL,
+ applicationId: STANDARD_APPLICATION_ID,
+ workspaceId: WORKSPACE_ID,
+ label: 'Create Calendar Event',
+ permissionType: 'tool',
+ }),
+ ]);
+ expect(permissionFlagsSkippedForKeyClash).toEqual([]);
+ });
+
+ it('creates nothing when the workspace already has every standard flag', () => {
+ const { permissionFlagsToCreate, permissionFlagsSkippedForKeyClash } =
+ computeMissingStandardPermissionFlags({
+ standardFlatPermissionFlagMaps,
+ existingFlatPermissionFlagMaps: toFlatPermissionFlagMaps(
+ standardFlatPermissionFlags,
+ ),
+ });
+
+ expect(permissionFlagsToCreate).toEqual([]);
+ expect(permissionFlagsSkippedForKeyClash).toEqual([]);
+ });
+
+ it('creates every standard flag the workspace lacks, not only the latest one', () => {
+ const { permissionFlagsToCreate } = computeMissingStandardPermissionFlags({
+ standardFlatPermissionFlagMaps,
+ existingFlatPermissionFlagMaps: toFlatPermissionFlagMaps(
+ withoutKeys([
+ PermissionFlagType.CREATE_CALENDAR_EVENT_TOOL,
+ PermissionFlagType.SEND_EMAIL_TOOL,
+ ]),
+ ),
+ });
+
+ expect(
+ permissionFlagsToCreate.map((permissionFlag) => permissionFlag.key),
+ ).toEqual(
+ expect.arrayContaining([
+ PermissionFlagType.CREATE_CALENDAR_EVENT_TOOL,
+ PermissionFlagType.SEND_EMAIL_TOOL,
+ ]),
+ );
+ expect(permissionFlagsToCreate).toHaveLength(2);
+ });
+
+ it('skips a standard flag whose key another application already registered', () => {
+ const appFlagWithStandardKey = {
+ ...standardFlatPermissionFlags.find(
+ (standardFlatPermissionFlag) =>
+ standardFlatPermissionFlag.key ===
+ PermissionFlagType.CREATE_CALENDAR_EVENT_TOOL,
+ ),
+ universalIdentifier: '20202020-0000-0000-0000-0000000000c3',
+ applicationId: OTHER_APPLICATION_ID,
+ } as FlatPermissionFlag;
+
+ const { permissionFlagsToCreate, permissionFlagsSkippedForKeyClash } =
+ computeMissingStandardPermissionFlags({
+ standardFlatPermissionFlagMaps,
+ existingFlatPermissionFlagMaps: toFlatPermissionFlagMaps([
+ ...withoutKeys([PermissionFlagType.CREATE_CALENDAR_EVENT_TOOL]),
+ appFlagWithStandardKey,
+ ]),
+ });
+
+ expect(permissionFlagsToCreate).toEqual([]);
+ expect(permissionFlagsSkippedForKeyClash).toEqual([
+ expect.objectContaining({
+ universalIdentifier: SystemPermissionFlag.CREATE_CALENDAR_EVENT_TOOL,
+ }),
+ ]);
+ });
+});
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/utils/compute-missing-standard-permission-flags.util.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/utils/compute-missing-standard-permission-flags.util.ts
new file mode 100644
index 00000000000..7fa653ad039
--- /dev/null
+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-53/utils/compute-missing-standard-permission-flags.util.ts
@@ -0,0 +1,50 @@
+import { isDefined } from 'twenty-shared/utils';
+
+import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
+import { type FlatPermissionFlag } from 'src/engine/metadata-modules/flat-permission-flag/types/flat-permission-flag.type';
+
+export const computeMissingStandardPermissionFlags = ({
+ standardFlatPermissionFlagMaps,
+ existingFlatPermissionFlagMaps,
+}: {
+ standardFlatPermissionFlagMaps: Pick<
+ FlatEntityMaps<FlatPermissionFlag>,
+ 'byUniversalIdentifier'
+ >;
+ existingFlatPermissionFlagMaps: Pick<
+ FlatEntityMaps<FlatPermissionFlag>,
+ 'byUniversalIdentifier'
+ >;
+}): {
+ permissionFlagsToCreate: FlatPermissionFlag[];
+ permissionFlagsSkippedForKeyClash: FlatPermissionFlag[];
+} => {
+ const takenKeys = new Set(
+ Object.values(existingFlatPermissionFlagMaps.byUniversalIdentifier)
+ .filter(isDefined)
+ .map((existingPermissionFlag) => existingPermissionFlag.key),
+ );
+
+ const missingPermissionFlags = Object.values(
+ standardFlatPermissionFlagMaps.byUniversalIdentifier,
+ )
+ .filter(isDefined)
+ .filter(
+ (standardPermissionFlag) =>
+ !isDefined(
+ existingFlatPermissionFlagMaps.byUniversalIdentifier[
+ standardPermissionFlag.universalIdentifier
+ ],
+ ),
+ );
+
+ // Keys are unique per workspace, and one rejected create would fail the whole migration
+ return {
+ permissionFlagsToCreate: missingPermissionFlags.filter(
+ (missingPermissionFlag) => !takenKeys.has(missingPermissionFlag.key),
+ ),
+ permissionFlagsSkippedForKeyClash: missingPermissionFlags.filter(
+ (missingPermissionFlag) => takenKeys.has(missingPermissionFlag.key),
+ ),
+ };
+};
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-install/jobs/trigger-install-application.job.ts b/packages/twenty-server/src/engine/core-modules/application/application-install/jobs/trigger-install-application.job.ts
index 9eaf8ca243d..f25e04f2089 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-install/jobs/trigger-install-application.job.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-install/jobs/trigger-install-application.job.ts
@@ -1,4 +1,5 @@
import { ApplicationInstallService } from 'src/engine/core-modules/application/application-install/application-install.service';
+import { toApplicationLifecycleJobError } from 'src/engine/core-modules/application/application-install/utils/to-application-lifecycle-job-error.util';
import { Process } from 'src/engine/core-modules/message-queue/decorators/process.decorator';
import { Processor } from 'src/engine/core-modules/message-queue/decorators/processor.decorator';
import { type MessageQueueJobProgressContext } from 'src/engine/core-modules/message-queue/interfaces/message-queue-job.interface';
@@ -20,11 +21,15 @@ export class TriggerInstallApplicationJob {
data: TriggerInstallApplicationJobData,
{ updateProgress }: MessageQueueJobProgressContext,
): Promise<void> {
- await this.applicationInstallService.installApplication({
- appRegistrationId: data.applicationRegistrationId,
- workspaceId: data.workspaceId,
- hasUserApprovedCapabilities: true,
- updateProgress,
- });
+ try {
+ await this.applicationInstallService.installApplication({
+ appRegistrationId: data.applicationRegistrationId,
+ workspaceId: data.workspaceId,
+ hasUserApprovedCapabilities: true,
+ updateProgress,
+ });
+ } catch (error) {
+ throw toApplicationLifecycleJobError(error);
+ }
}
}
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-install/utils/__tests__/to-application-lifecycle-job-error.util.spec.ts b/packages/twenty-server/src/engine/core-modules/application/application-install/utils/__tests__/to-application-lifecycle-job-error.util.spec.ts
new file mode 100644
index 00000000000..45aa5286457
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/application/application-install/utils/__tests__/to-application-lifecycle-job-error.util.spec.ts
@@ -0,0 +1,47 @@
+import { toApplicationLifecycleJobError } from 'src/engine/core-modules/application/application-install/utils/to-application-lifecycle-job-error.util';
+import { WorkspaceMigrationBuilderException } from 'src/engine/workspace-manager/workspace-migration/exceptions/workspace-migration-builder-exception';
+
+const MISSING_PERMISSION_FLAG_MESSAGE =
+ 'Standard permission flag CREATE_CALENDAR_EVENT_TOOL (5b8c104e-24d3-4e89-986b-1d9208df6cf4) not found in this workspace. Run the workspace upgrade to create it.';
+
+describe('toApplicationLifecycleJobError', () => {
+ it('replaces the generic sync message with the validation errors', () => {
+ const report = {
+ rolePermissionFlag: [
+ {
+ type: 'create',
+ metadataName: 'rolePermissionFlag',
+ errors: [
+ {
+ code: 'INVALID_SETTING',
+ message: MISSING_PERMISSION_FLAG_MESSAGE,
+ },
+ ],
+ flatEntityMinimalInformation: {},
+ },
+ ],
+ };
+
+ const jobError = toApplicationLifecycleJobError(
+ new WorkspaceMigrationBuilderException(
+ { status: 'fail', report } as never,
+ 'Validation errors occurred while syncing application manifest metadata',
+ ),
+ );
+
+ expect(jobError).toBeInstanceOf(WorkspaceMigrationBuilderException);
+ expect((jobError as WorkspaceMigrationBuilderException).message).toBe(
+ `Validation errors:\n[rolePermissionFlag] ${MISSING_PERMISSION_FLAG_MESSAGE}`,
+ );
+ expect(
+ (jobError as WorkspaceMigrationBuilderException)
+ .failedWorkspaceMigrationBuildResult.report,
+ ).toBe(report);
+ });
+
+ it('leaves any other error untouched', () => {
+ const error = new Error('Package resolution failed');
+
+ expect(toApplicationLifecycleJobError(error)).toBe(error);
+ });
+});
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-install/utils/to-application-lifecycle-job-error.util.ts b/packages/twenty-server/src/engine/core-modules/application/application-install/utils/to-application-lifecycle-job-error.util.ts
new file mode 100644
index 00000000000..fd80c0d2e4a
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/application/application-install/utils/to-application-lifecycle-job-error.util.ts
@@ -0,0 +1,11 @@
+import { formatValidationErrors } from 'src/engine/core-modules/tool-provider/utils/format-validation-errors.util';
+import { WorkspaceMigrationBuilderException } from 'src/engine/workspace-manager/workspace-migration/exceptions/workspace-migration-builder-exception';
+
+// The job's failedReason is the error message, the only text the CLI and the front show
+export const toApplicationLifecycleJobError = (error: unknown): unknown =>
+ error instanceof WorkspaceMigrationBuilderException
+ ? new WorkspaceMigrationBuilderException(
+ error.failedWorkspaceMigrationBuildResult,
+ formatValidationErrors(error),
+ )
+ : error;
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.service.ts
index 9f499a3acaf..20dba2875bc 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.service.ts
@@ -24,6 +24,8 @@ import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decora
import { type MessageQueueJobProgressContext } from 'src/engine/core-modules/message-queue/interfaces/message-queue-job.interface';
import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
import { MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';
+import { formatValidationErrors } from 'src/engine/core-modules/tool-provider/utils/format-validation-errors.util';
+import { WorkspaceMigrationBuilderException } from 'src/engine/workspace-manager/workspace-migration/exceptions/workspace-migration-builder-exception';
import { WorkspaceVersionService } from 'src/engine/workspace-manager/workspace-version/services/workspace-version.service';
import { InjectWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/inject-workspace-scoped-repository.decorator';
import { WorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/workspace-scoped-repository';
@@ -351,8 +353,11 @@ export class ApplicationUpgradeService {
throw error;
}
+ // The message is all the CLI, the front and the job's failedReason show
throw new ApplicationException(
- `Upgrade failed for ${appName}`,
+ error instanceof WorkspaceMigrationBuilderException
+ ? `Upgrade failed for ${appName}. ${formatValidationErrors(error)}`
+ : `Upgrade failed for ${appName}`,
ApplicationExceptionCode.UPGRADE_FAILED,
);
}
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/jobs/trigger-upgrade-application.job.ts b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/jobs/trigger-upgrade-application.job.ts
index 27be6b936eb..0b35336696a 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/jobs/trigger-upgrade-application.job.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/jobs/trigger-upgrade-application.job.ts
@@ -1,4 +1,5 @@
import { ApplicationUpgradeService } from 'src/engine/core-modules/application/application-upgrade/application-upgrade.service';
+import { toApplicationLifecycleJobError } from 'src/engine/core-modules/application/application-install/utils/to-application-lifecycle-job-error.util';
import { Process } from 'src/engine/core-modules/message-queue/decorators/process.decorator';
import { Processor } from 'src/engine/core-modules/message-queue/decorators/processor.decorator';
import { type MessageQueueJobProgressContext } from 'src/engine/core-modules/message-queue/interfaces/message-queue-job.interface';
@@ -21,11 +22,15 @@ export class TriggerUpgradeApplicationJob {
data: TriggerUpgradeApplicationJobData,
{ updateProgress }: MessageQueueJobProgressContext,
): Promise<void> {
- await this.applicationUpgradeService.upgradeApplication({
- appRegistrationId: data.applicationRegistrationId,
- targetVersion: data.targetVersion,
- workspaceId: data.workspaceId,
- updateProgress,
- });
+ try {
+ await this.applicationUpgradeService.upgradeApplication({
+ appRegistrationId: data.applicationRegistrationId,
+ targetVersion: data.targetVersion,
+ workspaceId: data.workspaceId,
+ updateProgress,
+ });
+ } catch (error) {
+ throw toApplicationLifecycleJobError(error);
+ }
}
}
diff --git a/packages/twenty-server/src/engine/metadata-modules/permission-flag/constants/__tests__/standard-permission-flag-definitions.constant.spec.ts b/packages/twenty-server/src/engine/metadata-modules/permission-flag/constants/__tests__/standard-permission-flag-definitions.constant.spec.ts
new file mode 100644
index 00000000000..7858578b70a
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/permission-flag/constants/__tests__/standard-permission-flag-definitions.constant.spec.ts
@@ -0,0 +1,46 @@
+import { STANDARD_PERMISSION_FLAG_DEFINITIONS } from 'src/engine/metadata-modules/permission-flag/constants/standard-permission-flag-definitions.constant';
+
+// Existing workspaces get a new standard flag only from an upgrade command: ship one, then add the key here
+const STANDARD_PERMISSION_FLAG_KEYS_BACKFILLED_IN_EXISTING_WORKSPACES = [
+ 'API_KEYS_AND_WEBHOOKS',
+ 'WORKSPACE',
+ 'WORKSPACE_MEMBERS',
+ 'ROLES',
+ 'DATA_MODEL',
+ 'SECURITY',
+ 'WORKFLOWS',
+ 'IMPERSONATE',
+ 'SSO_BYPASS',
+ 'APPLICATIONS',
+ 'MARKETPLACE_APPS',
+ 'LAYOUTS',
+ 'BILLING',
+ 'AI_SETTINGS',
+ 'AI',
+ 'VIEWS',
+ 'UPLOAD_FILE',
+ 'DOWNLOAD_FILE',
+ 'SEND_EMAIL_TOOL',
+ 'CREATE_CALENDAR_EVENT_TOOL',
+ 'HTTP_REQUEST_TOOL',
+ 'CODE_INTERPRETER_TOOL',
+ 'IMPORT_CSV',
+ 'EXPORT_CSV',
+ 'CONNECTED_ACCOUNTS',
+ 'PROFILE_INFORMATION',
+];
+
+describe('STANDARD_PERMISSION_FLAG_DEFINITIONS', () => {
+ it('only holds flags an upgrade command creates in existing workspaces', () => {
+ expect(
+ STANDARD_PERMISSION_FLAG_DEFINITIONS.map(
+ (standardPermissionFlagDefinition) =>
+ standardPermissionFlagDefinition.key,
+ ).sort(),
+ ).toEqual(
+ [
+ ...STANDARD_PERMISSION_FLAG_KEYS_BACKFILLED_IN_EXISTING_WORKSPACES,
+ ].sort(),
+ );
+ });
+});
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/__tests__/flat-role-permission-flag-validator.service.spec.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/__tests__/flat-role-permission-flag-validator.service.spec.ts
new file mode 100644
index 00000000000..4f95e01a572
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/__tests__/flat-role-permission-flag-validator.service.spec.ts
@@ -0,0 +1,70 @@
+import { type ALL_METADATA_NAME } from 'twenty-shared/metadata';
+import { SystemPermissionFlag } from 'twenty-shared/constants';
+
+import { PermissionsExceptionCode } from 'src/engine/metadata-modules/permissions/permissions.exception';
+import { type UniversalFlatEntityValidationArgs } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/universal-flat-entity-validation-args.type';
+import { FlatRolePermissionFlagValidatorService } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-role-permission-flag-validator.service';
+
+const APPLICATION_UNIVERSAL_IDENTIFIER = 'scheduling-app';
+const ROLE_UNIVERSAL_IDENTIFIER = 'scheduling-app-default-role';
+const UNKNOWN_PERMISSION_FLAG_UNIVERSAL_IDENTIFIER =
+ '20202020-0000-0000-0000-0000000000d4';
+
+const buildCreationArgs = (permissionFlagUniversalIdentifier: string) =>
+ ({
+ flatEntityToValidate: {
+ universalIdentifier: 'role-permission-flag',
+ roleUniversalIdentifier: ROLE_UNIVERSAL_IDENTIFIER,
+ permissionFlagUniversalIdentifier,
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ },
+ optimisticFlatEntityMapsAndRelatedFlatEntityMaps: {
+ flatPermissionFlagMaps: { byUniversalIdentifier: {} },
+ flatRolePermissionFlagMaps: { byUniversalIdentifier: {} },
+ flatRoleMaps: {
+ byUniversalIdentifier: {
+ [ROLE_UNIVERSAL_IDENTIFIER]: {
+ universalIdentifier: ROLE_UNIVERSAL_IDENTIFIER,
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ isEditable: true,
+ },
+ },
+ },
+ },
+ buildOptions: {
+ isSystemBuild: false,
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ },
+ }) as unknown as UniversalFlatEntityValidationArgs<
+ typeof ALL_METADATA_NAME.rolePermissionFlag
+ >;
+
+describe('FlatRolePermissionFlagValidatorService', () => {
+ const validator = new FlatRolePermissionFlagValidatorService();
+
+ it('names the missing standard permission flag when a workspace lacks it', () => {
+ const { errors } = validator.validateFlatRolePermissionFlagCreation(
+ buildCreationArgs(SystemPermissionFlag.CREATE_CALENDAR_EVENT_TOOL),
+ );
+
+ expect(errors).toHaveLength(1);
+ expect(errors[0].code).toBe(PermissionsExceptionCode.INVALID_SETTING);
+ expect(errors[0].message).toBe(
+ `Standard permission flag CREATE_CALENDAR_EVENT_TOOL (${SystemPermissionFlag.CREATE_CALENDAR_EVENT_TOOL}) not found in this workspace. Run the workspace upgrade to create it.`,
+ );
+ expect(errors[0].userFriendlyMessage?.values).toEqual({
+ permissionFlagName: 'CREATE_CALENDAR_EVENT_TOOL',
+ });
+ });
+
+ it('names the missing permission flag by universal identifier when it is not a standard one', () => {
+ const { errors } = validator.validateFlatRolePermissionFlagCreation(
+ buildCreationArgs(UNKNOWN_PERMISSION_FLAG_UNIVERSAL_IDENTIFIER),
+ );
+
+ expect(errors).toHaveLength(1);
+ expect(errors[0].message).toBe(
+ `Permission flag ${UNKNOWN_PERMISSION_FLAG_UNIVERSAL_IDENTIFIER} not found in this workspace`,
+ );
+ });
+});
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-role-permission-flag-validator.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-role-permission-flag-validator.service.ts
index 78df941dd28..aac4ac21773 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-role-permission-flag-validator.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-role-permission-flag-validator.service.ts
@@ -10,6 +10,7 @@ import { FailedFlatEntityValidation } from 'src/engine/workspace-manager/workspa
import { getEmptyFlatEntityValidationError } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/utils/get-flat-entity-validation-error.util';
import { FlatEntityUpdateValidationArgs } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/universal-flat-entity-update-validation-args.type';
import { UniversalFlatEntityValidationArgs } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/universal-flat-entity-validation-args.type';
+import { getPermissionFlagNotFoundError } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/get-permission-flag-not-found-error.util';
import { validateRoleBelongsToCallerApplication } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-role-belongs-to-caller-application.util';
@Injectable()
@@ -87,11 +88,11 @@ export class FlatRolePermissionFlagValidatorService {
});
if (!isDefined(referencedPermissionFlag)) {
- validationResult.errors.push({
- code: PermissionsExceptionCode.INVALID_SETTING,
- message: t`Permission flag not found`,
- userFriendlyMessage: msg`Invalid permission setting`,
- });
+ validationResult.errors.push(
+ getPermissionFlagNotFoundError(
+ flatRolePermissionFlagToValidate.permissionFlagUniversalIdentifier,
+ ),
+ );
}
const duplicateForSameRole = Object.values(
@@ -187,19 +188,21 @@ export class FlatRolePermissionFlagValidatorService {
}
}
- if (isDefined(flatEntityUpdate.permissionFlagUniversalIdentifier)) {
+ const updatedPermissionFlagUniversalIdentifier =
+ flatEntityUpdate.permissionFlagUniversalIdentifier;
+
+ if (isDefined(updatedPermissionFlagUniversalIdentifier)) {
const referencedPermissionFlag = findFlatEntityByUniversalIdentifier({
- universalIdentifier:
- flatEntityUpdate.permissionFlagUniversalIdentifier as string,
+ universalIdentifier: updatedPermissionFlagUniversalIdentifier,
flatEntityMaps: flatPermissionFlagMaps,
});
if (!isDefined(referencedPermissionFlag)) {
- validationResult.errors.push({
- code: PermissionsExceptionCode.INVALID_SETTING,
- message: t`Permission flag not found`,
- userFriendlyMessage: msg`Invalid permission setting`,
- });
+ validationResult.errors.push(
+ getPermissionFlagNotFoundError(
+ updatedPermissionFlagUniversalIdentifier,
+ ),
+ );
}
}
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/get-permission-flag-not-found-error.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/get-permission-flag-not-found-error.util.ts
new file mode 100644
index 00000000000..92b56b37fbc
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/get-permission-flag-not-found-error.util.ts
@@ -0,0 +1,27 @@
+import { msg, t } from '@lingui/core/macro';
+import { isDefined } from 'twenty-shared/utils';
+
+import { STANDARD_PERMISSION_FLAG_DEFINITIONS } from 'src/engine/metadata-modules/permission-flag/constants/standard-permission-flag-definitions.constant';
+import { PermissionsExceptionCode } from 'src/engine/metadata-modules/permissions/permissions.exception';
+import { type FlatEntityValidationError } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/types/failed-flat-entity-validation.type';
+
+export const getPermissionFlagNotFoundError = (
+ permissionFlagUniversalIdentifier: string,
+): FlatEntityValidationError => {
+ const standardPermissionFlagKey = STANDARD_PERMISSION_FLAG_DEFINITIONS.find(
+ (standardPermissionFlagDefinition) =>
+ standardPermissionFlagDefinition.universalIdentifier ===
+ permissionFlagUniversalIdentifier,
+ )?.key;
+
+ const permissionFlagName =
+ standardPermissionFlagKey ?? permissionFlagUniversalIdentifier;
+
+ return {
+ code: PermissionsExceptionCode.INVALID_SETTING,
+ message: isDefined(standardPermissionFlagKey)
+ ? t`Standard permission flag ${standardPermissionFlagKey} (${permissionFlagUniversalIdentifier}) not found in this workspace. Run the workspace upgrade to create it.`
+ : t`Permission flag ${permissionFlagUniversalIdentifier} not found in this workspace`,
+ userFriendlyMessage: msg`Permission flag ${permissionFlagName} is not available in this workspace`,
+ };
+};
diff --git a/packages/twenty-server/test/integration/upgrade/suites/2-53-workspace-command-1793198086907-backfill-standard-permission-flags.integration-spec.ts b/packages/twenty-server/test/integration/upgrade/suites/2-53-workspace-command-1793198086907-backfill-standard-permission-flags.integration-spec.ts
new file mode 100644
index 00000000000..90c23264d01
--- /dev/null
+++ b/packages/twenty-server/test/integration/upgrade/suites/2-53-workspace-command-1793198086907-backfill-standard-permission-flags.integration-spec.ts
@@ -0,0 +1,107 @@
+import { SystemPermissionFlag } from 'twenty-shared/constants';
+
+import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
+import { getCoreRepository } from 'test/integration/utils/get-core-repository.util';
+
+import { type BackfillStandardPermissionFlagsCommand } from 'src/database/commands/upgrade-version-command/2-53/2-53-workspace-command-1793198086907-backfill-standard-permission-flags.command';
+import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
+import { PermissionFlagEntity } from 'src/engine/metadata-modules/permission-flag/permission-flag.entity';
+import { type WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
+import { SEED_APPLE_WORKSPACE_ID } from 'src/engine/workspace-manager/dev-seeder/core/constants/seeder-workspaces.constant';
+import { TWENTY_STANDARD_APPLICATION } from 'src/engine/workspace-manager/twenty-standard-application/constants/twenty-standard-applications';
+
+const RUN_ON_WORKSPACE_ARGS = {
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ options: {},
+ index: 0,
+ total: 1,
+};
+
+const CALENDAR_FLAG_WHERE = {
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ universalIdentifier: SystemPermissionFlag.CREATE_CALENDAR_EVENT_TOOL,
+};
+
+describe('2-53 workspace command - backfill standard permission flags (integration)', () => {
+ let command: BackfillStandardPermissionFlagsCommand;
+ let workspaceCacheService: WorkspaceCacheService;
+
+ const permissionFlagRepository = () =>
+ getCoreRepository<PermissionFlagEntity>(PermissionFlagEntity);
+
+ const invalidatePermissionFlagCache = () =>
+ workspaceCacheService.invalidateAndRecompute(SEED_APPLE_WORKSPACE_ID, [
+ 'flatPermissionFlagMaps',
+ 'flatRolePermissionFlagMaps',
+ ]);
+
+ // Reproduces a workspace created before the flag existed
+ const removeCalendarFlag = async () => {
+ await permissionFlagRepository().delete(CALENDAR_FLAG_WHERE);
+ await invalidatePermissionFlagCache();
+ };
+
+ beforeAll(() => {
+ command = getAppProviderByClassName<BackfillStandardPermissionFlagsCommand>(
+ 'BackfillStandardPermissionFlagsCommand',
+ );
+ workspaceCacheService = getAppProviderByClassName<WorkspaceCacheService>(
+ 'WorkspaceCacheService',
+ );
+ });
+
+ afterAll(async () => {
+ await command.up(RUN_ON_WORKSPACE_ARGS);
+ });
+
+ it('changes nothing on a dry run', async () => {
+ await removeCalendarFlag();
+
+ await command.runOnWorkspace({
+ ...RUN_ON_WORKSPACE_ARGS,
+ options: { dryRun: true },
+ });
+
+ expect(
+ await permissionFlagRepository().count({ where: CALENDAR_FLAG_WHERE }),
+ ).toBe(0);
+ });
+
+ it('creates the missing standard flag on the standard application and is a no-op on a second run', async () => {
+ await removeCalendarFlag();
+
+ const permissionFlagCountBefore = await permissionFlagRepository().count({
+ where: { workspaceId: SEED_APPLE_WORKSPACE_ID },
+ });
+
+ await command.runOnWorkspace(RUN_ON_WORKSPACE_ARGS);
+ await command.runOnWorkspace(RUN_ON_WORKSPACE_ARGS);
+
+ const standardApplication = await getCoreRepository<ApplicationEntity>(
+ ApplicationEntity,
+ ).findOneOrFail({
+ where: {
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ universalIdentifier: TWENTY_STANDARD_APPLICATION.universalIdentifier,
+ },
+ });
+
+ const calendarFlags = await permissionFlagRepository().find({
+ where: CALENDAR_FLAG_WHERE,
+ });
+
+ expect(calendarFlags).toEqual([
+ expect.objectContaining({
+ key: 'CREATE_CALENDAR_EVENT_TOOL',
+ label: 'Create Calendar Event',
+ permissionType: 'tool',
+ applicationId: standardApplication.id,
+ }),
+ ]);
+ expect(
+ await permissionFlagRepository().count({
+ where: { workspaceId: SEED_APPLE_WORKSPACE_ID },
+ }),
+ ).toBe(permissionFlagCountBefore + 1);
+ });
+});