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

package/__cjs/core/QueryInfo.d.cts

@@ -1,13 +1,15 @@
 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";
 import type { ApolloClient } from "./ApolloClient.cjs";
+import { NetworkStatus } from "./networkStatus.cjs";
 import type { ObservableQuery } from "./ObservableQuery.cjs";
 import type { QueryManager } from "./QueryManager.cjs";
 import type { DataValue, DefaultContext, InternalRefetchQueriesInclude, MutationUpdaterFunction, NormalizedExecutionResult, OnQueryUpdated, OperationVariables, TypedDocumentNode } from "./types.cjs";
-import type { ErrorPolicy } from "./watchQueryOptions.cjs";
+import type { ErrorPolicy, WatchQueryFetchPolicy } from "./watchQueryOptions.cjs";
 type UpdateQueries<TData> = ApolloClient.MutateOptions<TData, any, any>["updateQueries"];
 export declare const enum CacheWriteBehavior {
     FORBID = 0,
@@ -18,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>;
@@ -38,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.
     */
@@ -49,8 +58,15 @@ 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, }: OperationInfo<TData, TVariables>): MarkQueryResult<DataValue.Complete<TData> | DataValue.Streaming<TData>, ExtensionsWithStreamInfo>;
+    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;
     markMutationResult(incoming: ApolloLink.Result<TData>, mutation: OperationInfo<TData, TVariables, CacheWriteBehavior.FORBID | CacheWriteBehavior.MERGE> & {
         context?: DefaultContext;
         updateQueries: UpdateQueries<TData>;

package/__cjs/core/QueryManager.cjs

@@ -18,6 +18,7 @@ const utilities_1 = require("@apollo/client/utilities");
 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 dataStateErrorCache_js_1 = require("./dataStateErrorCache.cjs");
 const networkStatus_js_1 = require("./networkStatus.cjs");
 const ObservableQuery_js_1 = require("./ObservableQuery.cjs");
 const QueryInfo_js_1 = require("./QueryInfo.cjs");
@@ -82,6 +83,12 @@ class QueryManager {
                     // selections and fragments from the fragment registry.
                     .concat(defaultDocumentTransform)
                 : defaultDocumentTransform;
+        // Put the incremental transform last so custom document transforms don't
+        // revert changes made to the document accidentally. Adding last also
+        // ensures `@defer` fragments added by the fragment registry are labeled.
+        if (this.incrementalHandler.documentTransform) {
+            this.documentTransform = this.documentTransform.concat(this.incrementalHandler.documentTransform);
+        }
         this.defaultContext = options.defaultContext || {};
         if ((this.onBroadcast = options.onBroadcast)) {
             this.mutationStore = {};
@@ -99,7 +106,7 @@ class QueryManager {
      */
     stop() {
         this.obsQueries.forEach((oq) => oq.stop());
-        this.cancelPendingFetches((0, invariant_1.newInvariantError)(89));
+        this.cancelPendingFetches((0, invariant_1.newInvariantError)(90));
     }
     cancelPendingFetches(error) {
         this.fetchCancelFns.forEach((cancel) => cancel(error));
@@ -114,7 +121,7 @@ class QueryManager {
             if (environment_1.__DEV__) {
                 (0, invariant_1.invariant)(
                     this.localState,
-                    90,
+                    91,
                     (0, internal_1.getOperationName)(mutation, "(anonymous)")
                 );
             }
@@ -349,7 +356,7 @@ class QueryManager {
         // depend on values that previously existed in the data portion of the
         // store. So, we cancel the promises and observers that we have issued
         // so far and not yet resolved (in the case of queries).
-        this.cancelPendingFetches((0, invariant_1.newInvariantError)(91));
+        this.cancelPendingFetches((0, invariant_1.newInvariantError)(92));
         this.obsQueries.forEach((observableQuery) => {
             // Set loading to true so listeners don't trigger unless they want
             // results with partial data.
@@ -419,10 +426,10 @@ class QueryManager {
                 if (!included) {
                     const queryName = queryNames.get(nameOrQueryString);
                     if (queryName) {
-                        __DEV__ && invariant_1.invariant.warn(92, queryName);
+                        __DEV__ && invariant_1.invariant.warn(93, queryName);
                     }
                     else {
-                        __DEV__ && invariant_1.invariant.warn(93);
+                        __DEV__ && invariant_1.invariant.warn(94);
                     }
                 }
             });
@@ -451,7 +458,7 @@ class QueryManager {
         if (environment_1.__DEV__) {
             (0, invariant_1.invariant)(
                 !this.getDocumentInfo(query).hasClientExports || this.localState,
-                94,
+                95,
                 (0, internal_1.getOperationName)(query, "(anonymous)")
             );
         }
@@ -596,14 +603,14 @@ class QueryManager {
             if (environment_1.__DEV__) {
                 (0, invariant_1.invariant)(
                     this.localState,
-                    95,
+                    96,
                     operation[0].toUpperCase() + operation.slice(1),
                     operationName ?? "(anonymous)"
                 );
             }
             (0, invariant_1.invariant)(
                 !hasIncrementalDirective,
-                96,
+                97,
                 operation[0].toUpperCase() + operation.slice(1),
                 operationName ?? "(anonymous)"
             );
@@ -627,7 +634,7 @@ class QueryManager {
             })),
         };
     }
-    getResultsFromLink(options, { queryInfo, cacheWriteBehavior, observableQuery, exposeExtensions, }) {
+    getResultsFromLink(options, { queryInfo, cacheWriteBehavior, observableQuery, exposeExtensions, prunePendingDeferFragments, }) {
         const { errorPolicy } = options;
         // Performing transformForLink here gives this.cache a chance to fill in
         // missing fragment definitions (for example) before sending this document
@@ -642,12 +649,15 @@ class QueryManager {
                 document: linkDocument,
                 cacheWriteBehavior,
                 returnPartialData: options.returnPartialData,
+                prunePendingDeferFragments,
             });
             const hasErrors = (0, internal_1.graphQLResultHasError)(result);
             if (hasErrors && errorPolicy === "none") {
                 queryInfo.resetLastWrite();
                 observableQuery?.["resetNotifications"]();
-                throw new errors_1.CombinedGraphQLErrors(removeStreamDetailsFromExtensions(result));
+                const error = new errors_1.CombinedGraphQLErrors(removeStreamDetailsFromExtensions(result));
+                dataStateErrorCache_js_1.dataStateErrorCache.set(error, dataState);
+                throw error;
             }
             const partial = dataState !== "complete";
             const aqr = {
@@ -669,16 +679,10 @@ class QueryManager {
             if (exposeExtensions && "extensions" in result) {
                 aqr[internal_1.extensionsSymbol] = result.extensions;
             }
-            if (hasErrors) {
-                if (errorPolicy === "none") {
-                    aqr.data = void 0;
-                    aqr.dataState = "empty";
-                }
-                if (errorPolicy !== "ignore") {
-                    aqr.error = new errors_1.CombinedGraphQLErrors(removeStreamDetailsFromExtensions(result));
-                    if (aqr.networkStatus !== networkStatus_js_1.NetworkStatus.streaming) {
-                        aqr.networkStatus = networkStatus_js_1.NetworkStatus.error;
-                    }
+            if (hasErrors && errorPolicy !== "ignore") {
+                aqr.error = new errors_1.CombinedGraphQLErrors(removeStreamDetailsFromExtensions(result));
+                if (aqr.networkStatus !== networkStatus_js_1.NetworkStatus.streaming) {
+                    aqr.networkStatus = networkStatus_js_1.NetworkStatus.error;
                 }
             }
             return aqr;
@@ -719,6 +723,7 @@ class QueryManager {
             fetchPolicy,
             errorPolicy,
             returnPartialData,
+            networkStatus,
             notifyOnNetworkStatusChange,
             context,
         });
@@ -777,7 +782,7 @@ class QueryManager {
             if (environment_1.__DEV__) {
                 (0, invariant_1.invariant)(
                     this.localState,
-                    97,
+                    98,
                     (0, internal_1.getOperationName)(normalized.query, "(anonymous)")
                 );
             }
@@ -953,7 +958,7 @@ class QueryManager {
                 !this.noCacheWarningsByCause.has(cause)) {
                 this.noCacheWarningsByCause.add(cause);
                 __DEV__ && invariant_1.invariant.warn(
-                    98,
+                    99,
                     (0, internal_1.getOperationName)(document, `Unnamed ${operationType ?? "operation"}`)
                 );
             }
@@ -968,7 +973,7 @@ class QueryManager {
             (0, masking_1.maskFragment)(data, fragment, this.cache, fragmentName)
             : data;
     }
-    fetchQueryByPolicy({ query, variables, fetchPolicy, errorPolicy, returnPartialData, context, }, { cacheWriteBehavior, onCacheHit, queryInfo, observableQuery, exposeExtensions, }) {
+    fetchQueryByPolicy({ query, variables, fetchPolicy, errorPolicy, returnPartialData, context, networkStatus, }, { cacheWriteBehavior, onCacheHit, queryInfo, observableQuery, exposeExtensions, }) {
         const readCache = () => this.cache.diff({
             query,
             variables,
@@ -1003,6 +1008,10 @@ class QueryManager {
                 return (0, rxjs_2.of)({
                     kind: "N",
                     value: toResult(data),
+                    // Always attach the variables used for this fetch so @export
+                    // resolution can update ObservableQuery.options.variables and
+                    // resubscribe the cache watch under the correct variable set.
+                    resolvedVariables: variables,
                     source: "cache",
                 });
             };
@@ -1015,7 +1024,7 @@ class QueryManager {
                 if (environment_1.__DEV__) {
                     (0, invariant_1.invariant)(
                         this.localState,
-                        99,
+                        100,
                         (0, internal_1.getOperationName)(query, "(anonymous)")
                     );
                 }
@@ -1032,6 +1041,10 @@ class QueryManager {
                 }).then((resolved) => ({
                     kind: "N",
                     value: toResult(resolved.data || void 0),
+                    // Always attach the variables used for this fetch so @export
+                    // resolution can update ObservableQuery.options.variables and
+                    // resubscribe the cache watch under the correct variable set.
+                    resolvedVariables: variables,
                     source: "cache",
                 })));
             }
@@ -1046,20 +1059,26 @@ class QueryManager {
             }
             return fromData(data || undefined);
         };
-        const resultsFromLink = () => this.getResultsFromLink({
+        const resultsFromLink = ({ prunePendingDeferFragments = true, } = {}) => this.getResultsFromLink({
             query,
             variables,
             context,
             fetchPolicy,
             errorPolicy,
             returnPartialData,
+            networkStatus,
         }, {
             cacheWriteBehavior,
             queryInfo,
             observableQuery,
             exposeExtensions,
+            prunePendingDeferFragments,
         }).pipe(validateDidEmitValue(), (0, rxjs_2.materialize)(), (0, rxjs_2.map)((result) => ({
             ...result,
+            // Always attach the variables used for this fetch so @export
+            // resolution can update ObservableQuery.options.variables and
+            // resubscribe the cache watch under the correct variable set.
+            resolvedVariables: variables,
             source: "network",
         })));
         switch (fetchPolicy) {
@@ -1085,7 +1104,7 @@ class QueryManager {
                 if (diff.complete || returnPartialData) {
                     return {
                         fromLink: true,
-                        observable: (0, rxjs_2.concat)(resultsFromCache(diff, networkStatus_js_1.NetworkStatus.loading), resultsFromLink()),
+                        observable: (0, rxjs_2.concat)(resultsFromCache(diff, networkStatus_js_1.NetworkStatus.loading), resultsFromLink({ prunePendingDeferFragments: false })),
                     };
                 }
                 return { fromLink: true, observable: resultsFromLink() };
@@ -1096,7 +1115,12 @@ class QueryManager {
                     observable: (0, rxjs_2.concat)(resultsFromCache(readCache(), networkStatus_js_1.NetworkStatus.ready)),
                 };
             case "network-only":
-                return { fromLink: true, observable: resultsFromLink() };
+                return {
+                    fromLink: true,
+                    observable: resultsFromLink({
+                        prunePendingDeferFragments: networkStatus !== networkStatus_js_1.NetworkStatus.refetch,
+                    }),
+                };
             case "no-cache":
                 return { fromLink: true, observable: resultsFromLink() };
             case "standby":
@@ -1112,7 +1136,7 @@ function validateDidEmitValue() {
             didEmitValue = true;
         },
         complete() {
-            (0, invariant_1.invariant)(didEmitValue, 100);
+            (0, invariant_1.invariant)(didEmitValue, 101);
         },
     });
 }