@apollo/client 3.10.3 → 3.10.4

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @apollo/client
 
+## 3.10.4
+
+### Patch Changes
+
+- [#11838](https://github.com/apollographql/apollo-client/pull/11838) [`8475346`](https://github.com/apollographql/apollo-client/commit/84753462af50d89c8693713990cccf432ff8267d) Thanks [@alex-kinokon](https://github.com/alex-kinokon)! - Don’t prompt for DevTools installation for browser extension page
+
+- [#11839](https://github.com/apollographql/apollo-client/pull/11839) [`6481fe1`](https://github.com/apollographql/apollo-client/commit/6481fe1196cedee987781dcb45ebdc0cafb3998c) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Fix a regression in [3.9.5](https://github.com/apollographql/apollo-client/releases/tag/v3.9.5) where a merge function that returned an incomplete result would not allow the client to refetch in order to fulfill the query.
+
+- [#11844](https://github.com/apollographql/apollo-client/pull/11844) [`86984f2`](https://github.com/apollographql/apollo-client/commit/86984f24bd9076a6034acd59bbcb28a2ea1add93) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Honor the `@nonreactive` directive when using `cache.watchFragment` or the `useFragment` hook to avoid rerendering when using these directives.
+
+- [#11824](https://github.com/apollographql/apollo-client/pull/11824) [`47ad806`](https://github.com/apollographql/apollo-client/commit/47ad806c7b0c55f1e05dbf276ca87a354ac389e5) Thanks [@phryneas](https://github.com/phryneas)! - Create branded `QueryRef` type without exposed properties.
+
+  This change deprecates `QueryReference` in favor of a `QueryRef` type that doesn't expose any properties.
+  This change also updates `preloadQuery` to return a new `PreloadedQueryRef` type, which exposes the `toPromise` function as it does today. This means that query refs produced by `useBackgroundQuery` and `useLoadableQuery` now return `QueryRef` types that do not have access to a `toPromise` function, which was never meant to be used in combination with these hooks.
+
+  While we tend to avoid any types of breaking changes in patch releases as this, this change was necessary to support an upcoming version of the React Server Component integration, which needed to omit the `toPromise` function that would otherwise have broken at runtime.
+  Note that this is a TypeScript-only change. At runtime, `toPromise` is still present on all queryRefs currently created by this package - but we strongly want to discourage you from accessing it in all cases except for the `PreloadedQueryRef` use case.
+
+  Migration is as simple as replacing all references to `QueryReference` with `QueryRef`, so it should be possible to do this with a search & replace in most code bases:
+
+  ```diff
+  -import { QueryReference } from '@apollo/client'
+  +import { QueryRef } from '@apollo/client'
+
+  - function Component({ queryRef }: { queryRef: QueryReference<TData> }) {
+  + function Component({ queryRef }: { queryRef: QueryRef<TData> }) {
+    // ...
+  }
+  ```
+
+- [#11845](https://github.com/apollographql/apollo-client/pull/11845) [`4c5c820`](https://github.com/apollographql/apollo-client/commit/4c5c820b6172f6a2455bcdd974109513e0e2a39e) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Remove `@nonreactive` directives from queries passed to `MockLink` to ensure they are properly matched.
+
+- [#11837](https://github.com/apollographql/apollo-client/pull/11837) [`dff15b1`](https://github.com/apollographql/apollo-client/commit/dff15b1b03ebac9cae508c69bf607a29d0f6eccb) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Fix an issue where a polled query created in React strict mode may not stop polling after the component unmounts while using the `cache-and-network` fetch policy.
+
 ## 3.10.3
 
 ### Patch Changes

package/apollo-client.cjs

@@ -31,7 +31,7 @@ function _interopNamespace(e) {
 var equal__default = /*#__PURE__*/_interopDefaultLegacy(equal);
 var React__namespace = /*#__PURE__*/_interopNamespace(React);
 
-var version = "3.10.3";
+var version = "3.10.4";
 
 function maybe(thunk) {
     try {
@@ -137,7 +137,7 @@ function shouldInclude(_a, variables) {
         if (ifArgument.value.kind === "Variable") {
             evaledValue =
                 variables && variables[ifArgument.value.name.value];
-            invariant(evaledValue !== void 0, 67, directive.name.value);
+            invariant(evaledValue !== void 0, 68, directive.name.value);
         }
         else {
             evaledValue = ifArgument.value.value;
@@ -172,12 +172,12 @@ function getInclusionDirectives(directives) {
                 return;
             var directiveArguments = directive.arguments;
             var directiveName = directive.name.value;
-            invariant(directiveArguments && directiveArguments.length === 1, 68, directiveName);
+            invariant(directiveArguments && directiveArguments.length === 1, 69, directiveName);
             var ifArgument = directiveArguments[0];
-            invariant(ifArgument.name && ifArgument.name.value === "if", 69, directiveName);
+            invariant(ifArgument.name && ifArgument.name.value === "if", 70, directiveName);
             var ifValue = ifArgument.value;
             invariant(ifValue &&
-                (ifValue.kind === "Variable" || ifValue.kind === "BooleanValue"), 70, directiveName);
+                (ifValue.kind === "Variable" || ifValue.kind === "BooleanValue"), 71, directiveName);
             result.push({ directive: directive, ifArgument: ifArgument });
         });
     }
@@ -204,7 +204,7 @@ function getFragmentQueryDocument(document, fragmentName) {
     document.definitions.forEach(function (definition) {
         if (definition.kind === "OperationDefinition") {
             throw newInvariantError(
-                71,
+                72,
                 definition.operation,
                 definition.name ? " named '".concat(definition.name.value, "'") : ""
             );
@@ -214,7 +214,7 @@ function getFragmentQueryDocument(document, fragmentName) {
         }
     });
     if (typeof actualFragmentName === "undefined") {
-        invariant(fragments.length === 1, 72, fragments.length);
+        invariant(fragments.length === 1, 73, fragments.length);
         actualFragmentName = fragments[0].name.value;
     }
     var query = tslib.__assign(tslib.__assign({}, document), { definitions: tslib.__spreadArray([
@@ -255,7 +255,7 @@ function getFragmentFromSelection(selection, fragmentMap) {
                 return fragmentMap(fragmentName);
             }
             var fragment = fragmentMap && fragmentMap[fragmentName];
-            invariant(fragment, 73, fragmentName);
+            invariant(fragment, 74, fragmentName);
             return fragment || null;
         }
         default:
@@ -506,7 +506,7 @@ function valueToObjectRepresentation(argObj, name, value, variables) {
         argObj[name.value] = null;
     }
     else {
-        throw newInvariantError(82, name.value, value.kind);
+        throw newInvariantError(83, name.value, value.kind);
     }
 }
 function storeKeyNameFromField(field, variables) {
@@ -640,16 +640,16 @@ function isInlineFragment(selection) {
 }
 
 function checkDocument(doc) {
-    invariant(doc && doc.kind === "Document", 74);
+    invariant(doc && doc.kind === "Document", 75);
     var operations = doc.definitions
         .filter(function (d) { return d.kind !== "FragmentDefinition"; })
         .map(function (definition) {
         if (definition.kind !== "OperationDefinition") {
-            throw newInvariantError(75, definition.kind);
+            throw newInvariantError(76, definition.kind);
         }
         return definition;
     });
-    invariant(operations.length <= 1, 76, operations.length);
+    invariant(operations.length <= 1, 77, operations.length);
     return doc;
 }
 function getOperationDefinition(doc) {
@@ -672,14 +672,14 @@ function getFragmentDefinitions(doc) {
 }
 function getQueryDefinition(doc) {
     var queryDef = getOperationDefinition(doc);
-    invariant(queryDef && queryDef.operation === "query", 77);
+    invariant(queryDef && queryDef.operation === "query", 78);
     return queryDef;
 }
 function getFragmentDefinition(doc) {
-    invariant(doc.kind === "Document", 78);
-    invariant(doc.definitions.length <= 1, 79);
+    invariant(doc.kind === "Document", 79);
+    invariant(doc.definitions.length <= 1, 80);
     var fragmentDef = doc.definitions[0];
-    invariant(fragmentDef.kind === "FragmentDefinition", 80);
+    invariant(fragmentDef.kind === "FragmentDefinition", 81);
     return fragmentDef;
 }
 function getMainDefinition(queryDoc) {
@@ -702,7 +702,7 @@ function getMainDefinition(queryDoc) {
     if (fragmentDefinition) {
         return fragmentDefinition;
     }
-    throw newInvariantError(81);
+    throw newInvariantError(82);
 }
 function getDefaultValues(definition) {
     var defaultValues = Object.create(null);
@@ -753,7 +753,7 @@ var DocumentTransform =  (function () {
                 makeCacheKey: function (document) {
                     var cacheKeys = _this.getCacheKey(document);
                     if (cacheKeys) {
-                        invariant(Array.isArray(cacheKeys), 66);
+                        invariant(Array.isArray(cacheKeys), 67);
                         return stableCacheKeys_1.lookupArray(cacheKeys);
                     }
                 },
@@ -883,7 +883,7 @@ function removeDirectivesFromDocument(directives, doc) {
                 return getInUseByFragmentName(ancestor.name.value);
             }
         }
-        globalThis.__DEV__ !== false && invariant.error(83);
+        globalThis.__DEV__ !== false && invariant.error(84);
         return null;
     };
     var operationCount = 0;
@@ -2381,6 +2381,72 @@ var HttpLink =  (function (_super) {
     return HttpLink;
 }(ApolloLink));
 
+function equalByQuery(query, _a, _b, variables) {
+    var aData = _a.data, aRest = tslib.__rest(_a, ["data"]);
+    var bData = _b.data, bRest = tslib.__rest(_b, ["data"]);
+    return (equal__default(aRest, bRest) &&
+        equalBySelectionSet(getMainDefinition(query).selectionSet, aData, bData, {
+            fragmentMap: createFragmentMap(getFragmentDefinitions(query)),
+            variables: variables,
+        }));
+}
+function equalBySelectionSet(selectionSet, aResult, bResult, context) {
+    if (aResult === bResult) {
+        return true;
+    }
+    var seenSelections = new Set();
+    return selectionSet.selections.every(function (selection) {
+        if (seenSelections.has(selection))
+            return true;
+        seenSelections.add(selection);
+        if (!shouldInclude(selection, context.variables))
+            return true;
+        if (selectionHasNonreactiveDirective(selection))
+            return true;
+        if (isField(selection)) {
+            var resultKey = resultKeyNameFromField(selection);
+            var aResultChild = aResult && aResult[resultKey];
+            var bResultChild = bResult && bResult[resultKey];
+            var childSelectionSet = selection.selectionSet;
+            if (!childSelectionSet) {
+                return equal__default(aResultChild, bResultChild);
+            }
+            var aChildIsArray = Array.isArray(aResultChild);
+            var bChildIsArray = Array.isArray(bResultChild);
+            if (aChildIsArray !== bChildIsArray)
+                return false;
+            if (aChildIsArray && bChildIsArray) {
+                var length_1 = aResultChild.length;
+                if (bResultChild.length !== length_1) {
+                    return false;
+                }
+                for (var i = 0; i < length_1; ++i) {
+                    if (!equalBySelectionSet(childSelectionSet, aResultChild[i], bResultChild[i], context)) {
+                        return false;
+                    }
+                }
+                return true;
+            }
+            return equalBySelectionSet(childSelectionSet, aResultChild, bResultChild, context);
+        }
+        else {
+            var fragment = getFragmentFromSelection(selection, context.fragmentMap);
+            if (fragment) {
+                if (selectionHasNonreactiveDirective(fragment))
+                    return true;
+                return equalBySelectionSet(fragment.selectionSet,
+                aResult, bResult, context);
+            }
+        }
+    });
+}
+function selectionHasNonreactiveDirective(selection) {
+    return (!!selection.directives && selection.directives.some(directiveIsNonreactive));
+}
+function directiveIsNonreactive(dir) {
+    return dir.name.value === "nonreactive";
+}
+
 var ApolloCache =  (function () {
     function ApolloCache() {
         this.assumeImmutableResults = false;
@@ -2424,16 +2490,19 @@ var ApolloCache =  (function () {
     ApolloCache.prototype.watchFragment = function (options) {
         var _this = this;
         var fragment = options.fragment, fragmentName = options.fragmentName, from = options.from, _a = options.optimistic, optimistic = _a === void 0 ? true : _a;
+        var query = this.getFragmentDoc(fragment, fragmentName);
         var diffOptions = {
             returnPartialData: true,
             id: typeof from === "string" ? from : this.identify(from),
-            query: this.getFragmentDoc(fragment, fragmentName),
+            query: query,
             optimistic: optimistic,
         };
         var latestDiff;
         return new zenObservableTs.Observable(function (observer) {
-            return _this.watch(tslib.__assign(tslib.__assign({}, diffOptions), { immediate: true, query: _this.getFragmentDoc(fragment, fragmentName), callback: function (diff) {
-                    if (equal.equal(diff, latestDiff)) {
+            return _this.watch(tslib.__assign(tslib.__assign({}, diffOptions), { immediate: true, callback: function (diff) {
+                    if (
+                    latestDiff &&
+                        equalByQuery(query, { data: latestDiff === null || latestDiff === void 0 ? void 0 : latestDiff.result }, { data: diff.result })) {
                         return;
                     }
                     var result = {
@@ -4805,72 +4874,6 @@ function isNetworkRequestSettled(networkStatus) {
     return networkStatus === 7 || networkStatus === 8;
 }
 
-function equalByQuery(query, _a, _b, variables) {
-    var aData = _a.data, aRest = tslib.__rest(_a, ["data"]);
-    var bData = _b.data, bRest = tslib.__rest(_b, ["data"]);
-    return (equal__default(aRest, bRest) &&
-        equalBySelectionSet(getMainDefinition(query).selectionSet, aData, bData, {
-            fragmentMap: createFragmentMap(getFragmentDefinitions(query)),
-            variables: variables,
-        }));
-}
-function equalBySelectionSet(selectionSet, aResult, bResult, context) {
-    if (aResult === bResult) {
-        return true;
-    }
-    var seenSelections = new Set();
-    return selectionSet.selections.every(function (selection) {
-        if (seenSelections.has(selection))
-            return true;
-        seenSelections.add(selection);
-        if (!shouldInclude(selection, context.variables))
-            return true;
-        if (selectionHasNonreactiveDirective(selection))
-            return true;
-        if (isField(selection)) {
-            var resultKey = resultKeyNameFromField(selection);
-            var aResultChild = aResult && aResult[resultKey];
-            var bResultChild = bResult && bResult[resultKey];
-            var childSelectionSet = selection.selectionSet;
-            if (!childSelectionSet) {
-                return equal__default(aResultChild, bResultChild);
-            }
-            var aChildIsArray = Array.isArray(aResultChild);
-            var bChildIsArray = Array.isArray(bResultChild);
-            if (aChildIsArray !== bChildIsArray)
-                return false;
-            if (aChildIsArray && bChildIsArray) {
-                var length_1 = aResultChild.length;
-                if (bResultChild.length !== length_1) {
-                    return false;
-                }
-                for (var i = 0; i < length_1; ++i) {
-                    if (!equalBySelectionSet(childSelectionSet, aResultChild[i], bResultChild[i], context)) {
-                        return false;
-                    }
-                }
-                return true;
-            }
-            return equalBySelectionSet(childSelectionSet, aResultChild, bResultChild, context);
-        }
-        else {
-            var fragment = getFragmentFromSelection(selection, context.fragmentMap);
-            if (fragment) {
-                if (selectionHasNonreactiveDirective(fragment))
-                    return true;
-                return equalBySelectionSet(fragment.selectionSet,
-                aResult, bResult, context);
-            }
-        }
-    });
-}
-function selectionHasNonreactiveDirective(selection) {
-    return (!!selection.directives && selection.directives.some(directiveIsNonreactive));
-}
-function directiveIsNonreactive(dir) {
-    return dir.name.value === "nonreactive";
-}
-
 var assign = Object.assign, hasOwnProperty$2 = Object.hasOwnProperty;
 var ObservableQuery =  (function (_super) {
     tslib.__extends(ObservableQuery, _super);
@@ -5242,7 +5245,7 @@ var ObservableQuery =  (function (_super) {
             return;
         }
         var _a = this, pollingInfo = _a.pollingInfo, pollInterval = _a.options.pollInterval;
-        if (!pollInterval) {
+        if (!pollInterval || !this.hasObservers()) {
             if (pollingInfo) {
                 clearTimeout(pollingInfo.timeout);
                 delete this.pollingInfo;
@@ -5857,10 +5860,7 @@ var QueryInfo =  (function () {
         var _this = this;
         var _a;
         var oldDiff = this.lastDiff && this.lastDiff.diff;
-        if (diff &&
-            !diff.complete &&
-            !((_a = this.observableQuery) === null || _a === void 0 ? void 0 : _a.options.returnPartialData) &&
-            !(oldDiff && oldDiff.complete)) {
+        if (diff && !diff.complete && ((_a = this.observableQuery) === null || _a === void 0 ? void 0 : _a.getLastError())) {
             return;
         }
         this.updateLastDiff(diff);
@@ -7029,7 +7029,8 @@ var ApolloClient =  (function () {
                 if (typeof window !== "undefined" &&
                     window.document &&
                     window.top === window.self &&
-                    !window.__APOLLO_DEVTOOLS_GLOBAL_HOOK__) {
+                    !window.__APOLLO_DEVTOOLS_GLOBAL_HOOK__ &&
+                    /^(https?|file):$/.test(window.location.protocol)) {
                     var nav = window.navigator;
                     var ua = nav && nav.userAgent;
                     var url = void 0;
@@ -7337,7 +7338,7 @@ function parser(document) {
     if (cached)
         return cached;
     var variables, type, name;
-    invariant(!!document && !!document.kind, 59, document);
+    invariant(!!document && !!document.kind, 60, document);
     var fragments = [];
     var queries = [];
     var mutations = [];
@@ -7365,10 +7366,10 @@ function parser(document) {
     invariant(!fragments.length ||
         queries.length ||
         mutations.length ||
-        subscriptions.length, 60);
+        subscriptions.length, 61);
     invariant(
         queries.length + mutations.length + subscriptions.length <= 1,
-        61,
+        62,
         document,
         queries.length,
         subscriptions.length,
@@ -7380,7 +7381,7 @@ function parser(document) {
     var definitions = queries.length ? queries
         : mutations.length ? mutations
             : subscriptions;
-    invariant(definitions.length === 1, 62, document, definitions.length);
+    invariant(definitions.length === 1, 63, document, definitions.length);
     var definition = definitions[0];
     variables = definition.variableDefinitions || [];
     if (definition.name && definition.name.kind === "Name") {
@@ -7405,7 +7406,7 @@ function verifyDocumentType(document, type) {
     var usedOperationName = operationName(operation.type);
     invariant(
         operation.type === type,
-        63,
+        64,
         requiredOperationName,
         requiredOperationName,
         usedOperationName
@@ -8133,6 +8134,9 @@ function wrapQueryRef(internalQueryRef) {
         _a);
     return ref;
 }
+function assertWrappedQueryRef(queryRef) {
+    invariant(!queryRef || QUERY_REFERENCE_SYMBOL in queryRef, 59);
+}
 function getWrappedPromise(queryRef) {
     var internalQueryRef = unwrapQueryRef(queryRef);
     return internalQueryRef.promise.status === "fulfilled" ?
@@ -8594,6 +8598,7 @@ function useLoadableQuery(query, options) {
     var watchQueryOptions = useWatchQueryOptions({ client: client, query: query, options: options });
     var _a = options.queryKey, queryKey = _a === void 0 ? [] : _a;
     var _b = React__namespace.useState(null), queryRef = _b[0], setQueryRef = _b[1];
+    assertWrappedQueryRef(queryRef);
     var internalQueryRef = queryRef && unwrapQueryRef(queryRef);
     if (queryRef && (internalQueryRef === null || internalQueryRef === void 0 ? void 0 : internalQueryRef.didChangeOptions(watchQueryOptions))) {
         var promise = internalQueryRef.applyOptions(watchQueryOptions);
@@ -8645,6 +8650,7 @@ function useQueryRefHandlers(queryRef) {
         : useApolloClient())(queryRef);
 }
 function _useQueryRefHandlers(queryRef) {
+    assertWrappedQueryRef(queryRef);
     var _a = React__namespace.useState(queryRef), previousQueryRef = _a[0], setPreviousQueryRef = _a[1];
     var _b = React__namespace.useState(queryRef), wrappedQueryRef = _b[0], setWrappedQueryRef = _b[1];
     var internalQueryRef = unwrapQueryRef(queryRef);
@@ -8675,6 +8681,7 @@ function useReadQuery(queryRef) {
         : useApolloClient())(queryRef);
 }
 function _useReadQuery(queryRef) {
+    assertWrappedQueryRef(queryRef);
     var internalQueryRef = React__namespace.useMemo(function () { return unwrapQueryRef(queryRef); }, [queryRef]);
     var getPromise = React__namespace.useCallback(function () { return getWrappedPromise(queryRef); }, [queryRef]);
     if (internalQueryRef.disposed) {