Fix cache override warning output (#11483)

apollographql · Jan 17, 2024 · 6394dda · 6394dda
1 parent abfd02a
commit 6394dda
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 6 deletions.
diff --git a/.changeset/spotty-bats-march.md b/.changeset/spotty-bats-march.md
@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Fix cache override warning output
diff --git a/src/cache/inmemory/__tests__/__snapshots__/writeToStore.ts.snap b/src/cache/inmemory/__tests__/__snapshots__/writeToStore.ts.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`writing to the store "Cache data maybe lost..." warnings should not warn when scalar fields are updated 1`] = `
+exports[`writing to the store "Cache data may be lost..." warnings should not warn when scalar fields are updated 1`] = `
 Object {
   "ROOT_QUERY": Object {
     "__typename": "Query",
@@ -18,7 +18,7 @@ Object {
 }
 `;
 
-exports[`writing to the store "Cache data maybe lost..." warnings should not warn when scalar fields are updated 2`] = `
+exports[`writing to the store "Cache data may be lost..." warnings should not warn when scalar fields are updated 2`] = `
 Object {
   "ROOT_QUERY": Object {
     "__typename": "Query",
@@ -34,7 +34,68 @@ Object {
 }
 `;
 
-exports[`writing to the store "Cache data maybe lost..." warnings should not warn when scalar fields are updated 3`] = `[MockFunction]`;
+exports[`writing to the store "Cache data may be lost..." warnings should not warn when scalar fields are updated 3`] = `[MockFunction]`;
+
+exports[`writing to the store "Cache data may be lost..." warnings should warn "Cache data may be lost..." message 1`] = `
+Object {
+  "ROOT_QUERY": Object {
+    "__typename": "Query",
+    "someJSON": Object {
+      "name": "Tom",
+    },
+  },
+}
+`;
+
+exports[`writing to the store "Cache data may be lost..." warnings should warn "Cache data may be lost..." message 2`] = `
+Object {
+  "ROOT_QUERY": Object {
+    "__typename": "Query",
+    "someJSON": Object {
+      "age": 20,
+    },
+  },
+}
+`;
+
+exports[`writing to the store "Cache data may be lost..." warnings should warn "Cache data may be lost..." message 3`] = `
+[MockFunction] {
+  "calls": Array [
+    Array [
+      "Cache data may be lost when replacing the %s field of a %s object.
+
+This could cause additional (usually avoidable) network requests to fetch data that were otherwise cached.
+
+To address this problem (which is not a bug in Apollo Client), %sdefine a custom merge function for the %s field, so InMemoryCache can safely merge these objects:
+
+  existing: %o
+  incoming: %o
+
+For more information about these options, please refer to the documentation:
+
+  * Ensuring entity objects have IDs: https://go.apollo.dev/c/generating-unique-identifiers
+  * Defining custom merge functions: https://go.apollo.dev/c/merging-non-normalized-objects
+",
+      "someJSON",
+      "Query",
+      "",
+      "Query.someJSON",
+      Object {
+        "name": "Tom",
+      },
+      Object {
+        "age": 20,
+      },
+    ],
+  ],
+  "results": Array [
+    Object {
+      "type": "return",
+      "value": undefined,
+    },
+  ],
+}
+`;
 
 exports[`writing to the store correctly merges fragment fields along multiple paths 1`] = `
 Object {

diff --git a/src/cache/inmemory/__tests__/writeToStore.ts b/src/cache/inmemory/__tests__/writeToStore.ts
@@ -2047,7 +2047,43 @@ describe("writing to the store", () => {
     });
   });
 
-  describe('"Cache data maybe lost..." warnings', () => {
+  describe('"Cache data may be lost..." warnings', () => {
+    it('should warn "Cache data may be lost..." message', () => {
+      using _consoleSpy = spyOnConsole.takeSnapshots("warn");
+      const cache = new InMemoryCache();
+
+      const query = gql`
+        query {
+          someJSON {
+            name
+            age
+          }
+        }
+      `;
+
+      cache.writeQuery({
+        query,
+        data: {
+          someJSON: {
+            name: "Tom",
+          },
+        },
+      });
+
+      expect(cache.extract()).toMatchSnapshot();
+
+      cache.writeQuery({
+        query,
+        data: {
+          someJSON: {
+            age: 20,
+          },
+        },
+      });
+
+      expect(cache.extract()).toMatchSnapshot();
+    });
+
     it("should not warn when scalar fields are updated", () => {
       using _consoleSpy = spyOnConsole.takeSnapshots("warn");
       const cache = new InMemoryCache();

diff --git a/src/cache/inmemory/writeToStore.ts b/src/cache/inmemory/writeToStore.ts
@@ -857,8 +857,8 @@ This could cause additional (usually avoidable) network requests to fetch data t
 
 To address this problem (which is not a bug in Apollo Client), %sdefine a custom merge function for the %s field, so InMemoryCache can safely merge these objects:
 
-  existing: %s
-  incoming: %s
+  existing: %o
+  incoming: %o
 
 For more information about these options, please refer to the documentation: