@apollo/client 4.3.3 → 4.3.5

package/__cjs/cache/inmemory/types.d.cts

@@ -1,7 +1,8 @@
 import type { DocumentNode, FieldNode } from "graphql";
 import type { OperationVariables } from "@apollo/client";
+import type { Incremental } from "@apollo/client/incremental";
 import type { Reference, StoreObject, StoreValue } from "@apollo/client/utilities";
-import type { DeferInfoTrie, ExtensionsWithStreamInfo, RemoveIndexSignature, StreamInfoTrie } from "@apollo/client/utilities/internal";
+import type { ExtensionsWithStreamInfo, handleIncrementalSymbol, RemoveIndexSignature, StreamInfoTrie } from "@apollo/client/utilities/internal";
 import type { ApolloCache, Transaction } from "../core/cache.cjs";
 import type { AllFieldsModifier, CanReadFunction, Modifiers, ToReferenceFunction } from "../core/types/common.cjs";
 import type { FieldValueGetter } from "./entityStore.cjs";
@@ -86,7 +87,10 @@ export type ReadQueryOptions = {
 */
 export interface DiffIncrementalInfo {
     streamInfo?: StreamInfoTrie;
-    deferInfo?: DeferInfoTrie;
+    isDeferPending?: (path: Incremental.Path, label: string | undefined) => boolean;
+}
+export interface WithHandleIncremental {
+    [handleIncrementalSymbol]?: DiffIncrementalInfo | undefined;
 }
 export type DiffQueryAgainstStoreOptions = ReadQueryOptions & {
     returnPartialData?: boolean;
@@ -128,6 +132,7 @@ export interface ReadMergeModifyContext {
     variables?: OperationVariables;
     varString?: string;
     extensions?: ExtensionsWithStreamInfo;
+    isDeferPending?: (path: Incremental.Path, label: string | undefined) => boolean;
 }
 type ListOf<T extends string> = `[${T}]`;
 type NestedScalarName<T extends string> = T | ListOf<T> | ListOf<ListOf<T>> | ListOf<ListOf<ListOf<T>>> | ListOf<ListOf<ListOf<ListOf<T>>>>;

package/__cjs/cache/inmemory/writeToStore.cjs

@@ -43,7 +43,7 @@ class StoreWriter {
         this.reader = reader;
         this.fragments = fragments;
     }
-    writeToStore(store, { query, result, dataId, variables, overwrite, extensions, }) {
+    writeToStore(store, { query, result, dataId, variables, overwrite, extensions, [internal_1.handleIncrementalSymbol]: incrementalInfo, }) {
         const operationDefinition = (0, internal_1.getOperationDefinition)(query);
         const merger = (0, helpers_js_1.makeProcessedFieldsMerger)();
         variables = {
@@ -65,6 +65,7 @@ class StoreWriter {
             deferred: false,
             flavors: new Map(),
             extensions,
+            isDeferPending: incrementalInfo?.isDeferPending,
         };
         const ref = this.processSelectionSet({
             result: result || {},
@@ -75,7 +76,7 @@ class StoreWriter {
             path: [],
         });
         if (!(0, utilities_1.isReference)(ref)) {
-            throw (0, invariant_1.newInvariantError)(122, result);
+            throw (0, invariant_1.newInvariantError)(123, 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.
@@ -173,10 +174,10 @@ class StoreWriter {
         // This WriteContext will be the default context value for fields returned
         // by the flattenFields method, but some fields may be assigned a modified
         // context, depending on the presence of @client and other directives.
-        context, typename).forEach((context, field) => {
+        context, currentPath, typename).forEach((context, field) => {
             const resultFieldKey = (0, internal_1.resultKeyNameFromField)(field);
             const value = result[resultFieldKey];
-            const path = [...currentPath, field.name.value];
+            const path = [...currentPath, resultFieldKey];
             fieldNodeSet.add(field);
             if (value !== void 0) {
                 const storeFieldName = policies.getStoreFieldName({
@@ -187,10 +188,15 @@ class StoreWriter {
                 });
                 const childTree = getChildMergeTree(mergeTree, storeFieldName);
                 let incomingValue = this.processFieldValue(value, field, 
-                // Reset context.clientOnly and context.deferred to their default
-                // values before processing nested selection sets.
+                // Reset context.clientOnly to its default value before processing
+                // nested selection sets, but inherit context.deferred: a resolved
+                // parent field must not erase the fact that an ancestor @defer
+                // boundary is still pending, or nested fields reached only through
+                // that ancestor will incorrectly be treated as complete and report
+                // spurious "Missing field" errors when their own boundary hasn't
+                // arrived yet.
                 field.selectionSet ?
-                    getContextFlavor(context, false, false)
+                    getContextFlavor(context, false, context.deferred)
                     : context, childTree, path);
                 // To determine if this field holds a child object with a merge function
                 // defined in its type policy (see PR #7070), we need to figure out the
@@ -237,7 +243,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(123, (0, internal_1.resultKeyNameFromField)(field), result);
+                invariant_1.invariant.error(124, (0, internal_1.resultKeyNameFromField)(field), result);
             }
         });
         // Identify the result object, even if dataId was already provided,
@@ -256,8 +262,9 @@ class StoreWriter {
             // Write any key fields that were used during identification, even if
             // they were not mentioned in the original query.
             if (keyObject) {
-                // TODO Reverse the order of the arguments?
-                incoming = context.merge(incoming, keyObject);
+                // Values in incoming take precedence over keyObject, which may contain
+                // serialized values used to compute the ID.
+                incoming = context.merge(keyObject, incoming);
             }
         }
         catch (e) {
@@ -329,7 +336,7 @@ class StoreWriter {
     }
     // Implements https://spec.graphql.org/draft/#sec-Field-Collection, but with
     // some additions for tracking @client and @defer directives.
-    flattenFields(selectionSet, result, context, typename = getTypenameFromResult(result, selectionSet, context.fragmentMap)) {
+    flattenFields(selectionSet, result, context, path, typename = getTypenameFromResult(result, selectionSet, context.fragmentMap)) {
         const fieldMap = new Map();
         const { policies } = this.cache;
         const limitingTrie = new trie_1.Trie(false); // No need for WeakMap, since limitingTrie does not escape.
@@ -364,10 +371,19 @@ class StoreWriter {
                             // @defer(if: false) does not make context.deferred false, but
                             // instead behaves as if there was no @defer directive.
                             if (!args || args.if !== false) {
-                                deferred = true;
+                                // If we know (via context.isDeferPending) that this specific
+                                // boundary has already been delivered, we don't need to mark
+                                // it deferred, which allows fields under it to be validated
+                                // normally instead of being silently exempted from the
+                                // "Missing field" check below. When we can't determine
+                                // whether the boundary is still pending (no callback, or the
+                                // handler can't identify individual boundaries),
+                                // conservatively assume it's still pending (`?? true`).
+                                // `||=` (rather than `=`) preserves `deferred` if it was
+                                // already true from an ancestor boundary.
+                                deferred ||=
+                                    context.isDeferPending?.(path, args?.label) ?? true;
                             }
-                            // TODO In the future, we may want to record args.label using
-                            // context.deferred, if a label is specified.
                         }
                     });
                 }
@@ -385,7 +401,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)(124, selection.name.value);
+                        throw (0, invariant_1.newInvariantError)(125, selection.name.value);
                     }
                     if (fragment &&
                         policies.fragmentMatches(fragment, typename, result, context.variables)) {
@@ -558,7 +574,7 @@ function warnAboutDataLoss(existingRef, incomingObj, storeFieldName, store) {
             }
         });
     }
-    __DEV__ && invariant_1.invariant.warn(125, fieldName, parentType, childTypenames.length ?
+    __DEV__ && invariant_1.invariant.warn(126, fieldName, parentType, childTypenames.length ?
         "either ensure all objects of type " +
             childTypenames.join(" and ") +
             " have an ID or a custom merge function, or "