const IoRedis = require('ioredis'); const { logger } = require('@librechat/data-schemas'); const { createClient, createCluster } = require('@keyv/redis'); const { cacheConfig } = require('./cacheConfig'); const GLOBAL_PREFIX_SEPARATOR = '::'; const urls = cacheConfig.REDIS_URI?.split(',').map((uri) => new URL(uri)); const username = urls?.[0].username || cacheConfig.REDIS_USERNAME; const password = urls?.[0].password || cacheConfig.REDIS_PASSWORD; const ca = cacheConfig.REDIS_CA; /** @type {import('ioredis').Redis | import('ioredis').Cluster | null} */ let ioredisClient = null; if (cacheConfig.USE_REDIS) { const redisOptions = { username: username, password: password, tls: ca ? { ca } : undefined, keyPrefix: `${cacheConfig.REDIS_KEY_PREFIX}${GLOBAL_PREFIX_SEPARATOR}`, maxListeners: cacheConfig.REDIS_MAX_LISTENERS, }; ioredisClient = urls.length === 1 ? new IoRedis(cacheConfig.REDIS_URI, redisOptions) : new IoRedis.Cluster(cacheConfig.REDIS_URI, { redisOptions }); ioredisClient.on('error', (err) => { logger.error('ioredis client error:', err); }); /** Ping Interval to keep the Redis server connection alive (if enabled) */ let pingInterval = null; const clearPingInterval = () => { if (pingInterval) { clearInterval(pingInterval); pingInterval = null; } }; if (cacheConfig.REDIS_PING_INTERVAL > 0) { pingInterval = setInterval(() => { if (ioredisClient && ioredisClient.status === 'ready') { ioredisClient.ping(); } }, cacheConfig.REDIS_PING_INTERVAL * 1000); ioredisClient.on('close', clearPingInterval); ioredisClient.on('end', clearPingInterval); } } /** @type {import('@keyv/redis').RedisClient | import('@keyv/redis').RedisCluster | null} */ let keyvRedisClient = null; if (cacheConfig.USE_REDIS) { /** * ** WARNING ** Keyv Redis client does not support Prefix like ioredis above. * The prefix feature will be handled by the Keyv-Redis store in cacheFactory.js */ const redisOptions = { username, password, socket: { tls: ca != null, ca } }; keyvRedisClient = urls.length === 1 ? createClient({ url: cacheConfig.REDIS_URI, ...redisOptions }) : createCluster({ rootNodes: cacheConfig.REDIS_URI.split(',').map((url) => ({ url })), defaults: redisOptions, }); keyvRedisClient.setMaxListeners(cacheConfig.REDIS_MAX_LISTENERS); keyvRedisClient.on('error', (err) => { logger.error('@keyv/redis client error:', err); }); /** Ping Interval to keep the Redis server connection alive (if enabled) */ let pingInterval = null; const clearPingInterval = () => { if (pingInterval) { clearInterval(pingInterval); pingInterval = null; } }; if (cacheConfig.REDIS_PING_INTERVAL > 0) { pingInterval = setInterval(() => { if (keyvRedisClient && keyvRedisClient.isReady) { keyvRedisClient.ping(); } }, cacheConfig.REDIS_PING_INTERVAL * 1000); keyvRedisClient.on('disconnect', clearPingInterval); keyvRedisClient.on('end', clearPingInterval); } } module.exports = { ioredisClient, keyvRedisClient, GLOBAL_PREFIX_SEPARATOR };