@apollo/client 4.2.10 → 4.2.11

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @apollo/client
 
+## 4.2.11
+
+### Patch Changes
+
+- [#13398](https://github.com/apollographql/apollo-client/pull/13398) [`3dd3e9a`](https://github.com/apollographql/apollo-client/commit/3dd3e9a6f195ea5dd27a973f153a0538ccdffd20) Thanks [@phryneas](https://github.com/phryneas)! - Fix type signature of some `DocumentationTypes` to fix their display in our documentation.
+
+- [#13392](https://github.com/apollographql/apollo-client/pull/13392) [`d4f0771`](https://github.com/apollographql/apollo-client/commit/d4f0771976766b54e0a95a3d51b708b64eb3cfe0) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Add a development-only warning when a network result is written to the cache but reading the query back from the cache returns a partial result. This usually points at a `merge` or `read` function that did not repair missing fields in the cache, which prevents Apollo Client from applying the cache result to the data received by the network.
+
 ## 4.2.10
 
 ### Patch Changes

package/__cjs/cache/core/cache.cjs

@@ -140,7 +140,7 @@ class ApolloCache {
             if (environment_1.__DEV__) {
                 const actualFragmentName = fragmentName || (0, internal_1.getFragmentDefinition)(fragment).name.value;
                 if (id === undefined) {
-                    __DEV__ && invariant_1.invariant.warn(118, actualFragmentName);
+                    __DEV__ && invariant_1.invariant.warn(119, actualFragmentName);
                 }
             }
             return id;

package/__cjs/cache/inmemory/entityStore.cjs

@@ -82,7 +82,7 @@ class EntityStore {
         // then there are no fields to be merged, so we're done.
         if (!incoming)
             return;
-        (0, invariant_1.invariant)(typeof dataId === "string", 104);
+        (0, invariant_1.invariant)(typeof dataId === "string", 105);
         const merged = new internal_1.DeepMerger({
             reconciler: storeObjectReconciler,
         }).merge(existing, incoming);
@@ -184,7 +184,7 @@ class EntityStore {
                             if (environment_1.__DEV__) {
                                 const checkReference = (ref) => {
                                     if (this.lookup(ref.__ref) === undefined) {
-                                        __DEV__ && invariant_1.invariant.warn(105, ref);
+                                        __DEV__ && invariant_1.invariant.warn(106, ref);
                                         return true;
                                     }
                                 };
@@ -213,7 +213,7 @@ class EntityStore {
                                             }
                                         }
                                         if (seenReference && someNonReference !== undefined) {
-                                            __DEV__ && invariant_1.invariant.warn(106, someNonReference);
+                                            __DEV__ && invariant_1.invariant.warn(107, someNonReference);
                                             break;
                                         }
                                     }

package/__cjs/cache/inmemory/key-extractor.cjs

@@ -41,7 +41,7 @@ function keyFieldsFnFromSpecifier(specifier) {
                     // context.readField for this extraction.
                     extracted = extractKeyPath(object, schemaKeyPath, extractKey);
                 }
-                (0, invariant_1.invariant)(extracted !== void 0, 107, schemaKeyPath.join("."), object);
+                (0, invariant_1.invariant)(extracted !== void 0, 108, schemaKeyPath.join("."), object);
                 return extracted;
             }));
             return `${context.typename}:${JSON.stringify(keyObject)}`;

package/__cjs/cache/inmemory/policies.cjs

@@ -229,7 +229,7 @@ class Policies {
         const rootId = "ROOT_" + which.toUpperCase();
         const old = this.rootTypenamesById[rootId];
         if (typename !== old) {
-            (0, invariant_1.invariant)(!old || old === which, 108, which);
+            (0, invariant_1.invariant)(!old || old === which, 109, which);
             // First, delete any old __typename associated with this rootId from
             // rootIdsByTypename.
             if (old)
@@ -372,7 +372,7 @@ class Policies {
                 if (supertypeSet.has(supertype)) {
                     if (!typenameSupertypeSet.has(supertype)) {
                         if (checkingFuzzySubtypes) {
-                            __DEV__ && invariant_1.invariant.warn(109, typename, supertype);
+                            __DEV__ && invariant_1.invariant.warn(110, typename, supertype);
                         }
                         // Record positive results for faster future lookup.
                         // Unfortunately, we cannot safely cache negative results,
@@ -625,7 +625,7 @@ function normalizeReadFieldOptions(readFieldArgs, objectOrReference, variables)
         }
     }
     if (environment_1.__DEV__ && options.from === void 0) {
-        __DEV__ && invariant_1.invariant.warn(110, (0, internal_2.stringifyForDisplay)(Array.from(readFieldArgs)));
+        __DEV__ && invariant_1.invariant.warn(111, (0, internal_2.stringifyForDisplay)(Array.from(readFieldArgs)));
     }
     if (void 0 === options.variables) {
         options.variables = variables;
@@ -635,7 +635,7 @@ function normalizeReadFieldOptions(readFieldArgs, objectOrReference, variables)
 function makeMergeObjectsFunction(store) {
     return function mergeObjects(existing, incoming) {
         if ((0, internal_2.isArray)(existing) || (0, internal_2.isArray)(incoming)) {
-            throw (0, invariant_1.newInvariantError)(111);
+            throw (0, invariant_1.newInvariantError)(112);
         }
         // These dynamic checks are necessary because the parameters of a
         // custom merge function can easily have the any type, so the type

package/__cjs/cache/inmemory/readFromStore.cjs

@@ -194,7 +194,7 @@ class StoreReader {
             else {
                 const fragment = (0, internal_1.getFragmentFromSelection)(selection, context.lookupFragment);
                 if (!fragment && selection.kind === graphql_1.Kind.FRAGMENT_SPREAD) {
-                    throw (0, invariant_1.newInvariantError)(112, selection.name.value);
+                    throw (0, invariant_1.newInvariantError)(113, selection.name.value);
                 }
                 if (fragment && policies.fragmentMatches(fragment, typename)) {
                     fragment.selectionSet.selections.forEach(workSet.add, workSet);
@@ -278,7 +278,7 @@ function assertSelectionSetForIdValue(store, field, fieldValue) {
             if ((0, internal_1.isNonNullObject)(value)) {
                 (0, invariant_1.invariant)(
                     !(0, utilities_1.isReference)(value),
-                    113,
+                    114,
                     (0, helpers_js_1.getTypenameFromStoreObject)(store, value),
                     field.name.value
                 );

package/__cjs/cache/inmemory/writeToStore.cjs

@@ -75,7 +75,7 @@ class StoreWriter {
             path: [],
         });
         if (!(0, utilities_1.isReference)(ref)) {
-            throw (0, invariant_1.newInvariantError)(114, result);
+            throw (0, invariant_1.newInvariantError)(115, result);
         }
         // So far, the store has not been modified, so now it's time to process
         // context.incomingById and merge those incoming fields into context.store.
@@ -237,7 +237,7 @@ class StoreWriter {
                 // provide a default value, so its absence from the written data should
                 // not be cause for alarm.
                 !policies.getReadFunction(typename, field.name.value)) {
-                invariant_1.invariant.error(115, (0, internal_1.resultKeyNameFromField)(field), result);
+                invariant_1.invariant.error(116, (0, internal_1.resultKeyNameFromField)(field), result);
             }
         });
         // Identify the result object, even if dataId was already provided,
@@ -385,7 +385,7 @@ class StoreWriter {
                 else {
                     const fragment = (0, internal_1.getFragmentFromSelection)(selection, context.lookupFragment);
                     if (!fragment && selection.kind === graphql_1.Kind.FRAGMENT_SPREAD) {
-                        throw (0, invariant_1.newInvariantError)(116, selection.name.value);
+                        throw (0, invariant_1.newInvariantError)(117, selection.name.value);
                     }
                     if (fragment &&
                         policies.fragmentMatches(fragment, typename, result, context.variables)) {
@@ -562,7 +562,7 @@ function warnAboutDataLoss(existingRef, incomingObj, storeFieldName, store) {
             }
         });
     }
-    __DEV__ && invariant_1.invariant.warn(117, fieldName, parentType, childTypenames.length ?
+    __DEV__ && invariant_1.invariant.warn(118, fieldName, parentType, childTypenames.length ?
         "either ensure all objects of type " +
             childTypenames.join(" and ") +
             " have an ID or a custom merge function, or "

package/__cjs/core/QueryInfo.cjs

@@ -1,7 +1,12 @@
-"use strict";
+"use strict";;
+const {
+    __DEV__
+} = require("@apollo/client/utilities/environment");
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueryInfo = void 0;
 const equality_1 = require("@wry/equality");
+const environment_1 = require("@apollo/client/utilities/environment");
 const internal_1 = require("@apollo/client/utilities/internal");
 const invariant_1 = require("@apollo/client/utilities/invariant");
 const IGNORE = {};
@@ -115,6 +120,7 @@ class QueryInfo {
             return result;
         }
         if (shouldWriteResult(result, errorPolicy)) {
+            let written = false;
             // Using a transaction here so we have a chance to read the result
             // back from the cache before the watch callback fires as a result
             // of writeQuery, so we can store the new diff quietly and ignore
@@ -138,6 +144,7 @@ class QueryInfo {
                             overwrite: cacheWriteBehavior === 1 /* CacheWriteBehavior.OVERWRITE */,
                             extensions: result.extensions,
                         });
+                        written = true;
                         this.lastWrite = {
                             result,
                             variables,
@@ -195,6 +202,13 @@ class QueryInfo {
                     if (diff.complete) {
                         result = { ...result, data: diff.result };
                     }
+                    else if (environment_1.__DEV__ &&
+                        written &&
+                        // A result that is still streaming is expected to read back
+                        // incomplete until the remaining chunks arrive.
+                        !this.hasNext) {
+                        warnAboutPartialCacheResult(query, result.data, diff);
+                    }
                 },
             });
         }
@@ -388,6 +402,15 @@ class QueryInfo {
     }
 }
 exports.QueryInfo = QueryInfo;
+function warnAboutPartialCacheResult(query, networkResult, diff) {
+    __DEV__ && invariant_1.invariant.warn(
+        89,
+        (0, internal_1.getOperationName)(query, "(anonymous)"),
+        diff.missing?.missing,
+        networkResult,
+        diff.result
+    );
+}
 function shouldWriteResult(result, errorPolicy = "none") {
     const ignoreErrors = errorPolicy === "ignore" || errorPolicy === "all";
     let writeWithErrors = !(0, internal_1.graphQLResultHasError)(result);