Skip to content

Commit 569112e

Browse files
tomerh2001tomerh2001
committed
chore: Update npm dependencies and add cache manager functions and tests
1 parent 7762898 commit 569112e

File tree

6 files changed

+10238
-229
lines changed

6 files changed

+10238
-229
lines changed

‎bun.lockb‎

0 Bytes
Binary file not shown.

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@
3030
"eslint-plugin-th-rules": "^1.13.4",
3131
"lodash": "^4.17.21",
3232
"reflect-metadata": "^0.2.2"
33-
}
33+
},
34+
"packageManager": "yarn@4.4.1"
3435
}

‎src/index.d.ts‎

Whitespace-only changes.

‎src/index.ts‎

Lines changed: 1 addition & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -1,132 +1 @@
1-
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
2-
// eslint-disable-next-line import/no-unassigned-import
3-
import 'reflect-metadata';
4-
import cacheManager, {type Cache} from 'cache-manager';
5-
import {redisStore} from 'cache-manager-ioredis-yet';
6-
import {get} from 'lodash';
7-
8-
export type CacheInitializationConfig = {
9-
host?: string;
10-
port?: number;
11-
password?: string;
12-
ttl: number;
13-
};
14-
15-
export type KeySelector = ((...arguments_: unknown[]) => unknown[]) | string | string[];
16-
17-
export type CacheOptions = {
18-
ttl: number;
19-
keySelector: KeySelector;
20-
} & Partial<CacheInitializationConfig>;
21-
22-
let cacheManagerInstance: Cache | undefined;
23-
24-
/**
25-
* Initializes the cache manager with ioredis store by default.
26-
*/
27-
export async function initializeCache(config: CacheInitializationConfig): Promise<void> {
28-
const store = async () => redisStore({
29-
host: config.host ?? 'localhost',
30-
port: config.port ?? 6379,
31-
password: config.password,
32-
});
33-
34-
cacheManagerInstance = await cacheManager.caching(store, {ttl: config.ttl});
35-
}
36-
37-
/**
38-
* Automatically initializes cache if not already initialized and initialization data is present.
39-
*/
40-
export async function ensureCacheInitialized(config?: CacheInitializationConfig): Promise<void> {
41-
if (!cacheManagerInstance && config) {
42-
await initializeCache(config);
43-
}
44-
}
45-
46-
/**
47-
* Decorator to provide metadata for caching with TTL and key selection.
48-
*/
49-
export function cacheMeta(options: CacheOptions) {
50-
return async (target: Record<string, unknown>, propertyKey: string): Promise<void> => {
51-
await ensureCacheInitialized(options);
52-
Reflect.defineMetadata('cacheKeySelector', options.keySelector, target, propertyKey);
53-
Reflect.defineMetadata('cacheTtl', options.ttl, target, propertyKey);
54-
};
55-
}
56-
57-
/**
58-
* Decorator to handle caching directly with TTL and key selection.
59-
*/
60-
export function cache(options: CacheOptions) {
61-
return (target: unknown, propertyKey: string, descriptor: PropertyDescriptor): void => {
62-
ensureCacheInitialized(options).catch((error: unknown) => {
63-
console.error(error);
64-
});
65-
const originalMethod = descriptor.value;
66-
67-
descriptor.value = async function (...arguments_: unknown[]): Promise<unknown> {
68-
if (!cacheManagerInstance) {
69-
throw new Error('Cache not initialized.');
70-
}
71-
72-
const cacheKey = createCacheKey(arguments_, options.keySelector);
73-
const cachedResult = await cacheManagerInstance.get(cacheKey);
74-
if (cachedResult) {
75-
return cachedResult;
76-
}
77-
78-
const result = await originalMethod.apply(this, arguments_);
79-
await cacheManagerInstance.set(cacheKey, result, options.ttl);
80-
81-
return result;
82-
};
83-
};
84-
}
85-
86-
/**
87-
* Creates a cache key based on the key selector function or paths.
88-
*/
89-
export function createCacheKey(arguments_: unknown[], keySelector: KeySelector): string {
90-
if (typeof keySelector === 'function') {
91-
const result = keySelector(...arguments_);
92-
return Array.isArray(result) ? result.join(':') : String(result);
93-
}
94-
95-
if (typeof keySelector === 'string') {
96-
return String(get(arguments_[0] as Record<string, unknown>, keySelector));
97-
}
98-
99-
if (Array.isArray(keySelector)) {
100-
return keySelector.map(path => String(get(arguments_[0] as Record<string, unknown>, path))).join(':');
101-
}
102-
103-
throw new Error('Invalid key selector type.');
104-
}
105-
106-
/**
107-
* Wraps and caches the original function using cache-manager and supports dynamic key selection.
108-
*/
109-
export function cacheFunction(
110-
function_: (...arguments_: unknown[]) => Promise<unknown>,
111-
options: CacheOptions,
112-
): (...arguments_: unknown[]) => Promise<unknown> {
113-
ensureCacheInitialized(options).catch((error: unknown) => {
114-
console.error(error);
115-
});
116-
return async (...arguments_: unknown[]): Promise<unknown> => {
117-
if (!cacheManagerInstance) {
118-
throw new Error('Cache not initialized.');
119-
}
120-
121-
const cacheKey = createCacheKey(arguments_, options.keySelector);
122-
const cachedResult = await cacheManagerInstance.get(cacheKey);
123-
if (cachedResult) {
124-
return cachedResult;
125-
}
126-
127-
const result = await function_(...arguments_);
128-
await cacheManagerInstance.set(cacheKey, result, options.ttl);
129-
130-
return result;
131-
};
132-
}
1+
console.log('test');

‎tests/index.test.ts‎

Lines changed: 0 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +0,0 @@
1-
2-
import {test, expect} from 'bun:test';
3-
import {
4-
initializeCache,
5-
ensureCacheInitialized,
6-
cacheMeta,
7-
cache,
8-
createCacheKey,
9-
cacheFunction,
10-
type CacheInitializationConfig,
11-
} from '../src/index';
12-
13-
const testConfig: CacheInitializationConfig = {
14-
host: '127.0.0.1',
15-
port: 6379,
16-
ttl: 300,
17-
};
18-
19-
test('initializeCache initializes cache manager with correct configuration', async () => {
20-
await initializeCache(testConfig);
21-
22-
expect(globalThis.cacheManagerInstance).toBeDefined();
23-
});
24-
25-
test('ensureCacheInitialized initializes cache if not initialized', async () => {
26-
globalThis.cacheManagerInstance = undefined;
27-
await ensureCacheInitialized(testConfig);
28-
expect(globalThis.cacheManagerInstance).toBeDefined();
29-
});
30-
31-
test('ensureCacheInitialized does not initialize cache if already initialized', async () => {
32-
globalThis.cacheManagerInstance = {get: async () => 'mocked'} as any;
33-
await ensureCacheInitialized(testConfig);
34-
expect(globalThis.cacheManagerInstance.get).toBeDefined();
35-
});
36-
37-
test('createCacheKey generates key correctly based on keySelector function', () => {
38-
const keySelector = (a: number, b: number) => [a, b];
39-
const key = createCacheKey([1, 2], keySelector);
40-
expect(key).toBe('1:2');
41-
});
42-
43-
test('createCacheKey generates key correctly based on string selector', () => {
44-
const key = createCacheKey([{name: 'test'}], 'name');
45-
expect(key).toBe('test');
46-
});
47-
48-
test('createCacheKey generates key correctly based on array of selectors', () => {
49-
const key = createCacheKey([{name: 'test', age: 25}], ['name', 'age']);
50-
expect(key).toBe('test:25');
51-
});
52-
53-
test('cacheMeta sets metadata correctly', async () => {
54-
const options = {ttl: 300, keySelector: 'name'};
55-
const target = {};
56-
const propertyKey = 'testMethod';
57-
58-
await cacheMeta(options)(target, propertyKey);
59-
60-
expect(Reflect.getMetadata('cacheKeySelector', target, propertyKey)).toBe('name');
61-
expect(Reflect.getMetadata('cacheTtl', target, propertyKey)).toBe(300);
62-
});
63-
64-
test('cache decorator caches function results', async () => {
65-
await initializeCache(testConfig);
66-
const options = {ttl: 300, keySelector: 'name'};
67-
const target = {};
68-
const descriptor = {
69-
async value() {
70-
return 'result';
71-
},
72-
} as PropertyDescriptor;
73-
74-
cache(options)(target, 'testMethod', descriptor);
75-
76-
const result = await descriptor.value({name: 'test'});
77-
78-
const cachedResult = await globalThis.cacheManagerInstance!.get('test');
79-
80-
expect(result).toBe('result');
81-
expect(cachedResult).toBe('result');
82-
});
83-
84-
test('cacheFunction caches results correctly', async () => {
85-
await initializeCache(testConfig);
86-
const options = {ttl: 300, keySelector: 'name'};
87-
const originalFunction = async () => 'result';
88-
89-
const wrappedFunction = cacheFunction(originalFunction, options);
90-
const result = await wrappedFunction({name: 'test'});
91-
92-
const cachedResult = await globalThis.cacheManagerInstance!.get('test');
93-
94-
expect(result).toBe('result');
95-
expect(cachedResult).toBe('result');
96-
});

0 commit comments

Comments
 (0)