@apollo/client 4.0.0-alpha.17 → 4.0.0-alpha.19

package/__cjs/core/QueryManager.cjs

@@ -8,6 +8,7 @@ exports.QueryManager = void 0;
 const trie_1 = require("@wry/trie");
 const graphql_1 = require("graphql");
 const rxjs_1 = require("rxjs");
+const rxjs_2 = require("rxjs");
 const cache_1 = require("@apollo/client/cache");
 const errors_1 = require("@apollo/client/errors");
 const errors_2 = require("@apollo/client/errors");
@@ -150,7 +151,7 @@ class QueryManager {
                 ...context,
                 optimisticResponse: isOptimistic ? optimisticResponse : void 0,
             }, variables, {}, false)
-                .pipe(validateDidEmitValue(), (0, rxjs_1.mergeMap)((result) => {
+                .observable.pipe(validateDidEmitValue(), (0, rxjs_2.mergeMap)((result) => {
                 const hasErrors = (0, internal_1.graphQLResultHasError)(result);
                 if (hasErrors && errorPolicy === "none") {
                     throw new errors_1.CombinedGraphQLErrors(result);
@@ -166,7 +167,7 @@ class QueryManager {
                 if (errorPolicy === "ignore" && hasErrors) {
                     delete storeResult.errors;
                 }
-                return (0, rxjs_1.from)(this.markMutationResult({
+                return (0, rxjs_2.from)(this.markMutationResult({
                     mutationId,
                     result: storeResult,
                     document: mutation,
@@ -414,7 +415,7 @@ class QueryManager {
         return true;
     }
     fetchQuery(queryId, options, networkStatus) {
-        return (0, rxjs_1.lastValueFrom)(this.fetchObservableWithInfo(this.getOrCreateQuery(queryId), options, {
+        return (0, rxjs_2.lastValueFrom)(this.fetchObservableWithInfo(this.getOrCreateQuery(queryId), options, {
             networkStatus,
         }).observable.pipe((0, internal_1.filterMap)((value) => {
             switch (value.kind) {
@@ -439,6 +440,7 @@ class QueryManager {
     getDocumentInfo(document) {
         const { transformCache } = this;
         if (!transformCache.has(document)) {
+            const operationDefinition = (0, internal_1.getOperationDefinition)(document);
             const cacheEntry = {
                 // TODO These three calls (hasClientExports, shouldForceResolvers, and
                 // usesNonreactiveDirective) are performing independent full traversals
@@ -456,7 +458,8 @@ class QueryManager {
                     { name: "nonreactive" },
                     { name: "unmask" },
                 ], document),
-                defaultVars: (0, internal_1.getDefaultValues)((0, internal_1.getOperationDefinition)(document)),
+                operationType: operationDefinition?.operation,
+                defaultVars: (0, internal_1.getDefaultValues)(operationDefinition),
                 // Transform any mutation or subscription operations to query operations
                 // so we can read/write them from/to the cache.
                 asQuery: {
@@ -660,69 +663,68 @@ class QueryManager {
         (0, internal_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)((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)(rawResult, errorPolicy)) {
-                    this.cache.write({
-                        query,
-                        result: rawResult.data,
-                        dataId: "ROOT_SUBSCRIPTION",
-                        variables: variables,
-                    });
-                }
-                this.broadcastQueries();
-            }
-            const result = {
-                data: rawResult.data ?? undefined,
-            };
-            if ((0, internal_1.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 (rawResult.extensions &&
-                Object.keys(rawResult.extensions).length) {
-                result.extensions = rawResult.extensions;
-            }
-            if (result.error && errorPolicy === "none") {
-                result.data = undefined;
-            }
-            if (errorPolicy === "ignore") {
-                delete result.error;
-            }
-            return result;
-        }), (0, rxjs_1.catchError)((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) {
-            if (environment_1.__DEV__) {
-                (0, invariant_1.invariant)(
-                    this.localState,
-                    89,
-                    (0, internal_1.getOperationName)(query, "(anonymous)")
-                );
-            }
-            const observablePromise = this.localState.getExportedVariables({
+        let restart;
+        if (environment_1.__DEV__) {
+            (0, invariant_1.invariant)(
+                !this.getDocumentInfo(query).hasClientExports || this.localState,
+                89,
+                (0, internal_1.getOperationName)(query, "(anonymous)")
+            );
+        }
+        const observable = (this.getDocumentInfo(query).hasClientExports ?
+            (0, rxjs_2.from)(this.localState.getExportedVariables({
                 client: this.client,
                 document: query,
                 variables,
                 context,
-            }).then(makeObservable);
-            return new rxjs_1.Observable((observer) => {
-                let sub = null;
-                observablePromise.then((observable) => (sub = observable.subscribe(observer)), observer.error);
-                return () => sub && sub.unsubscribe();
-            });
-        }
-        return makeObservable(variables);
+            }))
+            : (0, rxjs_2.of)(variables)).pipe((0, rxjs_2.mergeMap)((variables) => {
+            const { observable, restart: res } = this.getObservableFromLink(query, context, variables, extensions);
+            restart = res;
+            return observable.pipe((0, rxjs_2.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)(rawResult, errorPolicy)) {
+                        this.cache.write({
+                            query,
+                            result: rawResult.data,
+                            dataId: "ROOT_SUBSCRIPTION",
+                            variables: variables,
+                        });
+                    }
+                    this.broadcastQueries();
+                }
+                const result = {
+                    data: rawResult.data ?? undefined,
+                };
+                if ((0, internal_1.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 (rawResult.extensions &&
+                    Object.keys(rawResult.extensions).length) {
+                    result.extensions = rawResult.extensions;
+                }
+                if (result.error && errorPolicy === "none") {
+                    result.data = undefined;
+                }
+                if (errorPolicy === "ignore") {
+                    delete result.error;
+                }
+                return result;
+            }), (0, rxjs_2.catchError)((error) => {
+                if (errorPolicy === "ignore") {
+                    return (0, rxjs_2.of)({ data: undefined });
+                }
+                return (0, rxjs_2.of)({ data: undefined, error });
+            }), (0, rxjs_2.filter)((result) => !!(result.data || result.error)));
+        }));
+        return Object.assign(observable, { restart: () => restart?.() });
     }
     removeQuery(queryId) {
         // teardown all links
@@ -753,8 +755,8 @@ class QueryManager {
     // Prefer context.queryDeduplication if specified.
     deduplication = context?.queryDeduplication ??
         this.queryDeduplication) {
-        let observable;
-        const { serverQuery, clientQuery } = this.getDocumentInfo(query);
+        let entry = {};
+        const { serverQuery, clientQuery, operationType } = this.getDocumentInfo(query);
         const operationName = (0, internal_1.getOperationName)(query);
         const executeContext = {
             client: this.client,
@@ -774,29 +776,51 @@ class QueryManager {
                 extensions,
             };
             context = operation.context;
+            function withRestart(source) {
+                return new rxjs_1.Observable((observer) => {
+                    function subscribe() {
+                        return source.subscribe({
+                            next: observer.next.bind(observer),
+                            complete: observer.complete.bind(observer),
+                            error: observer.error.bind(observer),
+                        });
+                    }
+                    let subscription = subscribe();
+                    entry.restart ||= () => {
+                        subscription.unsubscribe();
+                        subscription = subscribe();
+                    };
+                    return () => {
+                        subscription.unsubscribe();
+                        entry.restart = undefined;
+                    };
+                });
+            }
             if (deduplication) {
                 const printedServerQuery = (0, utilities_1.print)(serverQuery);
                 const varJson = (0, cache_1.canonicalStringify)(variables);
-                const entry = inFlightLinkObservables.lookup(printedServerQuery, varJson);
-                observable = entry.observable;
-                if (!observable) {
-                    observable = entry.observable = (0, link_1.execute)(link, operation, executeContext).pipe((0, internal_1.onAnyEvent)((event) => {
-                        if ((event.type !== "next" ||
-                            !("hasNext" in event.value) ||
-                            !event.value.hasNext) &&
-                            inFlightLinkObservables.peek(printedServerQuery, varJson) ===
-                                entry) {
+                entry = inFlightLinkObservables.lookup(printedServerQuery, varJson);
+                if (!entry.observable) {
+                    entry.observable = (0, link_1.execute)(link, operation, executeContext).pipe(withRestart, (0, rxjs_2.finalize)(() => {
+                        if (inFlightLinkObservables.peek(printedServerQuery, varJson) ===
+                            entry) {
                             inFlightLinkObservables.remove(printedServerQuery, varJson);
                         }
-                    }), (0, rxjs_1.shareReplay)({ refCount: true }));
+                    }), 
+                    // We don't want to replay the last emitted value for
+                    // subscriptions and instead opt to wait to receive updates until
+                    // the subscription emits new values.
+                    operationType === graphql_1.OperationTypeNode.SUBSCRIPTION ?
+                        (0, rxjs_2.share)()
+                        : (0, rxjs_2.shareReplay)({ refCount: true }));
                 }
             }
             else {
-                observable = (0, link_1.execute)(link, operation, executeContext);
+                entry.observable = (0, link_1.execute)(link, operation, executeContext).pipe(withRestart);
             }
         }
         else {
-            observable = (0, rxjs_1.of)({ data: {} });
+            entry.observable = (0, rxjs_2.of)({ data: {} });
         }
         if (clientQuery) {
             if (environment_1.__DEV__) {
@@ -808,8 +832,8 @@ class QueryManager {
                     operationName ?? "(anonymous)"
                 );
             }
-            observable = observable.pipe((0, rxjs_1.mergeMap)((result) => {
-                return (0, rxjs_1.from)(this.localState.execute({
+            entry.observable = entry.observable.pipe((0, rxjs_2.mergeMap)((result) => {
+                return (0, rxjs_2.from)(this.localState.execute({
                     client: this.client,
                     document: clientQuery,
                     remoteResult: result,
@@ -818,11 +842,14 @@ class QueryManager {
                 }));
             }));
         }
-        return observable.pipe((0, rxjs_1.catchError)((error) => {
-            error = (0, errors_1.toErrorLike)(error);
-            (0, errors_1.registerLinkError)(error);
-            throw error;
-        }));
+        return {
+            restart: () => entry.restart?.(),
+            observable: entry.observable.pipe((0, rxjs_2.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());
@@ -831,7 +858,7 @@ class QueryManager {
         // 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.map)((result) => {
+        return this.getObservableFromLink(linkDocument, options.context, options.variables).observable.pipe((0, rxjs_2.map)((result) => {
             const graphQLErrors = (0, internal_1.getGraphQLErrorsFromResult)(result);
             const hasErrors = graphQLErrors.length > 0;
             // If we interrupted this request by calling getResultsFromLink again
@@ -875,7 +902,7 @@ class QueryManager {
                 }
             }
             return aqr;
-        }), (0, rxjs_1.catchError)((error) => {
+        }), (0, rxjs_2.catchError)((error) => {
             // Avoid storing errors from older interrupted queries.
             if (requestId >= queryInfo.lastRequestId && errorPolicy === "none") {
                 queryInfo.resetLastWrite();
@@ -893,7 +920,7 @@ class QueryManager {
                 aqr.error = error;
                 aqr.networkStatus = networkStatus_js_1.NetworkStatus.error;
             }
-            return (0, rxjs_1.of)(aqr);
+            return (0, rxjs_2.of)(aqr);
         }));
     }
     fetchObservableWithInfo(queryInfo, options, { 
@@ -959,7 +986,7 @@ class QueryManager {
             fetchCancelSubject.complete();
             cleanupCancelFn();
         });
-        const fetchCancelSubject = new rxjs_1.Subject();
+        const fetchCancelSubject = new rxjs_2.Subject();
         let observable, containsDataFromLink;
         // If the query has @export(as: ...) directives, then we need to
         // process those directives asynchronously. When there are no
@@ -976,12 +1003,12 @@ class QueryManager {
                     (0, internal_1.getOperationName)(normalized.query, "(anonymous)")
                 );
             }
-            observable = (0, rxjs_1.from)(this.localState.getExportedVariables({
+            observable = (0, rxjs_2.from)(this.localState.getExportedVariables({
                 client: this.client,
                 document: normalized.query,
                 variables: normalized.variables,
                 context: normalized.context,
-            })).pipe((0, rxjs_1.mergeMap)((variables) => fromVariables(variables).observable));
+            })).pipe((0, rxjs_2.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
@@ -995,7 +1022,7 @@ class QueryManager {
             observable = sourcesWithInfo.observable;
         }
         return {
-            observable: observable.pipe((0, rxjs_1.tap)({ error: cleanupCancelFn, complete: cleanupCancelFn }), (0, rxjs_1.mergeWith)(fetchCancelSubject), (0, rxjs_1.share)()),
+            observable: observable.pipe((0, rxjs_2.tap)({ error: cleanupCancelFn, complete: cleanupCancelFn }), (0, rxjs_2.mergeWith)(fetchCancelSubject), (0, rxjs_2.share)()),
             fromLink: containsDataFromLink,
         };
     }
@@ -1188,7 +1215,7 @@ class QueryManager {
                 };
             };
             const fromData = (data) => {
-                return (0, rxjs_1.of)({
+                return (0, rxjs_2.of)({
                     kind: "N",
                     value: toResult(data),
                     source: "cache",
@@ -1208,7 +1235,7 @@ class QueryManager {
                     );
                 }
                 onCacheHit();
-                return (0, rxjs_1.from)(this.localState.execute({
+                return (0, rxjs_2.from)(this.localState.execute({
                     client: this.client,
                     document: query,
                     remoteResult: data ? { data } : undefined,
@@ -1239,7 +1266,7 @@ class QueryManager {
             context,
             fetchPolicy,
             errorPolicy,
-        }).pipe(validateDidEmitValue(), (0, rxjs_1.materialize)(), (0, rxjs_1.map)((result) => ({
+        }).pipe(validateDidEmitValue(), (0, rxjs_2.materialize)(), (0, rxjs_2.map)((result) => ({
             ...result,
             source: "network",
         })));
@@ -1256,7 +1283,7 @@ class QueryManager {
                 if (returnPartialData) {
                     return {
                         fromLink: true,
-                        observable: (0, rxjs_1.concat)(resultsFromCache(diff, networkStatus_js_1.NetworkStatus.loading), resultsFromLink()),
+                        observable: (0, rxjs_2.concat)(resultsFromCache(diff, networkStatus_js_1.NetworkStatus.loading), resultsFromLink()),
                     };
                 }
                 return { fromLink: true, observable: resultsFromLink() };
@@ -1266,7 +1293,7 @@ class QueryManager {
                 if (diff.complete || returnPartialData) {
                     return {
                         fromLink: true,
-                        observable: (0, rxjs_1.concat)(resultsFromCache(diff, networkStatus_js_1.NetworkStatus.loading), resultsFromLink()),
+                        observable: (0, rxjs_2.concat)(resultsFromCache(diff, networkStatus_js_1.NetworkStatus.loading), resultsFromLink()),
                     };
                 }
                 return { fromLink: true, observable: resultsFromLink() };
@@ -1274,14 +1301,14 @@ class QueryManager {
             case "cache-only":
                 return {
                     fromLink: false,
-                    observable: (0, rxjs_1.concat)(resultsFromCache(readCache(), networkStatus_js_1.NetworkStatus.ready)),
+                    observable: (0, rxjs_2.concat)(resultsFromCache(readCache(), networkStatus_js_1.NetworkStatus.ready)),
                 };
             case "network-only":
                 return { fromLink: true, observable: resultsFromLink() };
             case "no-cache":
                 return { fromLink: true, observable: resultsFromLink() };
             case "standby":
-                return { fromLink: false, observable: rxjs_1.EMPTY };
+                return { fromLink: false, observable: rxjs_2.EMPTY };
         }
     }
     getOrCreateQuery(queryId) {
@@ -1294,7 +1321,7 @@ class QueryManager {
 exports.QueryManager = QueryManager;
 function validateDidEmitValue() {
     let didEmitValue = false;
-    return (0, rxjs_1.tap)({
+    return (0, rxjs_2.tap)({
         next() {
             didEmitValue = true;
         },