From b2286ac06aa1ca5fc7f0d54fb7f24a2477fabec4 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Sun, 13 Dec 2020 13:05:58 +0100 Subject: [PATCH] Add memoize util (#805) * Add memoize util * Allow for instanceId & normalize overrides * memoize tests --- packages/util/src/index.ts | 1 + packages/util/src/memoize.spec.ts | 71 +++++++++++++++++++++++++++++++ packages/util/src/memoize.ts | 45 ++++++++++++++++++++ packages/util/src/types.ts | 7 +++ 4 files changed, 124 insertions(+) create mode 100644 packages/util/src/memoize.spec.ts create mode 100644 packages/util/src/memoize.ts diff --git a/packages/util/src/index.ts b/packages/util/src/index.ts index 4c0a513de..bbb713e68 100644 --- a/packages/util/src/index.ts +++ b/packages/util/src/index.ts @@ -9,6 +9,7 @@ export { assert, assertReturn } from './assert'; export { detectPackage } from './detectPackage'; export { extractTime } from './extractTime'; export { logger } from './logger'; +export { memoize } from './memoize'; export { promisify } from './promisify'; export * from './array'; diff --git a/packages/util/src/memoize.spec.ts b/packages/util/src/memoize.spec.ts new file mode 100644 index 000000000..e5dc65cf8 --- /dev/null +++ b/packages/util/src/memoize.spec.ts @@ -0,0 +1,71 @@ +// Copyright 2017-2020 @polkadot/util authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +import { memoize } from '.'; + +describe('memoize', (): void => { + it('returns actual values', (): void => { + const fn = memoize(() => 5); + + expect(fn()).toEqual(5); + }); + + it('caches executions', (): void => { + const spy = jest.fn((a: number, b: number) => a + b); + const fn = memoize(spy); + + expect(fn(2, 4)).toEqual(6); + expect(fn(2, 4)).toEqual(6); + + expect(spy).toHaveBeenCalledTimes(1); + + expect(fn(4, 2)).toEqual(6); + + expect(spy).toHaveBeenCalledTimes(2); + }); + + it('does unmemoize', (): void => { + const spy = jest.fn((a: number, b: number) => a + b); + const fn = memoize(spy); + + expect(fn(2, 4)).toEqual(6); + expect(fn(4, 2)).toEqual(6); + expect(spy).toHaveBeenCalledTimes(2); + + fn.unmemoize(2, 4); + + expect(fn(2, 4)).toEqual(6); + expect(fn(4, 2)).toEqual(6); + expect(spy).toHaveBeenCalledTimes(3); + }); + + it('manages separate instances', (): void => { + let instanceId = 'a'; + const spy = jest.fn((a: number, b: number) => a + b); + const fn = memoize(spy, { getInstanceId: () => instanceId }); + + expect(fn(1, 3)).toEqual(4); + + instanceId = 'b'; + + expect(fn(1, 3)).toEqual(4); + expect(spy).toHaveBeenCalledTimes(2); + + instanceId = 'a'; + + expect(fn(1, 3)).toEqual(4); + expect(spy).toHaveBeenCalledTimes(2); + + instanceId = 'b'; + fn.unmemoize(1, 3); + + expect(fn(1, 3)).toEqual(4); + expect(spy).toHaveBeenCalledTimes(3); + + instanceId = 'a'; + fn.unmemoize(1, 3); + + expect(fn(1, 3)).toEqual(4); + expect(spy).toHaveBeenCalledTimes(4); + }); +}); diff --git a/packages/util/src/memoize.ts b/packages/util/src/memoize.ts new file mode 100644 index 000000000..740fcc279 --- /dev/null +++ b/packages/util/src/memoize.ts @@ -0,0 +1,45 @@ +// Copyright 2017-2020 @polkadot/util authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +/* eslint-disable @typescript-eslint/no-explicit-any */ + +import type { Memoized } from './types'; + +import { isUndefined } from './is/undefined'; + +interface Options { + getInstanceId?: () => string, + normalize?: (args: any[]) => string; +} + +const INSTANCEID = () => 'none'; + +export function memoize (fn: (...args: any[]) => T, { getInstanceId = INSTANCEID }: Options = {}): Memoized { + const cache: Record> = {}; + + const memoized = (...args: any[]): T => { + const stringParams = JSON.stringify({ args }); + const instanceId = getInstanceId(); + + if (!cache[instanceId]) { + cache[instanceId] = {}; + } + + if (isUndefined(cache[instanceId][stringParams])) { + cache[instanceId][stringParams] = fn(...args); + } + + return cache[instanceId][stringParams]; + }; + + memoized.unmemoize = (...args: any[]): void => { + const stringParams = JSON.stringify({ args }); + const instanceId = getInstanceId(); + + if (cache[instanceId] && !isUndefined(cache[instanceId][stringParams])) { + delete cache[instanceId][stringParams]; + } + }; + + return memoized; +} diff --git a/packages/util/src/types.ts b/packages/util/src/types.ts index e2d403af3..9f81b7428 100644 --- a/packages/util/src/types.ts +++ b/packages/util/src/types.ts @@ -47,3 +47,10 @@ export interface Time { seconds: number; milliseconds: number; } + +export interface Memoized { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + (...args: any[]): T; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + unmemoize: (...args: any[]) => void; +}