@apollo/client 3.9.0-alpha.5 → 3.9.0-beta.1

package/.changeset/chatty-comics-yawn.md

@@ -0,0 +1,8 @@
+---
+"@apollo/client": patch
+---
+
+Adds a deprecation warning to the HOC and render prop APIs.
+
+The HOC and render prop APIs have already been deprecated since 2020,
+but we previously didn't have a @deprecated tag in the DocBlocks.

package/.changeset/curvy-seas-hope.md

@@ -0,0 +1,13 @@
+---
+"@apollo/client": minor
+---
+
+Simplify RetryLink, fix potential memory leak
+
+Historically, `RetryLink` would keep a `values` array of all previous values,
+in case the operation would get an additional subscriber at a later point in time.
+In practice, this could lead to a memory leak (#11393) and did not serve any
+further purpose, as the resulting observable would only be subscribed to by
+Apollo Client itself, and only once - it would be wrapped in a `Concast` before
+being exposed to the user, and that `Concast` would handle subscribers on its
+own.

package/.changeset/dirty-tigers-matter.md

@@ -0,0 +1,13 @@
+---
+"@apollo/client": minor
+---
+
+Create a new `useQueryRefHandlers` hook that returns `refetch` and `fetchMore` functions for a given `queryRef`. This is useful to get access to handlers for a `queryRef` that was created by `createQueryPreloader` or when the handlers for a `queryRef` produced by a different component are inaccessible.
+
+```jsx
+const MyComponent({ queryRef }) {
+  const { refetch, fetchMore } = useQueryRefHandlers(queryRef);
+
+  // ...
+}
+```

package/.changeset/late-rabbits-protect.md

@@ -0,0 +1,7 @@
+---
+'@apollo/client': minor
+---
+
+Remove the need to call `retain` from `useLoadableQuery` since `useReadQuery` will now retain the query. This means that a `queryRef` that is not consumed by `useReadQuery` within the given `autoDisposeTimeoutMs` will now be auto diposed for you.
+
+Thanks to [#11412](https://github.com/apollographql/apollo-client/pull/11412), disposed query refs will be automatically resubscribed to the query when consumed by `useReadQuery` after it has been disposed.

package/.changeset/mighty-coats-check.md

@@ -0,0 +1,47 @@
+---
+"@apollo/client": minor
+---
+
+Allow returning `IGNORE` sentinel object from `optimisticResponse` functions to bail-out from the optimistic update.
+
+Consider this example:
+
+```jsx
+const UPDATE_COMMENT = gql`
+  mutation UpdateComment($commentId: ID!, $commentContent: String!) {
+    updateComment(commentId: $commentId, content: $commentContent) {
+      id
+      __typename
+      content
+    }
+  }
+`;
+
+function CommentPageWithData() {
+  const [mutate] = useMutation(UPDATE_COMMENT);
+  return (
+    <Comment
+      updateComment={({ commentId, commentContent }) =>
+        mutate({
+          variables: { commentId, commentContent },
+          optimisticResponse: (vars, { IGNORE }) => {
+            if (commentContent === "foo") {
+              // conditionally bail out of optimistic updates
+              return IGNORE;
+            }
+            return {
+              updateComment: {
+                id: commentId,
+                __typename: "Comment",
+                content: commentContent
+              }
+            }
+          },
+        })
+      }
+    />
+  );
+}
+```
+
+The `IGNORE` sentinel can be destructured from the second parameter in the callback function signature passed to `optimisticResponse`.

package/.changeset/pre.json

@@ -1,29 +1,43 @@
 {
   "mode": "pre",
-  "tag": "alpha",
+  "tag": "beta",
   "initialVersions": {
     "@apollo/client": "3.8.3"
   },
   "changesets": [
     "beige-geese-wink",
     "breezy-spiders-tap",
+    "chatty-comics-yawn",
     "clean-items-smash",
     "cold-llamas-turn",
+    "curvy-seas-hope",
     "dirty-kids-crash",
+    "dirty-tigers-matter",
     "forty-cups-shop",
     "friendly-clouds-laugh",
     "hot-ducks-burn",
+    "late-rabbits-protect",
+    "mighty-coats-check",
     "polite-avocados-warn",
     "quick-hats-marry",
+    "rare-snakes-melt",
     "shaggy-ears-scream",
     "shaggy-sheep-pull",
     "sixty-boxes-rest",
+    "smooth-plums-shout",
     "sour-sheep-walk",
+    "spicy-drinks-camp",
     "strong-terms-perform",
+    "swift-zoos-collect",
     "thick-mice-collect",
+    "thick-tips-cry",
     "thirty-ties-arrive",
+    "tough-timers-begin",
+    "unlucky-rats-decide",
     "violet-lions-draw",
+    "wet-forks-rhyme",
     "wild-dolphins-jog",
+    "wise-news-grab",
     "yellow-flies-repeat"
   ]
 }

package/.changeset/rare-snakes-melt.md

@@ -0,0 +1,24 @@
+---
+"@apollo/client": minor
+---
+
+Add the ability to start preloading a query outside React to begin fetching as early as possible. Call `createQueryPreloader` to create a `preloadQuery` function which can be called to start fetching a query. This returns a `queryRef` which is passed to `useReadQuery` and suspended until the query is done fetching.
+
+```tsx
+const preloadQuery = createQueryPreloader(client);
+const queryRef = preloadQuery(QUERY, { variables, ...otherOptions });
+
+function App() {
+  return {
+    <Suspense fallback={<div>Loading</div>}>
+      <MyQuery />
+    </Suspense>
+  }
+}
+
+function MyQuery() {
+  const { data } = useReadQuery(queryRef);
+
+  // do something with data
+}
+```

package/.changeset/smooth-plums-shout.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+ObservableQuery: prevent reporting results of previous queries if the variables changed since

package/.changeset/spicy-drinks-camp.md

@@ -0,0 +1,5 @@
+---
+'@apollo/client': patch
+---
+
+Address bundling issue introduced in [#11412](https://github.com/apollographql/apollo-client/pull/11412) where the `react/cache` internals ended up duplicated in the bundle. This was due to the fact that we had a `react/hooks` entrypoint that imported these files along with the newly introduced `createQueryPreloader` function, which lived outside of the `react/hooks` folder.

package/.changeset/swift-zoos-collect.md

@@ -0,0 +1,19 @@
+---
+"@apollo/client": minor
+---
+
+Adds a new `skipPollAttempt` callback function that's called whenever a refetch attempt occurs while polling. If the function returns `true`, the refetch is skipped and not reattempted until the next poll interval. This will solve the frequent use-case of disabling polling when the window is inactive.
+
+```ts
+useQuery(QUERY, {
+  pollInterval: 1000,
+  skipPollAttempt: () => document.hidden // or !document.hasFocus()
+});
+// or define it globally
+new ApolloClient({
+  defaultOptions: {
+    watchQuery: {
+      skipPollAttempt: () => document.hidden // or !document.hasFocus()
+    }
+  }
+})

package/.changeset/thick-tips-cry.md

@@ -0,0 +1,9 @@
+---
+"@apollo/client": patch
+---
+
+Persisted Query Link: improve memory management
+* use LRU `WeakCache` instead of `WeakMap` to keep a limited number of hash results
+* hash cache is initiated lazily, only when needed
+* expose `persistedLink.resetHashCache()` method
+* reset hash cache if the upstream server reports it doesn't accept persisted queries

package/.changeset/tough-timers-begin.md

@@ -0,0 +1,8 @@
+---
+"@apollo/client": minor
+---
+
+Deprecates `canonizeResults`.
+
+Using `canonizeResults` can result in memory leaks so we generally do not recommend using this option anymore.
+A future version of Apollo Client will contain a similar feature without the risk of memory leaks.

package/.changeset/unlucky-rats-decide.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+use WeakMap in React Native with Hermes

package/.changeset/wet-forks-rhyme.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Adds an experimental `ApolloClient.getMemoryInternals` helper

package/.changeset/wise-news-grab.md

@@ -0,0 +1,7 @@
+---
+'@apollo/client': minor
+---
+
+Remove the need to call `retain` from `useBackgroundQuery` since `useReadQuery` will now retain the query. This means that a `queryRef` that is not consumed by `useReadQuery` within the given `autoDisposeTimeoutMs` will now be auto diposed for you.
+
+Thanks to [#11412](https://github.com/apollographql/apollo-client/pull/11412), disposed query refs will be automatically resubscribed to the query when consumed by `useReadQuery` after it has been disposed.

package/CHANGELOG.md

@@ -1,5 +1,152 @@
 # @apollo/client
 
+## 3.9.0-beta.1
+
+### Minor Changes
+
+- [#11424](https://github.com/apollographql/apollo-client/pull/11424) [`62f3b6d`](https://github.com/apollographql/apollo-client/commit/62f3b6d0e89611e27d9f29812ee60e5db5963fd6) Thanks [@phryneas](https://github.com/phryneas)! - Simplify RetryLink, fix potential memory leak
+
+  Historically, `RetryLink` would keep a `values` array of all previous values,
+  in case the operation would get an additional subscriber at a later point in time.
+  In practice, this could lead to a memory leak (#11393) and did not serve any
+  further purpose, as the resulting observable would only be subscribed to by
+  Apollo Client itself, and only once - it would be wrapped in a `Concast` before
+  being exposed to the user, and that `Concast` would handle subscribers on its
+  own.
+
+- [#11442](https://github.com/apollographql/apollo-client/pull/11442) [`4b6f2bc`](https://github.com/apollographql/apollo-client/commit/4b6f2bccf3ba94643b38689b32edd2839e47aec1) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Remove the need to call `retain` from `useLoadableQuery` since `useReadQuery` will now retain the query. This means that a `queryRef` that is not consumed by `useReadQuery` within the given `autoDisposeTimeoutMs` will now be auto diposed for you.
+
+  Thanks to [#11412](https://github.com/apollographql/apollo-client/pull/11412), disposed query refs will be automatically resubscribed to the query when consumed by `useReadQuery` after it has been disposed.
+
+- [#11438](https://github.com/apollographql/apollo-client/pull/11438) [`6d46ab9`](https://github.com/apollographql/apollo-client/commit/6d46ab930a5e9bd5cae153d3b75b8966784fcd4e) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Remove the need to call `retain` from `useBackgroundQuery` since `useReadQuery` will now retain the query. This means that a `queryRef` that is not consumed by `useReadQuery` within the given `autoDisposeTimeoutMs` will now be auto diposed for you.
+
+  Thanks to [#11412](https://github.com/apollographql/apollo-client/pull/11412), disposed query refs will be automatically resubscribed to the query when consumed by `useReadQuery` after it has been disposed.
+
+### Patch Changes
+
+- [#11443](https://github.com/apollographql/apollo-client/pull/11443) [`ff5a332`](https://github.com/apollographql/apollo-client/commit/ff5a332ff8b190c418df25371e36719d70061ebe) Thanks [@phryneas](https://github.com/phryneas)! - Adds a deprecation warning to the HOC and render prop APIs.
+
+  The HOC and render prop APIs have already been deprecated since 2020,
+  but we previously didn't have a @deprecated tag in the DocBlocks.
+
+- [#11078](https://github.com/apollographql/apollo-client/pull/11078) [`14edebe`](https://github.com/apollographql/apollo-client/commit/14edebebefb7634c32b921d02c1c85c6c8737989) Thanks [@phryneas](https://github.com/phryneas)! - ObservableQuery: prevent reporting results of previous queries if the variables changed since
+
+- [#11439](https://github.com/apollographql/apollo-client/pull/11439) [`33454f0`](https://github.com/apollographql/apollo-client/commit/33454f0a40a05ea2b00633bda20a84d0ec3a4f4d) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Address bundling issue introduced in [#11412](https://github.com/apollographql/apollo-client/pull/11412) where the `react/cache` internals ended up duplicated in the bundle. This was due to the fact that we had a `react/hooks` entrypoint that imported these files along with the newly introduced `createQueryPreloader` function, which lived outside of the `react/hooks` folder.
+
+## 3.9.0-beta.0
+
+### Minor Changes
+
+- [#11412](https://github.com/apollographql/apollo-client/pull/11412) [`58db5c3`](https://github.com/apollographql/apollo-client/commit/58db5c3295b88162f91019f0898f6baa4b9cced6) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Create a new `useQueryRefHandlers` hook that returns `refetch` and `fetchMore` functions for a given `queryRef`. This is useful to get access to handlers for a `queryRef` that was created by `createQueryPreloader` or when the handlers for a `queryRef` produced by a different component are inaccessible.
+
+  ```jsx
+  const MyComponent({ queryRef }) {
+    const { refetch, fetchMore } = useQueryRefHandlers(queryRef);
+
+    // ...
+  }
+  ```
+
+- [#11410](https://github.com/apollographql/apollo-client/pull/11410) [`07fcf6a`](https://github.com/apollographql/apollo-client/commit/07fcf6a3bf5bc78ffe6f3e598897246b4da02cbb) Thanks [@sf-twingate](https://github.com/sf-twingate)! - Allow returning `IGNORE` sentinel object from `optimisticResponse` functions to bail-out from the optimistic update.
+
+  Consider this example:
+
+  ```jsx
+  const UPDATE_COMMENT = gql`
+    mutation UpdateComment($commentId: ID!, $commentContent: String!) {
+      updateComment(commentId: $commentId, content: $commentContent) {
+        id
+        __typename
+        content
+      }
+    }
+  `;
+
+  function CommentPageWithData() {
+    const [mutate] = useMutation(UPDATE_COMMENT);
+    return (
+      <Comment
+        updateComment={({ commentId, commentContent }) =>
+          mutate({
+            variables: { commentId, commentContent },
+            optimisticResponse: (vars, { IGNORE }) => {
+              if (commentContent === "foo") {
+                // conditionally bail out of optimistic updates
+                return IGNORE;
+              }
+              return {
+                updateComment: {
+                  id: commentId,
+                  __typename: "Comment",
+                  content: commentContent,
+                },
+              };
+            },
+          })
+        }
+      />
+    );
+  }
+  ```
+
+  The `IGNORE` sentinel can be destructured from the second parameter in the callback function signature passed to `optimisticResponse`.
+
+- [#11412](https://github.com/apollographql/apollo-client/pull/11412) [`58db5c3`](https://github.com/apollographql/apollo-client/commit/58db5c3295b88162f91019f0898f6baa4b9cced6) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Add the ability to start preloading a query outside React to begin fetching as early as possible. Call `createQueryPreloader` to create a `preloadQuery` function which can be called to start fetching a query. This returns a `queryRef` which is passed to `useReadQuery` and suspended until the query is done fetching.
+
+  ```tsx
+  const preloadQuery = createQueryPreloader(client);
+  const queryRef = preloadQuery(QUERY, { variables, ...otherOptions });
+
+  function App() {
+    return {
+      <Suspense fallback={<div>Loading</div>}>
+        <MyQuery />
+      </Suspense>
+    }
+  }
+
+  function MyQuery() {
+    const { data } = useReadQuery(queryRef);
+
+    // do something with data
+  }
+  ```
+
+- [#11397](https://github.com/apollographql/apollo-client/pull/11397) [`3f7eecb`](https://github.com/apollographql/apollo-client/commit/3f7eecbfbd4f4444cffcaac7dd9fd225c8c2a401) Thanks [@aditya-kumawat](https://github.com/aditya-kumawat)! - Adds a new `skipPollAttempt` callback function that's called whenever a refetch attempt occurs while polling. If the function returns `true`, the refetch is skipped and not reattempted until the next poll interval. This will solve the frequent use-case of disabling polling when the window is inactive.
+
+  ```ts
+  useQuery(QUERY, {
+    pollInterval: 1000,
+    skipPollAttempt: () => document.hidden, // or !document.hasFocus()
+  });
+  // or define it globally
+  new ApolloClient({
+    defaultOptions: {
+      watchQuery: {
+        skipPollAttempt: () => document.hidden, // or !document.hasFocus()
+      },
+    },
+  });
+  ```
+
+- [#11435](https://github.com/apollographql/apollo-client/pull/11435) [`5cce53e`](https://github.com/apollographql/apollo-client/commit/5cce53e83b976f85d2d2b06e28cc38f01324fea1) Thanks [@phryneas](https://github.com/phryneas)! - Deprecates `canonizeResults`.
+
+  Using `canonizeResults` can result in memory leaks so we generally do not recommend using this option anymore.
+  A future version of Apollo Client will contain a similar feature without the risk of memory leaks.
+
+### Patch Changes
+
+- [#11369](https://github.com/apollographql/apollo-client/pull/11369) [`2a47164`](https://github.com/apollographql/apollo-client/commit/2a471646616e3af1b5c039e961f8d5717fad8f32) Thanks [@phryneas](https://github.com/phryneas)! - Persisted Query Link: improve memory management
+
+  - use LRU `WeakCache` instead of `WeakMap` to keep a limited number of hash results
+  - hash cache is initiated lazily, only when needed
+  - expose `persistedLink.resetHashCache()` method
+  - reset hash cache if the upstream server reports it doesn't accept persisted queries
+
+- [#10804](https://github.com/apollographql/apollo-client/pull/10804) [`221dd99`](https://github.com/apollographql/apollo-client/commit/221dd99ffd1990f8bd0392543af35e9b08d0fed8) Thanks [@phryneas](https://github.com/phryneas)! - use WeakMap in React Native with Hermes
+
+- [#11409](https://github.com/apollographql/apollo-client/pull/11409) [`2e7203b`](https://github.com/apollographql/apollo-client/commit/2e7203b3a9618952ddb522627ded7cceabd7f250) Thanks [@phryneas](https://github.com/phryneas)! - Adds an experimental `ApolloClient.getMemoryInternals` helper
+
 ## 3.9.0-alpha.5
 
 ### Minor Changes
@@ -95,7 +242,7 @@
   import { Environment, Network, RecordSource, Store } from "relay-runtime";
 
   const fetchMultipartSubs = createFetchMultipartSubscription(
-    "http://localhost:4000"
+    "http://localhost:4000",
   );
 
   const network = Network.create(fetchQuery, fetchMultipartSubs);
@@ -377,7 +524,7 @@
     return data.breeds.map(({ characteristics }) =>
       characteristics.map((characteristic) => (
         <div key={characteristic}>{characteristic}</div>
-      ))
+      )),
     );
   }
   ```
@@ -428,7 +575,7 @@
 
   const { data } = useSuspenseQuery(
     query,
-    id ? { variables: { id } } : skipToken
+    id ? { variables: { id } } : skipToken,
   );
   ```
 
@@ -2383,7 +2530,7 @@ In upcoming v3.6.x and v3.7 (beta) releases, we will be completely overhauling o
     fields: {
       comments(comments: Reference[], { readField }) {
         return comments.filter(
-          (comment) => idToRemove !== readField("id", comment)
+          (comment) => idToRemove !== readField("id", comment),
         );
       },
     },