@apollo/client 4.0.0-alpha.0 → 4.0.0-alpha.10

package/__cjs/core/QueryManager.cjs

@@ -6,6 +6,7 @@ const {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueryManager = void 0;
 const trie_1 = require("@wry/trie");
+const graphql_1 = require("graphql");
 const rxjs_1 = require("rxjs");
 const cache_1 = require("@apollo/client/cache");
 const errors_1 = require("@apollo/client/errors");
@@ -37,6 +38,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 +96,16 @@ class QueryManager {
         this.queries.forEach((_info, queryId) => {
             this.removeQuery(queryId);
         });
-        this.cancelPendingFetches((0, invariant_1.newInvariantError)(71));
+        this.cancelPendingFetches((0, invariant_1.newInvariantError)(74));
     }
     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, 72);
-        (0, invariant_1.invariant)(fetchPolicy === "network-only" || fetchPolicy === "no-cache", 73);
+        (0, invariant_1.invariant)(mutation, 75);
+        (0, utilities_1.checkDocument)(mutation, graphql_1.OperationTypeNode.MUTATION);
+        (0, invariant_1.invariant)(fetchPolicy === "network-only" || fetchPolicy === "no-cache", 76);
         const mutationId = this.generateMutationId();
         mutation = this.cache.transformForLink(this.transform(mutation));
         const { hasClientExports } = this.getDocumentInfo(mutation);
@@ -125,9 +138,10 @@ class QueryManager {
                 ...context,
                 optimisticResponse: isOptimistic ? optimisticResponse : void 0,
             }, variables, {}, false)
-                .pipe((0, rxjs_1.mergeMap)((result) => {
-                if ((0, utilities_4.graphQLResultHasError)(result) && errorPolicy === "none") {
-                    throw new errors_1.CombinedGraphQLErrors((0, utilities_4.getGraphQLErrorsFromResult)(result));
+                .pipe(validateDidEmitValue(), (0, rxjs_1.mergeMap)((result) => {
+                const hasErrors = (0, utilities_4.graphQLResultHasError)(result);
+                if (hasErrors && errorPolicy === "none") {
+                    throw new errors_1.CombinedGraphQLErrors(result);
                 }
                 if (mutationStoreValue) {
                     mutationStoreValue.loading = false;
@@ -137,8 +151,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 +180,39 @@ 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(storeResult);
+                        }
+                        if (storeResult.extensions) {
+                            result.extensions = storeResult.extensions;
+                        }
+                        resolve(result);
                     }
                 },
-                error: (err) => {
-                    err = maybeWrapError(err);
+                error: (error) => {
                     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);
                 },
             });
         });
@@ -378,13 +402,17 @@ class QueryManager {
         return true;
     }
     fetchQuery(queryId, options, networkStatus) {
-        return (0, rxjs_1.lastValueFrom)(this.fetchObservableWithInfo(queryId, options, networkStatus).observable, { defaultValue: undefined });
+        return (0, rxjs_1.lastValueFrom)(this.fetchObservableWithInfo(this.getOrCreateQuery(queryId), options, networkStatus).observable.pipe((0, rxjs_1.map)(internal_1.toQueryResult)), {
+            // This default is needed when a `standby` fetch policy is used to avoid
+            // an EmptyError from rejecting this promise.
+            defaultValue: { data: undefined },
+        });
     }
     transform(document) {
         return this.documentTransform.transformDocument(document);
     }
     transformCache = new utilities_2.AutoCleanedWeakCache(utilities_2.cacheSizes["queryManager.getDocumentInfo"] ||
-        utilities_3.defaultCacheSizes["queryManager.getDocumentInfo"]);
+        2000 /* defaultCacheSizes["queryManager.getDocumentInfo"] */);
     getDocumentInfo(document) {
         const { transformCache } = this;
         if (!transformCache.has(document)) {
@@ -424,12 +452,15 @@ class QueryManager {
         return transformCache.get(document);
     }
     getVariables(document, variables) {
+        const defaultVars = this.getDocumentInfo(document).defaultVars;
+        const varsWithDefaults = Object.entries(variables ?? {}).map(([key, value]) => [key, value === undefined ? defaultVars[key] : value]);
         return {
-            ...this.getDocumentInfo(document).defaultVars,
-            ...variables,
+            ...defaultVars,
+            ...Object.fromEntries(varsWithDefaults),
         };
     }
     watchQuery(options) {
+        (0, utilities_1.checkDocument)(options.query, graphql_1.OperationTypeNode.QUERY);
         const query = this.transform(options.query);
         // assign variable default values if supplied
         // NOTE: We don't modify options.query here with the transformed query to
@@ -439,7 +470,7 @@ class QueryManager {
             variables: this.getVariables(query, options.variables),
         };
         if (typeof options.notifyOnNetworkStatusChange === "undefined") {
-            options.notifyOnNetworkStatusChange = false;
+            options.notifyOnNetworkStatusChange = true;
         }
         const queryInfo = new QueryInfo_js_1.QueryInfo(this);
         const observable = new ObservableQuery_js_1.ObservableQuery({
@@ -448,34 +479,30 @@ class QueryManager {
             options,
         });
         observable["lastQuery"] = query;
-        this.queries.set(observable.queryId, queryInfo);
+        if (!ObservableQuery_js_1.ObservableQuery["inactiveOnCreation"].getValue()) {
+            this.queries.set(observable.queryId, queryInfo);
+        }
         // We give queryInfo the transformed query to ensure the first cache diff
         // uses the transformed query instead of the raw query
-        queryInfo.init({
-            document: query,
-            observableQuery: observable,
-            variables: observable.variables,
-        });
+        queryInfo.init({ document: query, variables: observable.variables });
+        queryInfo.setObservableQuery(observable);
         return observable;
     }
-    // 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, 74);
-        (0, invariant_1.invariant)(options.query.kind === "Document", 75);
-        (0, invariant_1.invariant)(!options.returnPartialData, 76);
-        (0, invariant_1.invariant)(!options.pollInterval, 77);
         const query = this.transform(options.query);
-        return this.fetchQuery(queryId, { ...options, query })
-            .then((result) => result && {
-            ...result,
+        return this.fetchQuery(queryId, {
+            ...options,
+            query,
+        })
+            .then((value) => ({
+            ...value,
             data: this.maskOperation({
                 document: query,
-                data: result.data,
+                data: value?.data,
                 fetchPolicy: options.fetchPolicy,
                 id: queryId,
             }),
-        })
+        }))
             .finally(() => this.stopQuery(queryId));
     }
     queryIdCounter = 1;
@@ -498,7 +525,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)(78));
+        this.cancelPendingFetches((0, invariant_1.newInvariantError)(77));
         this.queries.forEach((queryInfo) => {
             if (queryInfo.observableQuery) {
                 // Set loading to true so listeners don't trigger unless they want
@@ -564,7 +591,7 @@ class QueryManager {
                 // pre-allocate a new query ID here, using a special prefix to enable
                 // cleaning up these temporary queries later, after fetching.
                 const queryId = (0, utilities_4.makeUniqueId)("legacyOneTimeQuery");
-                const queryInfo = this.getQuery(queryId).init({
+                const queryInfo = this.getOrCreateQuery(queryId).init({
                     document: options.query,
                     variables: options.variables,
                 });
@@ -586,10 +613,10 @@ class QueryManager {
                 if (!included) {
                     const queryName = queryNames.get(nameOrQueryString);
                     if (queryName) {
-                        __DEV__ && invariant_1.invariant.warn(79, queryName);
+                        __DEV__ && invariant_1.invariant.warn(78, queryName);
                     }
                     else {
-                        __DEV__ && invariant_1.invariant.warn(80);
+                        __DEV__ && invariant_1.invariant.warn(79);
                     }
                 }
             });
@@ -605,51 +632,59 @@ class QueryManager {
                 (fetchPolicy !== "standby" && fetchPolicy !== "cache-only")) {
                 observableQueryPromises.push(observableQuery.refetch());
             }
-            this.getQuery(queryId).setDiff(null);
+            (this.queries.get(queryId) || observableQuery["queryInfo"]).setDiff(null);
         });
         this.broadcastQueries();
         return Promise.all(observableQueryPromises);
     }
-    setObservableQuery(observableQuery) {
-        this.getQuery(observableQuery.queryId).setObservableQuery(observableQuery);
-    }
     startGraphQLSubscription(options) {
         let { query, variables } = options;
         const { fetchPolicy, errorPolicy = "none", context = {}, extensions = {}, } = options;
+        (0, utilities_1.checkDocument)(query, graphql_1.OperationTypeNode.SUBSCRIPTION);
         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);
+            }
+            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 (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 (rawResult.extensions &&
+                Object.keys(rawResult.extensions).length) {
+                result.extensions = rawResult.extensions;
+            }
+            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 });
+        }), (0, rxjs_1.filter)((result) => !!(result.data || result.error)));
         if (this.getDocumentInfo(query).hasClientExports) {
             const observablePromise = this.localState
                 .addExportedVariables(query, variables, context)
@@ -674,14 +709,14 @@ class QueryManager {
         // The same queryId could have two rejection fns for two promises
         this.fetchCancelFns.delete(queryId);
         if (this.queries.has(queryId)) {
-            this.getQuery(queryId).stop();
+            this.queries.get(queryId)?.stop();
             this.queries.delete(queryId);
         }
     }
     broadcastQueries() {
         if (this.onBroadcast)
             this.onBroadcast();
-        this.queries.forEach((info) => info.notify());
+        this.queries.forEach((info) => info.observableQuery?.["notify"]());
     }
     getLocalState() {
         return this.localState;
@@ -743,34 +778,30 @@ class QueryManager {
                 }));
             }));
         }
-        return observable;
+        return observable.pipe((0, rxjs_1.catchError)((error) => {
+            error = (0, errors_1.toErrorLike)(error);
+            (0, errors_1.registerLinkError)(error);
+            throw error;
+        }));
     }
     getResultsFromLink(queryInfo, cacheWriteBehavior, options) {
         const requestId = (queryInfo.lastRequestId = this.generateRequestId());
+        const { errorPolicy } = options;
         // Performing transformForLink here gives this.cache a chance to fill in
         // missing fragment definitions (for example) before sending this document
         // through the link chain.
         const linkDocument = this.cache.transformForLink(options.query);
-        return this.getObservableFromLink(linkDocument, options.context, options.variables).pipe((0, rxjs_1.catchError)((error) => {
-            error = maybeWrapError(error);
-            // Avoid storing errors from older interrupted queries.
-            if (requestId >= queryInfo.lastRequestId) {
-                queryInfo.resetLastWrite();
-                queryInfo.reset();
-            }
-            throw error;
-        }), (0, rxjs_1.map)((result) => {
+        return this.getObservableFromLink(linkDocument, options.context, options.variables).pipe((0, rxjs_1.map)((result) => {
             const graphQLErrors = (0, utilities_4.getGraphQLErrorsFromResult)(result);
             const hasErrors = graphQLErrors.length > 0;
-            const { errorPolicy } = options;
             // If we interrupted this request by calling getResultsFromLink again
             // with the same QueryInfo object, we ignore the old results.
             if (requestId >= queryInfo.lastRequestId) {
                 if (hasErrors && errorPolicy === "none") {
                     queryInfo.resetLastWrite();
-                    queryInfo.reset();
+                    queryInfo.observableQuery?.["resetNotifications"]();
                     // Throwing here effectively calls observer.error.
-                    throw new errors_1.CombinedGraphQLErrors(graphQLErrors);
+                    throw new errors_1.CombinedGraphQLErrors(result);
                 }
                 // Use linkDocument rather than queryInfo.document so the
                 // operation/fragments used to write the result are the same as the
@@ -791,21 +822,42 @@ class QueryManager {
                 aqr.data = void 0;
             }
             if (hasErrors && errorPolicy !== "ignore") {
-                aqr.error = new errors_1.CombinedGraphQLErrors(graphQLErrors);
+                aqr.error = new errors_1.CombinedGraphQLErrors(result);
                 aqr.networkStatus = networkStatus_js_1.NetworkStatus.error;
             }
             return aqr;
+        }), (0, rxjs_1.catchError)((error) => {
+            // Avoid storing errors from older interrupted queries.
+            if (requestId >= queryInfo.lastRequestId && errorPolicy === "none") {
+                queryInfo.resetLastWrite();
+                queryInfo.observableQuery?.["resetNotifications"]();
+                throw error;
+            }
+            const aqr = {
+                data: undefined,
+                loading: false,
+                networkStatus: networkStatus_js_1.NetworkStatus.ready,
+                partial: true,
+            };
+            if (errorPolicy !== "ignore") {
+                aqr.error = error;
+                aqr.networkStatus = networkStatus_js_1.NetworkStatus.error;
+            }
+            return (0, rxjs_1.of)(aqr);
         }));
     }
-    fetchObservableWithInfo(queryId, options, 
+    fetchObservableWithInfo(queryInfo, options, 
     // The initial networkStatus for this fetch, most often
     // NetworkStatus.loading, but also possibly fetchMore, poll, refetch,
     // or setVariables.
     networkStatus = networkStatus_js_1.NetworkStatus.loading, query = options.query, emitLoadingState = false) {
         const variables = this.getVariables(query, options.variables);
-        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;
+        let { fetchPolicy = (defaults && defaults.fetchPolicy) || "cache-first", errorPolicy = (defaults && defaults.errorPolicy) || "none", returnPartialData = false, notifyOnNetworkStatusChange = true, context = {}, } = options;
+        if (this.prioritizeCacheValues &&
+            (fetchPolicy === "network-only" || fetchPolicy === "cache-and-network")) {
+            fetchPolicy = "cache-first";
+        }
         const normalized = Object.assign({}, options, {
             query,
             variables,
@@ -833,13 +885,13 @@ class QueryManager {
         // This cancel function needs to be set before the concast is created,
         // in case concast creation synchronously cancels the request.
         const cleanupCancelFn = () => {
-            this.fetchCancelFns.delete(queryId);
+            this.fetchCancelFns.delete(queryInfo.queryId);
             // We need to call `complete` on the subject here otherwise the merged
             // observable will never complete since it waits for all source
             // observables to complete before itself completes.
             fetchCancelSubject.complete();
         };
-        this.fetchCancelFns.set(queryId, (reason) => {
+        this.fetchCancelFns.set(queryInfo.queryId, (reason) => {
             fetchCancelSubject.error(reason);
             cleanupCancelFn();
         });
@@ -877,7 +929,7 @@ class QueryManager {
             this.getObservableQueries(include).forEach((oq, queryId) => {
                 includedQueriesById.set(queryId, {
                     oq,
-                    lastDiff: this.getQuery(queryId).getDiff(),
+                    lastDiff: (this.queries.get(queryId) || oq["queryInfo"]).getDiff(),
                 });
             });
         }
@@ -963,9 +1015,7 @@ class QueryManager {
                 // queries, even the QueryOptions ones.
                 if (onQueryUpdated) {
                     if (!diff) {
-                        const info = oq["queryInfo"];
-                        info.reset(); // Force info.getDiff() to read from cache.
-                        diff = info.getDiff();
+                        diff = this.cache.diff(oq["queryInfo"]["getDiffOptions"]());
                     }
                     result = onQueryUpdated(oq, diff, lastDiff);
                 }
@@ -1005,7 +1055,7 @@ class QueryManager {
                 !(0, utilities_3.isFullyUnmaskedOperation)(document) &&
                 !this.noCacheWarningsByQueryId.has(operationId)) {
                 this.noCacheWarningsByQueryId.add(operationId);
-                __DEV__ && invariant_1.invariant.warn(81, (0, utilities_4.getOperationName)(document) ??
+                __DEV__ && invariant_1.invariant.warn(80, (0, utilities_4.getOperationName)(document) ??
                     `Unnamed ${operationType ?? "operation"}`);
             }
         }
@@ -1095,7 +1145,7 @@ class QueryManager {
             context,
             fetchPolicy,
             errorPolicy,
-        });
+        }).pipe(validateDidEmitValue());
         switch (fetchPolicy) {
             default:
             case "cache-first": {
@@ -1152,7 +1202,7 @@ class QueryManager {
                 return { fromLink: false, observable: rxjs_1.EMPTY };
         }
     }
-    getQuery(queryId) {
+    getOrCreateQuery(queryId) {
         if (queryId && !this.queries.has(queryId)) {
             this.queries.set(queryId, new QueryInfo_js_1.QueryInfo(this, queryId));
         }
@@ -1168,21 +1218,15 @@ class QueryManager {
     }
 }
 exports.QueryManager = QueryManager;
-function isErrorLike(error) {
-    return (error !== null &&
-        typeof error === "object" &&
-        typeof error.message === "string" &&
-        typeof error.name === "string" &&
-        (typeof error.stack === "undefined" ||
-            typeof error.stack === "string"));
-}
-function maybeWrapError(error) {
-    if (isErrorLike(error)) {
-        return error;
-    }
-    if (typeof error === "string") {
-        return new Error(error, { cause: error });
-    }
-    return new errors_1.UnconventionalError(error);
+function validateDidEmitValue() {
+    let didEmitValue = false;
+    return (0, rxjs_1.tap)({
+        next() {
+            didEmitValue = true;
+        },
+        complete() {
+            (0, invariant_1.invariant)(didEmitValue, 81);
+        },
+    });
 }
 //# sourceMappingURL=QueryManager.cjs.map