@graphql-box/cache-manager 3.4.2 → 4.0.0

package/src/__snapshots__/index.test.ts.snap

@@ -35193,6 +35193,137 @@ Object {
 }
 `;
 
+exports[`@graphql-box/cache-manager >> analyzeQuery >> some matching data >> single type with just ID match >> correct cache data 1`] = `
+Object {
+  "entries": Array [
+    Array [
+      "queryResponses::fe7ca217a961a692d575fe9973836699",
+      Object {
+        "cacheMetadata": Object {
+          "query": Object {
+            "cacheControl": Object {
+              "maxAge": 1,
+              "public": true,
+            },
+            "ttl": 297475201000,
+          },
+          "query.organization": Object {
+            "cacheControl": Object {
+              "maxAge": 1,
+              "public": true,
+            },
+            "ttl": 297475201000,
+          },
+        },
+        "data": Object {
+          "organization": Object {
+            "description": "We are working to build community through open source technology. NB: members must have two-factor auth.",
+            "email": "",
+            "id": "MDEyOk9yZ2FuaXphdGlvbjY5NjMx",
+          },
+        },
+      },
+    ],
+    Array [
+      "requestFieldPaths::5256db516a2438a7e5488a00413f4809",
+      Object {
+        "description": "We are working to build community through open source technology. NB: members must have two-factor auth.",
+        "email": "",
+        "id": "MDEyOk9yZ2FuaXphdGlvbjY5NjMx",
+      },
+    ],
+    Array [
+      "dataEntities::Organization::MDEyOk9yZ2FuaXphdGlvbjY5NjMx",
+      Object {
+        "description": "We are working to build community through open source technology. NB: members must have two-factor auth.",
+        "email": "",
+        "id": "MDEyOk9yZ2FuaXphdGlvbjY5NjMx",
+      },
+    ],
+  ],
+  "metadata": Array [
+    Object {
+      "accessedCount": 1,
+      "added": 297475200000,
+      "cacheability": Cacheability {
+        "metadata": Object {
+          "cacheControl": Object {
+            "maxAge": 1,
+            "public": true,
+          },
+          "etag": undefined,
+          "ttl": 297475201000,
+        },
+      },
+      "key": "requestFieldPaths::5256db516a2438a7e5488a00413f4809",
+      "lastAccessed": 297475200000,
+      "lastUpdated": 297475200000,
+      "size": 456,
+      "tags": Array [],
+      "updatedCount": 0,
+    },
+    Object {
+      "accessedCount": 1,
+      "added": 297475200000,
+      "cacheability": Cacheability {
+        "metadata": Object {
+          "cacheControl": Object {
+            "maxAge": 1,
+            "public": true,
+          },
+          "etag": undefined,
+          "ttl": 297475201000,
+        },
+      },
+      "key": "dataEntities::Organization::MDEyOk9yZ2FuaXphdGlvbjY5NjMx",
+      "lastAccessed": 297475200000,
+      "lastUpdated": 297475200000,
+      "size": 456,
+      "tags": Array [],
+      "updatedCount": 0,
+    },
+    Object {
+      "accessedCount": 0,
+      "added": 297475200000,
+      "cacheability": Cacheability {
+        "metadata": Object {
+          "cacheControl": Object {
+            "maxAge": 1,
+            "public": true,
+          },
+          "etag": undefined,
+          "ttl": 297475201000,
+        },
+      },
+      "key": "queryResponses::fe7ca217a961a692d575fe9973836699",
+      "lastAccessed": 297475200000,
+      "lastUpdated": 297475200000,
+      "size": 984,
+      "tags": Array [],
+      "updatedCount": 0,
+    },
+  ],
+}
+`;
+
+exports[`@graphql-box/cache-manager >> analyzeQuery >> some matching data >> single type with just ID match >> correct partial data 1`] = `Map {}`;
+
+exports[`@graphql-box/cache-manager >> analyzeQuery >> some matching data >> single type with just ID match >> correct request data 1`] = `
+Object {
+  "hash": "0f87f523d8cf0a8e383850d601aa3f86",
+  "request": "
+  {
+    organization(login: \\"facebook\\") {
+      login
+      name
+      url
+      id
+    }
+  }
+",
+}
+`;
+
 exports[`@graphql-box/cache-manager >> resolveQuery >> filtered >> defer >> cascading cache control >> correct cache data 1`] = `
 Object {
   "entries": Array [

package/src/defs/index.ts

@@ -42,18 +42,12 @@ export interface UserOptions {
    * directives used for caching object types.
    */
   typeCacheDirectives?: PlainObjectStringMap;
-}
-
-export interface ClientOptions {
-  typeIDKey: string;
-}
 
-export interface ConstructorOptions {
-  cache: Cachemap;
-  cascadeCacheControl?: boolean;
-  fallbackOperationCacheability?: string;
-  typeCacheDirectives?: PlainObjectStringMap;
-  typeIDKey: string;
+  /**
+   * The name of the property thats value is used as the unique
+   * identifier for each type in the GraphQL schema.
+   */
+  typeIDKey?: string;
 }
 
 export interface CacheManagerContext extends RequestContext {
@@ -194,5 +188,3 @@ export interface CacheManagerDef {
     context: CacheManagerContext,
   ): Promise<void>;
 }
-
-export type CacheManagerInit = (options: ClientOptions) => CacheManagerDef;

package/src/helpers/areOnlyPopulatedFieldsTypeIdKeys.ts

@@ -0,0 +1,40 @@
+import { PlainObjectMap } from "@graphql-box/core";
+import { isArray, isPlainObject } from "lodash";
+
+const checkValue = (value: any, typeIDKey: string): boolean => {
+  if (isArray(value)) {
+    return value.reduce((accB: boolean, entry) => {
+      if (!accB) {
+        return false;
+      }
+
+      return checkValue(entry, typeIDKey);
+    }, true);
+  }
+
+  if (isPlainObject(value)) {
+    return recursivelyCheckProps(value, typeIDKey);
+  }
+
+  return false;
+};
+
+const recursivelyCheckProps = (data: PlainObjectMap, typeIDKey: string): boolean => {
+  const keys = Object.keys(data);
+
+  if (keys.length === 1 && !!data[typeIDKey]) {
+    return true;
+  }
+
+  return keys.reduce((accA: boolean, key) => {
+    if (!accA) {
+      return false;
+    }
+
+    return checkValue(data[key], typeIDKey);
+  }, true);
+};
+
+export default (data: PlainObjectMap, typeIDKey: string) => {
+  return recursivelyCheckProps(data, typeIDKey);
+};

package/src/index.test.ts

@@ -17,7 +17,7 @@ import {
   requestFieldTypeMaps,
   responses,
 } from "@graphql-box/test-utils";
-import { AnalyzeQueryResult, CacheManager, CacheManagerDef } from ".";
+import CacheManager, { AnalyzeQueryResult, CacheManagerDef } from ".";
 
 describe("@graphql-box/cache-manager >>", () => {
   const realDateNow = Date.now.bind(global.Date);
@@ -1200,6 +1200,60 @@ describe("@graphql-box/cache-manager >>", () => {
         });
       });
 
+      describe("single type with just ID match >>", () => {
+        beforeAll(async () => {
+          analyzeQueryResult = undefined;
+          // @ts-ignore
+          jest.spyOn(CacheManager, "_isValid").mockReturnValue(true);
+
+          cacheManager = new CacheManager({
+            cache: new Cachemap({
+              name: "cachemap",
+              store: map(),
+              type: "someType",
+            }),
+            typeCacheDirectives: {
+              Organization: "public, max-age=1",
+            },
+            typeIDKey: DEFAULT_TYPE_ID_KEY,
+          });
+
+          const requestData = getRequestData(parsedRequests.singleTypeQuerySmallA);
+
+          await cacheManager.cacheQuery(
+            requestData,
+            requestData,
+            responses.singleTypeQuerySmallA,
+            { awaitDataCaching: true },
+            getRequestContext({ fieldTypeMap: requestFieldTypeMaps.singleTypeQuery }),
+          );
+
+          analyzeQueryResult = await cacheManager.analyzeQuery(
+            getRequestData(parsedRequests.singleTypeQuerySmallB),
+            { awaitDataCaching: true },
+            getRequestContext({ fieldTypeMap: requestFieldTypeMaps.singleTypeQuery }),
+          );
+        });
+
+        it("correct request data", () => {
+          const { ast, ...otherProps } = analyzeQueryResult?.updated as RequestData;
+          expect(otherProps).toMatchSnapshot();
+        });
+
+        it("no response data", () => {
+          expect(analyzeQueryResult?.response).toBeUndefined();
+        });
+
+        it("correct cache data", async () => {
+          expect(await cacheManager.cache.export()).toMatchSnapshot();
+        });
+
+        it("correct partial data", () => {
+          // @ts-ignore
+          expect(cacheManager._partialQueryResponses).toMatchSnapshot();
+        });
+      });
+
       describe("nested type with edges >", () => {
         beforeAll(async () => {
           analyzeQueryResult = undefined;

package/src/index.ts

@@ -1,2 +1,2 @@
 export * from "./defs";
-export { default, CacheManager } from "./main";
+export { default } from "./main";

package/src/main/index.ts

@@ -4,6 +4,7 @@ import {
   CacheTypes,
   CachemapOptions,
   DATA_ENTITIES,
+  DEFAULT_TYPE_ID_KEY,
   FieldTypeInfo,
   PlainObjectMap,
   PlainObjectStringMap,
@@ -41,12 +42,9 @@ import {
   AncestorKeysAndPaths,
   CacheManagerContext,
   CacheManagerDef,
-  CacheManagerInit,
   CachedAncestorFieldData,
   CachedResponseData,
   CheckCacheEntryResult,
-  ClientOptions,
-  ConstructorOptions,
   DataForCachingEntry,
   FieldCount,
   FieldPathChecklist,
@@ -59,6 +57,7 @@ import {
   TypeNamesAndKind,
   UserOptions,
 } from "../defs";
+import areOnlyPopulatedFieldsTypeIdKeys from "../helpers/areOnlyPopulatedFieldsTypeIdKeys";
 import deriveOpCacheability from "../helpers/deriveOpCacheability";
 import filterOutPropsWithArgsOrDirectives from "../helpers/filterOutPropsWithArgsOrDirectives";
 import filterQuery from "../helpers/filterQuery";
@@ -69,7 +68,7 @@ import mergeResponseDataSets from "../helpers/mergeResponseDataSets";
 import normalizePatchResponseData from "../helpers/normalizePatchResponseData";
 import { getValidTypeIDValue } from "../helpers/validTypeIDValue";
 
-export class CacheManager implements CacheManagerDef {
+export default class CacheManager implements CacheManagerDef {
   private static _countFieldPathChecklist(fieldPathChecklist: FieldPathChecklist): FieldCount {
     const fieldCount: FieldCount = { missing: 0, total: 0 };
 
@@ -213,7 +212,7 @@ export class CacheManager implements CacheManagerDef {
   private _typeCacheDirectives: PlainObjectStringMap;
   private _typeIDKey: string;
 
-  constructor(options: ConstructorOptions) {
+  constructor(options: UserOptions) {
     const errors: TypeError[] = [];
 
     if (!options.cache) {
@@ -233,7 +232,7 @@ export class CacheManager implements CacheManagerDef {
     this._cascadeCacheControl = options.cascadeCacheControl || false;
     this._fallbackOperationCacheability = options.fallbackOperationCacheability || NO_CACHE;
     this._typeCacheDirectives = options.typeCacheDirectives || {};
-    this._typeIDKey = options.typeIDKey;
+    this._typeIDKey = options.typeIDKey ?? DEFAULT_TYPE_ID_KEY;
   }
 
   get cache(): Cachemap {
@@ -260,7 +259,10 @@ export class CacheManager implements CacheManagerDef {
     const cachedResponseData = await this._retrieveCachedResponseData(requestData, options, cacheManagerContext);
     const { cacheMetadata, data, fieldCount } = cachedResponseData;
 
-    if (fieldCount.missing === fieldCount.total) {
+    // Second half of check is required for the scenario where the only matching data is
+    // the typeIDKey field, i.e. "id", in which case there is no point settings a partial
+    // query reponse because we request the typeIDKey field with every request.
+    if (fieldCount.missing === fieldCount.total || areOnlyPopulatedFieldsTypeIdKeys(data, this._typeIDKey)) {
       return { updated: requestData };
     }
 
@@ -1179,11 +1181,3 @@ export class CacheManager implements CacheManagerDef {
     }
   }
 }
-
-export default function init(userOptions: UserOptions): CacheManagerInit {
-  if (!isPlainObject(userOptions)) {
-    throw new TypeError("@graphql-box/cache-manager expected userOptions to be a plain object.");
-  }
-
-  return (clientOptions: ClientOptions) => new CacheManager({ ...clientOptions, ...userOptions });
-}