feat: Add focusPolling option to disable refetching if tab is inactive

apollographql · Nov 29, 2023 · b920b5a · b920b5a
1 parent 89ec18e
commit b920b5a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/src/core/ObservableQuery.ts b/src/core/ObservableQuery.ts
@@ -776,7 +776,10 @@ Did you mean to call refetch(variables) instead of refetch({ variables })?`,
 
     const maybeFetch = () => {
       if (this.pollingInfo) {
-        if (!isNetworkRequestInFlight(this.queryInfo.networkStatus)) {
+        if (
+          !isNetworkRequestInFlight(this.queryInfo.networkStatus) &&
+          (!this.options.focusPolling || document.hasFocus())
+        ) {
           this.reobserve(
             {
               // Most fetchPolicy options don't make sense to use in a polling context, as

diff --git a/src/core/watchQueryOptions.ts b/src/core/watchQueryOptions.ts
@@ -176,6 +176,12 @@ export interface WatchQueryOptions<
 
   /** {@inheritDoc @apollo/client!QueryOptions#canonizeResults:member} */
   canonizeResults?: boolean;
+
+  /**
+   * Specifies if refetching of query should be enabled if window is focused, ie,
+   * `document.hasFocused()` returns `true`.
+   */
+  focusPolling?: boolean;
 }
 
 export interface NextFetchPolicyContext<