File size: 3,730 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 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | import { config } from '@/config';
import { isWorker } from '@/utils/is-worker';
import logger from '@/utils/logger';
import type CacheModule from './base';
import memory from './memory';
import redis from './redis';
const globalCache: {
get: (key: string) => Promise<string | null | undefined> | string | null | undefined;
set: (key: string, value?: string | Record<string, any>, maxAge?: number) => any;
} = {
get: () => null,
set: () => null,
};
let cacheModule: CacheModule;
if (isWorker) {
// No-op cache for Cloudflare Workers
cacheModule = {
init: () => null,
get: () => null,
set: () => null,
status: {
available: false,
},
clients: {},
};
} else if (config.cache.type === 'redis') {
cacheModule = redis;
cacheModule.init();
const { redisClient } = cacheModule.clients;
globalCache.get = async (key) => {
if (key && cacheModule.status.available && redisClient) {
const value = await redisClient.get(key);
return value;
}
};
globalCache.set = cacheModule.set;
} else if (config.cache.type === 'memory') {
cacheModule = memory;
cacheModule.init();
const { memoryCache } = cacheModule.clients;
globalCache.get = (key) => {
if (key && cacheModule.status.available && memoryCache) {
return memoryCache.get(key, { updateAgeOnGet: false }) as string | undefined;
}
};
globalCache.set = (key, value, maxAge = config.cache.routeExpire) => {
if (!value || value === 'undefined') {
value = '';
}
if (typeof value === 'object') {
value = JSON.stringify(value);
}
if (key && memoryCache) {
return memoryCache.set(key, value, { ttl: maxAge * 1000 });
}
};
} else {
cacheModule = {
init: () => null,
get: () => null,
set: () => null,
status: {
available: false,
},
clients: {},
};
logger.error('Cache not available, concurrent requests are not limited. This could lead to bad behavior.');
}
// only give cache string, as the `!` condition tricky
// md5 is used to shrink key size
// plz, write these tips in comments!
export default {
...cacheModule,
/**
* Try to get the cache. If the cache does not exist, the `getValueFunc` function will be called to get the data, and the data will be cached.
* @param key The key used to store and retrieve the cache. You can use `:` as a separator to create a hierarchy.
* @param getValueFunc A function that returns data to be cached when a cache miss occurs.
* @param maxAge The maximum age of the cache in seconds. This should left to the default value in most cases which is `CACHE_CONTENT_EXPIRE`.
* @param refresh Whether to renew the cache expiration time when the cache is hit. `true` by default.
* @returns
*/
tryGet: async <T extends string | Record<string, any>>(key: string, getValueFunc: () => Promise<T>, maxAge = config.cache.contentExpire, refresh = true) => {
if (typeof key !== 'string') {
throw new TypeError('Cache key must be a string');
}
let v = await cacheModule.get(key, refresh);
if (v) {
let parsed;
try {
parsed = JSON.parse(v);
} catch {
parsed = null;
}
if (parsed) {
v = parsed;
}
return v as T;
} else {
const value = await getValueFunc();
cacheModule.set(key, value, maxAge);
return value;
}
},
globalCache,
};
|