@graphql-box/cache-manager 5.4.0 → 5.4.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@graphql-box/cache-manager",
   "description": "The GraphQL Box cache manager module.",
-  "version": "5.4.0",
+  "version": "5.4.2",
   "author": "Dylan Aubrey",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/graphql-box",
@@ -36,8 +36,8 @@
     "cacheability": "^4.0.27",
     "core-js": "^3.39.0",
     "lodash-es": "^4.17.21",
-    "@graphql-box/core": "5.4.0",
-    "@graphql-box/helpers": "5.4.0"
+    "@graphql-box/core": "5.4.1",
+    "@graphql-box/helpers": "5.4.1"
   },
   "peerDependencies": {
     "@cachemap/core": "<6",
@@ -50,7 +50,7 @@
     "cts-types": "^0.0.8",
     "del-cli": "^6.0.0",
     "graphql": "^16.9.0",
-    "@graphql-box/test-utils": "5.4.0"
+    "@graphql-box/test-utils": "5.4.1"
   },
   "keywords": [
     "client",

package/src/index.test.ts

@@ -72,7 +72,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
       });
 
@@ -119,7 +119,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
       });
     });
@@ -162,7 +162,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
       });
 
@@ -206,7 +206,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
       });
     });
@@ -253,7 +253,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
 
@@ -294,7 +294,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
       });
@@ -335,7 +335,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
 
@@ -379,7 +379,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
       });
@@ -420,7 +420,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
 
@@ -462,7 +462,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
       });
@@ -525,7 +525,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
 
@@ -586,7 +586,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
       });
@@ -647,7 +647,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
 
@@ -711,7 +711,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
       });
@@ -772,7 +772,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
 
@@ -834,7 +834,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
       });
@@ -915,7 +915,7 @@ describe('@graphql-box/cache-manager >>', () => {
           });
 
           it('correct cache data', async () => {
-            await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+            await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
           });
         });
       });
@@ -1121,7 +1121,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
       });
 
@@ -1177,7 +1177,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
       });
 
@@ -1231,7 +1231,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
       });
 
@@ -1298,7 +1298,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
       });
     });
@@ -1355,7 +1355,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
 
         it('correct partial data', () => {
@@ -1415,7 +1415,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
 
         it('correct partial data', () => {
@@ -1478,7 +1478,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
 
         it('correct partial data', () => {
@@ -1539,7 +1539,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
 
         it('correct partial data', () => {
@@ -1597,7 +1597,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
 
         it('correct partial data', () => {
@@ -1655,7 +1655,7 @@ describe('@graphql-box/cache-manager >>', () => {
         });
 
         it('correct cache data', async () => {
-          await expect(cacheManager.cache.export()).resolves.toMatchSnapshot();
+          await expect(cacheManager.cache?.export()).resolves.toMatchSnapshot();
         });
 
         it('correct partial data', () => {

package/src/main.ts

@@ -231,7 +231,7 @@ export class CacheManager implements CacheManagerDef {
     ]);
   }
 
-  private readonly _cache: Core;
+  private _cache: Core | undefined;
   private readonly _cacheTiersEnabled: CacheTiersEnabled = { entity: false, queryResponse: true, requestPath: false };
   private readonly _cascadeCacheControl: boolean;
   private readonly _fallbackOperationCacheability: string;
@@ -256,7 +256,19 @@ export class CacheManager implements CacheManagerDef {
       throw new GroupedError('@graphql-box/cache-manager argument validation errors.', errors);
     }
 
-    this._cache = options.cache;
+    if (typeof options.cache === 'function') {
+      void options
+        .cache()
+        .then(cache => {
+          this._cache = cache;
+        })
+        .catch((error: unknown) => {
+          throw error;
+        });
+    } else {
+      this._cache = options.cache;
+    }
+
     this._cacheTiersEnabled = { ...this._cacheTiersEnabled, ...options.cacheTiersEnabled };
     this._cascadeCacheControl = options.cascadeCacheControl ?? false;
     this._fallbackOperationCacheability = options.fallbackOperationCacheability ?? NO_CACHE;
@@ -321,7 +333,7 @@ export class CacheManager implements CacheManagerDef {
     };
   }
 
-  get cache(): Core {
+  get cache(): Core | undefined {
     return this._cache;
   }
 
@@ -744,7 +756,7 @@ export class CacheManager implements CacheManagerDef {
     _options: RequestOptions,
     _context: CacheManagerContext & { requestFieldCacheKey?: string },
   ): Promise<T | undefined> {
-    return this._cache.get<T>(`${cacheType}::${hash}`);
+    return this._cache?.get<T>(`${cacheType}::${hash}`);
   }
 
   private _getPartialQueryResponse(hash: string): PartialQueryResponse | undefined {
@@ -755,7 +767,7 @@ export class CacheManager implements CacheManagerDef {
 
   private async _hasCacheEntry(cacheType: CacheTypes, hash: string): Promise<Cacheability | false> {
     try {
-      return await this._cache.has(`${cacheType}::${hash}`);
+      return (await this._cache?.has(`${cacheType}::${hash}`)) ?? false;
     } catch {
       return false;
     }
@@ -1044,7 +1056,7 @@ export class CacheManager implements CacheManagerDef {
     _context: CacheManagerContext & { requestFieldCacheKey?: string },
   ): Promise<void> {
     try {
-      await this._cache.set(`${cacheType}::${hash}`, structuredClone(value), cachemapOptions);
+      await this._cache?.set(`${cacheType}::${hash}`, structuredClone(value), cachemapOptions);
     } catch {
       // no catch
     }

package/src/types.ts

@@ -26,7 +26,7 @@ export interface UserOptions {
    * The cache to use for storing query responses, data entities,
    * and request field paths.
    */
-  cache: Core;
+  cache: Core | (() => Promise<Core>);
   /**
    * Whether to enable/disable any/all the three cache tiers
    * the CacheManager uses. All three are enabled by default.
@@ -161,7 +161,7 @@ export interface QueryResponseCacheEntry {
 
 export interface CacheManagerDef {
   analyzeQuery(requestData: RequestData, options: RequestOptions, context: RequestContext): Promise<AnalyzeQueryResult>;
-  cache: Core;
+  cache: Core | undefined;
   cacheQuery(
     requestData: RequestData,
     updatedRequestData: RequestData | undefined,