Improve migration runner performances (#10572)
## Context Workspace creation and more specifically sync-metadata performances are bad at the moment. We are trying to identify bottlenecks and one of the root causes is the migration runner that can take up to 10s when setting up a new workspaces with all its tables. First observation is we do a lot of things sequentially, mostly to make the code easier to read and debug but it impacts performances. For example, a table creation is done in two steps, we first ask typeorm to create the table then ask typeorm to create columns (and sometimes columns one by one), each instruction can take time because typeorm seems to do some checks internally. The proposition here is to try to merge migrations when possible, for example when we create a table we want the migration to also contain the columns it will contain so we can ask typeorm to add the columns at the same time. We are also using batch operations when possible (addColumns instead of addColumn, dropColumns instead of dropColumn) Still, we could go further with foreign keys creations or/and try with raw query directly. ## Test New workspace creation: See screenshot, 9865.40233296156ms is on main, the rest is after the changes: <img width="610" alt="Screenshot 2025-02-28 at 09 27 21" src="https://github.com/user-attachments/assets/42e880ff-279e-4170-b705-009e4b72045c" /> ResetDB and Sync-metadata on an existing workspace commands still work
This commit is contained in:
@ -2,22 +2,22 @@ import { Injectable } from '@nestjs/common';
|
||||
|
||||
import { EntityManager } from 'typeorm';
|
||||
|
||||
import { WorkspaceSyncContext } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/workspace-sync-context.interface';
|
||||
import { FeatureFlagMap } from 'src/engine/core-modules/feature-flag/interfaces/feature-flag-map.interface';
|
||||
import { ComparatorAction } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/comparator.interface';
|
||||
import { WorkspaceMigrationBuilderAction } from 'src/engine/workspace-manager/workspace-migration-builder/interfaces/workspace-migration-builder-action.interface';
|
||||
import { ComparatorAction } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/comparator.interface';
|
||||
import { WorkspaceSyncContext } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/workspace-sync-context.interface';
|
||||
|
||||
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
|
||||
import { RelationMetadataEntity } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
|
||||
import { mapObjectMetadataByUniqueIdentifier } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/sync-metadata.util';
|
||||
import { StandardRelationFactory } from 'src/engine/workspace-manager/workspace-sync-metadata/factories/standard-relation.factory';
|
||||
import { WorkspaceRelationComparator } from 'src/engine/workspace-manager/workspace-sync-metadata/comparators/workspace-relation.comparator';
|
||||
import { WorkspaceMetadataUpdaterService } from 'src/engine/workspace-manager/workspace-sync-metadata/services/workspace-metadata-updater.service';
|
||||
import { WorkspaceMigrationEntity } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
|
||||
import { WorkspaceSyncStorage } from 'src/engine/workspace-manager/workspace-sync-metadata/storage/workspace-sync.storage';
|
||||
import { WorkspaceMigrationRelationFactory } from 'src/engine/workspace-manager/workspace-migration-builder/factories/workspace-migration-relation.factory';
|
||||
import { standardObjectMetadataDefinitions } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects';
|
||||
import { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
|
||||
import { WorkspaceMigrationRelationFactory } from 'src/engine/workspace-manager/workspace-migration-builder/factories/workspace-migration-relation.factory';
|
||||
import { WorkspaceRelationComparator } from 'src/engine/workspace-manager/workspace-sync-metadata/comparators/workspace-relation.comparator';
|
||||
import { StandardRelationFactory } from 'src/engine/workspace-manager/workspace-sync-metadata/factories/standard-relation.factory';
|
||||
import { WorkspaceMetadataUpdaterService } from 'src/engine/workspace-manager/workspace-sync-metadata/services/workspace-metadata-updater.service';
|
||||
import { standardObjectMetadataDefinitions } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects';
|
||||
import { WorkspaceSyncStorage } from 'src/engine/workspace-manager/workspace-sync-metadata/storage/workspace-sync.storage';
|
||||
import { mapObjectMetadataByUniqueIdentifier } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/sync-metadata.util';
|
||||
|
||||
@Injectable()
|
||||
export class WorkspaceSyncRelationMetadataService {
|
||||
|
||||
@ -1,14 +1,16 @@
|
||||
import { Injectable, Logger } from '@nestjs/common';
|
||||
import { InjectDataSource, InjectRepository } from '@nestjs/typeorm';
|
||||
import { InjectDataSource } from '@nestjs/typeorm';
|
||||
|
||||
import { DataSource, QueryFailedError, Repository } from 'typeorm';
|
||||
import { DataSource, QueryFailedError } from 'typeorm';
|
||||
|
||||
import { WorkspaceSyncContext } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/workspace-sync-context.interface';
|
||||
|
||||
import { FeatureFlag } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
|
||||
import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
|
||||
import { WorkspaceMetadataVersionService } from 'src/engine/metadata-modules/workspace-metadata-version/services/workspace-metadata-version.service';
|
||||
import { WorkspaceMigrationEntity } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
|
||||
import {
|
||||
WorkspaceMigrationEntity,
|
||||
WorkspaceMigrationTableActionType,
|
||||
} from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
|
||||
import { WorkspaceMigrationRunnerService } from 'src/engine/workspace-manager/workspace-migration-runner/workspace-migration-runner.service';
|
||||
import { WorkspaceSyncFieldMetadataService } from 'src/engine/workspace-manager/workspace-sync-metadata/services/workspace-sync-field-metadata.service';
|
||||
import { WorkspaceSyncIndexMetadataService } from 'src/engine/workspace-manager/workspace-sync-metadata/services/workspace-sync-index-metadata.service';
|
||||
@ -36,8 +38,6 @@ export class WorkspaceSyncMetadataService {
|
||||
private readonly workspaceSyncIndexMetadataService: WorkspaceSyncIndexMetadataService,
|
||||
private readonly workspaceSyncObjectMetadataIdentifiersService: WorkspaceSyncObjectMetadataIdentifiersService,
|
||||
private readonly workspaceMetadataVersionService: WorkspaceMetadataVersionService,
|
||||
@InjectRepository(FeatureFlag, 'core')
|
||||
private readonly featureFlagRepository: Repository<FeatureFlag>,
|
||||
) {}
|
||||
|
||||
/**
|
||||
@ -112,6 +112,15 @@ export class WorkspaceSyncMetadataService {
|
||||
`Workspace field migrations took ${workspaceFieldMigrationsEnd - workspaceFieldMigrationsStart}ms`,
|
||||
);
|
||||
|
||||
// Merge object and field migrations during table creation
|
||||
const {
|
||||
objectMigrations: mergedObjectMigrations,
|
||||
fieldMigrations: mergedFieldMigrations,
|
||||
} = this.mergeMigrations({
|
||||
objectMigrations: workspaceObjectMigrations,
|
||||
fieldMigrations: workspaceFieldMigrations,
|
||||
});
|
||||
|
||||
// 3 - Sync standard relations on standard and custom objects
|
||||
const workspaceRelationMigrationsStart = performance.now();
|
||||
const workspaceRelationMigrations =
|
||||
@ -164,8 +173,8 @@ export class WorkspaceSyncMetadataService {
|
||||
|
||||
// Save workspace migrations into the database
|
||||
workspaceMigrations = await workspaceMigrationRepository.save([
|
||||
...workspaceObjectMigrations,
|
||||
...workspaceFieldMigrations,
|
||||
...mergedObjectMigrations,
|
||||
...mergedFieldMigrations,
|
||||
...workspaceRelationMigrations,
|
||||
...workspaceIndexMigrations,
|
||||
]);
|
||||
@ -223,4 +232,62 @@ export class WorkspaceSyncMetadataService {
|
||||
storage,
|
||||
};
|
||||
}
|
||||
|
||||
private mergeMigrations({
|
||||
objectMigrations,
|
||||
fieldMigrations,
|
||||
}: {
|
||||
objectMigrations: Partial<WorkspaceMigrationEntity>[];
|
||||
fieldMigrations: Partial<WorkspaceMigrationEntity>[];
|
||||
}): {
|
||||
objectMigrations: Partial<WorkspaceMigrationEntity>[];
|
||||
fieldMigrations: Partial<WorkspaceMigrationEntity>[];
|
||||
} {
|
||||
const createMigrationsByTable = new Map<string, any>();
|
||||
|
||||
for (const objectMigration of objectMigrations) {
|
||||
if (
|
||||
!objectMigration.migrations ||
|
||||
objectMigration.migrations.length === 0
|
||||
)
|
||||
continue;
|
||||
|
||||
const tableMigration = objectMigration.migrations[0];
|
||||
|
||||
if (tableMigration.action === WorkspaceMigrationTableActionType.CREATE) {
|
||||
createMigrationsByTable.set(tableMigration.name, tableMigration);
|
||||
}
|
||||
}
|
||||
|
||||
const fieldMigrationsWithoutTableCreation = fieldMigrations.filter(
|
||||
(fieldMigration) => {
|
||||
if (
|
||||
!fieldMigration.migrations ||
|
||||
fieldMigration.migrations.length === 0
|
||||
)
|
||||
return true;
|
||||
|
||||
const tableMigration = fieldMigration.migrations[0];
|
||||
const tableName = tableMigration.name;
|
||||
|
||||
if (createMigrationsByTable.has(tableName)) {
|
||||
const createMigration = createMigrationsByTable.get(tableName);
|
||||
|
||||
if (tableMigration.columns?.length) {
|
||||
createMigration.columns = createMigration.columns || [];
|
||||
createMigration.columns.push(...tableMigration.columns);
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
},
|
||||
);
|
||||
|
||||
return {
|
||||
objectMigrations,
|
||||
fieldMigrations: fieldMigrationsWithoutTableCreation,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user