feat(esl-utils): add ability check if the memoized property create a …

…cache
exadel-inc · Aug 25, 2021 · 81f2e02 · 81f2e02
1 parent 420f8bc
commit 81f2e02
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 0 deletions.
diff --git a/src/modules/esl-utils/decorators/memoize.ts b/src/modules/esl-utils/decorators/memoize.ts
@@ -69,3 +69,12 @@ memoize.clear = function (target: any, property: string) {
   if (typeof desc.value === 'function' && typeof desc.value.clear === 'function') return desc.value.clear();
   if (Object.hasOwnProperty.call(target, property)) delete target[property];
 };
+
+/** Check if property has cache for the passed params */
+memoize.has = function (target: any, property: string, ...params: any[]) {
+  const desc = getPropertyDescriptor(target, property);
+  if (!desc) return false;
+  if (typeof desc.get === 'function' && typeof (desc.get as any).has === 'function') return (desc.get as any).has(...params);
+  if (typeof desc.value === 'function' && typeof desc.value.has === 'function') return desc.value.has(...params);
+  return Object.hasOwnProperty.call(target, property);
+};
diff --git a/src/modules/esl-utils/decorators/test/memoize.test.ts b/src/modules/esl-utils/decorators/test/memoize.test.ts
@@ -17,7 +17,10 @@ describe('common @memoize decorator test', () => {
       expect(instance.test).toBe(NaN);
       expect(fn).toBeCalledTimes(1);
 
+      expect(memoize.has(instance, 'test')).toBe(true);
       memoize.clear(instance, 'test');
+      expect(memoize.has(instance, 'test')).toBe(false);
+
       expect(instance.test).toBe(NaN);
       expect(fn).toBeCalledTimes(2);
     });
@@ -38,7 +41,10 @@ describe('common @memoize decorator test', () => {
       expect(TestClass.test).toBe(NaN);
       expect(fn).toBeCalledTimes(1);
 
+      expect(memoize.has(TestClass, 'test')).toBe(true);
       memoize.clear(TestClass, 'test');
+      expect(memoize.has(TestClass, 'test')).toBe(false);
+
       expect(TestClass.test).toBe(NaN);
       expect(fn).toBeCalledTimes(2);
     });
@@ -60,7 +66,10 @@ describe('common @memoize decorator test', () => {
       expect(instance.test()).toBe('a');
       expect(fn).toBeCalledTimes(1);
 
+      expect(memoize.has(instance, 'test')).toBe(true);
       memoize.clear(instance, 'test');
+      expect(memoize.has(instance, 'test')).toBe(false);
+
       expect(instance.test()).toBe('a');
       expect(instance.test()).toBe('a');
       expect(fn).toBeCalledTimes(2);
@@ -82,7 +91,10 @@ describe('common @memoize decorator test', () => {
       expect(TestClass.test()).toBe('a');
       expect(fn).toBeCalledTimes(1);
 
+      expect(memoize.has(TestClass, 'test')).toBe(true);
       memoize.clear(TestClass, 'test');
+      expect(memoize.has(TestClass, 'test')).toBe(false);
+
       expect(TestClass.test()).toBe('a');
       expect(TestClass.test()).toBe('a');
       expect(fn).toBeCalledTimes(2);

diff --git a/src/modules/esl-utils/misc/memoize.ts b/src/modules/esl-utils/misc/memoize.ts
@@ -6,6 +6,8 @@ export type MemoizedFn<T extends AnyToAnyFnSignature> = T & {
   cache: Map<null | string, ReturnType<T>>;
   /** Clear memoization cache */
   clear: () => void;
+  /** Check existence of cache fore passed params */
+  has: (...params: Parameters<T>) => boolean;
 };
 
 /**
@@ -28,6 +30,10 @@ export function memoizeFn<F extends AnyToAnyFnSignature>(fn: F, hashFn: MemoHash
 
   memo.cache = new Map<null | string, ReturnType<F>>();
   memo.clear = () => memo.cache.clear();
+  memo.has = (...args: Parameters<F>) => {
+    const key = hashFn(...args);
+    return key === undefined ? false : memo.cache.has(key);
+  };
   return memo as MemoizedFn<F>;
 }
 

diff --git a/src/modules/esl-utils/misc/test/memoize.test.ts b/src/modules/esl-utils/misc/test/memoize.test.ts
@@ -8,11 +8,14 @@ describe('misc/memoize', () => {
     expect(memoFn()).toBe(null);
     expect(memoFn()).toBe(null);
     expect(fn).toBeCalledTimes(1);
+    expect(memoFn.has()).toBe(true);
 
     memoFn.clear();
     fn.mockReturnValue(1);
+    expect(memoFn.has()).toBe(false);
     expect(memoFn()).toBe(1);
     expect(memoFn()).toBe(1);
+    expect(memoFn.has()).toBe(true);
     expect(fn).toBeCalledTimes(2);
   });
 
@@ -22,9 +25,12 @@ describe('misc/memoize', () => {
     expect(memoFn(1)).toBe(2);
     expect(memoFn(1)).toBe(2);
     expect(fn).toBeCalledTimes(1);
+    expect(memoFn.has(1)).toBe(true);
+    expect(memoFn.has(2)).toBe(false);
 
     expect(memoFn(2)).toBe(3);
     expect(memoFn(2)).toBe(3);
+    expect(memoFn.has(2)).toBe(true);
     expect(fn).toBeCalledTimes(2);
   });
 
@@ -34,6 +40,9 @@ describe('misc/memoize', () => {
     expect(memoFn(1, 2)).toBe(3);
     expect(memoFn(1, 1)).toBe(2);
     expect(memoFn(1, 2)).toBe(3);
+    expect(memoFn.has(1, 1)).toBe(true);
+    expect(memoFn.has(1, 2)).toBe(true);
+    expect(memoFn.has(1, 3)).toBe(false);
     expect(fn).toBeCalledTimes(2);
     expect(memoFn(1, 1)).toBe(2);
     expect(fn).toBeCalledTimes(2);
@@ -46,6 +55,8 @@ describe('misc/memoize', () => {
     expect(memoFn(1, 2)).toBe(3);
     expect(memoFn(1, 1)).toBe(2);
     expect(memoFn(1, 2)).toBe(3);
+    expect(memoFn.has(1, 1)).toBe(false);
+    expect(memoFn.has(1, 2)).toBe(false);
     expect(fn).toBeCalledTimes(3);
   });
 });