Skip to content

The open alternative to Salesforce, designed for AI.

refactor(server): remove the no-op ORMEntityMetadatas workspace cache (#27266)

Charles Bochetddd166250b03
diff --git a/packages/twenty-server/src/engine/twenty-orm/twenty-orm.module.ts b/packages/twenty-server/src/engine/twenty-orm/twenty-orm.module.ts
index ef88e627814..ca31c635d3c 100644
--- a/packages/twenty-server/src/engine/twenty-orm/twenty-orm.module.ts
+++ b/packages/twenty-server/src/engine/twenty-orm/twenty-orm.module.ts
@@ -13,7 +13,6 @@ import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { WorkspaceFeatureFlagsMapCacheModule } from 'src/engine/metadata-modules/workspace-feature-flags-map-cache/workspace-feature-flags-map-cache.module';
import { WorkspaceOrmManager } from 'src/engine/twenty-orm/workspace-orm.manager';
-import { WorkspaceORMEntityMetadatasCacheService } from 'src/engine/twenty-orm/workspace-orm-entity-metadatas-cache.service';
import { provideWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/provide-workspace-scoped-repository';
import { WorkspaceDataSourceService } from 'src/engine/twenty-orm/datasource/workspace-data-source.service';
import { WorkspaceCacheStorageModule } from 'src/engine/workspace-cache-storage/workspace-cache-storage.module';
@@ -43,7 +42,6 @@ import { WorkspaceEventEmitterModule } from 'src/engine/workspace-event-emitter/
providers: [
WorkspaceOrmManager,
WorkspaceDataSourceService,
- WorkspaceORMEntityMetadatasCacheService,
provideWorkspaceScopedRepository(FeatureFlagEntity),
],
exports: [WorkspaceOrmManager],
diff --git a/packages/twenty-server/src/engine/twenty-orm/workspace-orm-entity-metadatas-cache.service.ts b/packages/twenty-server/src/engine/twenty-orm/workspace-orm-entity-metadatas-cache.service.ts
deleted file mode 100644
index 8dd1744197c..00000000000
--- a/packages/twenty-server/src/engine/twenty-orm/workspace-orm-entity-metadatas-cache.service.ts
+++ /dev/null
@@ -1,23 +0,0 @@
-import { Injectable } from '@nestjs/common';
-
-import { type EntityMetadata } from 'typeorm';
-
-import { WorkspaceCacheProvider } from 'src/engine/workspace-cache/interfaces/workspace-cache-provider.service';
-
-import { WorkspaceCache } from 'src/engine/workspace-cache/decorators/workspace-cache.decorator';
-
-// The v1 TypeORM EntityMetadata graph is no longer built now that the ORM v2
-// read/write path is the only path. The cache key is kept because committed
-// upgrade commands and the migration runner still invalidate it.
-@Injectable()
-@WorkspaceCache('ORMEntityMetadatas', {
- localDataOnly: true,
- packingPonderation: 128,
-})
-export class WorkspaceORMEntityMetadatasCacheService extends WorkspaceCacheProvider<
- EntityMetadata[]
-> {
- async computeForCache(): Promise<EntityMetadata[]> {
- return [];
- }
-}
diff --git a/packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts b/packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts
index 8d4458d1d25..d85096d77a0 100644
--- a/packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts
+++ b/packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts
@@ -38,6 +38,7 @@ import {
WorkspaceCacheKeyName,
type WorkspaceCacheDataMap,
type WorkspaceCacheOrDerivedCacheDataMap,
+ type RemovedWorkspaceCacheKeyName,
type WorkspaceCacheOrDerivedCacheKeyName,
type WorkspaceCacheResult,
type WorkspaceCacheResultWithHashes,
@@ -70,9 +71,8 @@ const LOCAL_CACHE_SWEEP_INTERVAL_MS = 60 * 1000;
const PACKING_INTERVAL_MS = 500;
const PACKING_PONDERATION_BUDGET = 64;
const MIN_IDLE_BEFORE_PACKING_MS = 60 * 1000;
-// Per-cache-key entry caps; ORM graphs are ~5 MB each
+// Per-cache-key entry caps
const MAX_LOCAL_ENTRIES_BY_KEY_NAME = new Map<string, number>([
- ['ORMEntityMetadatas', 128],
['flatFieldMetadataMaps', 256],
['flatFieldMetadataMapsOrm', 512],
]);
@@ -471,10 +471,14 @@ export class WorkspaceCacheService implements OnModuleInit, OnModuleDestroy {
public async flush(
workspaceId: string,
- cacheKeyNames: WorkspaceCacheOrDerivedCacheKeyName[],
+ cacheKeyNames: (
+ | WorkspaceCacheOrDerivedCacheKeyName
+ | RemovedWorkspaceCacheKeyName
+ )[],
): Promise<void> {
const storedCacheKeyNames = cacheKeyNames.filter(
(cacheKeyName): cacheKeyName is WorkspaceCacheKeyName =>
+ cacheKeyName !== 'ORMEntityMetadatas' &&
!isWorkspaceDerivedCacheKeyName(cacheKeyName),
);
diff --git a/packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts b/packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts
index 2e7152a010a..7aa4ec256f5 100644
--- a/packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts
+++ b/packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts
@@ -2,7 +2,6 @@ import {
type FeatureFlagKey,
type ObjectsPermissionsByRoleId,
} from 'twenty-shared/types';
-import { type EntityMetadata } from 'typeorm';
import { type CompactFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/types/compact-flat-field-metadata-maps.type';
import { type OrmFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/orm-flat-field-metadata.type';
@@ -27,7 +26,6 @@ export type AdditionalCacheDataMaps = {
rolesPermissions: ObjectsPermissionsByRoleId;
apiKeyMap: Record<string, FlatApiKey>;
flatApplicationMaps: FlatApplicationCacheMaps;
- ORMEntityMetadatas: EntityMetadata[];
flatFieldMetadataMapsOrm: FlatEntityMaps<OrmFlatFieldMetadata>;
flatRowLevelPermissionPredicateMaps: FlatRowLevelPermissionPredicateMaps;
flatRowLevelPermissionPredicateGroupMaps: FlatRowLevelPermissionPredicateGroupMaps;
@@ -43,6 +41,9 @@ export type WorkspaceCacheDataMap = AllFlatEntityMaps<true> &
export type WorkspaceCacheKeyName = keyof WorkspaceCacheDataMap;
+// TODO: remove once the 2.8 upgrade command that flushes this key is removed
+export type RemovedWorkspaceCacheKeyName = 'ORMEntityMetadatas';
+
export type WorkspaceDerivedCacheDataMap = {
roleIdsWithAllRecordsAccess: string[];
userWorkspaceRoleMap: UserWorkspaceRoleMap;
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.ts
index 4be0c658257..0c70e2b4fe8 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
@@ -65,10 +65,6 @@ export class WorkspaceMigrationRunnerService {
flatMapsKeysSet.has('flatObjectMetadataMaps') ||
flatMapsKeysSet.has('flatFieldMetadataMaps');
- if (shouldIncrementMetadataGraphqlSchemaVersion) {
- legacyCacheKeyNames.push('ORMEntityMetadatas');
- }
-
const shouldInvalidateRolesPermissionsCache =
flatMapsKeysSet.has('flatRoleMaps') ||
flatMapsKeysSet.has('flatRoleTargetMaps') ||