@expo/entity-secondary-cache-redis 0.22.0 → 0.25.0

package/build/RedisSecondaryEntityCache.d.ts

@@ -1,33 +1,8 @@
-import { EntityConfiguration, ISecondaryEntityCache } from '@expo/entity';
+import { EntityConfiguration, GenericSecondaryEntityCache } from '@expo/entity';
 import { GenericRedisCacheContext } from '@expo/entity-cache-adapter-redis';
 /**
- * A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
- * single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
- * a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
+ * A redis {@link GenericSecondaryEntityCache}.
  */
-export default class RedisSecondaryEntityCache<TFields, TLoadParams> implements ISecondaryEntityCache<TFields, TLoadParams> {
-    private readonly entityConfiguration;
-    private readonly constructRedisKey;
-    private readonly genericRedisCacher;
+export default class RedisSecondaryEntityCache<TFields, TLoadParams> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
     constructor(entityConfiguration: EntityConfiguration<TFields>, genericRedisCacheContext: GenericRedisCacheContext, constructRedisKey: (params: Readonly<TLoadParams>) => string);
-    /**
-     * Read-through cache function. Steps:
-     *
-     * 1. Check for cached objects
-     * 2. Query the fetcher for loadParams not in the cache
-     * 3. Cache the results from the fetcher
-     * 4. Negatively cache anything missing from the fetcher
-     * 5. Return the full set of data for the query.
-     *
-     * @param loadParamsArray - array of loadParams to load from the cache
-     * @param fetcher - closure used to provide underlying data source objects for loadParams
-     * @returns map from loadParams to the entity field object
-     */
-    loadManyThroughAsync(loadParamsArray: readonly Readonly<TLoadParams>[], fetcher: (fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>;
-    /**
-     * Invalidate the cache for objects cached by constructRedisKey(loadParams).
-     *
-     * @param loadParamsArray - load params to invalidate
-     */
-    invalidateManyAsync(loadParamsArray: readonly Readonly<TLoadParams>[]): Promise<void>;
 }

package/build/RedisSecondaryEntityCache.js

@@ -1,86 +1,13 @@
 "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 entity_cache_adapter_redis_1 = require("@expo/entity-cache-adapter-redis");
-const invariant_1 = __importDefault(require("invariant"));
 /**
- * A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
- * single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
- * a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
+ * A redis {@link GenericSecondaryEntityCache}.
  */
-class RedisSecondaryEntityCache {
+class RedisSecondaryEntityCache extends entity_1.GenericSecondaryEntityCache {
     constructor(entityConfiguration, genericRedisCacheContext, constructRedisKey) {
-        this.entityConfiguration = entityConfiguration;
-        this.constructRedisKey = constructRedisKey;
-        this.genericRedisCacher = new entity_cache_adapter_redis_1.GenericRedisCacher(genericRedisCacheContext);
-    }
-    /**
-     * Read-through cache function. Steps:
-     *
-     * 1. Check for cached objects
-     * 2. Query the fetcher for loadParams not in the cache
-     * 3. Cache the results from the fetcher
-     * 4. Negatively cache anything missing from the fetcher
-     * 5. Return the full set of data for the query.
-     *
-     * @param loadParamsArray - array of loadParams to load from the cache
-     * @param fetcher - closure used to provide underlying data source objects for loadParams
-     * @returns map from loadParams to the entity field object
-     */
-    async loadManyThroughAsync(loadParamsArray, fetcher) {
-        const redisKeys = loadParamsArray.map(this.constructRedisKey);
-        const redisKeyToLoadParamsMap = (0, entity_1.zipToMap)(redisKeys, loadParamsArray);
-        const cacheLoadResults = await this.genericRedisCacher.loadManyAsync(redisKeys);
-        (0, invariant_1.default)(cacheLoadResults.size === loadParamsArray.length, `${this.constructor.name} loadMany should return a result for each key`);
-        const redisKeysToFetch = Array.from((0, entity_1.filterMap)(cacheLoadResults, (cacheLoadResult) => cacheLoadResult.status === entity_1.CacheStatus.MISS).keys());
-        // put transformed cache hits in result map
-        const results = new Map();
-        cacheLoadResults.forEach((cacheLoadResult, redisKey) => {
-            if (cacheLoadResult.status === entity_1.CacheStatus.HIT) {
-                const loadParams = redisKeyToLoadParamsMap.get(redisKey);
-                (0, invariant_1.default)(loadParams !== undefined, 'load params should be in redis key map');
-                results.set(loadParams, (0, entity_1.transformCacheObjectToFields)(this.entityConfiguration, entity_cache_adapter_redis_1.redisTransformerMap, cacheLoadResult.item));
-            }
-        });
-        // fetch any misses from DB, add DB objects to results, cache DB results, inform cache of any missing DB results
-        if (redisKeysToFetch.length > 0) {
-            const loadParamsToFetch = redisKeysToFetch.map((redisKey) => {
-                const loadParams = redisKeyToLoadParamsMap.get(redisKey);
-                (0, invariant_1.default)(loadParams !== undefined, 'load params should be in redis key map');
-                return loadParams;
-            });
-            const fetchResults = await fetcher(loadParamsToFetch);
-            const fetchMisses = loadParamsToFetch.filter((loadParams) => {
-                // all values of fetchResults should be field objects or undefined
-                return !fetchResults.get(loadParams);
-            });
-            for (const fetchMiss of fetchMisses) {
-                results.set(fetchMiss, null);
-            }
-            const objectsToCache = new Map();
-            for (const [loadParams, object] of fetchResults.entries()) {
-                if (object) {
-                    objectsToCache.set(this.constructRedisKey(loadParams), (0, entity_1.transformFieldsToCacheObject)(this.entityConfiguration, entity_cache_adapter_redis_1.redisTransformerMap, object));
-                    results.set(loadParams, object);
-                }
-            }
-            await Promise.all([
-                this.genericRedisCacher.cacheManyAsync(objectsToCache),
-                this.genericRedisCacher.cacheDBMissesAsync(fetchMisses.map(this.constructRedisKey)),
-            ]);
-        }
-        return results;
-    }
-    /**
-     * Invalidate the cache for objects cached by constructRedisKey(loadParams).
-     *
-     * @param loadParamsArray - load params to invalidate
-     */
-    async invalidateManyAsync(loadParamsArray) {
-        await this.genericRedisCacher.invalidateManyAsync(loadParamsArray.map(this.constructRedisKey));
+        super(new entity_cache_adapter_redis_1.GenericRedisCacher(genericRedisCacheContext, entityConfiguration), constructRedisKey);
     }
 }
 exports.default = RedisSecondaryEntityCache;

package/build/RedisSecondaryEntityCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"RedisSecondaryEntityCache.js","sourceRoot":"","sources":["../src/RedisSecondaryEntityCache.ts"],"names":[],"mappings":";;;;;AAAA,yCAQsB;AACtB,iFAI0C;AAC1C,0DAAkC;AAElC;;;;GAIG;AACH,MAAqB,yBAAyB;IAK5C,YACmB,mBAAiD,EAClE,wBAAkD,EACjC,iBAA4D;QAF5D,wBAAmB,GAAnB,mBAAmB,CAA8B;QAEjD,sBAAiB,GAAjB,iBAAiB,CAA2C;QAE7E,IAAI,CAAC,kBAAkB,GAAG,IAAI,+CAAkB,CAAC,wBAAwB,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,oBAAoB,CAC/B,eAAiD,EACjD,OAE0E;QAE1E,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9D,MAAM,uBAAuB,GAAG,IAAA,iBAAQ,EAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAErE,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAEhF,IAAA,mBAAS,EACP,gBAAgB,CAAC,IAAI,KAAK,eAAe,CAAC,MAAM,EAChD,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,+CAA+C,CACxE,CAAC;QAEF,MAAM,gBAAgB,GAAG,KAAK,CAAC,IAAI,CACjC,IAAA,kBAAS,EACP,gBAAgB,EAChB,CAAC,eAAe,EAAE,EAAE,CAAC,eAAe,CAAC,MAAM,KAAK,oBAAW,CAAC,IAAI,CACjE,CAAC,IAAI,EAAE,CACT,CAAC;QAEF,2CAA2C;QAC3C,MAAM,OAAO,GAAyD,IAAI,GAAG,EAAE,CAAC;QAChF,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,QAAQ,EAAE,EAAE;YACrD,IAAI,eAAe,CAAC,MAAM,KAAK,oBAAW,CAAC,GAAG,EAAE;gBAC9C,MAAM,UAAU,GAAG,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACzD,IAAA,mBAAS,EAAC,UAAU,KAAK,SAAS,EAAE,wCAAwC,CAAC,CAAC;gBAC9E,OAAO,CAAC,GAAG,CACT,UAAU,EACV,IAAA,qCAA4B,EAC1B,IAAI,CAAC,mBAAmB,EACxB,gDAAmB,EACnB,eAAe,CAAC,IAAI,CACrB,CACF,CAAC;aACH;QACH,CAAC,CAAC,CAAC;QAEH,gHAAgH;QAChH,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAC1D,MAAM,UAAU,GAAG,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACzD,IAAA,mBAAS,EAAC,UAAU,KAAK,SAAS,EAAE,wCAAwC,CAAC,CAAC;gBAC9E,OAAO,UAAU,CAAC;YACpB,CAAC,CAAC,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAC;YAEtD,MAAM,WAAW,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC1D,kEAAkE;gBAClE,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;YAEH,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE;gBACnC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;aAC9B;YAED,MAAM,cAAc,GAAwB,IAAI,GAAG,EAAE,CAAC;YACtD,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,YAAY,CAAC,OAAO,EAAE,EAAE;gBACzD,IAAI,MAAM,EAAE;oBACV,cAAc,CAAC,GAAG,CAChB,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAClC,IAAA,qCAA4B,EAAC,IAAI,CAAC,mBAAmB,EAAE,gDAAmB,EAAE,MAAM,CAAC,CACpF,CAAC;oBACF,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;iBACjC;aACF;YAED,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC;gBACtD,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;aACpF,CAAC,CAAC;SACJ;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAC9B,eAAiD;QAEjD,MAAM,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACjG,CAAC;CACF;AAlHD,4CAkHC"}
+{"version":3,"file":"RedisSecondaryEntityCache.js","sourceRoot":"","sources":["../src/RedisSecondaryEntityCache.ts"],"names":[],"mappings":";;AAAA,yCAAgF;AAChF,iFAAgG;AAEhG;;GAEG;AACH,MAAqB,yBAGnB,SAAQ,oCAAiD;IACzD,YACE,mBAAiD,EACjD,wBAAkD,EAClD,iBAA4D;QAE5D,KAAK,CAAC,IAAI,+CAAkB,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAClG,CAAC;CACF;AAXD,4CAWC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expo/entity-secondary-cache-redis",
-  "version": "0.22.0",
+  "version": "0.25.0",
   "description": "Redis secondary cache for @expo/entity",
   "files": [
     "build",
@@ -34,8 +34,8 @@
     "ioredis": "^4.17.3"
   },
   "devDependencies": {
-    "@expo/entity": "^0.22.0",
-    "@expo/entity-cache-adapter-redis": "^0.22.0",
+    "@expo/entity": "^0.25.0",
+    "@expo/entity-cache-adapter-redis": "^0.25.0",
     "nullthrows": "^1.1.1"
   }
 }

package/src/RedisSecondaryEntityCache.ts

@@ -1,136 +1,18 @@
-import {
-  CacheStatus,
-  EntityConfiguration,
-  filterMap,
-  ISecondaryEntityCache,
-  transformCacheObjectToFields,
-  transformFieldsToCacheObject,
-  zipToMap,
-} from '@expo/entity';
-import {
-  GenericRedisCacheContext,
-  GenericRedisCacher,
-  redisTransformerMap,
-} from '@expo/entity-cache-adapter-redis';
-import invariant from 'invariant';
+import { EntityConfiguration, GenericSecondaryEntityCache } from '@expo/entity';
+import { GenericRedisCacheContext, GenericRedisCacher } from '@expo/entity-cache-adapter-redis';
 
 /**
- * A custom secondary read-through entity cache is a way to add a custom second layer of caching for a particular
- * single entity load. One common way this may be used is to add a second layer of caching in a hot path that makes
- * a call to {@link EntityLoader.loadManyByFieldEqualityConjunctionAsync} is guaranteed to return at most one entity.
+ * A redis {@link GenericSecondaryEntityCache}.
  */
-export default class RedisSecondaryEntityCache<TFields, TLoadParams>
-  implements ISecondaryEntityCache<TFields, TLoadParams>
-{
-  private readonly genericRedisCacher: GenericRedisCacher;
-
+export default class RedisSecondaryEntityCache<
+  TFields,
+  TLoadParams
+> extends GenericSecondaryEntityCache<TFields, TLoadParams> {
   constructor(
-    private readonly entityConfiguration: EntityConfiguration<TFields>,
+    entityConfiguration: EntityConfiguration<TFields>,
     genericRedisCacheContext: GenericRedisCacheContext,
-    private readonly constructRedisKey: (params: Readonly<TLoadParams>) => string
+    constructRedisKey: (params: Readonly<TLoadParams>) => string
   ) {
-    this.genericRedisCacher = new GenericRedisCacher(genericRedisCacheContext);
-  }
-
-  /**
-   * Read-through cache function. Steps:
-   *
-   * 1. Check for cached objects
-   * 2. Query the fetcher for loadParams not in the cache
-   * 3. Cache the results from the fetcher
-   * 4. Negatively cache anything missing from the fetcher
-   * 5. Return the full set of data for the query.
-   *
-   * @param loadParamsArray - array of loadParams to load from the cache
-   * @param fetcher - closure used to provide underlying data source objects for loadParams
-   * @returns map from loadParams to the entity field object
-   */
-  public async loadManyThroughAsync(
-    loadParamsArray: readonly Readonly<TLoadParams>[],
-    fetcher: (
-      fetcherLoadParamsArray: readonly Readonly<TLoadParams>[]
-    ) => Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>>
-  ): Promise<ReadonlyMap<Readonly<TLoadParams>, Readonly<TFields> | null>> {
-    const redisKeys = loadParamsArray.map(this.constructRedisKey);
-    const redisKeyToLoadParamsMap = zipToMap(redisKeys, loadParamsArray);
-
-    const cacheLoadResults = await this.genericRedisCacher.loadManyAsync(redisKeys);
-
-    invariant(
-      cacheLoadResults.size === loadParamsArray.length,
-      `${this.constructor.name} loadMany should return a result for each key`
-    );
-
-    const redisKeysToFetch = Array.from(
-      filterMap(
-        cacheLoadResults,
-        (cacheLoadResult) => cacheLoadResult.status === CacheStatus.MISS
-      ).keys()
-    );
-
-    // put transformed cache hits in result map
-    const results: Map<Readonly<TLoadParams>, Readonly<TFields> | null> = new Map();
-    cacheLoadResults.forEach((cacheLoadResult, redisKey) => {
-      if (cacheLoadResult.status === CacheStatus.HIT) {
-        const loadParams = redisKeyToLoadParamsMap.get(redisKey);
-        invariant(loadParams !== undefined, 'load params should be in redis key map');
-        results.set(
-          loadParams,
-          transformCacheObjectToFields(
-            this.entityConfiguration,
-            redisTransformerMap,
-            cacheLoadResult.item
-          )
-        );
-      }
-    });
-
-    // fetch any misses from DB, add DB objects to results, cache DB results, inform cache of any missing DB results
-    if (redisKeysToFetch.length > 0) {
-      const loadParamsToFetch = redisKeysToFetch.map((redisKey) => {
-        const loadParams = redisKeyToLoadParamsMap.get(redisKey);
-        invariant(loadParams !== undefined, 'load params should be in redis key map');
-        return loadParams;
-      });
-      const fetchResults = await fetcher(loadParamsToFetch);
-
-      const fetchMisses = loadParamsToFetch.filter((loadParams) => {
-        // all values of fetchResults should be field objects or undefined
-        return !fetchResults.get(loadParams);
-      });
-
-      for (const fetchMiss of fetchMisses) {
-        results.set(fetchMiss, null);
-      }
-
-      const objectsToCache: Map<string, object> = new Map();
-      for (const [loadParams, object] of fetchResults.entries()) {
-        if (object) {
-          objectsToCache.set(
-            this.constructRedisKey(loadParams),
-            transformFieldsToCacheObject(this.entityConfiguration, redisTransformerMap, object)
-          );
-          results.set(loadParams, object);
-        }
-      }
-
-      await Promise.all([
-        this.genericRedisCacher.cacheManyAsync(objectsToCache),
-        this.genericRedisCacher.cacheDBMissesAsync(fetchMisses.map(this.constructRedisKey)),
-      ]);
-    }
-
-    return results;
-  }
-
-  /**
-   * Invalidate the cache for objects cached by constructRedisKey(loadParams).
-   *
-   * @param loadParamsArray - load params to invalidate
-   */
-  public async invalidateManyAsync(
-    loadParamsArray: readonly Readonly<TLoadParams>[]
-  ): Promise<void> {
-    await this.genericRedisCacher.invalidateManyAsync(loadParamsArray.map(this.constructRedisKey));
+    super(new GenericRedisCacher(genericRedisCacheContext, entityConfiguration), constructRedisKey);
   }
 }