feat(server): make workspace Custom application carry an applicationRegistration so custom labels are translatable (#22378)

## Why Custom objects/fields belong to a per-workspace **Custom** application (`workspace.workspaceCustomApplicationId`). That application was created with `applicationRegistrationId = null`. Because the metadata label resolver loads a translation catalog from `core.applicationTranslation` **keyed by `applicationRegistrationId`** (`ApplicationTranslationCacheService.getCatalog` → `applicationTranslationCatalogLoader` → `resolveObjectMetadataStandardOverride` / `resolveFieldMetadataStandardOverride`), the Custom app had no catalog and custom labels always resolved to the raw source string. This is the foundational slice: it wires up the missing key so custom labels can be translated **exactly like any installed third-party app**. The read/resolve path already works once a catalog exists — confirmed end-to-end. `flatApplicationMaps` carries `applicationRegistrationId` straight from the entity column, so setting it + recomputing that cache is all that's needed. ## What changed - **`ApplicationService.createWorkspaceCustomApplication`** now creates a workspace-scoped `applicationRegistration` and links it to the Custom application. This covers both production creation sites (sign-in-up and the dev-seeder), which are the only callers. - **New idempotent workspace upgrade command** `upgrade:2-18:backfill-workspace-custom-application-registration` creates a registration for each existing workspace's Custom application that lacks one and links it. It delegates the registration lifecycle (create + link + `flatApplicationMaps` recompute) to `ApplicationService`, so the command only decides *which* workspaces need it. - New `WORKSPACE_CUSTOM_APPLICATION_NAME` constant; the registration creation lives in `ApplicationService.createWorkspaceCustomApplicationRegistration`. ## Design decisions - **Per-workspace registration (not a shared "custom" registration).** `applicationTranslation` is keyed *only* by `applicationRegistrationId` (cross-workspace). A shared registration would force every workspace's custom translations into one catalog keyed by `generateMessageId(sourceText)`, guaranteeing cross-workspace collisions and leakage (two workspaces both naming an object "Project" would clash). Each workspace's Custom app gets its own registration (`ownerWorkspaceId = workspaceId`, `universalIdentifier = the Custom app's per-workspace uuid`) and thus an isolated catalog — matching installed-app behaviour, where `application.universalIdentifier === registration.universalIdentifier`. - **Source-label keying kept** (`generateMessageId(sourceLabel)`). The resolve path and the third-party manifest pipeline both key catalogs this way. Re-keying by a stable `universalIdentifier` would require changing the shared resolver/dataloader for *all* apps and would break marketplace manifest translations — out of scope for this slice. Consequence: renaming a label orphans its catalog entry (it falls back to the source label until re-translated) — the same behaviour an installed app has when it changes a source string. Re-keying on rename can be handled later by the interactive write path. - **Workspace command (not instance command)** for the backfill: it is per-workspace data logic that must recompute the per-workspace `flatApplicationMaps` cache the resolver reads from. It is idempotent (skips Custom apps that already have a registration), supports `--dry-run`, and is forward-only by design. - **Interactive write path deferred** as an explicit follow-up. This slice proves the read/resolve path; an editor that writes custom translations into `applicationTranslation` (+ cache invalidation) is the natural next step. ## Tests - **Unit test** for the backfill command: creation + linking, idempotency, dry-run, and the skip paths. - **Integration test** (`custom-application-translation.integration-spec.ts`): on a freshly created workspace (so the registration's translation cache is guaranteed cold), it asserts the Custom application is created with a registration, seeds an `applicationTranslation` row, and verifies a custom object's label resolves from that catalog while a label with no catalog entry falls back to its source label. ## Notes for reviewers - No new entity columns or migrations beyond the workspace command — `ApplicationRegistrationEntity` already supports a workspace-scoped `workspaceId`. - The backfill follows the established upgrade-command pattern: it imports `ApplicationModule` and delegates to `ApplicationService` (consistent with the other version-command modules). https://claude.ai/code/session_018heTgu4ew4AJ99VVz4bjqd --- _Generated by [Claude Code](https://claude.ai/code/session_018heTgu4ew4AJ99VVz4bjqd)_  <a href="https://cubic.dev/pr/twentyhq/twenty/pull/22378?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>
2026-06-30 23:08:38 +02:00
parent 52d3735147
commit 1df00698cf
8 changed files with 511 additions and 1 deletions
@@ -0,0 +1,18 @@
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+
+import { WorkspaceIteratorModule } from 'src/database/commands/command-runners/workspace-iterator.module';
+import { BackfillWorkspaceCustomApplicationRegistrationCommand } from 'src/database/commands/upgrade-version-command/2-19/2-19-workspace-command-1820000000000-backfill-workspace-custom-application-registration.command';
+import { ApplicationModule } from 'src/engine/core-modules/application/application.module';
+import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+
+@Module({
+  imports: [
+    ApplicationModule,
+    TypeOrmModule.forFeature([WorkspaceEntity, ApplicationEntity]),
+    WorkspaceIteratorModule,
+  ],
+  providers: [BackfillWorkspaceCustomApplicationRegistrationCommand],
+})
+export class V2_19_UpgradeVersionCommandModule {}
@@ -0,0 +1,99 @@
+import { InjectRepository } from '@nestjs/typeorm';
+
+import { Command } from 'nest-commander';
+import { isDefined } from 'twenty-shared/utils';
+import { Repository } from 'typeorm';
+
+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 { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
+import { ApplicationService } from 'src/engine/core-modules/application/application.service';
+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+import { RegisteredWorkspaceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-workspace-command.decorator';
+
+@RegisteredWorkspaceCommand('2.19.0', 1820000000000)
+@Command({
+  name: 'upgrade:2-19:backfill-workspace-custom-application-registration',
+  description:
+    'Create a workspace-scoped application registration for each existing workspace Custom application so custom object/field labels become translatable.',
+})
+export class BackfillWorkspaceCustomApplicationRegistrationCommand extends ActiveOrSuspendedWorkspaceCommandRunner {
+  constructor(
+    protected readonly workspaceIteratorService: WorkspaceIteratorService,
+    @InjectRepository(WorkspaceEntity)
+    private readonly workspaceRepository: Repository<WorkspaceEntity>,
+    @InjectRepository(ApplicationEntity)
+    private readonly applicationRepository: Repository<ApplicationEntity>,
+    private readonly applicationService: ApplicationService,
+  ) {
+    super(workspaceIteratorService);
+  }
+
+  override async runOnWorkspace({
+    workspaceId,
+    options,
+  }: RunOnWorkspaceArgs): Promise<void> {
+    // Suspended workspaces are soft-deleted, so the row needs withDeleted.
+    const workspace = await this.workspaceRepository.findOne({
+      select: ['id', 'workspaceCustomApplicationId'],
+      where: { id: workspaceId },
+      withDeleted: true,
+    });
+
+    if (!isDefined(workspace)) {
+      this.logger.log(`Workspace ${workspaceId} not found, skipping`);
+
+      return;
+    }
+
+    const customApplication = await this.applicationRepository.findOne({
+      select: ['id', 'universalIdentifier', 'applicationRegistrationId'],
+      where: {
+        id: workspace.workspaceCustomApplicationId,
+        workspaceId,
+      },
+    });
+
+    if (!isDefined(customApplication)) {
+      this.logger.log(
+        `No custom application for workspace ${workspaceId}, skipping`,
+      );
+
+      return;
+    }
+
+    if (isDefined(customApplication.applicationRegistrationId)) {
+      this.logger.log(
+        `Custom application for workspace ${workspaceId} already has a registration, skipping`,
+      );
+
+      return;
+    }
+
+    if (options.dryRun) {
+      this.logger.log(
+        `[DRY RUN] Would create an application registration for workspace ${workspaceId} custom application`,
+      );
+
+      return;
+    }
+
+    const registration =
+      await this.applicationService.createWorkspaceCustomApplicationRegistration(
+        {
+          workspaceId,
+          universalIdentifier: customApplication.universalIdentifier,
+        },
+      );
+
+    await this.applicationService.update(customApplication.id, {
+      applicationRegistrationId: registration.id,
+      workspaceId,
+    });
+
+    this.logger.log(
+      `Created application registration ${registration.id} for workspace ${workspaceId} custom application`,
+    );
+  }
+}
@@ -0,0 +1,135 @@
+import { type Repository } from 'typeorm';
+
+import { type WorkspaceIteratorService } from 'src/database/commands/command-runners/workspace-iterator.service';
+import { BackfillWorkspaceCustomApplicationRegistrationCommand } from 'src/database/commands/upgrade-version-command/2-19/2-19-workspace-command-1820000000000-backfill-workspace-custom-application-registration.command';
+import { type ApplicationService } from 'src/engine/core-modules/application/application.service';
+import { type ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
+import { type WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+
+const WORKSPACE_ID = '20202020-0000-0000-0000-000000000001';
+const CUSTOM_APPLICATION_ID = '20202020-0000-0000-0000-0000000000a1';
+
+describe('BackfillWorkspaceCustomApplicationRegistrationCommand', () => {
+  let command: BackfillWorkspaceCustomApplicationRegistrationCommand;
+  let workspaceFindOne: jest.Mock;
+  let applicationFindOne: jest.Mock;
+  let createRegistration: jest.Mock;
+  let updateApplication: jest.Mock;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+
+    workspaceFindOne = jest.fn();
+    applicationFindOne = jest.fn();
+    createRegistration = jest.fn().mockResolvedValue({ id: 'registration-1' });
+    updateApplication = jest.fn();
+
+    const workspaceRepository = {
+      findOne: workspaceFindOne,
+    } as unknown as Repository<WorkspaceEntity>;
+    const applicationRepository = {
+      findOne: applicationFindOne,
+    } as unknown as Repository<ApplicationEntity>;
+    const applicationService = {
+      createWorkspaceCustomApplicationRegistration: createRegistration,
+      update: updateApplication,
+    } as unknown as ApplicationService;
+
+    command = new BackfillWorkspaceCustomApplicationRegistrationCommand(
+      {} as WorkspaceIteratorService,
+      workspaceRepository,
+      applicationRepository,
+      applicationService,
+    );
+
+    jest.spyOn(command['logger'], 'log').mockImplementation();
+  });
+
+  const runOnWorkspace = (dryRun = false) =>
+    command.runOnWorkspace({
+      workspaceId: WORKSPACE_ID,
+      options: { dryRun },
+      index: 0,
+      total: 1,
+    });
+
+  it('creates a registration through ApplicationService and links it to the custom application', async () => {
+    workspaceFindOne.mockResolvedValue({
+      id: WORKSPACE_ID,
+      workspaceCustomApplicationId: CUSTOM_APPLICATION_ID,
+    });
+    applicationFindOne.mockResolvedValue({
+      id: CUSTOM_APPLICATION_ID,
+      universalIdentifier: CUSTOM_APPLICATION_ID,
+      applicationRegistrationId: null,
+    });
+
+    await runOnWorkspace();
+
+    expect(createRegistration).toHaveBeenCalledWith({
+      workspaceId: WORKSPACE_ID,
+      universalIdentifier: CUSTOM_APPLICATION_ID,
+    });
+    expect(updateApplication).toHaveBeenCalledWith(CUSTOM_APPLICATION_ID, {
+      applicationRegistrationId: 'registration-1',
+      workspaceId: WORKSPACE_ID,
+    });
+  });
+
+  it('is idempotent: skips when the custom application already has a registration', async () => {
+    workspaceFindOne.mockResolvedValue({
+      id: WORKSPACE_ID,
+      workspaceCustomApplicationId: CUSTOM_APPLICATION_ID,
+    });
+    applicationFindOne.mockResolvedValue({
+      id: CUSTOM_APPLICATION_ID,
+      universalIdentifier: CUSTOM_APPLICATION_ID,
+      applicationRegistrationId: 'existing-registration',
+    });
+
+    await runOnWorkspace();
+
+    expect(createRegistration).not.toHaveBeenCalled();
+    expect(updateApplication).not.toHaveBeenCalled();
+  });
+
+  it('does not write anything in dry-run mode', async () => {
+    workspaceFindOne.mockResolvedValue({
+      id: WORKSPACE_ID,
+      workspaceCustomApplicationId: CUSTOM_APPLICATION_ID,
+    });
+    applicationFindOne.mockResolvedValue({
+      id: CUSTOM_APPLICATION_ID,
+      universalIdentifier: CUSTOM_APPLICATION_ID,
+      applicationRegistrationId: null,
+    });
+
+    await runOnWorkspace(true);
+
+    expect(createRegistration).not.toHaveBeenCalled();
+    expect(updateApplication).not.toHaveBeenCalled();
+  });
+
+  it('skips when the workspace row cannot be found', async () => {
+    workspaceFindOne.mockResolvedValue(null);
+
+    await runOnWorkspace();
+
+    expect(applicationFindOne).not.toHaveBeenCalled();
+    expect(createRegistration).not.toHaveBeenCalled();
+    expect(updateApplication).not.toHaveBeenCalled();
+  });
+
+  it('skips when the custom application row cannot be found', async () => {
+    workspaceFindOne.mockResolvedValue({
+      id: WORKSPACE_ID,
+      workspaceCustomApplicationId: CUSTOM_APPLICATION_ID,
+    });
+    applicationFindOne.mockResolvedValue(null);
+
+    await runOnWorkspace();
+
+    expect(createRegistration).not.toHaveBeenCalled();
+    expect(updateApplication).not.toHaveBeenCalled();
+  });
+});
@@ -19,6 +19,7 @@ import { V2_15_UpgradeVersionCommandModule } from 'src/database/commands/upgrade
 import { V2_16_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-16/2-16-upgrade-version-command.module';
 import { V2_17_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-17/2-17-upgrade-version-command.module';
 import { V2_18_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-18/2-18-upgrade-version-command.module';
+import { V2_19_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/2-19/2-19-upgrade-version-command.module';

@Module({
  imports: [
@@ -41,6 +42,7 @@ import { V2_18_UpgradeVersionCommandModule } from 'src/database/commands/upgrade
    V2_16_UpgradeVersionCommandModule,
    V2_17_UpgradeVersionCommandModule,
    V2_18_UpgradeVersionCommandModule,
+    V2_19_UpgradeVersionCommandModule,
  ],
 })
 export class WorkspaceCommandProviderModule {}