@apollo/client 4.0.0-alpha.13 → 4.0.0-alpha.15

package/core/QueryManager.js

@@ -1,6 +1,6 @@
 import { Trie } from "@wry/trie";
 import { BREAK, Kind, OperationTypeNode, visit } from "graphql";
-import { catchError, concat, EMPTY, filter, from, lastValueFrom, map, mergeMap, mergeWith, Observable, of, share, shareReplay, Subject, tap, } from "rxjs";
+import { catchError, concat, EMPTY, filter, from, lastValueFrom, map, materialize, mergeMap, mergeWith, Observable, of, share, shareReplay, Subject, tap, } from "rxjs";
 import { canonicalStringify } from "@apollo/client/cache";
 import { CombinedGraphQLErrors, graphQLResultHasProtocolErrors, registerLinkError, toErrorLike, } from "@apollo/client/errors";
 import { PROTOCOL_ERRORS_SYMBOL } from "@apollo/client/errors";
@@ -10,7 +10,7 @@ import { print } from "@apollo/client/utilities";
 import { cacheSizes } from "@apollo/client/utilities";
 import { DocumentTransform } from "@apollo/client/utilities";
 import { __DEV__ } from "@apollo/client/utilities/environment";
-import { AutoCleanedWeakCache, checkDocument, getDefaultValues, getGraphQLErrorsFromResult, getOperationDefinition, getOperationName, graphQLResultHasError, hasDirectives, isDocumentNode, isExecutionPatchIncrementalResult, isExecutionPatchResult, isNonEmptyArray, isNonNullObject, makeUniqueId, mergeIncrementalData, onAnyEvent, removeDirectivesFromDocument, toQueryResult, } from "@apollo/client/utilities/internal";
+import { AutoCleanedWeakCache, checkDocument, filterMap, getDefaultValues, getGraphQLErrorsFromResult, getOperationDefinition, getOperationName, graphQLResultHasError, hasDirectives, hasForcedResolvers, isDocumentNode, isExecutionPatchIncrementalResult, isExecutionPatchResult, isNonEmptyArray, isNonNullObject, makeUniqueId, mergeIncrementalData, onAnyEvent, removeDirectivesFromDocument, toQueryResult, } from "@apollo/client/utilities/internal";
 import { invariant, newInvariantError, } from "@apollo/client/utilities/invariant";
 import { isNetworkRequestInFlight, NetworkStatus } from "./networkStatus.js";
 import { logMissingFieldErrors, ObservableQuery } from "./ObservableQuery.js";
@@ -25,9 +25,9 @@ export class QueryManager {
     ssrMode;
     defaultContext;
     dataMasking;
+    localState;
     queryDeduplication;
     clientAwareness = {};
-    localState;
     /**
      * Whether to prioritize cache values over network results when
      * `fetchObservableWithInfo` is called.
@@ -57,10 +57,10 @@ export class QueryManager {
         this.defaultOptions = options.defaultOptions;
         this.queryDeduplication = options.queryDeduplication;
         this.clientAwareness = options.clientAwareness;
-        this.localState = options.localState;
         this.ssrMode = options.ssrMode;
         this.assumeImmutableResults = options.assumeImmutableResults;
         this.dataMasking = options.dataMasking;
+        this.localState = options.localState;
         const documentTransform = options.documentTransform;
         this.documentTransform =
             documentTransform ?
@@ -91,22 +91,30 @@ export class QueryManager {
         this.queries.forEach((_info, queryId) => {
             this.removeQuery(queryId);
         });
-        this.cancelPendingFetches(newInvariantError(74));
+        this.cancelPendingFetches(newInvariantError(82));
     }
     cancelPendingFetches(error) {
         this.fetchCancelFns.forEach((cancel) => cancel(error));
         this.fetchCancelFns.clear();
     }
     async mutate({ mutation, variables, optimisticResponse, updateQueries, refetchQueries = [], awaitRefetchQueries = false, update: updateWithProxyFn, onQueryUpdated, fetchPolicy = this.defaultOptions.mutate?.fetchPolicy || "network-only", errorPolicy = this.defaultOptions.mutate?.errorPolicy || "none", keepRootFields, context, }) {
-        invariant(mutation, 75);
+        invariant(mutation, 83);
         checkDocument(mutation, OperationTypeNode.MUTATION);
-        invariant(fetchPolicy === "network-only" || fetchPolicy === "no-cache", 76);
+        invariant(fetchPolicy === "network-only" || fetchPolicy === "no-cache", 84);
         const mutationId = this.generateMutationId();
         mutation = this.cache.transformForLink(this.transform(mutation));
         const { hasClientExports } = this.getDocumentInfo(mutation);
         variables = this.getVariables(mutation, variables);
         if (hasClientExports) {
-            variables = (await this.localState.addExportedVariables(mutation, variables, context));
+            if (__DEV__) {
+                invariant(this.localState, 85, getOperationName(mutation, "(anonymous)"));
+            }
+            variables = await this.localState.getExportedVariables({
+                client: this.client,
+                document: mutation,
+                variables,
+                context,
+            });
         }
         const mutationStoreValue = this.mutationStore &&
             (this.mutationStore[mutationId] = {
@@ -397,7 +405,18 @@ export class QueryManager {
         return true;
     }
     fetchQuery(queryId, options, networkStatus) {
-        return lastValueFrom(this.fetchObservableWithInfo(this.getOrCreateQuery(queryId), options, networkStatus).observable.pipe(map(toQueryResult)), {
+        return lastValueFrom(this.fetchObservableWithInfo(this.getOrCreateQuery(queryId), options, {
+            networkStatus,
+        }).observable.pipe(filterMap((value) => {
+            switch (value.kind) {
+                case "E":
+                    throw value.error;
+                case "N": {
+                    if (value.source !== "newNetworkStatus")
+                        return toQueryResult(value.value);
+                }
+            }
+        })), {
             // This default is needed when a `standby` fetch policy is used to avoid
             // an EmptyError from rejecting this promise.
             defaultValue: { data: undefined },
@@ -418,10 +437,10 @@ export class QueryManager {
                 // traversals into a single pass in the future, though the work is
                 // cached after the first time.
                 hasClientExports: hasDirectives(["client", "export"], document, true),
-                hasForcedResolvers: this.localState.shouldForceResolvers(document),
+                hasForcedResolvers: hasForcedResolvers(document),
                 hasNonreactiveDirective: hasDirectives(["nonreactive"], document),
                 nonReactiveQuery: addNonReactiveToNamedFragments(document),
-                clientQuery: this.localState.clientQuery(document),
+                clientQuery: hasDirectives(["client"], document) ? document : null,
                 serverQuery: removeDirectivesFromDocument([
                     { name: "client", remove: true },
                     { name: "connection" },
@@ -483,7 +502,7 @@ export class QueryManager {
         queryInfo.setObservableQuery(observable);
         return observable;
     }
-    query(options, queryId = this.generateQueryId()) {
+    async query(options, queryId = this.generateQueryId()) {
         const query = this.transform(options.query);
         return this.fetchQuery(queryId, {
             ...options,
@@ -520,16 +539,11 @@ 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(77));
-        this.queries.forEach((queryInfo) => {
-            if (queryInfo.observableQuery) {
-                // Set loading to true so listeners don't trigger unless they want
-                // results with partial data.
-                queryInfo.observableQuery["networkStatus"] = NetworkStatus.loading;
-            }
-            else {
-                queryInfo.stop();
-            }
+        this.cancelPendingFetches(newInvariantError(86));
+        this.queries.forEach(({ observableQuery }) => {
+            // Set loading to true so listeners don't trigger unless they want
+            // results with partial data.
+            observableQuery?.reset();
         });
         if (this.mutationStore) {
             this.mutationStore = {};
@@ -608,26 +622,25 @@ export class QueryManager {
                 if (!included) {
                     const queryName = queryNames.get(nameOrQueryString);
                     if (queryName) {
-                        __DEV__ && invariant.warn(78, queryName);
+                        __DEV__ && invariant.warn(87, queryName);
                     }
                     else {
-                        __DEV__ && invariant.warn(79);
+                        __DEV__ && invariant.warn(88);
                     }
                 }
             });
         }
         return queries;
     }
-    reFetchObservableQueries(includeStandby = false) {
+    refetchObservableQueries(includeStandby = false) {
         const observableQueryPromises = [];
         this.getObservableQueries(includeStandby ? "all" : "active").forEach((observableQuery, queryId) => {
             const { fetchPolicy } = observableQuery.options;
-            observableQuery.resetLastResults();
             if (includeStandby ||
                 (fetchPolicy !== "standby" && fetchPolicy !== "cache-only")) {
                 observableQueryPromises.push(observableQuery.refetch());
             }
-            (this.queries.get(queryId) || observableQuery["queryInfo"]).setDiff(null);
+            (this.queries.get(queryId) || observableQuery["queryInfo"]).resetDiff();
         });
         this.broadcastQueries();
         return Promise.all(observableQueryPromises);
@@ -681,9 +694,15 @@ export class QueryManager {
             return of({ data: undefined, error });
         }), filter((result) => !!(result.data || result.error)));
         if (this.getDocumentInfo(query).hasClientExports) {
-            const observablePromise = this.localState
-                .addExportedVariables(query, variables, context)
-                .then(makeObservable);
+            if (__DEV__) {
+                invariant(this.localState, 89, getOperationName(query, "(anonymous)"));
+            }
+            const observablePromise = this.localState.getExportedVariables({
+                client: this.client,
+                document: query,
+                variables,
+                context,
+            }).then(makeObservable);
             return new Observable((observer) => {
                 let sub = null;
                 observablePromise.then((observable) => (sub = observable.subscribe(observer)), observer.error);
@@ -700,17 +719,19 @@ export class QueryManager {
         // The same queryId could have two rejection fns for two promises
         this.fetchCancelFns.delete(queryId);
         if (this.queries.has(queryId)) {
-            this.queries.get(queryId)?.stop();
+            const oq = this.queries.get(queryId).observableQuery;
+            if (oq) {
+                oq["resetNotifications"]();
+                oq["unsubscribeFromCache"]?.();
+                oq.stopPolling();
+            }
             this.queries.delete(queryId);
         }
     }
     broadcastQueries() {
         if (this.onBroadcast)
             this.onBroadcast();
-        this.queries.forEach((info) => info.observableQuery?.["notify"]());
-    }
-    getLocalState() {
-        return this.localState;
+        this.queries.forEach((info) => info.observableQuery?.notify());
     }
     // Use protected instead of private field so
     // @apollo/experimental-nextjs-app-support can access type info.
@@ -721,15 +742,7 @@ export class QueryManager {
         this.queryDeduplication) {
         let observable;
         const { serverQuery, clientQuery } = this.getDocumentInfo(query);
-        const prepareContext = (context = {}) => {
-            const newContext = this.localState.prepareContext(context);
-            return {
-                ...this.defaultContext,
-                ...newContext,
-                queryDeduplication: deduplication,
-                clientAwareness: this.clientAwareness,
-            };
-        };
+        const operationName = getOperationName(query);
         const executeContext = {
             client: this.client,
         };
@@ -738,8 +751,13 @@ export class QueryManager {
             const operation = {
                 query: serverQuery,
                 variables,
-                operationName: getOperationName(serverQuery) || void 0,
-                context: prepareContext(context),
+                operationName,
+                context: {
+                    ...this.defaultContext,
+                    ...context,
+                    queryDeduplication: deduplication,
+                    clientAwareness: this.clientAwareness,
+                },
                 extensions,
             };
             context = operation.context;
@@ -766,11 +784,20 @@ export class QueryManager {
         }
         else {
             observable = of({ data: {} });
-            context = prepareContext(context);
         }
         if (clientQuery) {
+            if (__DEV__) {
+                const { operation } = getOperationDefinition(query);
+                invariant(
+                    this.localState,
+                    90,
+                    operation[0].toUpperCase() + operation.slice(1),
+                    operationName ?? "(anonymous)"
+                );
+            }
             observable = observable.pipe(mergeMap((result) => {
-                return from(this.localState.runResolvers({
+                return from(this.localState.execute({
+                    client: this.client,
                     document: clientQuery,
                     remoteResult: result,
                     context,
@@ -846,11 +873,11 @@ export class QueryManager {
             return of(aqr);
         }));
     }
-    fetchObservableWithInfo(queryInfo, options, 
+    fetchObservableWithInfo(queryInfo, options, { 
     // The initial networkStatus for this fetch, most often
     // NetworkStatus.loading, but also possibly fetchMore, poll, refetch,
     // or setVariables.
-    networkStatus = NetworkStatus.loading, query = options.query, emitLoadingState = false) {
+    networkStatus = NetworkStatus.loading, query = options.query, fetchQueryOperator = (x) => x, onCacheHit = () => { }, }) {
         const variables = this.getVariables(query, options.variables);
         const defaults = this.defaultOptions.watchQuery;
         let { fetchPolicy = (defaults && defaults.fetchPolicy) || "cache-first", errorPolicy = (defaults && defaults.errorPolicy) || "none", returnPartialData = false, notifyOnNetworkStatusChange = true, context = {}, } = options;
@@ -872,7 +899,16 @@ export class QueryManager {
             // modify its properties here, rather than creating yet another new
             // WatchQueryOptions object.
             normalized.variables = variables;
-            const observableWithInfo = this.fetchQueryByPolicy(queryInfo, normalized, networkStatus, emitLoadingState);
+            const cacheWriteBehavior = fetchPolicy === "no-cache" ? 0 /* CacheWriteBehavior.FORBID */
+                // Watched queries must opt into overwriting existing data on refetch,
+                // by passing refetchWritePolicy: "overwrite" in their WatchQueryOptions.
+                : (networkStatus === NetworkStatus.refetch &&
+                    normalized.refetchWritePolicy !== "merge") ?
+                    1 /* CacheWriteBehavior.OVERWRITE */
+                    : 2 /* CacheWriteBehavior.MERGE */;
+            const observableWithInfo = this.fetchQueryByPolicy(queryInfo, normalized, cacheWriteBehavior, onCacheHit);
+            observableWithInfo.observable =
+                observableWithInfo.observable.pipe(fetchQueryOperator);
             if (
             // If we're in standby, postpone advancing options.fetchPolicy using
             // applyNextFetchPolicy.
@@ -891,8 +927,13 @@ export class QueryManager {
             // observables to complete before itself completes.
             fetchCancelSubject.complete();
         };
-        this.fetchCancelFns.set(queryInfo.queryId, (reason) => {
-            fetchCancelSubject.error(reason);
+        this.fetchCancelFns.set(queryInfo.queryId, (error) => {
+            fetchCancelSubject.next({
+                kind: "E",
+                error,
+                source: "network",
+            });
+            fetchCancelSubject.complete();
             cleanupCancelFn();
         });
         const fetchCancelSubject = new Subject();
@@ -905,7 +946,15 @@ export class QueryManager {
         // for backwards compatibility. TODO This code could be simpler if
         // we deprecated and removed LocalState.
         if (this.getDocumentInfo(normalized.query).hasClientExports) {
-            observable = from(this.localState.addExportedVariables(normalized.query, normalized.variables, normalized.context)).pipe(mergeMap((variables) => fromVariables(variables).observable));
+            if (__DEV__) {
+                invariant(this.localState, 91, getOperationName(normalized.query, "(anonymous)"));
+            }
+            observable = from(this.localState.getExportedVariables({
+                client: this.client,
+                document: normalized.query,
+                variables: normalized.variables,
+                context: normalized.context,
+            })).pipe(mergeMap((variables) => fromVariables(variables).observable));
             // there is just no way we can synchronously get the *right* value here,
             // so we will assume `true`, which is the behaviour before the bug fix in
             // #10597. This means that bug is not fixed in that case, and is probably
@@ -927,14 +976,19 @@ export class QueryManager {
         const includedQueriesById = new Map();
         if (include) {
             this.getObservableQueries(include).forEach((oq, queryId) => {
+                const current = oq.getCurrentResult();
                 includedQueriesById.set(queryId, {
                     oq,
-                    lastDiff: (this.queries.get(queryId) || oq["queryInfo"]).getDiff(),
+                    lastDiff: {
+                        result: current?.data,
+                        complete: !current?.partial,
+                    },
                 });
             });
         }
         const results = new Map();
         if (updateCache) {
+            const handled = new Set();
             this.cache.batch({
                 update: updateCache,
                 // Since you can perform any combination of cache reads and/or writes in
@@ -976,9 +1030,10 @@ export class QueryManager {
                 // temporary optimistic layer, in case that ever matters.
                 removeOptimistic,
                 onWatchUpdated(watch, diff, lastDiff) {
-                    const oq = watch.watcher instanceof QueryInfo && watch.watcher.observableQuery;
-                    if (oq) {
-                        if (onQueryUpdated) {
+                    const oq = watch.watcher;
+                    if (oq instanceof ObservableQuery) {
+                        if (onQueryUpdated && !handled.has(oq)) {
+                            handled.add(oq);
                             // Since we're about to handle this query now, remove it from
                             // includedQueriesById, in case it was added earlier because of
                             // options.include.
@@ -1015,7 +1070,7 @@ export class QueryManager {
                 // queries, even the QueryOptions ones.
                 if (onQueryUpdated) {
                     if (!diff) {
-                        diff = this.cache.diff(oq["queryInfo"]["getDiffOptions"]());
+                        diff = this.cache.diff(oq["queryInfo"].getDiffOptions());
                     }
                     result = onQueryUpdated(oq, diff, lastDiff);
                 }
@@ -1055,8 +1110,7 @@ export class QueryManager {
                 !isFullyUnmaskedOperation(document) &&
                 !this.noCacheWarningsByQueryId.has(operationId)) {
                 this.noCacheWarningsByQueryId.add(operationId);
-                __DEV__ && invariant.warn(80, getOperationName(document) ??
-                    `Unnamed ${operationType ?? "operation"}`);
+                __DEV__ && invariant.warn(92, getOperationName(document, `Unnamed ${operationType ?? "operation"}`));
             }
         }
         return (this.dataMasking ?
@@ -1069,17 +1123,13 @@ export class QueryManager {
             maskFragment(data, fragment, this.cache, fragmentName)
             : data;
     }
-    fetchQueryByPolicy(queryInfo, { query, variables, fetchPolicy, refetchWritePolicy, errorPolicy, returnPartialData, context, }, 
-    // The initial networkStatus for this fetch, most often
-    // NetworkStatus.loading, but also possibly fetchMore, poll, refetch,
-    // or setVariables.
-    newNetworkStatus, emitLoadingState) {
+    fetchQueryByPolicy(queryInfo, { query, variables, fetchPolicy, errorPolicy, returnPartialData, context, }, cacheWriteBehavior, onCacheHit) {
         queryInfo.init({
             document: query,
             variables,
         });
-        const readCache = () => queryInfo.getDiff();
-        const resultsFromCache = (diff, networkStatus = newNetworkStatus) => {
+        const readCache = () => this.cache.diff(queryInfo.getDiffOptions());
+        const resultsFromCache = (diff, networkStatus) => {
             const data = diff.result;
             if (__DEV__ && !returnPartialData && data !== null) {
                 logMissingFieldErrors(diff.missing);
@@ -1101,25 +1151,35 @@ export class QueryManager {
                 };
             };
             const fromData = (data) => {
-                return of(toResult(data));
+                return of({
+                    kind: "N",
+                    value: toResult(data),
+                    source: "cache",
+                });
             };
-            if (this.getDocumentInfo(query).hasForcedResolvers) {
-                return from(this.localState
-                    .runResolvers({
+            if (
+            // Don't attempt to run forced resolvers if we have incomplete cache
+            // data and partial isn't allowed since this result would get set to
+            // `undefined` anyways in `toResult`.
+            (diff.complete || returnPartialData) &&
+                this.getDocumentInfo(query).hasForcedResolvers) {
+                if (__DEV__) {
+                    invariant(this.localState, 93, getOperationName(query, "(anonymous)"));
+                }
+                onCacheHit();
+                return from(this.localState.execute({
+                    client: this.client,
                     document: query,
-                    // TODO: Update remoteResult to handle `null`. In v3 the `if`
-                    // statement contained a check against `data`, but this value was
-                    // always `{}` if nothing was in the cache, which meant the check
-                    // above always succeeded when there were forced resolvers. Now that
-                    // `data` is nullable, this `remoteResult` needs to be an empty
-                    // object. Ideally we can pass in `null` here and the resolvers
-                    // would be able to handle this the same way.
-                    remoteResult: { data: data || {} },
+                    remoteResult: data ? { data } : undefined,
                     context,
                     variables,
                     onlyRunForcedResolvers: true,
-                })
-                    .then((resolved) => toResult(resolved.data || void 0)));
+                    returnPartialData: true,
+                }).then((resolved) => ({
+                    kind: "N",
+                    value: toResult(resolved.data || void 0),
+                    source: "cache",
+                })));
             }
             // Resolves https://github.com/apollographql/apollo-client/issues/10317.
             // If errorPolicy is 'none' and notifyOnNetworkStatusChange is true,
@@ -1132,20 +1192,16 @@ export class QueryManager {
             }
             return fromData(data || undefined);
         };
-        const cacheWriteBehavior = fetchPolicy === "no-cache" ? 0 /* CacheWriteBehavior.FORBID */
-            // Watched queries must opt into overwriting existing data on refetch,
-            // by passing refetchWritePolicy: "overwrite" in their WatchQueryOptions.
-            : (newNetworkStatus === NetworkStatus.refetch &&
-                refetchWritePolicy !== "merge") ?
-                1 /* CacheWriteBehavior.OVERWRITE */
-                : 2 /* CacheWriteBehavior.MERGE */;
         const resultsFromLink = () => this.getResultsFromLink(queryInfo, cacheWriteBehavior, {
             query,
             variables,
             context,
             fetchPolicy,
             errorPolicy,
-        }).pipe(validateDidEmitValue());
+        }).pipe(validateDidEmitValue(), materialize(), map((result) => ({
+            ...result,
+            source: "network",
+        })));
         switch (fetchPolicy) {
             default:
             case "cache-first": {
@@ -1156,20 +1212,20 @@ export class QueryManager {
                         observable: resultsFromCache(diff, NetworkStatus.ready),
                     };
                 }
-                if (returnPartialData || emitLoadingState) {
+                if (returnPartialData) {
                     return {
                         fromLink: true,
-                        observable: concat(resultsFromCache(diff), resultsFromLink()),
+                        observable: concat(resultsFromCache(diff, NetworkStatus.loading), resultsFromLink()),
                     };
                 }
                 return { fromLink: true, observable: resultsFromLink() };
             }
             case "cache-and-network": {
                 const diff = readCache();
-                if (diff.complete || returnPartialData || emitLoadingState) {
+                if (diff.complete || returnPartialData) {
                     return {
                         fromLink: true,
-                        observable: concat(resultsFromCache(diff), resultsFromLink()),
+                        observable: concat(resultsFromCache(diff, NetworkStatus.loading), resultsFromLink()),
                     };
                 }
                 return { fromLink: true, observable: resultsFromLink() };
@@ -1180,23 +1236,8 @@ export class QueryManager {
                     observable: concat(resultsFromCache(readCache(), NetworkStatus.ready)),
                 };
             case "network-only":
-                if (emitLoadingState) {
-                    return {
-                        fromLink: true,
-                        observable: concat(resultsFromCache(readCache()), resultsFromLink()),
-                    };
-                }
                 return { fromLink: true, observable: resultsFromLink() };
             case "no-cache":
-                if (emitLoadingState) {
-                    return {
-                        fromLink: true,
-                        // Note that queryInfo.getDiff() for no-cache queries does not call
-                        // cache.diff, but instead returns a { complete: false } stub result
-                        // when there is no queryInfo.diff already defined.
-                        observable: concat(resultsFromCache(queryInfo.getDiff()), resultsFromLink()),
-                    };
-                }
                 return { fromLink: true, observable: resultsFromLink() };
             case "standby":
                 return { fromLink: false, observable: EMPTY };
@@ -1216,7 +1257,7 @@ function validateDidEmitValue() {
             didEmitValue = true;
         },
         complete() {
-            invariant(didEmitValue, 81);
+            invariant(didEmitValue, 94);
         },
     });
 }