mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-16 08:20:14 +01:00
* Refactor: Moved Redis cache infra logic into `packages/api` - Moved cacheFactory and redisClients from `api/cache` into `packages/api/src/cache` so that features in `packages/api` can use cache without importing backward from the backend. - Converted all moved files into TS with proper typing. - Created integration tests to run against actual Redis servers for redisClients and cacheFactory. - Added a GitHub workflow to run integration tests for the cache feature. - Bug fix: keyvRedisClient now implements the PING feature properly. * chore: consolidate imports in getLogStores.js * chore: reorder imports * chore: re-add fs-extra as dev dep. * chore: reorder imports in cacheConfig.ts, cacheFactory.ts, and keyvMongo.ts --------- Co-authored-by: Danny Avila <danny@librechat.ai>
182 lines
6.5 KiB
TypeScript
182 lines
6.5 KiB
TypeScript
describe('cacheConfig', () => {
|
|
let originalEnv: NodeJS.ProcessEnv;
|
|
|
|
beforeEach(() => {
|
|
originalEnv = { ...process.env };
|
|
|
|
// Clear all related env vars first
|
|
delete process.env.REDIS_URI;
|
|
delete process.env.REDIS_CA;
|
|
delete process.env.REDIS_KEY_PREFIX_VAR;
|
|
delete process.env.REDIS_KEY_PREFIX;
|
|
delete process.env.USE_REDIS;
|
|
delete process.env.USE_REDIS_CLUSTER;
|
|
delete process.env.REDIS_PING_INTERVAL;
|
|
delete process.env.FORCED_IN_MEMORY_CACHE_NAMESPACES;
|
|
|
|
// Clear module cache
|
|
jest.resetModules();
|
|
});
|
|
|
|
afterEach(() => {
|
|
process.env = originalEnv;
|
|
jest.resetModules();
|
|
});
|
|
|
|
describe('REDIS_KEY_PREFIX validation and resolution', () => {
|
|
test('should throw error when both REDIS_KEY_PREFIX_VAR and REDIS_KEY_PREFIX are set', async () => {
|
|
process.env.REDIS_KEY_PREFIX_VAR = 'DEPLOYMENT_ID';
|
|
process.env.REDIS_KEY_PREFIX = 'manual-prefix';
|
|
|
|
await expect(async () => {
|
|
await import('../cacheConfig');
|
|
}).rejects.toThrow('Only either REDIS_KEY_PREFIX_VAR or REDIS_KEY_PREFIX can be set.');
|
|
});
|
|
|
|
test('should resolve REDIS_KEY_PREFIX from variable reference', async () => {
|
|
process.env.REDIS_KEY_PREFIX_VAR = 'DEPLOYMENT_ID';
|
|
process.env.DEPLOYMENT_ID = 'test-deployment-123';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.REDIS_KEY_PREFIX).toBe('test-deployment-123');
|
|
});
|
|
|
|
test('should use direct REDIS_KEY_PREFIX value', async () => {
|
|
process.env.REDIS_KEY_PREFIX = 'direct-prefix';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.REDIS_KEY_PREFIX).toBe('direct-prefix');
|
|
});
|
|
|
|
test('should default to empty string when no prefix is configured', async () => {
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.REDIS_KEY_PREFIX).toBe('');
|
|
});
|
|
|
|
test('should handle empty variable reference', async () => {
|
|
process.env.REDIS_KEY_PREFIX_VAR = 'EMPTY_VAR';
|
|
process.env.EMPTY_VAR = '';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.REDIS_KEY_PREFIX).toBe('');
|
|
});
|
|
|
|
test('should handle undefined variable reference', async () => {
|
|
process.env.REDIS_KEY_PREFIX_VAR = 'UNDEFINED_VAR';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.REDIS_KEY_PREFIX).toBe('');
|
|
});
|
|
});
|
|
|
|
describe('USE_REDIS and REDIS_URI validation', () => {
|
|
test('should throw error when USE_REDIS is enabled but REDIS_URI is not set', async () => {
|
|
process.env.USE_REDIS = 'true';
|
|
|
|
await expect(async () => {
|
|
await import('../cacheConfig');
|
|
}).rejects.toThrow('USE_REDIS is enabled but REDIS_URI is not set.');
|
|
});
|
|
|
|
test('should not throw error when USE_REDIS is enabled and REDIS_URI is set', async () => {
|
|
process.env.USE_REDIS = 'true';
|
|
process.env.REDIS_URI = 'redis://localhost:6379';
|
|
|
|
const importModule = async () => {
|
|
await import('../cacheConfig');
|
|
};
|
|
await expect(importModule()).resolves.not.toThrow();
|
|
});
|
|
|
|
test('should handle empty REDIS_URI when USE_REDIS is enabled', async () => {
|
|
process.env.USE_REDIS = 'true';
|
|
process.env.REDIS_URI = '';
|
|
|
|
await expect(async () => {
|
|
await import('../cacheConfig');
|
|
}).rejects.toThrow('USE_REDIS is enabled but REDIS_URI is not set.');
|
|
});
|
|
});
|
|
|
|
describe('USE_REDIS_CLUSTER configuration', () => {
|
|
test('should default to false when USE_REDIS_CLUSTER is not set', async () => {
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.USE_REDIS_CLUSTER).toBe(false);
|
|
});
|
|
|
|
test('should be false when USE_REDIS_CLUSTER is set to false', async () => {
|
|
process.env.USE_REDIS_CLUSTER = 'false';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.USE_REDIS_CLUSTER).toBe(false);
|
|
});
|
|
|
|
test('should be true when USE_REDIS_CLUSTER is set to true', async () => {
|
|
process.env.USE_REDIS_CLUSTER = 'true';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.USE_REDIS_CLUSTER).toBe(true);
|
|
});
|
|
|
|
test('should work with USE_REDIS enabled and REDIS_URI set', async () => {
|
|
process.env.USE_REDIS_CLUSTER = 'true';
|
|
process.env.USE_REDIS = 'true';
|
|
process.env.REDIS_URI = 'redis://localhost:6379';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.USE_REDIS_CLUSTER).toBe(true);
|
|
expect(cacheConfig.USE_REDIS).toBe(true);
|
|
expect(cacheConfig.REDIS_URI).toBe('redis://localhost:6379');
|
|
});
|
|
});
|
|
|
|
describe('REDIS_CA file reading', () => {
|
|
test('should be null when REDIS_CA is not set', async () => {
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.REDIS_CA).toBeNull();
|
|
});
|
|
});
|
|
|
|
describe('REDIS_PING_INTERVAL configuration', () => {
|
|
test('should default to 0 when REDIS_PING_INTERVAL is not set', async () => {
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.REDIS_PING_INTERVAL).toBe(0);
|
|
});
|
|
|
|
test('should use provided REDIS_PING_INTERVAL value', async () => {
|
|
process.env.REDIS_PING_INTERVAL = '300';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.REDIS_PING_INTERVAL).toBe(300);
|
|
});
|
|
});
|
|
|
|
describe('FORCED_IN_MEMORY_CACHE_NAMESPACES validation', () => {
|
|
test('should parse comma-separated cache keys correctly', async () => {
|
|
process.env.FORCED_IN_MEMORY_CACHE_NAMESPACES = ' ROLES, MESSAGES ';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.FORCED_IN_MEMORY_CACHE_NAMESPACES).toEqual(['ROLES', 'MESSAGES']);
|
|
});
|
|
|
|
test('should throw error for invalid cache keys', async () => {
|
|
process.env.FORCED_IN_MEMORY_CACHE_NAMESPACES = 'INVALID_KEY,ROLES';
|
|
|
|
await expect(async () => {
|
|
await import('../cacheConfig');
|
|
}).rejects.toThrow('Invalid cache keys in FORCED_IN_MEMORY_CACHE_NAMESPACES: INVALID_KEY');
|
|
});
|
|
|
|
test('should handle empty string gracefully', async () => {
|
|
process.env.FORCED_IN_MEMORY_CACHE_NAMESPACES = '';
|
|
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.FORCED_IN_MEMORY_CACHE_NAMESPACES).toEqual([]);
|
|
});
|
|
|
|
test('should handle undefined env var gracefully', async () => {
|
|
const { cacheConfig } = await import('../cacheConfig');
|
|
expect(cacheConfig.FORCED_IN_MEMORY_CACHE_NAMESPACES).toEqual([]);
|
|
});
|
|
});
|
|
});
|