Fix object metadata collection not found (#11306)

## Context
This fix ensures that even if a datasource creation promise throws and
is cached, subsequent requests won't return that cached exception.
Also adding a TTL on MetadataObjectMetadataOngoingCachingLock, this is
not something that should stay in the cache forever and could
potentially unlock some race conditions (the origin of the issue is
probably due to performances where the lock is not removed as it should
be after metadata computation and caching)
This commit is contained in:
Weiko
2025-04-01 16:38:43 +02:00
committed by GitHub
parent 7e07b3f7e9
commit 8385e2d08b
6 changed files with 399 additions and 205 deletions

View File

@ -1,6 +1,7 @@
import { CACHE_MANAGER, Cache } from '@nestjs/cache-manager'; import { CACHE_MANAGER, Cache } from '@nestjs/cache-manager';
import { Inject, Injectable } from '@nestjs/common'; import { Inject, Injectable } from '@nestjs/common';
import { Milliseconds } from 'cache-manager';
import { RedisCache } from 'cache-manager-redis-yet'; import { RedisCache } from 'cache-manager-redis-yet';
import { CacheStorageNamespace } from 'src/engine/core-modules/cache-storage/types/cache-storage-namespace.enum'; import { CacheStorageNamespace } from 'src/engine/core-modules/cache-storage/types/cache-storage-namespace.enum';
@ -17,7 +18,7 @@ export class CacheStorageService {
return this.cache.get(`${this.namespace}:${key}`); return this.cache.get(`${this.namespace}:${key}`);
} }
async set<T>(key: string, value: T, ttl?: number) { async set<T>(key: string, value: T, ttl?: Milliseconds) {
return this.cache.set(`${this.namespace}:${key}`, value, ttl); return this.cache.set(`${this.namespace}:${key}`, value, ttl);
} }
@ -25,7 +26,7 @@ export class CacheStorageService {
return this.cache.del(`${this.namespace}:${key}`); return this.cache.del(`${this.namespace}:${key}`);
} }
async setAdd(key: string, value: string[], ttl?: number) { async setAdd(key: string, value: string[], ttl?: Milliseconds) {
if (value.length === 0) { if (value.length === 0) {
return; return;
} }

View File

@ -13,18 +13,14 @@ import {
TwentyORMExceptionCode, TwentyORMExceptionCode,
} from 'src/engine/twenty-orm/exceptions/twenty-orm.exception'; } from 'src/engine/twenty-orm/exceptions/twenty-orm.exception';
import { EntitySchemaFactory } from 'src/engine/twenty-orm/factories/entity-schema.factory'; import { EntitySchemaFactory } from 'src/engine/twenty-orm/factories/entity-schema.factory';
import { CacheManager } from 'src/engine/twenty-orm/storage/cache-manager.storage'; import { PromiseMemoizer } from 'src/engine/twenty-orm/storage/promise-memoizer.storage';
import { CacheKey } from 'src/engine/twenty-orm/storage/types/cache-key.type'; import { CacheKey } from 'src/engine/twenty-orm/storage/types/cache-key.type';
import { WorkspaceCacheStorageService } from 'src/engine/workspace-cache-storage/workspace-cache-storage.service'; import { WorkspaceCacheStorageService } from 'src/engine/workspace-cache-storage/workspace-cache-storage.service';
@Injectable() @Injectable()
export class WorkspaceDatasourceFactory { export class WorkspaceDatasourceFactory {
private readonly logger = new Logger(WorkspaceDatasourceFactory.name); private readonly logger = new Logger(WorkspaceDatasourceFactory.name);
private cacheManager = new CacheManager<WorkspaceDataSource>(); private promiseMemoizer = new PromiseMemoizer<WorkspaceDataSource>();
private cachedDataSourcePromise: Record<
CacheKey,
Promise<WorkspaceDataSource>
>;
constructor( constructor(
private readonly dataSourceService: DataSourceService, private readonly dataSourceService: DataSourceService,
@ -32,9 +28,7 @@ export class WorkspaceDatasourceFactory {
private readonly workspaceCacheStorageService: WorkspaceCacheStorageService, private readonly workspaceCacheStorageService: WorkspaceCacheStorageService,
private readonly workspaceMetadataCacheService: WorkspaceMetadataCacheService, private readonly workspaceMetadataCacheService: WorkspaceMetadataCacheService,
private readonly entitySchemaFactory: EntitySchemaFactory, private readonly entitySchemaFactory: EntitySchemaFactory,
) { ) {}
this.cachedDataSourcePromise = {};
}
public async create( public async create(
workspaceId: string, workspaceId: string,
@ -59,142 +53,116 @@ export class WorkspaceDatasourceFactory {
const cacheKey: CacheKey = `${workspaceId}-${cachedWorkspaceMetadataVersion}`; const cacheKey: CacheKey = `${workspaceId}-${cachedWorkspaceMetadataVersion}`;
if (cacheKey in this.cachedDataSourcePromise) { const workspaceDataSource =
return this.cachedDataSourcePromise[cacheKey]; await this.promiseMemoizer.memoizePromiseAndExecute(
} cacheKey,
async () => {
const creationPromise = (async (): Promise<WorkspaceDataSource> => { const dataSourceMetadata =
try { await this.dataSourceService.getLastDataSourceMetadataFromWorkspaceId(
const result = await this.cacheManager.execute( workspaceId,
cacheKey,
async () => {
const dataSourceMetadata =
await this.dataSourceService.getLastDataSourceMetadataFromWorkspaceId(
workspaceId,
);
if (!dataSourceMetadata) {
throw new TwentyORMException(
`Workspace Schema not found for workspace ${workspaceId}`,
TwentyORMExceptionCode.WORKSPACE_SCHEMA_NOT_FOUND,
);
}
const cachedEntitySchemaOptions =
await this.workspaceCacheStorageService.getORMEntitySchema(
workspaceId,
cachedWorkspaceMetadataVersion,
);
let cachedEntitySchemas: EntitySchema[];
const cachedObjectMetadataMaps =
await this.workspaceCacheStorageService.getObjectMetadataMaps(
workspaceId,
cachedWorkspaceMetadataVersion,
);
if (!cachedObjectMetadataMaps) {
throw new TwentyORMException(
`Object metadata collection not found for workspace ${workspaceId}`,
TwentyORMExceptionCode.METADATA_COLLECTION_NOT_FOUND,
);
}
if (cachedEntitySchemaOptions) {
cachedEntitySchemas = cachedEntitySchemaOptions.map(
(option) => new EntitySchema(option),
);
} else {
const entitySchemas = await Promise.all(
Object.values(cachedObjectMetadataMaps.byId).map(
(objectMetadata) =>
this.entitySchemaFactory.create(
workspaceId,
cachedWorkspaceMetadataVersion,
objectMetadata,
cachedObjectMetadataMaps,
),
),
);
await this.workspaceCacheStorageService.setORMEntitySchema(
workspaceId,
cachedWorkspaceMetadataVersion,
entitySchemas.map((entitySchema) => entitySchema.options),
);
cachedEntitySchemas = entitySchemas;
}
const workspaceDataSource = new WorkspaceDataSource(
{
workspaceId,
objectMetadataMaps: cachedObjectMetadataMaps,
},
{
url:
dataSourceMetadata.url ??
this.environmentService.get('PG_DATABASE_URL'),
type: 'postgres',
logging:
this.environmentService.get('NODE_ENV') ===
NodeEnvironment.development
? ['query', 'error']
: ['error'],
schema: dataSourceMetadata.schema,
entities: cachedEntitySchemas,
ssl: this.environmentService.get('PG_SSL_ALLOW_SELF_SIGNED')
? {
rejectUnauthorized: false,
}
: undefined,
},
); );
await workspaceDataSource.initialize(); if (!dataSourceMetadata) {
throw new TwentyORMException(
`Workspace Schema not found for workspace ${workspaceId}`,
TwentyORMExceptionCode.WORKSPACE_SCHEMA_NOT_FOUND,
);
}
return workspaceDataSource; const cachedEntitySchemaOptions =
}, await this.workspaceCacheStorageService.getORMEntitySchema(
async (dataSource) => { workspaceId,
try { cachedWorkspaceMetadataVersion,
await dataSource.destroy(); );
} catch (error) {
// Ignore error if pool has already been destroyed which is a common race condition case
if (error.message === 'Called end on pool more than once') {
return;
}
throw error; let cachedEntitySchemas: EntitySchema[];
}
},
);
if (result === null) { const cachedObjectMetadataMaps =
throw new Error( await this.workspaceCacheStorageService.getObjectMetadataMaps(
`Failed to create WorkspaceDataSource for ${cacheKey}`, workspaceId,
cachedWorkspaceMetadataVersion,
);
if (!cachedObjectMetadataMaps) {
throw new TwentyORMException(
`Object metadata collection not found for workspace ${workspaceId}`,
TwentyORMExceptionCode.METADATA_COLLECTION_NOT_FOUND,
);
}
if (cachedEntitySchemaOptions) {
cachedEntitySchemas = cachedEntitySchemaOptions.map(
(option) => new EntitySchema(option),
);
} else {
const entitySchemas = await Promise.all(
Object.values(cachedObjectMetadataMaps.byId).map(
(objectMetadata) =>
this.entitySchemaFactory.create(
workspaceId,
cachedWorkspaceMetadataVersion,
objectMetadata,
cachedObjectMetadataMaps,
),
),
);
await this.workspaceCacheStorageService.setORMEntitySchema(
workspaceId,
cachedWorkspaceMetadataVersion,
entitySchemas.map((entitySchema) => entitySchema.options),
);
cachedEntitySchemas = entitySchemas;
}
const workspaceDataSource = new WorkspaceDataSource(
{
workspaceId,
objectMetadataMaps: cachedObjectMetadataMaps,
},
{
url:
dataSourceMetadata.url ??
this.environmentService.get('PG_DATABASE_URL'),
type: 'postgres',
logging:
this.environmentService.get('NODE_ENV') ===
NodeEnvironment.development
? ['query', 'error']
: ['error'],
schema: dataSourceMetadata.schema,
entities: cachedEntitySchemas,
ssl: this.environmentService.get('PG_SSL_ALLOW_SELF_SIGNED')
? {
rejectUnauthorized: false,
}
: undefined,
},
); );
}
return result; await workspaceDataSource.initialize();
} finally {
delete this.cachedDataSourcePromise[cacheKey];
}
})();
this.cachedDataSourcePromise[cacheKey] = creationPromise; return workspaceDataSource;
},
async (dataSource) => {
try {
await dataSource.destroy();
} catch (error) {
// Ignore error if pool has already been destroyed which is a common race condition case
if (error.message === 'Called end on pool more than once') {
return;
}
throw error;
}
},
);
return creationPromise; if (!workspaceDataSource) {
} throw new Error(`Failed to create WorkspaceDataSource for ${cacheKey}`);
public async destroy(workspaceId: string): Promise<void> {
const cacheKeys = (
Object.keys(this.cachedDataSourcePromise) as CacheKey[]
).filter((key) => key.startsWith(`${workspaceId}`));
for (const cacheKey of cacheKeys) {
await this.cacheManager.clearKey(cacheKey);
} }
return workspaceDataSource;
} }
private async getWorkspaceMetadataVersionFromCache( private async getWorkspaceMetadataVersionFromCache(
@ -232,4 +200,10 @@ export class WorkspaceDatasourceFactory {
return latestWorkspaceMetadataVersion; return latestWorkspaceMetadataVersion;
} }
public async destroy(workspaceId: string) {
await this.promiseMemoizer.clearKeys(`${workspaceId}-`, (dataSource) => {
dataSource.destroy();
});
}
} }

View File

@ -0,0 +1,182 @@
import { PromiseMemoizer } from 'src/engine/twenty-orm/storage/promise-memoizer.storage';
describe('PromiseMemoizer', () => {
let memoizer: PromiseMemoizer<string>;
let originalDateNow: () => number;
const mockFactory = jest.fn();
const mockOnDelete = jest.fn();
const TTL_MS = 1000; // 1 second TTL for testing
beforeAll(() => {
// Store the original Date.now function
originalDateNow = Date.now;
});
afterAll(() => {
// Restore the original Date.now function
global.Date.now = originalDateNow;
});
beforeEach(() => {
jest.clearAllMocks();
// Start with a fixed timestamp
const currentTimestamp = 1000;
global.Date.now = jest.fn(() => currentTimestamp);
memoizer = new PromiseMemoizer<string>(TTL_MS);
});
describe('memoizePromiseAndExecute', () => {
it('should execute factory and cache result', async () => {
mockFactory.mockResolvedValue('test-value');
const result = await memoizer.memoizePromiseAndExecute(
'test-key-1',
mockFactory,
);
expect(result).toBe('test-value');
expect(mockFactory).toHaveBeenCalledTimes(1);
});
it('should return cached value within TTL', async () => {
mockFactory.mockResolvedValue('test-value');
await memoizer.memoizePromiseAndExecute('test-key-1', mockFactory);
// Move time forward but still within TTL
const currentTime = Date.now();
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => currentTime + TTL_MS / 2);
const result = await memoizer.memoizePromiseAndExecute(
'test-key-1',
mockFactory,
);
expect(result).toBe('test-value');
expect(mockFactory).toHaveBeenCalledTimes(1);
});
it('should re-execute factory after TTL expires', async () => {
mockFactory.mockResolvedValue('test-value');
await memoizer.memoizePromiseAndExecute('test-key-1', mockFactory);
// Move time beyond TTL
const currentTime = Date.now();
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => currentTime + TTL_MS + 100);
const result = await memoizer.memoizePromiseAndExecute(
'test-key-1',
mockFactory,
);
expect(result).toBe('test-value');
expect(mockFactory).toHaveBeenCalledTimes(2);
});
it('should handle null values', async () => {
mockFactory.mockResolvedValue(null);
const result = await memoizer.memoizePromiseAndExecute(
'test-key-1',
mockFactory,
);
expect(result).toBeNull();
});
it('should deduplicate concurrent requests', async () => {
let resolveFactory: (value: string) => void;
const factoryPromise = new Promise<string>((resolve) => {
resolveFactory = resolve;
});
mockFactory.mockImplementation(() => factoryPromise);
const promise1 = memoizer.memoizePromiseAndExecute(
'test-key-1',
mockFactory,
);
const promise2 = memoizer.memoizePromiseAndExecute(
'test-key-1',
mockFactory,
);
resolveFactory!('test-value');
const [result1, result2] = await Promise.all([promise1, promise2]);
expect(result1).toBe('test-value');
expect(result2).toBe('test-value');
expect(mockFactory).toHaveBeenCalledTimes(1);
});
});
describe('clearKey', () => {
it('should clear specific key and call onDelete', async () => {
mockFactory.mockResolvedValue('test-value');
await memoizer.memoizePromiseAndExecute('test-key-1', mockFactory);
await memoizer.clearKey('test-key-1', mockOnDelete);
const result = await memoizer.memoizePromiseAndExecute(
'test-key-1',
mockFactory,
);
expect(result).toBe('test-value');
expect(mockOnDelete).toHaveBeenCalledWith('test-value');
expect(mockFactory).toHaveBeenCalledTimes(2);
});
it('should handle non-existent key', async () => {
await memoizer.clearKey('non-existent-key-1', mockOnDelete);
expect(mockOnDelete).not.toHaveBeenCalled();
});
});
describe('clearKeys', () => {
it('should clear all keys with matching prefix', async () => {
mockFactory.mockResolvedValue('test-value');
await memoizer.memoizePromiseAndExecute('prefix-key-1', mockFactory);
await memoizer.memoizePromiseAndExecute('prefix-key-2', mockFactory);
await memoizer.memoizePromiseAndExecute('other-key-1', mockFactory);
mockFactory.mockClear();
await memoizer.clearKeys('prefix-key', mockOnDelete);
await memoizer.memoizePromiseAndExecute('prefix-key-1', mockFactory);
await memoizer.memoizePromiseAndExecute('prefix-key-2', mockFactory);
await memoizer.memoizePromiseAndExecute('other-key-1', mockFactory);
expect(mockFactory).toHaveBeenCalledTimes(2); // Only prefix keys should be re-executed
expect(mockOnDelete).toHaveBeenCalledTimes(2); // Only prefix keys should trigger onDelete
});
});
describe('clearAll', () => {
it('should clear all cached values', async () => {
mockFactory.mockResolvedValue('test-value');
await memoizer.memoizePromiseAndExecute('key-1-1', mockFactory);
await memoizer.memoizePromiseAndExecute('key-1-2', mockFactory);
mockFactory.mockClear();
await memoizer.clearAll(mockOnDelete);
await memoizer.memoizePromiseAndExecute('key-1-1', mockFactory);
await memoizer.memoizePromiseAndExecute('key-1-2', mockFactory);
expect(mockOnDelete).toHaveBeenCalledTimes(2);
expect(mockFactory).toHaveBeenCalledTimes(2);
});
});
});

View File

@ -1,67 +0,0 @@
import { isDefined } from 'twenty-shared/utils';
import { CacheKey } from 'src/engine/twenty-orm/storage/types/cache-key.type';
type AsyncFactoryCallback<T> = () => Promise<T | null>;
export class CacheManager<T> {
private cache = new Map<CacheKey, T>();
async execute(
cacheKey: CacheKey,
factory: AsyncFactoryCallback<T>,
onDelete?: (value: T) => Promise<void> | void,
): Promise<T | null> {
const [workspaceId] = cacheKey.split('-');
const cachedValue = this.cache.get(cacheKey);
if (isDefined(cachedValue)) {
return cachedValue;
}
for (const key of this.cache.keys()) {
if (key.startsWith(`${workspaceId}-`)) {
const cachedValue = this.cache.get(key);
if (cachedValue) {
await onDelete?.(cachedValue);
}
this.cache.delete(key);
}
}
const value = await factory();
if (!value) {
return null;
}
this.cache.set(cacheKey, value);
return value;
}
async clearKey(
cacheKey: CacheKey,
onDelete?: (value: T) => Promise<void> | void,
): Promise<void> {
const cachedValue = this.cache.get(cacheKey);
if (isDefined(cachedValue)) {
await onDelete?.(cachedValue);
this.cache.delete(cacheKey);
}
// TODO: remove this once we have debug on prod
// eslint-disable-next-line no-console
console.log('Datasource cache size: ', this.cache.size);
}
async clear(onDelete?: (value: T) => Promise<void> | void): Promise<void> {
for (const value of this.cache.values()) {
await onDelete?.(value);
this.cache.delete(value as any);
}
this.cache.clear();
}
}

View File

@ -0,0 +1,104 @@
import { Milliseconds } from 'cache-manager';
import { isDefined } from 'twenty-shared/utils';
import { CacheKey } from 'src/engine/twenty-orm/storage/types/cache-key.type';
type AsyncFactoryCallback<T> = () => Promise<T | null>;
const ONE_HOUR_IN_MS = 3600_000;
export class PromiseMemoizer<T> {
private cache = new Map<CacheKey, { value: T; ttl: number }>();
private pending = new Map<CacheKey, Promise<T | null>>();
private ttlMs: number;
constructor(ttlMs: Milliseconds = ONE_HOUR_IN_MS) {
this.ttlMs = ttlMs;
}
async memoizePromiseAndExecute(
cacheKey: CacheKey,
factory: AsyncFactoryCallback<T>,
onDelete?: (value: T) => Promise<void> | void,
): Promise<T | null> {
const now = Date.now();
await this.clearExpiredKeys(onDelete);
const cachedEntry = this.cache.get(cacheKey);
if (cachedEntry) {
return cachedEntry.value;
}
const existingPromise = this.pending.get(cacheKey);
if (existingPromise) {
return existingPromise;
}
// eslint-disable-next-line no-console
console.log(
`Computing new Datasource for cacheKey: ${cacheKey} out of ${this.cache.size}`,
);
const newPromise = (async () => {
try {
const value = await factory();
if (value) {
this.cache.set(cacheKey, { value, ttl: now + this.ttlMs });
}
return value;
} finally {
this.pending.delete(cacheKey);
}
})();
this.pending.set(cacheKey, newPromise);
return newPromise;
}
async clearExpiredKeys(onDelete?: (value: T) => Promise<void> | void) {
const now = Date.now();
for (const [cacheKey, cachedEntry] of this.cache.entries()) {
if (cachedEntry.ttl < now) {
await this.clearKey(cacheKey, onDelete);
}
}
}
async clearKey(
cacheKey: CacheKey,
onDelete?: (value: T) => Promise<void> | void,
): Promise<void> {
const cachedValue = this.cache.get(cacheKey);
if (isDefined(cachedValue)) {
await onDelete?.(cachedValue.value);
}
this.cache.delete(cacheKey);
}
async clearKeys(
cacheKeyPrefix: CacheKey,
onDelete?: (value: T) => Promise<void> | void,
): Promise<void> {
for (const cacheKey of [...this.cache.keys()]) {
if (cacheKey.startsWith(cacheKeyPrefix)) {
await this.clearKey(cacheKey, onDelete);
}
}
}
async clearAll(onDelete?: (value: T) => Promise<void> | void): Promise<void> {
for (const [, entry] of this.cache.entries()) {
await onDelete?.(entry.value);
}
this.cache.clear();
}
}

View File

@ -73,7 +73,7 @@ export class WorkspaceCacheStorageService {
return this.cacheStorageService.set<boolean>( return this.cacheStorageService.set<boolean>(
`${WorkspaceCacheKeys.MetadataObjectMetadataOngoingCachingLock}:${workspaceId}:${metadataVersion}`, `${WorkspaceCacheKeys.MetadataObjectMetadataOngoingCachingLock}:${workspaceId}:${metadataVersion}`,
true, true,
TTL_INFINITE, 1_000 * 60, // 1 minute
); );
} }