(graphcache) - Enable more cache.keyOfEntity parent cases and depreca…

…te cache.resolveFieldByKey (#1219)

* Enable store.keyOfEntity to handle more parent cases

* Add test for store.keyOfEntity with missing __typename field

* Deprecate cache.resolveFieldByKey in favor of cache.resolve

* Add changesets

* Replace cache.resolveFieldByKey in extras sources

.changeset/tough-keys-visit.md

@@ -0,0 +1,5 @@
+---
+'@urql/exchange-graphcache': patch
+---
+
+Update `cache.resolve(parent, ...)` case to enable _even more_ cases, for instance where `parent.__typename` isn't set yet. This was intended to be enabled in the previous patch but has been forgotten.

.changeset/wild-pandas-vanish.md

@@ -0,0 +1,5 @@
+---
+'@urql/exchange-graphcache': patch
+---
+
+Deprecate `cache.resolveFieldByKey` in favour of `cache.resolve`, which functionally was already able to do the same.

docs/api/graphcache.md

@@ -250,15 +250,16 @@ an entity key, which makes it possible to pass a key from `cache.keyOfEntity` or
 > be dangerous to use in some cases. It's a good idea to make sure first whether the field you're
 > reading will be a key or a value.
 
-There's an alternative method, `cache.resolveFieldByKey` which accepts a field key that may be
-generated using `cache.keyOfField`.
+The `cache.resolve` method may also be called with a field key as generated by `cache.keyOfField`.
 
 ```js
-cache.resolveFieldByKey({ __typename: 'Query' }, cache.keyOfField('todo', { id: 1 })); // 'Todo:1'
+cache.resolve({ __typename: 'Query' }, cache.keyOfField('todo', { id: 1 })); // 'Todo:1'
 ```
 
-This specialized method is likely only going to be useful in combination with
-[`cache.inspectFields`](#inspectfields).
+This specialized case is likely only going to be useful in combination with
+[`cache.inspectFields`](#inspectfields). Previously a specialised method existed for this
+case specifically and was called `cache.resolveFieldByKey`, which is now deprecated, since
+`cache.resolve` may be called with a field key and no extra arguments.
 
 ### inspectFields
 

exchanges/graphcache/default-storage/package.json

@@ -15,7 +15,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@urql/core": ">=1.15.2",
+    "@urql/core": ">=1.16.0",
     "wonka": "^4.0.14"
   }
 }

exchanges/graphcache/src/extras/relayPagination.ts

@@ -128,7 +128,7 @@ const getPage = (
   entityKey: string,
   fieldKey: string
 ): Page | null => {
-  const link = ensureKey(cache.resolveFieldByKey(entityKey, fieldKey));
+  const link = ensureKey(cache.resolve(entityKey, fieldKey));
   if (!link) return null;
 
   const typename = cache.resolve(link, '__typename') as string;

exchanges/graphcache/src/extras/simplePagination.ts

@@ -67,7 +67,7 @@ export const simplePagination = ({
         continue;
       }
 
-      const links = cache.resolveFieldByKey(entityKey, fieldKey) as string[];
+      const links = cache.resolve(entityKey, fieldKey) as string[];
       const currentOffset = args[offsetArgument];
 
       if (

exchanges/graphcache/src/store/store.test.ts

@@ -393,6 +393,10 @@ describe('Store with OptimisticMutationConfig', () => {
 
     expect(store.keyOfEntity(randomData)).toBe(context.parentKey);
     expect(store.keyOfEntity({})).not.toBe(context.parentKey);
+
+    // Should work without a __typename field
+    delete (randomData as any).__typename;
+    expect(store.keyOfEntity(randomData)).toBe(context.parentKey);
   });
 
   it('should resolve with a key as first argument', () => {

exchanges/graphcache/src/store/store.ts

@@ -105,45 +105,43 @@ export class Store implements Cache {
   keyOfField = keyOfField;
 
   keyOfEntity(data: Data | null | string) {
-    if (data == null || typeof data === 'string') return data || null;
-    const { __typename: typename, id, _id } = data;
-    if (!typename) return null;
-    if (this.rootNames[typename]) return typename;
-
     // In resolvers and updaters we may have a specific parent
     // object available that can be used to skip to a specific parent
     // key directly without looking at its incomplete properties
     if (contextRef.current && data === contextRef.current.parent)
       return contextRef.current!.parentKey;
 
+    if (data == null || typeof data === 'string') return data || null;
+    if (!data.__typename) return null;
+    if (this.rootNames[data.__typename]) return data.__typename;
+
     let key: string | null | void;
-    if (this.keys[typename]) {
-      key = this.keys[typename](data);
-    } else if (id !== undefined && id !== null) {
-      key = `${id}`;
-    } else if (_id !== undefined && _id !== null) {
-      key = `${_id}`;
+    if (this.keys[data.__typename]) {
+      key = this.keys[data.__typename](data);
+    } else if (data.id != null) {
+      key = `${data.id}`;
+    } else if (data._id != null) {
+      key = `${data._id}`;
     }
 
-    return key ? `${typename}:${key}` : null;
+    return key ? `${data.__typename}:${key}` : null;
   }
 
-  resolveFieldByKey(entity: Data | string | null, fieldKey: string): DataField {
+  resolve(
+    entity: Data | string | null,
+    field: string,
+    args?: Variables
+  ): DataField {
+    const fieldKey = keyOfField(field, args);
     const entityKey = this.keyOfEntity(entity);
     if (!entityKey) return null;
     const fieldValue = InMemoryData.readRecord(entityKey, fieldKey);
     if (fieldValue !== undefined) return fieldValue;
     const link = InMemoryData.readLink(entityKey, fieldKey);
-    return link ? link : null;
+    return link || null;
   }
 
-  resolve(
-    entity: Data | string | null,
-    field: string,
-    args?: Variables
-  ): DataField {
-    return this.resolveFieldByKey(entity, keyOfField(field, args));
-  }
+  resolveFieldByKey = this.resolve;
 
   invalidate(entity: Data | string | null, field?: string, args?: Variables) {
     const entityKey = this.keyOfEntity(entity);

exchanges/graphcache/src/types.ts

@@ -91,7 +91,7 @@ export interface Cache {
     args?: Variables
   ): DataField;
 
-  /** resolveFieldByKey() returns a field's value on an entity, given that field's key */
+  /** @deprecated use resolve() instead */
   resolveFieldByKey(entity: Data | string | null, fieldKey: string): DataField;
 
   /** inspectFields() retrieves all known fields for a given entity */