fix: support async subscribe in useSWRSubscription#4244
Open
solssak wants to merge 1 commit intovercel:mainfrom
Open
fix: support async subscribe in useSWRSubscription#4244solssak wants to merge 1 commit intovercel:mainfrom
solssak wants to merge 1 commit intovercel:mainfrom
Conversation
Handle async subscribe functions that return a Promise, such as those needed for AWS Amplify or other async connection APIs. - Detect Promise returns and resolve them to get the dispose function - Handle race condition where cleanup runs before async subscribe resolves - Update TypeScript types to explicitly allow async subscribe - Add runtime and type tests Fixes vercel#4214
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
useSWRSubscription does not support async subscribe functions. When the subscribe callback is async (e.g. to connect to AWS Amplify), the returned Promise is not handled, causing the typeof check to throw.
This PR adds support for async subscribe by detecting Promise returns and resolving them properly, including handling the race condition where the component unmounts before the async subscribe resolves.
Fixes #4214
src/subscription/types.ts — Subscribe return type now accepts Promise.
src/subscription/index.ts — Detect and handle Promise returns from subscribe().
test/ — Added runtime and type tests for async subscribe.
All checks pass: pnpm run-all-checks + pnpm test (367 tests passed).