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

Add restart function to useSubscription #11927

Merged
merged 7 commits into from
Jul 8, 2024
Merged

Conversation

phryneas
Copy link
Member

@phryneas phryneas commented Jul 5, 2024

Naming is open for discussion, but I did pretty deliberately select something different from refetch:

  • refetch feels wrong in the case of something long-running like a subscription
  • it has very different usage (doesn't accept parameters, doesn't return anything) from existing refetch functions.

@phryneas phryneas added this to the 3.11.0 milestone Jul 5, 2024
Copy link

changeset-bot bot commented Jul 5, 2024

🦋 Changeset detected

Latest commit: 2224ff3

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 Patch

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
Contributor

github-actions bot commented Jul 5, 2024

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 39.03 KB (+0.12% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 47.73 KB (+0.07% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 45.28 KB (+0.11% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 34.27 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 32.13 KB (0%)
import { ApolloProvider } from "dist/react/index.js" 1.26 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production) 1.24 KB (0%)
import { useQuery } from "dist/react/index.js" 5.23 KB (-0.02% 🔽)
import { useQuery } from "dist/react/index.js" (production) 4.31 KB (+0.03% 🔺)
import { useLazyQuery } from "dist/react/index.js" 5.71 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.79 KB (+0.03% 🔺)
import { useMutation } from "dist/react/index.js" 3.62 KB (+0.03% 🔺)
import { useMutation } from "dist/react/index.js" (production) 2.84 KB (0%)
import { useSubscription } from "dist/react/index.js" 3.73 KB (+2.75% 🔺)
import { useSubscription } from "dist/react/index.js" (production) 2.88 KB (+3.52% 🔺)
import { useSuspenseQuery } from "dist/react/index.js" 5.49 KB (-0.02% 🔽)
import { useSuspenseQuery } from "dist/react/index.js" (production) 4.15 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 4.99 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.64 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" 5.07 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production) 3.72 KB (0%)
import { useReadQuery } from "dist/react/index.js" 3.39 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 3.33 KB (0%)
import { useFragment } from "dist/react/index.js" 2.32 KB (+0.05% 🔺)
import { useFragment } from "dist/react/index.js" (production) 2.27 KB (0%)

Copy link

netlify bot commented Jul 5, 2024

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit 2224ff3
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/668bb212b9b75700082266ac
😎 Deploy Preview https://deploy-preview-11927--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.

@phryneas phryneas force-pushed the useSubscription/restart branch from df52adc to 2ba59a4 Compare July 5, 2024 12:51
@phryneas phryneas marked this pull request as ready for review July 5, 2024 13:02
@phryneas phryneas requested review from jerelmiller and alessbell July 5, 2024 13:02
Copy link
Member

@jerelmiller jerelmiller left a comment

Choose a reason for hiding this comment

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

Other than the typo in the tests, this looks great! I'm sure this will be a well received feature.

src/react/hooks/__tests__/useSubscription.test.tsx Outdated Show resolved Hide resolved
src/react/hooks/__tests__/useSubscription.test.tsx Outdated Show resolved Hide resolved
src/react/hooks/__tests__/useSubscription.test.tsx Outdated Show resolved Hide resolved
src/react/hooks/__tests__/useSubscription.test.tsx Outdated Show resolved Hide resolved
src/react/hooks/__tests__/useSubscription.test.tsx Outdated Show resolved Hide resolved
Co-authored-by: Jerel Miller <jerelmiller@gmail.com>
@phryneas phryneas added the auto-cleanup 🤖 label Jul 8, 2024
@phryneas phryneas merged commit 2941824 into release-3.11 Jul 8, 2024
35 of 36 checks passed
@phryneas phryneas deleted the useSubscription/restart branch July 8, 2024 09:38
@github-actions github-actions bot mentioned this pull request Jul 9, 2024
@github-actions github-actions bot mentioned this pull request Jul 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 8, 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.

useSubscription has no way to re-connect after error
2 participants