The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
perf(server): bump metadata version only when object or field metadata changes (#27265)
Charles Bocheta3e874920cfa
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.tsindex 0c70e2b4fe8..775da8ce4d8 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts@@ -27,6 +27,7 @@ import {WorkspaceMigrationRunnerExceptionCode,} from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/exceptions/workspace-migration-runner.exception';import { InFlightDeferredWorkspaceMigrationActionsService } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/in-flight-deferred-workspace-migration-actions.service';+import { SCHEMA_AFFECTING_WORKSPACE_MIGRATION_METADATA_NAMES } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/constants/schema-affecting-workspace-migration-metadata-names.constant';import { isSchemaAffectingWorkspaceMigration } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/utils/is-schema-affecting-workspace-migration.util';import { WorkspaceMigrationRunnerActionHandlerRegistryService } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/registry/workspace-migration-runner-action-handler-registry.service';import { DeferredWorkspaceMigrationActionRunnerService } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/deferred-workspace-migration-action-runner.service';@@ -52,55 +53,38 @@ export class WorkspaceMigrationRunnerService {private readonly inFlightDeferredWorkspaceMigrationActionsService: InFlightDeferredWorkspaceMigrationActionsService,) {}- private getLegacyCacheInvalidation(- allFlatEntityMapsKeys: (keyof AllFlatEntityMaps)[],- ): {- shouldIncrementMetadataGraphqlSchemaVersion: boolean;- legacyCacheKeyNames: WorkspaceCacheKeyName[];- } {- const flatMapsKeysSet = new Set(allFlatEntityMapsKeys);- const legacyCacheKeyNames: WorkspaceCacheKeyName[] = [];-- const shouldIncrementMetadataGraphqlSchemaVersion =- flatMapsKeysSet.has('flatObjectMetadataMaps') ||- flatMapsKeysSet.has('flatFieldMetadataMaps');-- const shouldInvalidateRolesPermissionsCache =- flatMapsKeysSet.has('flatRoleMaps') ||- flatMapsKeysSet.has('flatRoleTargetMaps') ||- flatMapsKeysSet.has('flatObjectPermissionMaps') ||- flatMapsKeysSet.has('flatFieldPermissionMaps') ||- flatMapsKeysSet.has('flatRolePermissionFlagMaps');-- if (shouldInvalidateRolesPermissionsCache) {- legacyCacheKeyNames.push('rolesPermissions');- }-- return {- shouldIncrementMetadataGraphqlSchemaVersion,- legacyCacheKeyNames,- };- }-async invalidateCache({allFlatEntityMapsKeys,workspaceId,+ hasSchemaMetadataChanged = SCHEMA_AFFECTING_WORKSPACE_MIGRATION_METADATA_NAMES.some(+ (metadataName) =>+ allFlatEntityMapsKeys.includes(+ getMetadataFlatEntityMapsKey(metadataName),+ ),+ ),}: {allFlatEntityMapsKeys: (keyof AllFlatEntityMaps)[];workspaceId: string;+ hasSchemaMetadataChanged?: boolean;}): Promise<void> {this.logger.perfTime('Runner',`Cache invalidation ${allFlatEntityMapsKeys.join()}`,);- const { shouldIncrementMetadataGraphqlSchemaVersion, legacyCacheKeyNames } =- this.getLegacyCacheInvalidation(allFlatEntityMapsKeys);+ const hasRolesPermissionsChanged = allFlatEntityMapsKeys.some(+ (flatEntityMapsKey) =>+ flatEntityMapsKey === 'flatRoleMaps' ||+ flatEntityMapsKey === 'flatRoleTargetMaps' ||+ flatEntityMapsKey === 'flatObjectPermissionMaps' ||+ flatEntityMapsKey === 'flatFieldPermissionMaps' ||+ flatEntityMapsKey === 'flatRolePermissionFlagMaps',+ );- const cacheKeyNamesToInvalidate = [+ const cacheKeyNamesToInvalidate: WorkspaceCacheKeyName[] = [...new Set([...withDerivedFieldMetadataMaps(allFlatEntityMapsKeys),- ...legacyCacheKeyNames,+ ...(hasRolesPermissionsChanged ? ['rolesPermissions' as const] : []),]),];@@ -109,7 +93,7 @@ export class WorkspaceMigrationRunnerService {cacheKeyNamesToInvalidate,);- if (shouldIncrementMetadataGraphqlSchemaVersion) {+ if (hasSchemaMetadataChanged) {await this.workspaceMetadataVersionService.incrementMetadataVersion(workspaceId,);@@ -263,6 +247,8 @@ export class WorkspaceMigrationRunnerService {const actionMetadataNames = [...new Set(actions.flatMap((action) => action.metadataName)),];+ const hasSchemaMetadataChanged =+ isSchemaAffectingWorkspaceMigration(actions);const hasSearchVectorRebuildAction = actions.some((action) =>@@ -514,6 +500,7 @@ export class WorkspaceMigrationRunnerService {await this.invalidateCache({allFlatEntityMapsKeys,workspaceId,+ hasSchemaMetadataChanged,});} catch (cacheError) {this.logger.error(@@ -543,6 +530,7 @@ export class WorkspaceMigrationRunnerService {await this.invalidateCache({allFlatEntityMapsKeys,workspaceId,+ hasSchemaMetadataChanged,});this.recordRunPhaseMetric({@@ -581,10 +569,6 @@ export class WorkspaceMigrationRunnerService {},);- const hasSchemaMetadataChanged =- allFlatEntityMapsKeys.includes('flatObjectMetadataMaps') ||- allFlatEntityMapsKeys.includes('flatFieldMetadataMaps');-this.logger.perfTimeEnd('Runner', 'Total execution');return {diff --git a/packages/twenty-server/test/integration/metadata/suites/workspace-metadata-version/workspace-metadata-version.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/workspace-metadata-version/workspace-metadata-version.integration-spec.tsnew file mode 100644index 00000000000..eadd80ba268--- /dev/null+++ b/packages/twenty-server/test/integration/metadata/suites/workspace-metadata-version/workspace-metadata-version.integration-spec.ts@@ -0,0 +1,103 @@+import { createTestViewWithGraphQL } from 'test/integration/graphql/utils/view-graphql.util';+import { createOneFieldMetadata } from 'test/integration/metadata/suites/field-metadata/utils/create-one-field-metadata.util';+import { createOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/create-one-object-metadata.util';+import { deleteOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/delete-one-object-metadata.util';+import { updateOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/update-one-object-metadata.util';+import { createOneViewFilter } from 'test/integration/metadata/suites/view-filter/utils/create-one-view-filter.util';+import { FieldMetadataType, ViewFilterOperand } from 'twenty-shared/types';++import { SEED_APPLE_WORKSPACE_ID } from 'src/engine/workspace-manager/dev-seeder/core/constants/seeder-workspaces.constant';++const getMetadataVersion = async (): Promise<number> => {+ const [{ metadataVersion }] = await global.testDataSource.query(+ `SELECT "metadataVersion" FROM core.workspace WHERE id = $1`,+ [SEED_APPLE_WORKSPACE_ID],+ );++ return metadataVersion;+};++describe('Workspace metadata version', () => {+ let objectMetadataId: string;+ let fieldMetadataId: string;++ beforeAll(async () => {+ const { data: objectData } = await createOneObjectMetadata({+ expectToFail: false,+ input: {+ nameSingular: 'metadataVersionTestObject',+ namePlural: 'metadataVersionTestObjects',+ labelSingular: 'Metadata Version Test Object',+ labelPlural: 'Metadata Version Test Objects',+ icon: 'IconBox',+ },+ });++ objectMetadataId = objectData.createOneObject.id;++ const { data: fieldData } = await createOneFieldMetadata({+ expectToFail: false,+ input: {+ name: 'testField',+ label: 'Test Field',+ type: FieldMetadataType.TEXT,+ objectMetadataId,+ isLabelSyncedWithName: true,+ },+ });++ fieldMetadataId = fieldData.createOneField.id;+ });++ afterAll(async () => {+ await updateOneObjectMetadata({+ expectToFail: false,+ input: {+ idToUpdate: objectMetadataId,+ updatePayload: { isActive: false },+ },+ });+ await deleteOneObjectMetadata({+ expectToFail: false,+ input: { idToDelete: objectMetadataId },+ });+ });++ it('should not bump the metadata version when a view filter is created', async () => {+ const view = await createTestViewWithGraphQL({+ name: 'Metadata version test view',+ objectMetadataId,+ });++ const versionBefore = await getMetadataVersion();++ await createOneViewFilter({+ expectToFail: false,+ input: {+ fieldMetadataId,+ viewId: view.id,+ operand: ViewFilterOperand.CONTAINS,+ value: 'test',+ },+ });++ expect(await getMetadataVersion()).toBe(versionBefore);+ });++ it('should bump the metadata version when a field is created', async () => {+ const versionBefore = await getMetadataVersion();++ await createOneFieldMetadata({+ expectToFail: false,+ input: {+ name: 'otherTestField',+ label: 'Other Test Field',+ type: FieldMetadataType.TEXT,+ objectMetadataId,+ isLabelSyncedWithName: true,+ },+ });++ expect(await getMetadataVersion()).toBeGreaterThan(versionBefore);+ });+});