@apollo/client 4.3.0-alpha.4 → 4.3.0-alpha.5

package/core/QueryInfo.d.ts

@@ -1,5 +1,6 @@
 import type { DocumentNode, FormattedExecutionResult } from "graphql";
 import type { Cache } from "@apollo/client/cache";
+import type { Incremental } from "@apollo/client/incremental";
 import type { ApolloLink } from "@apollo/client/link";
 import type { Unmasked } from "@apollo/client/masking";
 import type { ExtensionsWithStreamInfo } from "@apollo/client/utilities/internal";
@@ -19,6 +20,7 @@ interface LastWrite {
     result: FormattedExecutionResult<any, ExtensionsWithStreamInfo>;
     variables: ApolloClient.WatchQueryOptions["variables"];
     dmCount: number | undefined;
+    hasNext: boolean;
 }
 interface OperationInfo<TData, TVariables extends OperationVariables, AllowedCacheWriteBehavior = CacheWriteBehavior> {
     document: DocumentNode | TypedDocumentNode<TData, TVariables>;
@@ -39,8 +41,14 @@ export declare class QueryInfo<TData, TVariables extends OperationVariables = Op
     constructor(queryManager: QueryManager, observableQuery?: ObservableQuery<any, any>);
     /**
     * @internal
-    * For feud-preventing behaviour, `lastWrite` should be shared by all `QueryInfo` instances of an `ObservableQuery`.
-    * In the case of a standalone `QueryInfo`, we will keep a local version.
+    * Tracks the last result written to the cache so that `shouldWrite` can skip
+    * an identical write. Since a `QueryInfo` only ever represents a single
+    * network request, this is shared by all `QueryInfo` instances of an
+    * `ObservableQuery`. A standalone `QueryInfo` keeps a local version.
+    *
+    * A network result that was explicitly asked for always takes precedence over
+    * what is already cached, so `ObservableQuery.refetch` and polling clear this
+    * value before starting their request.
     * 
     * @deprecated This is an internal API and should not be used directly. This can be removed or changed at any time.
     */
@@ -50,10 +58,12 @@ export declare class QueryInfo<TData, TVariables extends OperationVariables = Op
     resetLastWrite(): void;
     private shouldWrite;
     get hasNext(): boolean;
+    get incrementalHandler(): Incremental.Handler<Record<string, unknown>>;
     private maybeHandleIncrementalResult;
-    markQueryResult(incoming: ApolloLink.Result<TData>, { document: query, variables, errorPolicy, cacheWriteBehavior, returnPartialData, fetchPolicy, networkStatus, }: OperationInfo<TData, TVariables> & {
+    markQueryResult(incoming: ApolloLink.Result<TData>, { document: query, variables, errorPolicy, cacheWriteBehavior, returnPartialData, fetchPolicy, networkStatus, prunePendingDeferFragments: prune, }: OperationInfo<TData, TVariables> & {
         fetchPolicy: WatchQueryFetchPolicy;
         networkStatus: NetworkStatus;
+        prunePendingDeferFragments: boolean;
     }): MarkQueryResult<DataValue.Complete<TData> | DataValue.Streaming<TData>, ExtensionsWithStreamInfo>;
     private getIncrementalInfo;
     private getDiff;

package/core/QueryInfo.js

@@ -1,6 +1,7 @@
 import { equal } from "@wry/equality";
 import { Trie } from "@wry/trie";
-import { getOperationName, graphQLResultHasError, handleIncrementalSymbol, hasDirectives, streamInfoSymbol, } from "@apollo/client/utilities/internal";
+import { __DEV__ } from "@apollo/client/utilities/environment";
+import { getOperationName, graphQLResultHasError, handleIncrementalSymbol, hasDirectives, } from "@apollo/client/utilities/internal";
 import { invariant } from "@apollo/client/utilities/invariant";
 import { NetworkStatus } from "./networkStatus.js";
 const IGNORE = {};
@@ -41,10 +42,10 @@ export class QueryInfo {
         this.observableQuery = observableQuery;
         this.queryManager = queryManager;
         // Track how often cache.evict is called, since we want eviction to
-        // override the feud-stopping logic in the markQueryResult method, by
-        // causing shouldWrite to return true. Wrapping the cache.evict method
-        // is a bit of a hack, but it saves us from having to make eviction
-        // counting an official part of the ApolloCache API.
+        // override the write-skipping logic in `shouldWrite`, by causing it to
+        // return true. Wrapping the cache.evict method is a bit of a hack, but it
+        // saves us from having to make eviction counting an official part of the
+        // ApolloCache API.
         if (!destructiveMethodCounts.has(cache)) {
             destructiveMethodCounts.set(cache, 0);
             wrapDestructiveCacheMethod(cache, "evict");
@@ -54,8 +55,14 @@ export class QueryInfo {
     }
     /**
     * @internal
-    * For feud-preventing behaviour, `lastWrite` should be shared by all `QueryInfo` instances of an `ObservableQuery`.
-    * In the case of a standalone `QueryInfo`, we will keep a local version.
+    * Tracks the last result written to the cache so that `shouldWrite` can skip
+    * an identical write. Since a `QueryInfo` only ever represents a single
+    * network request, this is shared by all `QueryInfo` instances of an
+    * `ObservableQuery`. A standalone `QueryInfo` keeps a local version.
+    *
+    * A network result that was explicitly asked for always takes precedence over
+    * what is already cached, so `ObservableQuery.refetch` and polling clear this
+    * value before starting their request.
     * 
     * @deprecated This is an internal API and should not be used directly. This can be removed or changed at any time.
     */
@@ -71,33 +78,34 @@ export class QueryInfo {
     }
     shouldWrite(result, variables) {
         const { lastWrite } = this;
-        return !(lastWrite &&
+        return (!lastWrite ||
             // If cache.evict has been called since the last time we wrote this
             // data into the cache, there's a chance writing this result into
             // the cache will repair what was evicted.
-            lastWrite.dmCount === destructiveMethodCounts.get(this.cache) &&
-            equal(variables, lastWrite.variables) &&
-            equal(result.data, lastWrite.result.data) &&
+            lastWrite.dmCount !== destructiveMethodCounts.get(this.cache) ||
+            !equal(variables, lastWrite.variables) ||
+            !equal(result.data, lastWrite.result.data) ||
             // We have to compare these values because its possible the final chunk
             // emitted in the incremental result is just `hasNext: false`. This
             // ensures we trigger a cache write when we get `isLastChunk: true`.
-            result.extensions?.[streamInfoSymbol] ===
-                lastWrite.result.extensions?.[streamInfoSymbol]);
+            lastWrite.hasNext !== this.hasNext);
     }
     get hasNext() {
         return this.incremental ? this.incremental.hasNext : false;
     }
+    get incrementalHandler() {
+        return this.queryManager.incrementalHandler;
+    }
     maybeHandleIncrementalResult(cacheData, incoming, query) {
-        const { incrementalHandler } = this.queryManager;
-        if (incrementalHandler.isIncrementalResult(incoming)) {
-            this.incremental ||= incrementalHandler.startRequest({
+        if (this.incrementalHandler.isIncrementalResult(incoming)) {
+            this.incremental ||= this.incrementalHandler.startRequest({
                 query,
             });
             return this.incremental.handle(cacheData, incoming);
         }
         return incoming;
     }
-    markQueryResult(incoming, { document: query, variables, errorPolicy, cacheWriteBehavior, returnPartialData, fetchPolicy, networkStatus, }) {
+    markQueryResult(incoming, { document: query, variables, errorPolicy, cacheWriteBehavior, returnPartialData, fetchPolicy, networkStatus, prunePendingDeferFragments: prune, }) {
         const diffOptions = {
             query,
             variables,
@@ -107,154 +115,160 @@ export class QueryInfo {
         // requests. To allow future notify timeouts, diff and dirty are reset as well.
         this.observableQuery?.["resetNotifications"]();
         const skipCache = cacheWriteBehavior === 0 /* CacheWriteBehavior.FORBID */;
-        const lastDiff = skipCache ? undefined : (this.getDiff({
+        const diff = skipCache ? undefined : (this.getDiff({
             ...diffOptions,
-            // Always request partial data to ensure the network incremental
+            // We usually request partial data to ensure the network incremental
             // result is merged with all existing data (especially true to
-            // maintain @stream arrays with partial list items in the right order)
-            returnPartialData: true,
-        }));
-        const incrementalResult = this.maybeHandleIncrementalResult(lastDiff?.result, incoming, query);
+            // maintain @stream arrays with partial list items in the right order
+            // or when chunk might otherwise replace a partial non-normalized
+            // object), but if we are about to throw away the result anyways due
+            // to the error policy (which early returns below), prune any
+            // pending boundaries so that CombinedGraphQLErrors contains the
+            // right `data` value.
+            returnPartialData: errorPolicy !== "none" ||
+                !this.incrementalHandler.extractErrors(incoming)?.length,
+        }, this.getIncrementalInfo({ prune })));
+        const incrementalResult = this.maybeHandleIncrementalResult(diff?.result, incoming, query);
         let result = {
             ...incrementalResult,
             dataState: incrementalResult.data == null ? "empty" : "complete",
         };
+        const hasPendingDefer = this.incremental
+            ?.getPendingWithInfo?.()
+            .some((pending) => pending.type === "defer" && !pending.delivered);
+        if (hasPendingDefer ||
+            // The Defer20220824Handler cannot track pending/completed incremental
+            // chunks due to its data format so we naively set dataState to
+            // streaming if we are still processing chunks. The only case where
+            // streaming is incorrect and should actually be complete is when
+            // both a @defer and @stream boundary is present and the @defer chunk
+            // has completed before the `@stream` array.
+            //
+            // Assigning the naive "streaming" value avoids a much more expensive
+            // pass over `result.data` that would otherwise need to traverse the
+            // selection sets and evaluate the data object at each defer boundary
+            // to see if it fulfills the selection set. For such a narrow case where
+            // its incorrect on a format that is now outdated is not worth the
+            // fix so we are ok with reporting a `streaming` here.
+            (!this.incremental?.getPendingWithInfo &&
+                this.hasNext &&
+                hasDirectives(["defer"], query))) {
+            result.dataState = "streaming";
+        }
         if (skipCache) {
-            const hasPendingDefer = this.incremental?.pending?.some((pending) => this.incremental?.getPendingType?.(pending.id) === "defer");
-            if (hasPendingDefer ||
-                // The Defer20220824Handler cannot track pending/completed incremental
-                // chunks due to its data format so we naively set dataState to
-                // streaming if we are still processing chunks. The only case where
-                // streaming is incorrect and should actually be complete is when
-                // both a @defer and @stream boundary is present and the @defer chunk
-                // has completed before the `@stream` array.
-                //
-                // Assigning the naive "streaming" value avoids a much more expensive
-                // pass over `result.data` that would otherwise need to traverse the
-                // selection sets and evaluate the data object at each defer boundary
-                // to see if it fulfills the selection set. For such a narrow case where
-                // its incorrect on a format that is now outdated is not worth the
-                // fix so we are ok with reporting a `streaming` here.
-                (!this.incremental?.pending &&
-                    this.hasNext &&
-                    hasDirectives(["defer"], query))) {
-                result.dataState = "streaming";
-            }
             return result;
         }
-        if (shouldWriteResult(result, errorPolicy)) {
-            // 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
-            // it when we receive it redundantly from the watch callback.
-            this.cache.batch({
-                onWatchUpdated: (
-                // all additional options on ObservableQuery.CacheWatchOptions are
-                // optional so we can use the type here
-                watch, diff) => {
-                    if (watch.watcher === this.observableQuery) {
-                        // see comment on `lastOwnDiff` for explanation
-                        watch.lastOwnDiff = diff;
-                    }
-                },
-                update: (cache) => {
-                    const shouldWrite = this.shouldWrite(result, variables);
-                    if (shouldWrite) {
-                        cache.writeQuery({
-                            query,
-                            data: result.data,
-                            variables,
-                            overwrite: cacheWriteBehavior === 1 /* CacheWriteBehavior.OVERWRITE */,
-                            extensions: result.extensions,
-                        });
-                        this.lastWrite = {
-                            result,
-                            variables,
-                            dmCount: destructiveMethodCounts.get(this.cache),
-                        };
-                    }
-                    else {
-                        // If result is the same as the last result we received from
-                        // the network (and the variables match too), avoid writing
-                        // result into the cache again. The wisdom of skipping this
-                        // cache write is far from obvious, since any cache write
-                        // could be the one that puts the cache back into a desired
-                        // state, fixing corruption or missing data. However, if we
-                        // always write every network result into the cache, we enable
-                        // feuds between queries competing to update the same data in
-                        // incompatible ways, which can lead to an endless cycle of
-                        // cache broadcasts and useless network requests. As with any
-                        // feud, eventually one side must step back from the brink,
-                        // letting the other side(s) have the last word(s). There may
-                        // be other points where we could break this cycle, such as
-                        // silencing the broadcast for cache.writeQuery (not a good
-                        // idea, since it just delays the feud a bit) or somehow
-                        // avoiding the network request that just happened (also bad,
-                        // because the server could return useful new data). All
-                        // options considered, skipping this cache write seems to be
-                        // the least damaging place to break the cycle, because it
-                        // reflects the intuition that we recently wrote this exact
-                        // result into the cache, so the cache *should* already/still
-                        // contain this data. If some other query has clobbered that
-                        // data in the meantime, that's too bad, but there will be no
-                        // winners if every query blindly reverts to its own version
-                        // of the data. This approach also gives the network a chance
-                        // to return new data, which will be written into the cache as
-                        // usual, notifying only those queries that are directly
-                        // affected by the cache updates, as usual. In the future, an
-                        // even more sophisticated cache could perhaps prevent or
-                        // mitigate the clobbering somehow, but that would make this
-                        // particular cache write even less important, and thus
-                        // skipping it would be even safer than it is today.
-                        if (lastDiff && lastDiff.complete) {
-                            // Reuse data from the last good (complete) diff that we
-                            // received, when possible.
-                            result = {
-                                ...result,
-                                data: lastDiff.result,
-                                dataState: "complete",
-                            };
-                            return;
-                        }
-                        // If the previous this.diff was incomplete, fall through to
-                        // re-reading the latest data with cache.diff, below.
-                    }
-                    const isNetworkOnly = fetchPolicy === "network-only" &&
-                        networkStatus !== NetworkStatus.refetch;
-                    const { dataState, result: diffResult } = this.getDiff({
-                        ...diffOptions,
-                        // Never deliver partial data for network-only requests
-                        returnPartialData: returnPartialData && !isNetworkOnly,
-                    }, this.getIncrementalInfo(result, { isNetworkOnly }));
-                    if (dataState === "complete" ||
-                        (returnPartialData && dataState === "partial" && shouldWrite) ||
-                        (this.hasNext && dataState === "streaming")) {
-                        result = { ...result, data: diffResult, dataState };
-                    }
-                },
-            });
-        }
-        else {
+        if (!shouldWriteResult(result, errorPolicy)) {
             this.lastWrite = void 0;
+            return result;
         }
+        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
+        // it when we receive it redundantly from the watch callback.
+        this.cache.batch({
+            onWatchUpdated: (
+            // all additional options on ObservableQuery.CacheWatchOptions are
+            // optional so we can use the type here
+            watch, diff) => {
+                if (watch.watcher === this.observableQuery) {
+                    // see comment on `lastOwnDiff` for explanation
+                    watch.lastOwnDiff = diff;
+                }
+            },
+            update: (cache) => {
+                const shouldWrite = this.shouldWrite(result, variables);
+                // If result is the same as the last result we received from
+                // the network (and the variables match too), avoid writing
+                // result into the cache again. The wisdom of skipping this
+                // cache write is far from obvious, since any cache write
+                // could be the one that puts the cache back into a desired
+                // state, fixing corruption or missing data. However, if we
+                // always write every network result into the cache, we enable
+                // feuds between queries competing to update the same data in
+                // incompatible ways, which can lead to an endless cycle of
+                // cache broadcasts and useless network requests. As with any
+                // feud, eventually one side must step back from the brink,
+                // letting the other side(s) have the last word(s). There may
+                // be other points where we could break this cycle, such as
+                // silencing the broadcast for cache.writeQuery (not a good
+                // idea, since it just delays the feud a bit) or somehow
+                // avoiding the network request that just happened (also bad,
+                // because the server could return useful new data). All
+                // options considered, skipping this cache write seems to be
+                // the least damaging place to break the cycle, because it
+                // reflects the intuition that we recently wrote this exact
+                // result into the cache, so the cache *should* already/still
+                // contain this data. If some other query has clobbered that
+                // data in the meantime, that's too bad, but there will be no
+                // winners if every query blindly reverts to its own version
+                // of the data. This approach also gives the network a chance
+                // to return new data, which will be written into the cache as
+                // usual, notifying only those queries that are directly
+                // affected by the cache updates, as usual. In the future, an
+                // even more sophisticated cache could perhaps prevent or
+                // mitigate the clobbering somehow, but that would make this
+                // particular cache write even less important, and thus
+                // skipping it would be even safer than it is today.
+                if (shouldWrite) {
+                    cache.writeQuery({
+                        query,
+                        data: result.data,
+                        variables,
+                        overwrite: cacheWriteBehavior === 1 /* CacheWriteBehavior.OVERWRITE */,
+                        extensions: result.extensions,
+                    });
+                    this.lastWrite = {
+                        result,
+                        variables,
+                        dmCount: destructiveMethodCounts.get(this.cache),
+                        hasNext: this.hasNext,
+                    };
+                    written = true;
+                }
+                const { dataState, result: diffResult } = this.getDiff({
+                    ...diffOptions,
+                    returnPartialData: returnPartialData &&
+                        // Never deliver partial data for network-only requests
+                        (fetchPolicy !== "network-only" ||
+                            networkStatus === NetworkStatus.refetch),
+                }, this.getIncrementalInfo({ prune }));
+                if (dataState === "complete" ||
+                    dataState === "streaming" ||
+                    (returnPartialData && dataState === "partial" && shouldWrite)) {
+                    result = { ...result, data: diffResult, dataState };
+                }
+                else if (__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, 
+                    // Always show the partial result for debugging, otherwise the user
+                    // sees `null` when `returnPartialData` is false which isn't helpful
+                    // for figuring out where the problem is.
+                    cache.diff({ ...diffOptions, returnPartialData: true }));
+                }
+            },
+        });
         return result;
     }
-    getIncrementalInfo(result, { isNetworkOnly }) {
-        const pending = this.incremental?.pending ?? [];
-        const streamInfo = result.extensions?.[streamInfoSymbol]?.deref();
+    getIncrementalInfo({ prune }) {
+        const pending = this.incremental?.getPendingWithInfo?.() ?? [];
+        const streamInfo = this.incremental?.streamInfo;
         const incrementalInfo = { streamInfo };
         // We don't want to deliver stream items or complete defer boundaries
         // for a network-only request if they haven't yet streamed from the
         // network. We record all the still-pending paths so that cache.diff
         // can prune complete defer/stream boundaries at those paths.
-        if (isNetworkOnly) {
+        if (prune) {
             for (const item of pending) {
-                const type = this.incremental?.getPendingType?.(item.id);
-                if (type === "defer") {
+                if (item.type === "defer" && !item.delivered) {
                     incrementalInfo.deferInfo ||= new Trie(true, () => true);
-                    incrementalInfo.deferInfo.lookupArray(item.path);
+                    incrementalInfo.deferInfo.lookupArray(item.path.concat(item.label || []));
                 }
-                else if (streamInfo && type === "stream") {
+                else if (streamInfo && item.type === "stream") {
                     streamInfo.lookupArray(item.path).state.truncate = true;
                 }
             }
@@ -262,17 +276,13 @@ export class QueryInfo {
         return incrementalInfo;
     }
     getDiff(options, incrementalInfo) {
-        if (this.cache[handleIncrementalSymbol]) {
-            return this.cache.diff({
-                ...options,
-                [handleIncrementalSymbol]: incrementalInfo || true,
-            });
+        const diff = this.cache.diff({
+            ...options,
+            [handleIncrementalSymbol]: incrementalInfo,
+        });
+        if ("dataState" in diff) {
+            return diff;
         }
-        // returnPartialData is overridden for backwards compatibility with caches
-        // that don't handle incremental results. Without this, in-flight
-        // incremental cache data would come back null when returnPartialData is
-        // false due to the partial result.
-        const diff = this.cache.diff({ ...options, returnPartialData: true });
         return {
             ...diff,
             dataState: diff.complete ? "complete"
@@ -474,6 +484,15 @@ export class QueryInfo {
         }
     }
 }
+function warnAboutPartialCacheResult(query, networkResult, diff) {
+    __DEV__ && invariant.warn(
+        89,
+        getOperationName(query, "(anonymous)"),
+        diff.missing?.missing,
+        networkResult,
+        diff.result
+    );
+}
 function shouldWriteResult(result, errorPolicy = "none") {
     const ignoreErrors = errorPolicy === "ignore" || errorPolicy === "all";
     let writeWithErrors = !graphQLResultHasError(result);