@apollo/client 4.3.0-alpha.1 → 4.3.0-alpha.10

package/core/QueryManager.js

@@ -9,8 +9,9 @@ import { execute } from "@apollo/client/link";
 import { maskFragment, maskOperation } from "@apollo/client/masking";
 import { cacheSizes, DocumentTransform, isNetworkRequestInFlight, print, } from "@apollo/client/utilities";
 import { __DEV__ } from "@apollo/client/utilities/environment";
-import { AutoCleanedWeakCache, checkDocument, extensionsSymbol, filterMap, getDefaultValues, getOperationDefinition, getOperationName, graphQLResultHasError, hasDirectives, hasForcedResolvers, isDocumentNode, isNonNullObject, makeUniqueId, mergeOptions, removeDirectivesFromDocument, streamInfoSymbol, toQueryResult, } from "@apollo/client/utilities/internal";
+import { AutoCleanedWeakCache, checkDocument, coerceScalarFieldsToParsed, extensionsSymbol, filterMap, getDefaultValues, getOperationDefinition, getOperationName, graphQLResultHasError, hasDirectives, hasForcedResolvers, isDocumentNode, isNonNullObject, makeUniqueId, mergeOptions, removeDirectivesFromDocument, streamInfoSymbol, toQueryResult, } from "@apollo/client/utilities/internal";
 import { invariant, newInvariantError, } from "@apollo/client/utilities/invariant";
+import { dataStateErrorCache } from "./dataStateErrorCache.js";
 import { NetworkStatus } from "./networkStatus.js";
 import { logMissingFieldErrors, ObservableQuery } from "./ObservableQuery.js";
 import { QueryInfo } from "./QueryInfo.js";
@@ -75,6 +76,12 @@ export 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 = {};
@@ -92,7 +99,7 @@ export class QueryManager {
      */
     stop() {
         this.obsQueries.forEach((oq) => oq.stop());
-        this.cancelPendingFetches(newInvariantError(89));
+        this.cancelPendingFetches(newInvariantError(92));
     }
     cancelPendingFetches(error) {
         this.fetchCancelFns.forEach((cancel) => cancel(error));
@@ -105,7 +112,7 @@ export class QueryManager {
         variables = this.getVariables(mutation, variables);
         if (hasClientExports) {
             if (__DEV__) {
-                invariant(this.localState, 90, getOperationName(mutation, "(anonymous)"));
+                invariant(this.localState, 93, getOperationName(mutation, "(anonymous)"));
             }
             variables = await this.localState.getExportedVariables({
                 client: this.client,
@@ -117,7 +124,7 @@ export class QueryManager {
         const mutationStoreValue = this.mutationStore &&
             (this.mutationStore[queryInfo.id] = {
                 mutation,
-                variables,
+                variables: this.cache.serializeVariables(mutation, variables),
                 loading: true,
                 error: null,
             });
@@ -330,10 +337,6 @@ export class QueryManager {
             }),
         }));
     }
-    requestIdCounter = 1;
-    generateRequestId() {
-        return this.requestIdCounter++;
-    }
     clearStore(options = {
         discardWatches: true,
     }) {
@@ -342,7 +345,7 @@ export 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(newInvariantError(91));
+        this.cancelPendingFetches(newInvariantError(94));
         this.obsQueries.forEach((observableQuery) => {
             // Set loading to true so listeners don't trigger unless they want
             // results with partial data.
@@ -412,10 +415,10 @@ export class QueryManager {
                 if (!included) {
                     const queryName = queryNames.get(nameOrQueryString);
                     if (queryName) {
-                        __DEV__ && invariant.warn(92, queryName);
+                        __DEV__ && invariant.warn(95, queryName);
                     }
                     else {
-                        __DEV__ && invariant.warn(93);
+                        __DEV__ && invariant.warn(96);
                     }
                 }
             });
@@ -444,7 +447,7 @@ export class QueryManager {
         if (__DEV__) {
             invariant(
                 !this.getDocumentInfo(query).hasClientExports || this.localState,
-                94,
+                97,
                 getOperationName(query, "(anonymous)")
             );
         }
@@ -519,6 +522,7 @@ export class QueryManager {
         const executeContext = {
             client: this.client,
         };
+        variables = this.cache.serializeVariables(query, variables);
         if (serverQuery) {
             const { inFlightLinkObservables, link } = this;
             try {
@@ -588,14 +592,14 @@ export class QueryManager {
             if (__DEV__) {
                 invariant(
                     this.localState,
-                    95,
+                    98,
                     operation[0].toUpperCase() + operation.slice(1),
                     operationName ?? "(anonymous)"
                 );
             }
             invariant(
                 !hasIncrementalDirective,
-                96,
+                99,
                 operation[0].toUpperCase() + operation.slice(1),
                 operationName ?? "(anonymous)"
             );
@@ -619,8 +623,7 @@ export class QueryManager {
             })),
         };
     }
-    getResultsFromLink(options, { queryInfo, cacheWriteBehavior, observableQuery, exposeExtensions, }) {
-        const requestId = (queryInfo.lastRequestId = this.generateRequestId());
+    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
@@ -630,57 +633,49 @@ export class QueryManager {
             // Use linkDocument rather than queryInfo.document so the
             // operation/fragments used to write the result are the same as the
             // ones used to obtain it from the link.
-            const result = queryInfo.markQueryResult(incoming, {
+            const { dataState, ...result } = queryInfo.markQueryResult(incoming, {
                 ...options,
                 document: linkDocument,
                 cacheWriteBehavior,
+                returnPartialData: options.returnPartialData,
+                prunePendingDeferFragments,
             });
             const hasErrors = graphQLResultHasError(result);
             if (hasErrors && errorPolicy === "none") {
-                queryInfo.resetLastWrite();
                 observableQuery?.["resetNotifications"]();
-                throw new CombinedGraphQLErrors(removeStreamDetailsFromExtensions(result));
+                const error = new CombinedGraphQLErrors(removeStreamDetailsFromExtensions(result));
+                dataStateErrorCache.set(error, dataState);
+                throw error;
             }
+            const partial = dataState !== "complete";
             const aqr = {
                 data: result.data,
                 ...(queryInfo.hasNext ?
                     {
                         loading: true,
                         networkStatus: NetworkStatus.streaming,
-                        dataState: "streaming",
-                        partial: true,
+                        dataState,
+                        partial,
                     }
                     : {
-                        dataState: result.data ? "complete" : "empty",
+                        dataState,
                         loading: false,
                         networkStatus: NetworkStatus.ready,
-                        partial: !result.data,
+                        partial,
                     }),
             };
             if (exposeExtensions && "extensions" in result) {
                 aqr[extensionsSymbol] = result.extensions;
             }
-            // In the case we start multiple network requests simultaneously, we
-            // want to ensure we properly set `data` if we're reporting on an old
-            // result which will not be caught by the conditional above that ends up
-            // throwing the markError result.
-            if (hasErrors) {
-                if (errorPolicy === "none") {
-                    aqr.data = void 0;
-                    aqr.dataState = "empty";
-                }
-                if (errorPolicy !== "ignore") {
-                    aqr.error = new CombinedGraphQLErrors(removeStreamDetailsFromExtensions(result));
-                    if (aqr.dataState !== "streaming") {
-                        aqr.networkStatus = NetworkStatus.error;
-                    }
+            if (hasErrors && errorPolicy !== "ignore") {
+                aqr.error = new CombinedGraphQLErrors(removeStreamDetailsFromExtensions(result));
+                if (aqr.networkStatus !== NetworkStatus.streaming) {
+                    aqr.networkStatus = NetworkStatus.error;
                 }
             }
             return aqr;
         }), catchError((error) => {
-            // Avoid storing errors from older interrupted queries.
-            if (requestId >= queryInfo.lastRequestId && errorPolicy === "none") {
-                queryInfo.resetLastWrite();
+            if (errorPolicy === "none") {
                 observableQuery?.["resetNotifications"]();
                 throw error;
             }
@@ -715,6 +710,7 @@ export class QueryManager {
             fetchPolicy,
             errorPolicy,
             returnPartialData,
+            networkStatus,
             notifyOnNetworkStatusChange,
             context,
         });
@@ -771,7 +767,7 @@ export class QueryManager {
         // we deprecated and removed LocalState.
         if (this.getDocumentInfo(normalized.query).hasClientExports) {
             if (__DEV__) {
-                invariant(this.localState, 97, getOperationName(normalized.query, "(anonymous)"));
+                invariant(this.localState, 100, getOperationName(normalized.query, "(anonymous)"));
             }
             observable = from(this.localState.getExportedVariables({
                 client: this.client,
@@ -944,7 +940,7 @@ export class QueryManager {
                 !isFullyUnmaskedOperation(document) &&
                 !this.noCacheWarningsByCause.has(cause)) {
                 this.noCacheWarningsByCause.add(cause);
-                __DEV__ && invariant.warn(98, getOperationName(document, `Unnamed ${operationType ?? "operation"}`));
+                __DEV__ && invariant.warn(101, getOperationName(document, `Unnamed ${operationType ?? "operation"}`));
             }
         }
         return (this.dataMasking ?
@@ -957,32 +953,33 @@ export class QueryManager {
             maskFragment(data, fragment, this.cache, fragmentName)
             : data;
     }
-    fetchQueryByPolicy({ query, variables, fetchPolicy, errorPolicy, returnPartialData, context, }, { cacheWriteBehavior, onCacheHit, queryInfo, observableQuery, exposeExtensions, }) {
-        const readCache = () => this.cache.diff({
-            query,
-            variables,
-            returnPartialData: true,
-            optimistic: true,
-        });
+    fetchQueryByPolicy({ query, variables, fetchPolicy, errorPolicy, returnPartialData, context, networkStatus, }, { cacheWriteBehavior, onCacheHit, queryInfo, observableQuery, exposeExtensions, }) {
+        const readCache = () => {
+            return queryInfo.getDiff({
+                query,
+                variables,
+                returnPartialData: true,
+                optimistic: true,
+            });
+        };
         const resultsFromCache = (diff, networkStatus) => {
             const data = diff.result;
             if (__DEV__ && !returnPartialData && data !== null) {
                 logMissingFieldErrors(diff.missing);
             }
-            const toResult = (data) => {
+            const toResult = (data, dataState = diff.dataState) => {
                 // TODO: Eventually we should move this handling into
                 // queryInfo.getDiff() directly. Since getDiff is updated to return null
                 // on returnPartialData: false, we should take advantage of that instead
                 // of having to patch it elsewhere.
                 if (!diff.complete && !returnPartialData) {
                     data = undefined;
+                    dataState = "empty";
                 }
                 return {
                     // TODO: Handle partial data
                     data: data,
-                    dataState: diff.complete ? "complete"
-                        : data ? "partial"
-                            : "empty",
+                    dataState,
                     loading: isNetworkRequestInFlight(networkStatus),
                     networkStatus,
                     partial: !diff.complete,
@@ -992,6 +989,10 @@ export class QueryManager {
                 return 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",
                 });
             };
@@ -1002,7 +1003,7 @@ export class QueryManager {
             (diff.complete || returnPartialData) &&
                 this.getDocumentInfo(query).hasForcedResolvers) {
                 if (__DEV__) {
-                    invariant(this.localState, 99, getOperationName(query, "(anonymous)"));
+                    invariant(this.localState, 102, getOperationName(query, "(anonymous)"));
                 }
                 onCacheHit();
                 return from(this.localState.execute({
@@ -1016,7 +1017,13 @@ export class QueryManager {
                     fetchPolicy,
                 }).then((resolved) => ({
                     kind: "N",
-                    value: toResult(resolved.data || void 0),
+                    value: toResult(resolved.data || void 0, diff.complete ? "complete"
+                        : resolved.data ? "partial"
+                            : "empty"),
+                    // 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",
                 })));
             }
@@ -1031,19 +1038,26 @@ export 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(), materialize(), 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) {
@@ -1069,7 +1083,7 @@ export class QueryManager {
                 if (diff.complete || returnPartialData) {
                     return {
                         fromLink: true,
-                        observable: concat(resultsFromCache(diff, NetworkStatus.loading), resultsFromLink()),
+                        observable: concat(resultsFromCache(diff, NetworkStatus.loading), resultsFromLink({ prunePendingDeferFragments: false })),
                     };
                 }
                 return { fromLink: true, observable: resultsFromLink() };
@@ -1080,9 +1094,24 @@ export class QueryManager {
                     observable: concat(resultsFromCache(readCache(), NetworkStatus.ready)),
                 };
             case "network-only":
-                return { fromLink: true, observable: resultsFromLink() };
+                return {
+                    fromLink: true,
+                    observable: resultsFromLink({
+                        prunePendingDeferFragments: networkStatus !== NetworkStatus.refetch,
+                    }),
+                };
             case "no-cache":
-                return { fromLink: true, observable: resultsFromLink() };
+                return {
+                    fromLink: true,
+                    observable: resultsFromLink().pipe(map((notification) => {
+                        if (notification.kind === "N" &&
+                            notification.value.data != null &&
+                            this.cache.configuresScalars()) {
+                            notification.value.data = coerceScalarFieldsToParsed(notification.value.data, query, this.cache);
+                        }
+                        return notification;
+                    })),
+                };
             case "standby":
                 return { fromLink: false, observable: EMPTY };
         }
@@ -1095,7 +1124,7 @@ function validateDidEmitValue() {
             didEmitValue = true;
         },
         complete() {
-            invariant(didEmitValue, 100);
+            invariant(didEmitValue, 103);
         },
     });
 }