@expo/entity-cache-adapter-local-memory 0.24.0

package/README.md

@@ -0,0 +1,44 @@
+# `@expo/entity-cache-adapter-local-memory`
+
+Cross-request [LRU](https://github.com/isaacs/node-lru-cache) cache adapter for `@expo/entity`. Use
+this cache with caution - it is nonstandard. The cache is shared between requests in the node process.
+
+## Why NOT use this cache
+
+Because this is an in-memory cache, cross-box invalidation is not possible. Do not use this cache
+if you have the following use cases:
+
+- The objects stored have high mutability
+- Reading a stale object from the cache is not acceptable in your application
+- Cross-box invalidation is not possible
+
+## Typical use cases
+
+If your application sees many requests fetching the same objects, you can save a trip to your cache
+cluster and backing datastore by using this in-memory cache. Here are some good use cases:
+
+- The objects stored are mostly immutable
+- You have a low TTL setting in your cache
+
+## Usage
+
+During `EntityCompanionProvider` instantiation:
+
+```typescript
+export const createDefaultEntityCompanionProvider = (
+  metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter()
+): EntityCompanionProvider => {
+  return new EntityCompanionProvider(
+    metricsAdapter,
+    {
+      ...
+    },
+    {
+      ['local-memory']: {
+        cacheAdapterProvider: new LocalMemoryCacheAdapterProvider.getProvider(),
+      },
+    }
+  );
+};
+
+```

package/build/GenericLocalMemoryCacher.d.ts

@@ -0,0 +1,20 @@
+import { CacheLoadResult } from '@expo/entity';
+import LRUCache from 'lru-cache';
+export declare const DOES_NOT_EXIST_LOCAL_MEMORY_CACHE: unique symbol;
+declare type LocalMemoryCacheValue<TFields> = Readonly<TFields> | typeof DOES_NOT_EXIST_LOCAL_MEMORY_CACHE;
+export declare type LocalMemoryCache<TFields> = LRUCache<string, LocalMemoryCacheValue<TFields>>;
+export default class GenericLocalMemoryCacher<TFields> {
+    private readonly lruCache;
+    constructor(lruCache: LocalMemoryCache<TFields>);
+    static createLRUCache<TFields>(options?: {
+        maxSize?: number;
+        ttlSeconds?: number;
+    }): LocalMemoryCache<TFields>;
+    static createNoOpLRUCache<TFields>(): LocalMemoryCache<TFields>;
+    loadManyAsync(keys: readonly string[]): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>>;
+    cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): Promise<void>;
+    cacheDBMissesAsync(keys: string[]): Promise<void>;
+    invalidateManyAsync(keys: string[]): Promise<void>;
+    makeCacheKey(parts: string[]): string;
+}
+export {};

package/build/GenericLocalMemoryCacher.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOES_NOT_EXIST_LOCAL_MEMORY_CACHE = void 0;
+const entity_1 = require("@expo/entity");
+const lru_cache_1 = __importDefault(require("lru-cache"));
+// Sentinel value we store in local memory to negatively cache a database miss.
+// The sentinel value is distinct from any (positively) cached value.
+exports.DOES_NOT_EXIST_LOCAL_MEMORY_CACHE = Symbol('doesNotExist');
+class GenericLocalMemoryCacher {
+    constructor(lruCache) {
+        this.lruCache = lruCache;
+    }
+    static createLRUCache(options = {}) {
+        var _a, _b;
+        const DEFAULT_LRU_CACHE_MAX_AGE_SECONDS = 10;
+        const DEFAULT_LRU_CACHE_SIZE = 10000;
+        const maxAgeSeconds = (_a = options.ttlSeconds) !== null && _a !== void 0 ? _a : DEFAULT_LRU_CACHE_MAX_AGE_SECONDS;
+        const lruCacheOptions = {
+            max: (_b = options.maxSize) !== null && _b !== void 0 ? _b : DEFAULT_LRU_CACHE_SIZE,
+            sizeCalculation: (value) => value === exports.DOES_NOT_EXIST_LOCAL_MEMORY_CACHE ? 0 : 1,
+            ttl: maxAgeSeconds * 1000, // convert to ms
+        };
+        return new lru_cache_1.default(lruCacheOptions);
+    }
+    static createNoOpLRUCache() {
+        return new lru_cache_1.default({
+            max: 0,
+            maxAge: -1,
+        });
+    }
+    async loadManyAsync(keys) {
+        const cacheResults = new Map();
+        for (const key of keys) {
+            const cacheResult = this.lruCache.get(key);
+            if (cacheResult === exports.DOES_NOT_EXIST_LOCAL_MEMORY_CACHE) {
+                cacheResults.set(key, {
+                    status: entity_1.CacheStatus.NEGATIVE,
+                });
+            }
+            else if (cacheResult) {
+                cacheResults.set(key, {
+                    status: entity_1.CacheStatus.HIT,
+                    item: cacheResult,
+                });
+            }
+            else {
+                cacheResults.set(key, {
+                    status: entity_1.CacheStatus.MISS,
+                });
+            }
+        }
+        return cacheResults;
+    }
+    async cacheManyAsync(objectMap) {
+        for (const [key, item] of objectMap) {
+            this.lruCache.set(key, item);
+        }
+    }
+    async cacheDBMissesAsync(keys) {
+        for (const key of keys) {
+            this.lruCache.set(key, exports.DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
+        }
+    }
+    async invalidateManyAsync(keys) {
+        for (const key of keys) {
+            this.lruCache.del(key);
+        }
+    }
+    makeCacheKey(parts) {
+        const delimiter = ':';
+        const escapedParts = parts.map((part) => part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`));
+        return escapedParts.join(delimiter);
+    }
+}
+exports.default = GenericLocalMemoryCacher;
+//# sourceMappingURL=GenericLocalMemoryCacher.js.map

package/build/GenericLocalMemoryCacher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenericLocalMemoryCacher.js","sourceRoot":"","sources":["../src/GenericLocalMemoryCacher.ts"],"names":[],"mappings":";;;;;;AAAA,yCAA4D;AAC5D,0DAAiC;AAEjC,+EAA+E;AAC/E,qEAAqE;AACxD,QAAA,iCAAiC,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;AA0ExE,MAAqB,wBAAwB;IAC3C,YAA6B,QAAmC;QAAnC,aAAQ,GAAR,QAAQ,CAA2B;IAAG,CAAC;IAEpE,MAAM,CAAC,cAAc,CACnB,UAAqD,EAAE;;QAEvD,MAAM,iCAAiC,GAAG,EAAE,CAAC;QAC7C,MAAM,sBAAsB,GAAG,KAAK,CAAC;QACrC,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,UAAU,mCAAI,iCAAiC,CAAC;QAC9E,MAAM,eAAe,GAAuC;YAC1D,GAAG,EAAE,MAAA,OAAO,CAAC,OAAO,mCAAI,sBAAsB;YAC9C,eAAe,EAAE,CAAC,KAAqC,EAAE,EAAE,CACzD,KAAK,KAAK,yCAAiC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,GAAG,EAAE,aAAa,GAAG,IAAI,EAAE,gBAAgB;SAC5C,CAAC;QACF,OAAO,IAAI,mBAAQ,CAAyC,eAAsB,CAAC,CAAC;IACtF,CAAC;IAED,MAAM,CAAC,kBAAkB;QACvB,OAAO,IAAI,mBAAQ,CAAyC;YAC1D,GAAG,EAAE,CAAC;YACN,MAAM,EAAE,CAAC,CAAC;SACX,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,aAAa,CACxB,IAAuB;QAEvB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAoC,CAAC;QACjE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC3C,IAAI,WAAW,KAAK,yCAAiC,EAAE;gBACrD,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE;oBACpB,MAAM,EAAE,oBAAW,CAAC,QAAQ;iBAC7B,CAAC,CAAC;aACJ;iBAAM,IAAI,WAAW,EAAE;gBACtB,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE;oBACpB,MAAM,EAAE,oBAAW,CAAC,GAAG;oBACvB,IAAI,EAAE,WAAiC;iBACxC,CAAC,CAAC;aACJ;iBAAM;gBACL,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE;oBACpB,MAAM,EAAE,oBAAW,CAAC,IAAI;iBACzB,CAAC,CAAC;aACJ;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,SAAiD;QAC3E,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,SAAS,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;SAC9B;IACH,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,IAAc;QAC5C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,yCAAiC,CAAC,CAAC;SAC3D;IACH,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,IAAc;QAC7C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACxB;IACH,CAAC;IAEM,YAAY,CAAC,KAAe;QACjC,MAAM,SAAS,GAAG,GAAG,CAAC;QACtB,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACtC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,SAAS,EAAE,CAAC,CAChE,CAAC;QACF,OAAO,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;CACF;AA1ED,2CA0EC"}

package/build/LocalMemoryCacheAdapter.d.ts

@@ -0,0 +1,11 @@
+import { EntityCacheAdapter, CacheLoadResult, EntityConfiguration } from '@expo/entity';
+import { LocalMemoryCache } from './GenericLocalMemoryCacher';
+export default class LocalMemoryCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
+    private readonly genericLocalMemoryCacher;
+    constructor(entityConfiguration: EntityConfiguration<TFields>, lruCache: LocalMemoryCache<TFields>);
+    loadManyAsync<N extends keyof TFields>(fieldName: N, fieldValues: readonly NonNullable<TFields[N]>[]): Promise<ReadonlyMap<NonNullable<TFields[N]>, CacheLoadResult<TFields>>>;
+    cacheManyAsync<N extends keyof TFields>(fieldName: N, objectMap: ReadonlyMap<NonNullable<TFields[N]>, Readonly<TFields>>): Promise<void>;
+    cacheDBMissesAsync<N extends keyof TFields>(fieldName: N, fieldValues: readonly NonNullable<TFields[N]>[]): Promise<void>;
+    invalidateManyAsync<N extends keyof TFields>(fieldName: N, fieldValues: readonly NonNullable<TFields[N]>[]): Promise<void>;
+    private makeCacheKey;
+}

package/build/LocalMemoryCacheAdapter.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const entity_1 = require("@expo/entity");
+const invariant_1 = __importDefault(require("invariant"));
+const GenericLocalMemoryCacher_1 = __importDefault(require("./GenericLocalMemoryCacher"));
+class LocalMemoryCacheAdapter extends entity_1.EntityCacheAdapter {
+    constructor(entityConfiguration, lruCache) {
+        super(entityConfiguration);
+        this.genericLocalMemoryCacher = new GenericLocalMemoryCacher_1.default(lruCache);
+    }
+    async loadManyAsync(fieldName, fieldValues) {
+        const localMemoryCacheKeyToFieldValueMapping = new Map(fieldValues.map((fieldValue) => [this.makeCacheKey(fieldName, fieldValue), fieldValue]));
+        const cacheResults = await this.genericLocalMemoryCacher.loadManyAsync(Array.from(localMemoryCacheKeyToFieldValueMapping.keys()));
+        return (0, entity_1.mapKeys)(cacheResults, (cacheKey) => {
+            const fieldValue = localMemoryCacheKeyToFieldValueMapping.get(cacheKey);
+            (0, invariant_1.default)(fieldValue !== undefined, 'Unspecified cache key %s returned from generic Local Memory cacher', cacheKey);
+            return fieldValue;
+        });
+    }
+    async cacheManyAsync(fieldName, objectMap) {
+        await this.genericLocalMemoryCacher.cacheManyAsync((0, entity_1.mapKeys)(objectMap, (fieldValue) => this.makeCacheKey(fieldName, fieldValue)));
+    }
+    async cacheDBMissesAsync(fieldName, fieldValues) {
+        await this.genericLocalMemoryCacher.cacheDBMissesAsync(fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue)));
+    }
+    async invalidateManyAsync(fieldName, fieldValues) {
+        await this.genericLocalMemoryCacher.invalidateManyAsync(fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue)));
+    }
+    makeCacheKey(fieldName, fieldValue) {
+        const columnName = this.entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
+        (0, invariant_1.default)(columnName, `database field mapping missing for ${fieldName}`);
+        const parts = [
+            this.entityConfiguration.tableName,
+            `${this.entityConfiguration.cacheKeyVersion}`,
+            columnName,
+            String(fieldValue),
+        ];
+        return this.genericLocalMemoryCacher.makeCacheKey(parts);
+    }
+}
+exports.default = LocalMemoryCacheAdapter;
+//# sourceMappingURL=LocalMemoryCacheAdapter.js.map

package/build/LocalMemoryCacheAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalMemoryCacheAdapter.js","sourceRoot":"","sources":["../src/LocalMemoryCacheAdapter.ts"],"names":[],"mappings":";;;;;AAAA,yCAAiG;AACjG,0DAAkC;AAElC,0FAAwF;AAExF,MAAqB,uBAAiC,SAAQ,2BAA2B;IAGvF,YACE,mBAAiD,EACjD,QAAmC;QAEnC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAC3B,IAAI,CAAC,wBAAwB,GAAG,IAAI,kCAAwB,CAAC,QAAQ,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,aAAa,CACxB,SAAY,EACZ,WAA+C;QAE/C,MAAM,sCAAsC,GAAG,IAAI,GAAG,CACpD,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,CACxF,CAAC;QACF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,aAAa,CACpE,KAAK,CAAC,IAAI,CAAC,sCAAsC,CAAC,IAAI,EAAE,CAAC,CAC1D,CAAC;QAEF,OAAO,IAAA,gBAAO,EAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,EAAE;YACxC,MAAM,UAAU,GAAG,sCAAsC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACxE,IAAA,mBAAS,EACP,UAAU,KAAK,SAAS,EACxB,oEAAoE,EACpE,QAAQ,CACT,CAAC;YACF,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,SAAY,EACZ,SAAkE;QAElE,MAAM,IAAI,CAAC,wBAAwB,CAAC,cAAc,CAChD,IAAA,gBAAO,EAAC,SAAS,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAC7E,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC7B,SAAY,EACZ,WAA+C;QAE/C,MAAM,IAAI,CAAC,wBAAwB,CAAC,kBAAkB,CACpD,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAC1E,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC9B,SAAY,EACZ,WAA+C;QAE/C,MAAM,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CACrD,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAC1E,CAAC;IACJ,CAAC;IAEO,YAAY,CAClB,SAAY,EACZ,UAAmC;QAEnC,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,CAAC,0BAA0B,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACtF,IAAA,mBAAS,EAAC,UAAU,EAAE,sCAAsC,SAAS,EAAE,CAAC,CAAC;QACzE,MAAM,KAAK,GAAG;YACZ,IAAI,CAAC,mBAAmB,CAAC,SAAS;YAClC,GAAG,IAAI,CAAC,mBAAmB,CAAC,eAAe,EAAE;YAC7C,UAAU;YACV,MAAM,CAAC,UAAU,CAAC;SACnB,CAAC;QACF,OAAO,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;CACF;AA1ED,0CA0EC"}

package/build/LocalMemoryCacheAdapterProvider.d.ts

@@ -0,0 +1,13 @@
+import { EntityCacheAdapter, EntityConfiguration, IEntityCacheAdapterProvider } from '@expo/entity';
+import LocalMemoryCacheAdapter from './LocalMemoryCacheAdapter';
+export declare class LocalMemoryCacheAdapterProvider implements IEntityCacheAdapterProvider {
+    private readonly lruCacheCreator;
+    static localMemoryCacheAdapterMap: Map<string, LocalMemoryCacheAdapter<any>>;
+    static getNoOpProvider(): IEntityCacheAdapterProvider;
+    static getProvider(options?: {
+        maxSize?: number;
+        ttlSeconds?: number;
+    }): IEntityCacheAdapterProvider;
+    private constructor();
+    getCacheAdapter<TFields>(entityConfiguration: EntityConfiguration<TFields>): EntityCacheAdapter<TFields>;
+}

package/build/LocalMemoryCacheAdapterProvider.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalMemoryCacheAdapterProvider = void 0;
+const entity_1 = require("@expo/entity");
+const GenericLocalMemoryCacher_1 = __importDefault(require("./GenericLocalMemoryCacher"));
+const LocalMemoryCacheAdapter_1 = __importDefault(require("./LocalMemoryCacheAdapter"));
+class LocalMemoryCacheAdapterProvider {
+    constructor(lruCacheCreator) {
+        this.lruCacheCreator = lruCacheCreator;
+    }
+    static getNoOpProvider() {
+        return new LocalMemoryCacheAdapterProvider(() => GenericLocalMemoryCacher_1.default.createNoOpLRUCache());
+    }
+    static getProvider(options = {}) {
+        return new LocalMemoryCacheAdapterProvider(() => GenericLocalMemoryCacher_1.default.createLRUCache(options));
+    }
+    getCacheAdapter(entityConfiguration) {
+        return (0, entity_1.computeIfAbsent)(LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap, entityConfiguration.tableName, () => {
+            const lruCache = this.lruCacheCreator();
+            return new LocalMemoryCacheAdapter_1.default(entityConfiguration, lruCache);
+        });
+    }
+}
+exports.LocalMemoryCacheAdapterProvider = LocalMemoryCacheAdapterProvider;
+// local memory cache adapters should be shared/reused across requests
+LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap = new Map();
+//# sourceMappingURL=LocalMemoryCacheAdapterProvider.js.map

package/build/LocalMemoryCacheAdapterProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalMemoryCacheAdapterProvider.js","sourceRoot":"","sources":["../src/LocalMemoryCacheAdapterProvider.ts"],"names":[],"mappings":";;;;;;AAAA,yCAKsB;AAEtB,0FAAwF;AACxF,wFAAgE;AAEhE,MAAa,+BAA+B;IAkB1C,YAAqC,eAAyD;QAAzD,oBAAe,GAAf,eAAe,CAA0C;IAAG,CAAC;IAdlG,MAAM,CAAC,eAAe;QACpB,OAAO,IAAI,+BAA+B,CAAC,GAAY,EAAE,CACvD,kCAAwB,CAAC,kBAAkB,EAAW,CACvD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,WAAW,CAChB,UAAqD,EAAE;QAEvD,OAAO,IAAI,+BAA+B,CAAC,GAAY,EAAE,CACvD,kCAAwB,CAAC,cAAc,CAAU,OAAO,CAAC,CAC1D,CAAC;IACJ,CAAC;IAIM,eAAe,CACpB,mBAAiD;QAEjD,OAAO,IAAA,wBAAe,EACpB,+BAA+B,CAAC,0BAA0B,EAC1D,mBAAmB,CAAC,SAAS,EAC7B,GAAG,EAAE;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,EAAW,CAAC;YACjD,OAAO,IAAI,iCAAuB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QACpE,CAAC,CACF,CAAC;IACJ,CAAC;;AA/BH,0EAgCC;AA/BC,sEAAsE;AAC/D,0DAA0B,GAAG,IAAI,GAAG,EAAwC,CAAC"}

package/build/__integration-tests__/LocalMemoryCacheAdapter-integration-test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__integration-tests__/LocalMemoryCacheAdapter-integration-test.js

@@ -0,0 +1,128 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const entity_1 = require("@expo/entity");
+const uuid_1 = require("uuid");
+const GenericLocalMemoryCacher_1 = __importDefault(require("../GenericLocalMemoryCacher"));
+const LocalMemoryCacheAdapter_1 = __importDefault(require("../LocalMemoryCacheAdapter"));
+const LocalMemoryCacheAdapterProvider_1 = require("../LocalMemoryCacheAdapterProvider");
+const LocalMemoryTestEntity_1 = __importDefault(require("../testfixtures/LocalMemoryTestEntity"));
+const createLocalMemoryIntegrationTestEntityCompanionProvider_1 = require("../testfixtures/createLocalMemoryIntegrationTestEntityCompanionProvider");
+class TestViewerContext extends entity_1.ViewerContext {
+}
+describe(LocalMemoryCacheAdapter_1.default, () => {
+    beforeEach(async () => {
+        LocalMemoryCacheAdapterProvider_1.LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.clear();
+    });
+    it('has correct caching behavior', async () => {
+        const viewerContext = new TestViewerContext((0, createLocalMemoryIntegrationTestEntityCompanionProvider_1.createLocalMemoryIntegrationTestEntityCompanionProvider)());
+        const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity_1.default, LocalMemoryTestEntity_1.default.getCompanionDefinition())['tableDataCoordinator']['cacheAdapter'];
+        const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
+        const date = new Date();
+        const entity1Created = await LocalMemoryTestEntity_1.default.creator(viewerContext)
+            .setField('name', 'blah')
+            .setField('dateField', date)
+            .enforceCreateAsync();
+        // loading an entity should put it in cache
+        const entity1 = await LocalMemoryTestEntity_1.default.loader(viewerContext)
+            .enforcing()
+            .loadByIDAsync(entity1Created.getID());
+        const entitySpecificGenericCacher = LocalMemoryCacheAdapterProvider_1.LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(LocalMemoryTestEntity_1.default.getCompanionDefinition().entityConfiguration.tableName)['genericLocalMemoryCacher'];
+        const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
+            cacheKeyMaker('id', entity1.getID()),
+        ]);
+        const cachedValue = cachedResult.get(cacheKeyMaker('id', entity1.getID()));
+        expect(cachedValue).toMatchObject({
+            status: entity_1.CacheStatus.HIT,
+            item: {
+                id: entity1.getID(),
+                name: 'blah',
+                dateField: date,
+            },
+        });
+        // simulate non existent db fetch, should write negative result ('') to cache
+        const nonExistentId = (0, uuid_1.v4)();
+        const entityNonExistentResult = await LocalMemoryTestEntity_1.default.loader(viewerContext).loadByIDAsync(nonExistentId);
+        expect(entityNonExistentResult.ok).toBe(false);
+        const nonExistentCachedResult = await entitySpecificGenericCacher.loadManyAsync([
+            cacheKeyMaker('id', nonExistentId),
+        ]);
+        expect(nonExistentCachedResult.get(cacheKeyMaker('id', nonExistentId))).toMatchObject({
+            status: entity_1.CacheStatus.NEGATIVE,
+        });
+        // load again through entities framework to ensure it reads negative result
+        const entityNonExistentResult2 = await LocalMemoryTestEntity_1.default.loader(viewerContext).loadByIDAsync(nonExistentId);
+        expect(entityNonExistentResult2.ok).toBe(false);
+        // invalidate from cache to ensure it invalidates correctly
+        await LocalMemoryTestEntity_1.default.loader(viewerContext).invalidateFieldsAsync(entity1.getAllFields());
+        const cachedResultMiss = await entitySpecificGenericCacher.loadManyAsync([
+            cacheKeyMaker('id', entity1.getID()),
+        ]);
+        const cachedValueMiss = cachedResultMiss.get(cacheKeyMaker('id', entity1.getID()));
+        expect(cachedValueMiss).toMatchObject({ status: entity_1.CacheStatus.MISS });
+    });
+    it('shares the cache between different requests', async () => {
+        const genericLocalMemoryCacherLoadManySpy = jest.spyOn(GenericLocalMemoryCacher_1.default.prototype, 'loadManyAsync');
+        const viewerContext = new TestViewerContext((0, createLocalMemoryIntegrationTestEntityCompanionProvider_1.createLocalMemoryIntegrationTestEntityCompanionProvider)());
+        const date = new Date();
+        const entity1Created = await LocalMemoryTestEntity_1.default.creator(viewerContext)
+            .setField('name', 'blah')
+            .setField('dateField', date)
+            .enforceCreateAsync();
+        // loading an entity should put it in cache
+        await LocalMemoryTestEntity_1.default.loader(viewerContext)
+            .enforcing()
+            .loadByIDAsync(entity1Created.getID());
+        // load entity with a different request
+        const viewerContext2 = new TestViewerContext((0, createLocalMemoryIntegrationTestEntityCompanionProvider_1.createLocalMemoryIntegrationTestEntityCompanionProvider)());
+        const entity1WithVc2 = await LocalMemoryTestEntity_1.default.loader(viewerContext2)
+            .enforcing()
+            .loadByIDAsync(entity1Created.getID());
+        const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity_1.default, LocalMemoryTestEntity_1.default.getCompanionDefinition())['tableDataCoordinator']['cacheAdapter'];
+        const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
+        expect(entity1WithVc2.getAllFields()).toMatchObject({
+            id: entity1WithVc2.getID(),
+            name: 'blah',
+            dateField: date,
+        });
+        expect(genericLocalMemoryCacherLoadManySpy).toBeCalledWith([
+            cacheKeyMaker('id', entity1WithVc2.getID()),
+        ]);
+        expect(genericLocalMemoryCacherLoadManySpy).toBeCalledTimes(2);
+    });
+    it('respects the parameters of a noop cache', async () => {
+        const viewerContext = new TestViewerContext((0, createLocalMemoryIntegrationTestEntityCompanionProvider_1.createNoopLocalMemoryIntegrationTestEntityCompanionProvider)());
+        const cacheAdapter = viewerContext.entityCompanionProvider.getCompanionForEntity(LocalMemoryTestEntity_1.default, LocalMemoryTestEntity_1.default.getCompanionDefinition())['tableDataCoordinator']['cacheAdapter'];
+        const cacheKeyMaker = cacheAdapter['makeCacheKey'].bind(cacheAdapter);
+        const date = new Date();
+        const entity1Created = await LocalMemoryTestEntity_1.default.creator(viewerContext)
+            .setField('name', 'blah')
+            .setField('dateField', date)
+            .enforceCreateAsync();
+        // loading an entity will try to put it in cache but it's a noop cache, so it should be a miss
+        const entity1 = await LocalMemoryTestEntity_1.default.loader(viewerContext)
+            .enforcing()
+            .loadByIDAsync(entity1Created.getID());
+        const entitySpecificGenericCacher = LocalMemoryCacheAdapterProvider_1.LocalMemoryCacheAdapterProvider.localMemoryCacheAdapterMap.get(LocalMemoryTestEntity_1.default.getCompanionDefinition().entityConfiguration.tableName)['genericLocalMemoryCacher'];
+        const cachedResult = await entitySpecificGenericCacher.loadManyAsync([
+            cacheKeyMaker('id', entity1.getID()),
+        ]);
+        const cachedValue = cachedResult.get(cacheKeyMaker('id', entity1.getID()));
+        expect(cachedValue).toMatchObject({
+            status: entity_1.CacheStatus.MISS,
+        });
+        // a non existent db fetch should try to write negative result ('') but it's a noop cache, so it should be a miss
+        const nonExistentId = (0, uuid_1.v4)();
+        const entityNonExistentResult = await LocalMemoryTestEntity_1.default.loader(viewerContext).loadByIDAsync(nonExistentId);
+        expect(entityNonExistentResult.ok).toBe(false);
+        const nonExistentCachedResult = await entitySpecificGenericCacher.loadManyAsync([
+            cacheKeyMaker('id', nonExistentId),
+        ]);
+        expect(nonExistentCachedResult.get(cacheKeyMaker('id', nonExistentId))).toMatchObject({
+            status: entity_1.CacheStatus.MISS,
+        });
+    });
+});
+//# sourceMappingURL=LocalMemoryCacheAdapter-integration-test.js.map

package/build/__integration-tests__/LocalMemoryCacheAdapter-integration-test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalMemoryCacheAdapter-integration-test.js","sourceRoot":"","sources":["../../src/__integration-tests__/LocalMemoryCacheAdapter-integration-test.ts"],"names":[],"mappings":";;;;;AAAA,yCAA0D;AAC1D,+BAAoC;AAEpC,2FAAmE;AACnE,yFAAiE;AACjE,wFAAqF;AACrF,kGAA0E;AAC1E,qJAGiF;AAEjF,MAAM,iBAAkB,SAAQ,sBAAa;CAAG;AAEhD,QAAQ,CAAC,iCAAuB,EAAE,GAAG,EAAE;IACrC,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,iEAA+B,CAAC,0BAA0B,CAAC,KAAK,EAAE,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,aAAa,GAAG,IAAI,iBAAiB,CACzC,IAAA,iHAAuD,GAAE,CAC1D,CAAC;QACF,MAAM,YAAY,GAAG,aAAa,CAAC,uBAAuB,CAAC,qBAAqB,CAC9E,+BAAqB,EACrB,+BAAqB,CAAC,sBAAsB,EAAE,CAC/C,CAAC,sBAAsB,CAAC,CAAC,cAAc,CAAC,CAAC;QAC1C,MAAM,aAAa,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEtE,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,MAAM,cAAc,GAAG,MAAM,+BAAqB,CAAC,OAAO,CAAC,aAAa,CAAC;aACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;aACxB,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;aAC3B,kBAAkB,EAAE,CAAC;QAExB,2CAA2C;QAC3C,MAAM,OAAO,GAAG,MAAM,+BAAqB,CAAC,MAAM,CAAC,aAAa,CAAC;aAC9D,SAAS,EAAE;aACX,aAAa,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;QAEzC,MAAM,2BAA2B,GAC/B,iEAA+B,CAAC,0BAA0B,CAAC,GAAG,CAC5D,+BAAqB,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAC5E,CAAC,0BAA0B,CAAC,CAAC;QACjC,MAAM,YAAY,GAAG,MAAM,2BAA2B,CAAC,aAAa,CAAC;YACnE,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;SACrC,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAE,CAAC;QAC5E,MAAM,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC;YAChC,MAAM,EAAE,oBAAW,CAAC,GAAG;YACvB,IAAI,EAAE;gBACJ,EAAE,EAAE,OAAO,CAAC,KAAK,EAAE;gBACnB,IAAI,EAAE,MAAM;gBACZ,SAAS,EAAE,IAAI;aAChB;SACF,CAAC,CAAC;QAEH,6EAA6E;QAC7E,MAAM,aAAa,GAAG,IAAA,SAAM,GAAE,CAAC;QAE/B,MAAM,uBAAuB,GAAG,MAAM,+BAAqB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,aAAa,CAC7F,aAAa,CACd,CAAC;QACF,MAAM,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE/C,MAAM,uBAAuB,GAAG,MAAM,2BAA2B,CAAC,aAAa,CAAC;YAC9E,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC;SACnC,CAAC,CAAC;QACH,MAAM,CAAC,uBAAuB,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YACpF,MAAM,EAAE,oBAAW,CAAC,QAAQ;SAC7B,CAAC,CAAC;QAEH,2EAA2E;QAC3E,MAAM,wBAAwB,GAAG,MAAM,+BAAqB,CAAC,MAAM,CACjE,aAAa,CACd,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAC/B,MAAM,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEhD,2DAA2D;QAC3D,MAAM,+BAAqB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QAChG,MAAM,gBAAgB,GAAG,MAAM,2BAA2B,CAAC,aAAa,CAAC;YACvE,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;SACrC,CAAC,CAAC;QACH,MAAM,eAAe,GAAG,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACnF,MAAM,CAAC,eAAe,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,oBAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,mCAAmC,GAAG,IAAI,CAAC,KAAK,CACpD,kCAAwB,CAAC,SAA2B,EACpD,eAAe,CAChB,CAAC;QACF,MAAM,aAAa,GAAG,IAAI,iBAAiB,CACzC,IAAA,iHAAuD,GAAE,CAC1D,CAAC;QAEF,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,MAAM,cAAc,GAAG,MAAM,+BAAqB,CAAC,OAAO,CAAC,aAAa,CAAC;aACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;aACxB,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;aAC3B,kBAAkB,EAAE,CAAC;QAExB,2CAA2C;QAC3C,MAAM,+BAAqB,CAAC,MAAM,CAAC,aAAa,CAAC;aAC9C,SAAS,EAAE;aACX,aAAa,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;QAEzC,uCAAuC;QACvC,MAAM,cAAc,GAAG,IAAI,iBAAiB,CAC1C,IAAA,iHAAuD,GAAE,CAC1D,CAAC;QACF,MAAM,cAAc,GAAG,MAAM,+BAAqB,CAAC,MAAM,CAAC,cAAc,CAAC;aACtE,SAAS,EAAE;aACX,aAAa,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;QAEzC,MAAM,YAAY,GAAG,aAAa,CAAC,uBAAuB,CAAC,qBAAqB,CAC9E,+BAAqB,EACrB,+BAAqB,CAAC,sBAAsB,EAAE,CAC/C,CAAC,sBAAsB,CAAC,CAAC,cAAc,CAAC,CAAC;QAC1C,MAAM,aAAa,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACtE,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC,aAAa,CAAC;YAClD,EAAE,EAAE,cAAc,CAAC,KAAK,EAAE;YAC1B,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QACH,MAAM,CAAC,mCAAmC,CAAC,CAAC,cAAc,CAAC;YACzD,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,CAAC;SAC5C,CAAC,CAAC;QACH,MAAM,CAAC,mCAAmC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,aAAa,GAAG,IAAI,iBAAiB,CACzC,IAAA,qHAA2D,GAAE,CAC9D,CAAC;QACF,MAAM,YAAY,GAAG,aAAa,CAAC,uBAAuB,CAAC,qBAAqB,CAC9E,+BAAqB,EACrB,+BAAqB,CAAC,sBAAsB,EAAE,CAC/C,CAAC,sBAAsB,CAAC,CAAC,cAAc,CAAC,CAAC;QAC1C,MAAM,aAAa,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEtE,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,MAAM,cAAc,GAAG,MAAM,+BAAqB,CAAC,OAAO,CAAC,aAAa,CAAC;aACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;aACxB,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;aAC3B,kBAAkB,EAAE,CAAC;QAExB,8FAA8F;QAC9F,MAAM,OAAO,GAAG,MAAM,+BAAqB,CAAC,MAAM,CAAC,aAAa,CAAC;aAC9D,SAAS,EAAE;aACX,aAAa,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;QAEzC,MAAM,2BAA2B,GAC/B,iEAA+B,CAAC,0BAA0B,CAAC,GAAG,CAC5D,+BAAqB,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAC5E,CAAC,0BAA0B,CAAC,CAAC;QACjC,MAAM,YAAY,GAAG,MAAM,2BAA2B,CAAC,aAAa,CAAC;YACnE,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;SACrC,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAE,CAAC;QAC5E,MAAM,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC;YAChC,MAAM,EAAE,oBAAW,CAAC,IAAI;SACzB,CAAC,CAAC;QAEH,iHAAiH;QACjH,MAAM,aAAa,GAAG,IAAA,SAAM,GAAE,CAAC;QAE/B,MAAM,uBAAuB,GAAG,MAAM,+BAAqB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,aAAa,CAC7F,aAAa,CACd,CAAC;QACF,MAAM,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE/C,MAAM,uBAAuB,GAAG,MAAM,2BAA2B,CAAC,aAAa,CAAC;YAC9E,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC;SACnC,CAAC,CAAC;QACH,MAAM,CAAC,uBAAuB,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YACpF,MAAM,EAAE,oBAAW,CAAC,IAAI;SACzB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/__tests__/LocalMemoryCacheAdapter-test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/LocalMemoryCacheAdapter-test.js

@@ -0,0 +1,118 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const entity_1 = require("@expo/entity");
+const GenericLocalMemoryCacher_1 = __importStar(require("../GenericLocalMemoryCacher"));
+const LocalMemoryCacheAdapter_1 = __importDefault(require("../LocalMemoryCacheAdapter"));
+const entityConfiguration = new entity_1.EntityConfiguration({
+    idField: 'id',
+    tableName: 'blah',
+    schema: {
+        id: new entity_1.UUIDField({ columnName: 'id', cache: true }),
+    },
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'local-memory',
+});
+describe(LocalMemoryCacheAdapter_1.default, () => {
+    describe('loadManyAsync', () => {
+        it('returns appropriate cache results', async () => {
+            const cacheAdapter = new LocalMemoryCacheAdapter_1.default(entityConfiguration, GenericLocalMemoryCacher_1.default.createLRUCache({
+                maxSize: Number.MAX_SAFE_INTEGER,
+                ttlSeconds: Number.MAX_SAFE_INTEGER,
+            }));
+            const cacheHits = new Map([['test-id-1', { id: 'test-id-1' }]]);
+            await cacheAdapter.cacheManyAsync('id', cacheHits);
+            await cacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
+            const results = await cacheAdapter.loadManyAsync('id', [
+                'test-id-1',
+                'test-id-2',
+                'test-id-3',
+            ]);
+            expect(results.get('test-id-1')).toMatchObject({
+                status: entity_1.CacheStatus.HIT,
+                item: { id: 'test-id-1' },
+            });
+            expect(results.get('test-id-2')).toMatchObject({ status: entity_1.CacheStatus.NEGATIVE });
+            expect(results.get('test-id-3')).toMatchObject({ status: entity_1.CacheStatus.MISS });
+            expect(results.size).toBe(3);
+        });
+        it('returns empty map when passed empty array of fieldValues', async () => {
+            const cacheAdapter = new LocalMemoryCacheAdapter_1.default(entityConfiguration, GenericLocalMemoryCacher_1.default.createLRUCache({
+                maxSize: Number.MAX_SAFE_INTEGER,
+                ttlSeconds: Number.MAX_SAFE_INTEGER,
+            }));
+            const results = await cacheAdapter.loadManyAsync('id', []);
+            expect(results).toEqual(new Map());
+        });
+    });
+    describe('cacheManyAsync', () => {
+        it('correctly caches all objects', async () => {
+            const lruCache = GenericLocalMemoryCacher_1.default.createLRUCache({
+                maxSize: Number.MAX_SAFE_INTEGER,
+                ttlSeconds: Number.MAX_SAFE_INTEGER,
+            });
+            const cacheAdapter = new LocalMemoryCacheAdapter_1.default(entityConfiguration, lruCache);
+            await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
+            const cacheKey = cacheAdapter['makeCacheKey']('id', 'test-id-1');
+            expect(lruCache.get(cacheKey)).toMatchObject({
+                id: 'test-id-1',
+            });
+        });
+    });
+    describe('cacheDBMissesAsync', () => {
+        it('correctly caches misses', async () => {
+            const lruCache = GenericLocalMemoryCacher_1.default.createLRUCache({
+                maxSize: Number.MAX_SAFE_INTEGER,
+                ttlSeconds: Number.MAX_SAFE_INTEGER,
+            });
+            const cacheAdapter = new LocalMemoryCacheAdapter_1.default(entityConfiguration, lruCache);
+            await cacheAdapter.cacheDBMissesAsync('id', ['test-id-1']);
+            const cacheKey = cacheAdapter['makeCacheKey']('id', 'test-id-1');
+            expect(lruCache.get(cacheKey)).toEqual(GenericLocalMemoryCacher_1.DOES_NOT_EXIST_LOCAL_MEMORY_CACHE);
+        });
+    });
+    describe('invalidateManyAsync', () => {
+        it('invalidates correctly', async () => {
+            const lruCache = GenericLocalMemoryCacher_1.default.createLRUCache({
+                maxSize: Number.MAX_SAFE_INTEGER,
+                ttlSeconds: Number.MAX_SAFE_INTEGER,
+            });
+            const cacheAdapter = new LocalMemoryCacheAdapter_1.default(entityConfiguration, lruCache);
+            await cacheAdapter.cacheManyAsync('id', new Map([['test-id-1', { id: 'test-id-1' }]]));
+            await cacheAdapter.cacheDBMissesAsync('id', ['test-id-2']);
+            await cacheAdapter.invalidateManyAsync('id', ['test-id-1', 'test-id-2']);
+            const results = await cacheAdapter.loadManyAsync('id', ['test-id-1', 'test-id-2']);
+            expect(results.get('test-id-1')).toMatchObject({ status: entity_1.CacheStatus.MISS });
+            expect(results.get('test-id-2')).toMatchObject({ status: entity_1.CacheStatus.MISS });
+        });
+        it('returns when passed empty array of fieldValues', async () => {
+            const cacheAdapter = new LocalMemoryCacheAdapter_1.default(entityConfiguration, GenericLocalMemoryCacher_1.default.createLRUCache({
+                maxSize: Number.MAX_SAFE_INTEGER,
+                ttlSeconds: Number.MAX_SAFE_INTEGER,
+            }));
+            await cacheAdapter.invalidateManyAsync('id', []);
+        });
+    });
+});
+//# sourceMappingURL=LocalMemoryCacheAdapter-test.js.map

package/build/__tests__/LocalMemoryCacheAdapter-test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalMemoryCacheAdapter-test.js","sourceRoot":"","sources":["../../src/__tests__/LocalMemoryCacheAdapter-test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2E;AAE3E,wFAEqC;AACrC,yFAAiE;AAMjE,MAAM,mBAAmB,GAAG,IAAI,4BAAmB,CAAa;IAC9D,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE;QACN,EAAE,EAAE,IAAI,kBAAS,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;KACrD;IACD,qBAAqB,EAAE,UAAU;IACjC,kBAAkB,EAAE,cAAc;CACnC,CAAC,CAAC;AAEH,QAAQ,CAAC,iCAAuB,EAAE,GAAG,EAAE;IACrC,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,YAAY,GAAG,IAAI,iCAAuB,CAC9C,mBAAmB,EACnB,kCAAwB,CAAC,cAAc,CAAC;gBACtC,OAAO,EAAE,MAAM,CAAC,gBAAgB;gBAChC,UAAU,EAAE,MAAM,CAAC,gBAAgB;aACpC,CAAC,CACH,CAAC;YAEF,MAAM,SAAS,GAAG,IAAI,GAAG,CAA+B,CAAC,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;YAC9F,MAAM,YAAY,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACnD,MAAM,YAAY,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;YAE3D,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,IAAI,EAAE;gBACrD,WAAW;gBACX,WAAW;gBACX,WAAW;aACZ,CAAC,CAAC;YAEH,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC;gBAC7C,MAAM,EAAE,oBAAW,CAAC,GAAG;gBACvB,IAAI,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;aAC1B,CAAC,CAAC;YACH,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,oBAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjF,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,oBAAW,CAAC,IAAI,EAAE,CAAC,CAAC;YAC7E,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,MAAM,YAAY,GAAG,IAAI,iCAAuB,CAC9C,mBAAmB,EACnB,kCAAwB,CAAC,cAAc,CAAC;gBACtC,OAAO,EAAE,MAAM,CAAC,gBAAgB;gBAChC,UAAU,EAAE,MAAM,CAAC,gBAAgB;aACpC,CAAC,CACH,CAAC;YACF,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3D,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,QAAQ,GAAG,kCAAwB,CAAC,cAAc,CAAa;gBACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB;gBAChC,UAAU,EAAE,MAAM,CAAC,gBAAgB;aACpC,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,IAAI,iCAAuB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;YAChF,MAAM,YAAY,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAEvF,MAAM,QAAQ,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACjE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC;gBAC3C,EAAE,EAAE,WAAW;aAChB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;YACvC,MAAM,QAAQ,GAAG,kCAAwB,CAAC,cAAc,CAAa;gBACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB;gBAChC,UAAU,EAAE,MAAM,CAAC,gBAAgB;aACpC,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,IAAI,iCAAuB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;YAChF,MAAM,YAAY,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;YAE3D,MAAM,QAAQ,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACjE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,4DAAiC,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;YACrC,MAAM,QAAQ,GAAG,kCAAwB,CAAC,cAAc,CAAa;gBACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB;gBAChC,UAAU,EAAE,MAAM,CAAC,gBAAgB;aACpC,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,IAAI,iCAAuB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;YAChF,MAAM,YAAY,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACvF,MAAM,YAAY,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;YAC3D,MAAM,YAAY,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;YAEzE,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;YACnF,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,oBAAW,CAAC,IAAI,EAAE,CAAC,CAAC;YAC7E,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,oBAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;YAC9D,MAAM,YAAY,GAAG,IAAI,iCAAuB,CAC9C,mBAAmB,EACnB,kCAAwB,CAAC,cAAc,CAAa;gBAClD,OAAO,EAAE,MAAM,CAAC,gBAAgB;gBAChC,UAAU,EAAE,MAAM,CAAC,gBAAgB;aACpC,CAAC,CACH,CAAC;YACF,MAAM,YAAY,CAAC,mBAAmB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/testfixtures/LocalMemoryTestEntity.d.ts

@@ -0,0 +1,16 @@
+import { AlwaysAllowPrivacyPolicyRule, EntityPrivacyPolicy, ViewerContext, EntityConfiguration, EntityCompanionDefinition, Entity } from '@expo/entity';
+export declare type LocalMemoryTestEntityFields = {
+    id: string;
+    name: string;
+    dateField: Date | null;
+};
+export default class LocalMemoryTestEntity extends Entity<LocalMemoryTestEntityFields, string, ViewerContext> {
+    static getCompanionDefinition(): EntityCompanionDefinition<LocalMemoryTestEntityFields, string, ViewerContext, LocalMemoryTestEntity, LocalMemoryTestEntityPrivacyPolicy>;
+}
+export declare class LocalMemoryTestEntityPrivacyPolicy extends EntityPrivacyPolicy<LocalMemoryTestEntityFields, string, ViewerContext, LocalMemoryTestEntity> {
+    protected readonly createRules: AlwaysAllowPrivacyPolicyRule<LocalMemoryTestEntityFields, string, ViewerContext, LocalMemoryTestEntity, keyof LocalMemoryTestEntityFields>[];
+    protected readonly readRules: AlwaysAllowPrivacyPolicyRule<LocalMemoryTestEntityFields, string, ViewerContext, LocalMemoryTestEntity, keyof LocalMemoryTestEntityFields>[];
+    protected readonly updateRules: AlwaysAllowPrivacyPolicyRule<LocalMemoryTestEntityFields, string, ViewerContext, LocalMemoryTestEntity, keyof LocalMemoryTestEntityFields>[];
+    protected readonly deleteRules: AlwaysAllowPrivacyPolicyRule<LocalMemoryTestEntityFields, string, ViewerContext, LocalMemoryTestEntity, keyof LocalMemoryTestEntityFields>[];
+}
+export declare const localMemoryTestEntityConfiguration: EntityConfiguration<LocalMemoryTestEntityFields>;

package/build/testfixtures/LocalMemoryTestEntity.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.localMemoryTestEntityConfiguration = exports.LocalMemoryTestEntityPrivacyPolicy = void 0;
+const entity_1 = require("@expo/entity");
+class LocalMemoryTestEntity extends entity_1.Entity {
+    static getCompanionDefinition() {
+        return localMemoryTestEntityCompanionDefinition;
+    }
+}
+exports.default = LocalMemoryTestEntity;
+class LocalMemoryTestEntityPrivacyPolicy extends entity_1.EntityPrivacyPolicy {
+    constructor() {
+        super(...arguments);
+        this.createRules = [
+            new entity_1.AlwaysAllowPrivacyPolicyRule(),
+        ];
+        this.readRules = [
+            new entity_1.AlwaysAllowPrivacyPolicyRule(),
+        ];
+        this.updateRules = [
+            new entity_1.AlwaysAllowPrivacyPolicyRule(),
+        ];
+        this.deleteRules = [
+            new entity_1.AlwaysAllowPrivacyPolicyRule(),
+        ];
+    }
+}
+exports.LocalMemoryTestEntityPrivacyPolicy = LocalMemoryTestEntityPrivacyPolicy;
+exports.localMemoryTestEntityConfiguration = new entity_1.EntityConfiguration({
+    idField: 'id',
+    tableName: 'local_memory_test_entities',
+    schema: {
+        id: new entity_1.UUIDField({
+            columnName: 'id',
+            cache: true,
+        }),
+        name: new entity_1.StringField({
+            columnName: 'name',
+            cache: true,
+        }),
+        dateField: new entity_1.DateField({
+            columnName: 'date_field',
+        }),
+    },
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'local-memory',
+});
+const localMemoryTestEntityCompanionDefinition = new entity_1.EntityCompanionDefinition({
+    entityClass: LocalMemoryTestEntity,
+    entityConfiguration: exports.localMemoryTestEntityConfiguration,
+    privacyPolicyClass: LocalMemoryTestEntityPrivacyPolicy,
+});
+//# sourceMappingURL=LocalMemoryTestEntity.js.map

package/build/testfixtures/LocalMemoryTestEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalMemoryTestEntity.js","sourceRoot":"","sources":["../../src/testfixtures/LocalMemoryTestEntity.ts"],"names":[],"mappings":";;;AAAA,yCAUsB;AAQtB,MAAqB,qBAAsB,SAAQ,eAIlD;IACC,MAAM,CAAC,sBAAsB;QAO3B,OAAO,wCAAwC,CAAC;IAClD,CAAC;CACF;AAdD,wCAcC;AAED,MAAa,kCAAmC,SAAQ,4BAKvD;IALD;;QAM8B,gBAAW,GAAG;YACxC,IAAI,qCAA4B,EAK7B;SACJ,CAAC;QAC0B,cAAS,GAAG;YACtC,IAAI,qCAA4B,EAK7B;SACJ,CAAC;QAC0B,gBAAW,GAAG;YACxC,IAAI,qCAA4B,EAK7B;SACJ,CAAC;QAC0B,gBAAW,GAAG;YACxC,IAAI,qCAA4B,EAK7B;SACJ,CAAC;IACJ,CAAC;CAAA;AAtCD,gFAsCC;AAEY,QAAA,kCAAkC,GAC7C,IAAI,4BAAmB,CAA8B;IACnD,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,4BAA4B;IACvC,MAAM,EAAE;QACN,EAAE,EAAE,IAAI,kBAAS,CAAC;YAChB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,IAAI;SACZ,CAAC;QACF,IAAI,EAAE,IAAI,oBAAW,CAAC;YACpB,UAAU,EAAE,MAAM;YAClB,KAAK,EAAE,IAAI;SACZ,CAAC;QACF,SAAS,EAAE,IAAI,kBAAS,CAAC;YACvB,UAAU,EAAE,YAAY;SACzB,CAAC;KACH;IACD,qBAAqB,EAAE,UAAU;IACjC,kBAAkB,EAAE,cAAc;CACnC,CAAC,CAAC;AAEL,MAAM,wCAAwC,GAAG,IAAI,kCAAyB,CAAC;IAC7E,WAAW,EAAE,qBAAqB;IAClC,mBAAmB,EAAE,0CAAkC;IACvD,kBAAkB,EAAE,kCAAkC;CACvD,CAAC,CAAC"}

package/build/testfixtures/createLocalMemoryIntegrationTestEntityCompanionProvider.d.ts

@@ -0,0 +1,6 @@
+import { IEntityMetricsAdapter, EntityCompanionProvider } from '@expo/entity';
+export declare const createLocalMemoryIntegrationTestEntityCompanionProvider: (localMemoryOptions?: {
+    maxSize?: number;
+    ttlSeconds?: number;
+}, metricsAdapter?: IEntityMetricsAdapter) => EntityCompanionProvider;
+export declare const createNoopLocalMemoryIntegrationTestEntityCompanionProvider: (metricsAdapter?: IEntityMetricsAdapter) => EntityCompanionProvider;