File size: 2,775 Bytes
bf48b89 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 | import Redis from 'ioredis';
import { config } from '@/config';
import logger from '@/utils/logger';
import type CacheModule from './base';
const status = { available: false };
const clients: {
redisClient?: Redis;
} = {};
const getCacheTtlKey = (key: string) => {
if (key.startsWith('rsshub:cacheTtl:')) {
throw new Error('"rsshub:cacheTtl:" prefix is reserved for the internal usage, please change your cache key'); // blocking any attempt to get/set the cacheTtl
}
return `rsshub:cacheTtl:${key}`;
};
export default {
init: () => {
clients.redisClient = new Redis(config.redis.url);
clients.redisClient.on('error', (error) => {
status.available = false;
logger.error('Redis error: ', error);
});
clients.redisClient.on('end', () => {
status.available = false;
});
clients.redisClient.on('connect', () => {
status.available = true;
logger.info('Redis connected.');
});
},
get: async (key: string, refresh = true) => {
if (key && status.available && clients.redisClient) {
const cacheTtlKey = getCacheTtlKey(key);
let [value, cacheTtl] = await clients.redisClient.mget(key, cacheTtlKey);
if (value && refresh) {
if (cacheTtl) {
clients.redisClient.expire(cacheTtlKey, cacheTtl);
} else {
// if cacheTtl is not set, that means the cache expire time is contentExpire
cacheTtl = config.cache.contentExpire + '';
// dont save cacheTtl to Redis, as it is the default value
// redisClient.set(cacheTtlKey, cacheTtl, 'EX', cacheTtl);
}
clients.redisClient.expire(key, cacheTtl);
value = value + '';
}
return value || '';
} else {
return null;
}
},
set: (key: string, value?: string | Record<string, any>, maxAge = config.cache.contentExpire) => {
if (!status.available || !clients.redisClient) {
return;
}
if (!value || value === 'undefined') {
value = '';
}
if (typeof value === 'object') {
value = JSON.stringify(value);
}
if (key) {
if (maxAge !== config.cache.contentExpire) {
// intentionally store the cache ttl if it is not the default value
clients.redisClient.set(getCacheTtlKey(key), maxAge, 'EX', maxAge);
}
return clients.redisClient.set(key, value, 'EX', maxAge); // setMode: https://redis.io/commands/set
}
},
clients,
status,
} as CacheModule;
|