Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove retain call from useBackgroundQuery to allow for auto disposal #11438

Merged
merged 8 commits into from Dec 19, 2023

Conversation

jerelmiller
Copy link
Member

Thanks to the work in #11412, we no longer need to retain the queryRef produced by useBackgroundQuery since this is handled in useReadQuery for us. This means that a queryRef not consumed by useReadQuery within the given autoDisposeTimeoutMs will now be auto disposed, removing the need for the query to hang out as active while not used. #11412 enabled the ability to auto resubscribe to a disposed queryRef, so when the queryRef is consumed after it has been disposed, it will automatically resubscribe.

Checklist:

  • If this PR contains changes to the library itself (not necessary for e.g. docs updates), please include a changeset (see CONTRIBUTING.md)
  • If this PR is a new feature, please reference an issue where a consensus about the design was reached (not necessary for small changes)
  • Make sure all of the significant new logic is covered by tests

Copy link

changeset-bot bot commented Dec 19, 2023

🦋 Changeset detected

Latest commit: 163047a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@apollo/client Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Member

@phryneas phryneas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to see one more test, but generally approved :)


await expect(Profiler).not.toRerender();
});

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add one more test with a "natural dispose after being mounted with useReadQuery"
useBackgroundQuery -> mount useReadQuery -> unmount useReadQuery -> make sure it's disposed -> mount useReadQuery -> make sure it resubscribes

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call! e9165f1

Base automatically changed from jerel/rewrite-background-query-tests to release-3.9 December 19, 2023 15:35
Copy link
Contributor

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 38.21 KB (-0.02% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 46 KB (-0.02% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 43.56 KB (-0.03% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 33.96 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 31.89 KB (0%)
import { ApolloProvider } from "dist/react/index.js" 1.24 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production) 1.22 KB (0%)
import { useQuery } from "dist/react/index.js" 5.2 KB (0%)
import { useQuery } from "dist/react/index.js" (production) 4.27 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 5.51 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.58 KB (0%)
import { useMutation } from "dist/react/index.js" 3.51 KB (0%)
import { useMutation } from "dist/react/index.js" (production) 2.73 KB (0%)
import { useSubscription } from "dist/react/index.js" 3.19 KB (0%)
import { useSubscription } from "dist/react/index.js" (production) 2.39 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 5.28 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production) 3.94 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 4.75 KB (-0.35% 🔽)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.39 KB (-0.46% 🔽)
import { useLoadableQuery } from "dist/react/index.js" 4.98 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production) 3.64 KB (0%)
import { useReadQuery } from "dist/react/index.js" 3.03 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 2.97 KB (0%)
import { useFragment } from "dist/react/index.js" 2.1 KB (0%)
import { useFragment } from "dist/react/index.js" (production) 2.05 KB (0%)

Copy link

netlify bot commented Dec 19, 2023

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit 55871c5
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/6581b9fd25609000089cda4a
😎 Deploy Preview https://deploy-preview-11438--apollo-client-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Dec 19, 2023

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit 163047a
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/6581ba8338b1fb0008727b0c
😎 Deploy Preview https://deploy-preview-11438--apollo-client-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jerelmiller jerelmiller merged commit 6d46ab9 into release-3.9 Dec 19, 2023
26 checks passed
@jerelmiller jerelmiller deleted the jerel/remove-uBQ-retain branch December 19, 2023 15:56
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants