Refactor global datasource part 3 (#16447)

## Context Following https://github.com/twentyhq/twenty/pull/16399 Now using the new global orm manager everywhere and returning a GlobalDatasource/WorkspaceDatasource based on a feature flag. This means we now need to wrap all our ORM calls within executeInWorkspaceContext callback (at least for now) so the global datasource can dynamically hydrate its context via the new store (the global datasource does not store anything related to workspaces as it is now a unique singleton). If feature flag is off it still uses local data stored in the workspace datasource.
2025-12-10 17:17:33 +01:00
parent 4f13022774
commit 9bd8f94b3a
203 changed files with 8887 additions and 7237 deletions
@@ -12,7 +12,7 @@ import { type ConfigVariables } from 'src/engine/core-modules/twenty-config/conf
 import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
 import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
 import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
-import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
+import { GlobalWorkspaceOrmManager } from 'src/engine/twenty-orm/global-workspace-datasource/global-workspace-orm.manager';
 import { SyncWorkspaceMetadataCommand } from 'src/engine/workspace-manager/workspace-sync-metadata/commands/sync-workspace-metadata.command';

 class BasicUpgradeCommandRunner extends UpgradeCommandRunner {
@@ -84,14 +84,14 @@ const buildUpgradeCommandModule = async ({
        useFactory: (
          workspaceRepository: Repository<WorkspaceEntity>,
          twentyConfigService: TwentyConfigService,
-          twentyORMGlobalManager: TwentyORMGlobalManager,
+          globalWorkspaceOrmManager: GlobalWorkspaceOrmManager,
          dataSourceService: DataSourceService,
          syncWorkspaceMetadataCommand: SyncWorkspaceMetadataCommand,
        ) => {
          return new commandRunner(
            workspaceRepository,
            twentyConfigService,
-            twentyORMGlobalManager,
+            globalWorkspaceOrmManager,
            dataSourceService,
            syncWorkspaceMetadataCommand,
          );
@@ -99,7 +99,7 @@ const buildUpgradeCommandModule = async ({
        inject: [
          getRepositoryToken(WorkspaceEntity),
          TwentyConfigService,
-          TwentyORMGlobalManager,
+          GlobalWorkspaceOrmManager,
          DataSourceService,
          SyncWorkspaceMetadataCommand,
        ],
@@ -132,11 +132,14 @@ const buildUpgradeCommandModule = async ({
        },
      },
      {
-        provide: TwentyORMGlobalManager,
+        provide: GlobalWorkspaceOrmManager,
        useValue: {
          connect: jest.fn(),
          destroyDataSourceForWorkspace: jest.fn(),
          getDataSourceForWorkspace: jest.fn(),
+          executeInWorkspaceContext: jest
+            .fn()
+            .mockImplementation((_authContext: any, fn: () => any) => fn()),
        },
      },
      {
@@ -162,7 +165,7 @@ describe('UpgradeCommandRunner', () => {
  let runAfterSyncMetadataSpy: jest.SpyInstance;
  let runBeforeSyncMetadataSpy: jest.SpyInstance;
  let runCoreMigrationsSpy: jest.SpyInstance;
-  let twentyORMGlobalManagerSpy: TwentyORMGlobalManager;
+  let globalWorkspaceOrmManagerSpy: GlobalWorkspaceOrmManager;

  type BuildModuleAndSetupSpiesArgs = {
    numberOfWorkspace?: number;
@@ -215,8 +218,8 @@ describe('UpgradeCommandRunner', () => {
      getRepositoryToken(WorkspaceEntity),
    );
    syncWorkspaceMetadataCommand = module.get(SyncWorkspaceMetadataCommand);
-    twentyORMGlobalManagerSpy = module.get<TwentyORMGlobalManager>(
-      TwentyORMGlobalManager,
+    globalWorkspaceOrmManagerSpy = module.get<GlobalWorkspaceOrmManager>(
+      GlobalWorkspaceOrmManager,
    );
  };

@@ -246,7 +249,7 @@ describe('UpgradeCommandRunner', () => {
    expect(failReport.length).toBe(0);

    [
-      twentyORMGlobalManagerSpy.destroyDataSourceForWorkspace,
+      globalWorkspaceOrmManagerSpy.destroyDataSourceForWorkspace,
      upgradeCommandRunner.runOnWorkspace,
    ].forEach((fn) => expect(fn).toHaveBeenCalledTimes(1));

@@ -278,7 +281,7 @@ describe('UpgradeCommandRunner', () => {
      upgradeCommandRunner.runBeforeSyncMetadata,
      upgradeCommandRunner.runAfterSyncMetadata,
      syncWorkspaceMetadataCommand.runOnWorkspace,
-      twentyORMGlobalManagerSpy.destroyDataSourceForWorkspace,
+      globalWorkspaceOrmManagerSpy.destroyDataSourceForWorkspace,
    ].forEach((fn) => expect(fn).toHaveBeenCalledTimes(numberOfWorkspace));
    expect(workspaceRepository.update).toHaveBeenNthCalledWith(
      numberOfWorkspace,
@@ -303,7 +306,7 @@ describe('UpgradeCommandRunner', () => {
      upgradeCommandRunner.runBeforeSyncMetadata,
      upgradeCommandRunner.runAfterSyncMetadata,
      syncWorkspaceMetadataCommand.runOnWorkspace,
-      twentyORMGlobalManagerSpy.destroyDataSourceForWorkspace,
+      globalWorkspaceOrmManagerSpy.destroyDataSourceForWorkspace,
    ].forEach((fn) => expect(fn).toHaveBeenCalledTimes(1));

    // Verify order of execution
@@ -7,7 +7,7 @@ import {
 } from 'src/database/commands/command-runners/workspaces-migration.command-runner';
 import { type WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
 import { type DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
-import { type TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
+import { type GlobalWorkspaceOrmManager } from 'src/engine/twenty-orm/global-workspace-datasource/global-workspace-orm.manager';

 export type ActiveOrSuspendedWorkspacesMigrationCommandOptions =
  WorkspacesMigrationCommandOptions;
@@ -18,10 +18,10 @@ export abstract class ActiveOrSuspendedWorkspacesMigrationCommandRunner<
 > extends WorkspacesMigrationCommandRunner<Options> {
  constructor(
    protected readonly workspaceRepository: Repository<WorkspaceEntity>,
-    protected readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+    protected readonly globalWorkspaceOrmManager: GlobalWorkspaceOrmManager,
    protected readonly dataSourceService: DataSourceService,
  ) {
-    super(workspaceRepository, twentyORMGlobalManager, dataSourceService, [
+    super(workspaceRepository, globalWorkspaceOrmManager, dataSourceService, [
      WorkspaceActivationStatus.ACTIVE,
      WorkspaceActivationStatus.SUSPENDED,
    ]);
@@ -20,7 +20,7 @@ import {
 import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
 import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
 import { type DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
-import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
+import { GlobalWorkspaceOrmManager } from 'src/engine/twenty-orm/global-workspace-datasource/global-workspace-orm.manager';
 import { SyncWorkspaceMetadataCommand } from 'src/engine/workspace-manager/workspace-sync-metadata/commands/sync-workspace-metadata.command';
 import {
  type CompareVersionMajorAndMinorReturnType,
@@ -52,11 +52,11 @@ export abstract class UpgradeCommandRunner extends ActiveOrSuspendedWorkspacesMi
    @InjectRepository(WorkspaceEntity)
    protected readonly workspaceRepository: Repository<WorkspaceEntity>,
    protected readonly twentyConfigService: TwentyConfigService,
-    protected readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+    protected readonly globalWorkspaceOrmManager: GlobalWorkspaceOrmManager,
    protected readonly dataSourceService: DataSourceService,
    protected readonly syncWorkspaceMetadataCommand: SyncWorkspaceMetadataCommand,
  ) {
-    super(workspaceRepository, twentyORMGlobalManager, dataSourceService);
+    super(workspaceRepository, globalWorkspaceOrmManager, dataSourceService);
  }

  private async loadActiveOrSuspendedWorkspace() {
@@ -1,14 +1,16 @@
 import chalk from 'chalk';
 import { Option } from 'nest-commander';
+import { isDefined } from 'twenty-shared/utils';
 import { WorkspaceActivationStatus } from 'twenty-shared/workspace';
 import { In, MoreThanOrEqual, type Repository } from 'typeorm';
-import { isDefined } from 'twenty-shared/utils';
+
+import { type WorkspaceDataSourceInterface } from 'src/engine/twenty-orm/interfaces/workspace-datasource.interface';

 import { MigrationCommandRunner } from 'src/database/commands/command-runners/migration.command-runner';
 import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
 import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
-import { type WorkspaceDataSource } from 'src/engine/twenty-orm/datasource/workspace.datasource';
-import { type TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
+import { type GlobalWorkspaceOrmManager } from 'src/engine/twenty-orm/global-workspace-datasource/global-workspace-orm.manager';
+import { buildSystemAuthContext } from 'src/engine/twenty-orm/utils/build-system-auth-context.util';

 export type WorkspacesMigrationCommandOptions = {
  workspaceIds: string[];
@@ -21,7 +23,7 @@ export type WorkspacesMigrationCommandOptions = {
 export type RunOnWorkspaceArgs = {
  options: WorkspacesMigrationCommandOptions;
  workspaceId: string;
-  dataSource?: WorkspaceDataSource;
+  dataSource?: WorkspaceDataSourceInterface;
  index: number;
  total: number;
 };
@@ -50,7 +52,7 @@ export abstract class WorkspacesMigrationCommandRunner<

  constructor(
    protected readonly workspaceRepository: Repository<WorkspaceEntity>,
-    protected readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+    protected readonly globalWorkspaceOrmManager: GlobalWorkspaceOrmManager,
    protected readonly dataSourceService: DataSourceService,
    protected readonly activationStatuses: WorkspaceActivationStatus[],
  ) {
@@ -138,24 +140,32 @@ export abstract class WorkspacesMigrationCommandRunner<
      );

      try {
-        const workspaceHasDataSource =
-          await this.dataSourceService.getLastDataSourceMetadataFromWorkspaceId(
-            workspaceId,
-          );
+        const authContext = buildSystemAuthContext(workspaceId);

-        const dataSource = isDefined(workspaceHasDataSource)
-          ? await this.twentyORMGlobalManager.getDataSourceForWorkspace({
+        await this.globalWorkspaceOrmManager.executeInWorkspaceContext(
+          authContext,
+          async () => {
+            const workspaceHasDataSource =
+              await this.dataSourceService.getLastDataSourceMetadataFromWorkspaceId(
+                workspaceId,
+              );
+
+            const dataSource = isDefined(workspaceHasDataSource)
+              ? await this.globalWorkspaceOrmManager.getDataSourceForWorkspace(
+                  workspaceId,
+                )
+              : undefined;
+
+            await this.runOnWorkspace({
+              options,
              workspaceId,
-            })
-          : undefined;
+              dataSource,
+              index: index,
+              total: workspaceIdsToProcess.length,
+            });
+          },
+        );

-        await this.runOnWorkspace({
-          options,
-          workspaceId,
-          dataSource,
-          index: index,
-          total: workspaceIdsToProcess.length,
-        });
        this.migrationReport.success.push({
          workspaceId,
        });
@@ -170,7 +180,7 @@ export abstract class WorkspacesMigrationCommandRunner<
      }

      try {
-        await this.twentyORMGlobalManager.destroyDataSourceForWorkspace(
+        await this.globalWorkspaceOrmManager.destroyDataSourceForWorkspace(
          workspaceId,
        );
      } catch (error) {