Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: cache s key prefix configuration #666

Merged
merged 5 commits into from
May 9, 2024
Merged

feat: cache s key prefix configuration #666

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ce8d169
feat: cache s key prefix configuration
ezermellocontavoltz Apr 19, 2024
1d65b56
fix: remove changeOptions and include in options
ezermellocontavoltz Apr 24, 2024
7b324df
Merge branch 'main' into feature/cache-prefix
jaredwray Apr 24, 2024
1f4b29b
Merge branch 'main' into feature/cache-prefix
jaredwray May 9, 2024
dc0c74e
Merge branch 'main' into feature/cache-prefix
jaredwray May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 19 additions & 8 deletions packages/cache-manager-redis-yet/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ export interface RedisStore<T extends Clients = RedisClientType> extends Store {
get client(): T;
}

export type CustomOptions = {
keyPrefix?: string;
}

export class NoCacheableError implements Error {
name = 'NoCacheableError';
constructor(public message: string) {}
Expand All @@ -48,29 +52,34 @@ export const avoidNoCacheable = async <T>(p: Promise<T>) => {

const getVal = (value: unknown) => JSON.stringify(value) || '"undefined"';

const getFullKey = (originalKey: string, keyPrefix?: string) => `${keyPrefix? `${keyPrefix}:` : ''}${originalKey}`;

function builder<T extends Clients>(
redisCache: T,
name: Name<T>,
reset: () => Promise<void>,
keys: (pattern: string) => Promise<string[]>,
options?: Config,
options?: Config & CustomOptions,
) {
const isCacheable =
options?.isCacheable || ((value) => value !== undefined && value !== null);

return {
async get<T>(key: string) {
const val = await redisCache.get(key);
const val = await redisCache.get(getFullKey(key, options?.keyPrefix));
if (val === undefined || val === null) return undefined;
else return JSON.parse(val) as T;
},
async set(key, value, ttl) {

if (!isCacheable(value))
throw new NoCacheableError(`"${value}" is not a cacheable value`);
const t = ttl === undefined ? options?.ttl : ttl;

const t = ttl === undefined ? options?.ttl : ttl;

if (t !== undefined && t !== 0)
await redisCache.set(key, getVal(value), { PX: t });
else await redisCache.set(key, getVal(value));
await redisCache.set(getFullKey(key, options?.keyPrefix), getVal(value), { PX: t });
else await redisCache.set(getFullKey(key, options?.keyPrefix), getVal(value));
},
async mset(args, ttl) {
const t = ttl === undefined ? options?.ttl : ttl;
Expand All @@ -81,7 +90,8 @@ function builder<T extends Clients>(
throw new NoCacheableError(
`"${getVal(value)}" is not a cacheable value`,
);
multi.set(key, getVal(value), { PX: t });

multi.set(getFullKey(key, options?.keyPrefix), getVal(value), { PX: t });
}
await multi.exec();
} else
Expand Down Expand Up @@ -120,8 +130,9 @@ function builder<T extends Clients>(
} as RedisStore<T>;
}


// TODO: past instance as option
export async function redisStore(options?: RedisClientOptions & Config) {
export async function redisStore(options?: RedisClientOptions & Config & CustomOptions) {
const redisCache = createClient(options);
await redisCache.connect();

Expand All @@ -131,7 +142,7 @@ export async function redisStore(options?: RedisClientOptions & Config) {
/**
* redisCache should be connected
*/
export function redisInsStore(redisCache: RedisClientType, options?: Config) {
export function redisInsStore(redisCache: RedisClientType, options?: Config & CustomOptions) {
const reset = async () => {
await redisCache.flushDb();
};
Expand Down