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

package/__cjs/core/ObservableQuery.d.cts

@@ -3,7 +3,6 @@ import type { Observable } from "rxjs";
 import type { MissingFieldError } from "@apollo/client/cache";
 import type { MissingTree } from "@apollo/client/cache";
 import type { MaybeMasked, Unmasked } from "@apollo/client/masking";
-import { NetworkStatus } from "./networkStatus.cjs";
 import type { QueryInfo } from "./QueryInfo.cjs";
 import type { QueryManager } from "./QueryManager.cjs";
 import type { ApolloQueryResult, ErrorLike, OperationVariables, TypedDocumentNode } from "./types.cjs";
@@ -78,7 +77,7 @@ export declare class ObservableQuery<TData = unknown, TVariables extends Operati
      * This function returns _another_ function that you can call to terminate the subscription.
      */
     subscribeToMore<TSubscriptionData = TData, TSubscriptionVariables extends OperationVariables = TVariables>(options: SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData, TVariables>): () => void;
-    setOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
+    /** @internal */
     silentSetOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): void;
     /**
      * Update the variables of this observable query, and fetch the new results
@@ -117,7 +116,11 @@ export declare class ObservableQuery<TData = unknown, TVariables extends Operati
     private fetch;
     private updatePolling;
     private updateLastResult;
-    reobserve(newOptions?: Partial<WatchQueryOptions<TVariables, TData>>, newNetworkStatus?: NetworkStatus): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
+    /**
+     * Reevaluate the query, optionally against new options. New options will be
+     * merged with the current options when given.
+     */
+    reobserve(newOptions?: Partial<WatchQueryOptions<TVariables, TData>>): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
     private observe;
     private reportResult;
     private reportError;

package/__cjs/core/QueryManager.cjs

@@ -37,6 +37,17 @@ class QueryManager {
     queryDeduplication;
     clientAwareness = {};
     localState;
+    /**
+     * Whether to prioritize cache values over network results when
+     * `fetchObservableWithInfo` is called.
+     * This will essentially turn a `"network-only"` or `"cache-and-network"`
+     * fetchPolicy into a `"cache-first"` fetchPolicy, but without influencing
+     * the `fetchPolicy` of the `ObservableQuery`.
+     *
+     * This can e.g. be used to prioritize the cache during the first render after
+     * SSR.
+     */
+    prioritizeCacheValues = false;
     onBroadcast;
     mutationStore;
     // All the queries that the QueryManager is currently managing (not
@@ -84,15 +95,15 @@ class QueryManager {
         this.queries.forEach((_info, queryId) => {
             this.removeQuery(queryId);
         });
-        this.cancelPendingFetches((0, invariant_1.newInvariantError)(72));
+        this.cancelPendingFetches((0, invariant_1.newInvariantError)(68));
     }
     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, }) {
-        (0, invariant_1.invariant)(mutation, 73);
-        (0, invariant_1.invariant)(fetchPolicy === "network-only" || fetchPolicy === "no-cache", 74);
+        (0, invariant_1.invariant)(mutation, 69);
+        (0, invariant_1.invariant)(fetchPolicy === "network-only" || fetchPolicy === "no-cache", 70);
         const mutationId = this.generateMutationId();
         mutation = this.cache.transformForLink(this.transform(mutation));
         const { hasClientExports } = this.getDocumentInfo(mutation);
@@ -126,7 +137,8 @@ class QueryManager {
                 optimisticResponse: isOptimistic ? optimisticResponse : void 0,
             }, variables, {}, false)
                 .pipe((0, rxjs_1.mergeMap)((result) => {
-                if ((0, utilities_4.graphQLResultHasError)(result) && errorPolicy === "none") {
+                const hasErrors = (0, utilities_4.graphQLResultHasError)(result);
+                if (hasErrors && errorPolicy === "none") {
                     throw new errors_1.CombinedGraphQLErrors((0, utilities_4.getGraphQLErrorsFromResult)(result));
                 }
                 if (mutationStoreValue) {
@@ -137,8 +149,7 @@ class QueryManager {
                 if (typeof refetchQueries === "function") {
                     refetchQueries = refetchQueries(storeResult);
                 }
-                if (errorPolicy === "ignore" &&
-                    (0, utilities_4.graphQLResultHasError)(storeResult)) {
+                if (errorPolicy === "ignore" && hasErrors) {
                     delete storeResult.errors;
                 }
                 return (0, rxjs_1.from)(this.markMutationResult({
@@ -167,28 +178,40 @@ class QueryManager {
                     // ExecutionPatchResult has arrived and we have assembled the
                     // multipart response into a single result.
                     if (!("hasNext" in storeResult) || storeResult.hasNext === false) {
-                        resolve({
-                            ...storeResult,
+                        const result = {
                             data: this.maskOperation({
                                 document: mutation,
                                 data: storeResult.data,
                                 fetchPolicy,
                                 id: mutationId,
                             }),
-                        });
+                        };
+                        if ((0, utilities_4.graphQLResultHasError)(storeResult)) {
+                            result.error = new errors_1.CombinedGraphQLErrors((0, utilities_4.getGraphQLErrorsFromResult)(storeResult));
+                        }
+                        if (storeResult.extensions) {
+                            result.extensions = storeResult.extensions;
+                        }
+                        resolve(result);
                     }
                 },
                 error: (err) => {
-                    err = maybeWrapError(err);
+                    const error = maybeWrapError(err);
                     if (mutationStoreValue) {
                         mutationStoreValue.loading = false;
-                        mutationStoreValue.error = err;
+                        mutationStoreValue.error = error;
                     }
                     if (isOptimistic) {
                         this.cache.removeOptimistic(mutationId);
                     }
                     this.broadcastQueries();
-                    reject(err);
+                    if (errorPolicy === "ignore") {
+                        return resolve({ data: undefined });
+                    }
+                    if (errorPolicy === "all") {
+                        return resolve({ data: undefined, error });
+                    }
+                    reject(error);
                 },
             });
         });
@@ -461,10 +484,10 @@ class QueryManager {
     // TODO: catch `EmptyError` and rethrow as network error if `complete`
     // notification is emitted without a value.
     query(options, queryId = this.generateQueryId()) {
-        (0, invariant_1.invariant)(options.query, 75);
-        (0, invariant_1.invariant)(options.query.kind === "Document", 76);
-        (0, invariant_1.invariant)(!options.returnPartialData, 77);
-        (0, invariant_1.invariant)(!options.pollInterval, 78);
+        (0, invariant_1.invariant)(options.query, 71);
+        (0, invariant_1.invariant)(options.query.kind === "Document", 72);
+        (0, invariant_1.invariant)(!options.returnPartialData, 73);
+        (0, invariant_1.invariant)(!options.pollInterval, 74);
         const query = this.transform(options.query);
         return this.fetchQuery(queryId, { ...options, query })
             .then((result) => result && {
@@ -498,7 +521,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)(79));
+        this.cancelPendingFetches((0, invariant_1.newInvariantError)(75));
         this.queries.forEach((queryInfo) => {
             if (queryInfo.observableQuery) {
                 // Set loading to true so listeners don't trigger unless they want
@@ -586,10 +609,10 @@ class QueryManager {
                 if (!included) {
                     const queryName = queryNames.get(nameOrQueryString);
                     if (queryName) {
-                        __DEV__ && invariant_1.invariant.warn(80, queryName);
+                        __DEV__ && invariant_1.invariant.warn(76, queryName);
                     }
                     else {
-                        __DEV__ && invariant_1.invariant.warn(81);
+                        __DEV__ && invariant_1.invariant.warn(77);
                     }
                 }
             });
@@ -618,38 +641,48 @@ class QueryManager {
         const { fetchPolicy, errorPolicy = "none", context = {}, extensions = {}, } = options;
         query = this.transform(query);
         variables = this.getVariables(query, variables);
-        const makeObservable = (variables) => this.getObservableFromLink(query, context, variables, extensions).pipe((0, rxjs_1.map)((result) => {
+        const makeObservable = (variables) => this.getObservableFromLink(query, context, variables, extensions).pipe((0, rxjs_1.map)((rawResult) => {
             if (fetchPolicy !== "no-cache") {
                 // the subscription interface should handle not sending us results we no longer subscribe to.
                 // XXX I don't think we ever send in an object with errors, but we might in the future...
-                if ((0, QueryInfo_js_1.shouldWriteResult)(result, errorPolicy)) {
+                if ((0, QueryInfo_js_1.shouldWriteResult)(rawResult, errorPolicy)) {
                     this.cache.write({
                         query,
-                        result: result.data,
+                        result: rawResult.data,
                         dataId: "ROOT_SUBSCRIPTION",
                         variables: variables,
                     });
                 }
                 this.broadcastQueries();
             }
-            const hasErrors = (0, utilities_4.graphQLResultHasError)(result);
-            const hasProtocolErrors = (0, errors_1.graphQLResultHasProtocolErrors)(result);
-            if (hasErrors && errorPolicy === "none") {
-                throw new errors_1.CombinedGraphQLErrors(result.errors);
+            const result = {
+                data: rawResult.data ?? undefined,
+            };
+            if ((0, utilities_4.graphQLResultHasError)(rawResult)) {
+                result.error = new errors_1.CombinedGraphQLErrors(rawResult.errors);
+            }
+            else if ((0, errors_1.graphQLResultHasProtocolErrors)(rawResult)) {
+                result.error = rawResult.extensions[errors_2.PROTOCOL_ERRORS_SYMBOL];
+                // Don't emit protocol errors added by HttpLink
+                delete rawResult.extensions[errors_2.PROTOCOL_ERRORS_SYMBOL];
+            }
+            if (rawResult.extensions &&
+                Object.keys(rawResult.extensions).length) {
+                result.extensions = rawResult.extensions;
             }
-            if (hasProtocolErrors) {
-                // `errorPolicy` is a mechanism for handling GraphQL errors, according
-                // to our documentation, so we throw protocol errors regardless of the
-                // set error policy.
-                throw result.extensions[errors_2.PROTOCOL_ERRORS_SYMBOL];
+            if (result.error && errorPolicy === "none") {
+                result.data = undefined;
             }
             if (errorPolicy === "ignore") {
-                delete result.errors;
+                delete result.error;
             }
             return result;
         }), (0, rxjs_1.catchError)((error) => {
-            throw maybeWrapError(error);
-        }));
+            if (errorPolicy === "ignore") {
+                return (0, rxjs_1.of)({ data: undefined });
+            }
+            return (0, rxjs_1.of)({ data: undefined, error: maybeWrapError(error) });
+        }), (0, rxjs_1.filter)((result) => !!(result.data || result.error)));
         if (this.getDocumentInfo(query).hasClientExports) {
             const observablePromise = this.localState
                 .addExportedVariables(query, variables, context)
@@ -817,6 +850,10 @@ class QueryManager {
         const queryInfo = this.getQuery(queryId);
         const defaults = this.defaultOptions.watchQuery;
         let { fetchPolicy = (defaults && defaults.fetchPolicy) || "cache-first", errorPolicy = (defaults && defaults.errorPolicy) || "none", returnPartialData = false, notifyOnNetworkStatusChange = false, context = {}, } = options;
+        if (this.prioritizeCacheValues &&
+            (fetchPolicy === "network-only" || fetchPolicy === "cache-and-network")) {
+            fetchPolicy = "cache-first";
+        }
         const normalized = Object.assign({}, options, {
             query,
             variables,
@@ -1016,7 +1053,7 @@ class QueryManager {
                 !(0, utilities_3.isFullyUnmaskedOperation)(document) &&
                 !this.noCacheWarningsByQueryId.has(operationId)) {
                 this.noCacheWarningsByQueryId.add(operationId);
-                __DEV__ && invariant_1.invariant.warn(82, (0, utilities_4.getOperationName)(document) ??
+                __DEV__ && invariant_1.invariant.warn(78, (0, utilities_4.getOperationName)(document) ??
                     `Unnamed ${operationType ?? "operation"}`);
             }
         }