fix(tanstack-react-query): use skipToken instead of overriding enabled option#994
Open
msvargas wants to merge 1 commit into
Open
Conversation
|
c21342d to
730b80b
Compare
…d option Replace the enabled: streamsHaveSynced pattern with TanStack's skipToken to preserve the user's own enabled option. Problems fixed: - User's enabled option was silently overridden by PowerSync's streamsHaveSynced - usePowerSyncQueries final useMemo was missing streamsHaveSynced in deps, returning stale values - Race condition: change listeners attached watching [] tables while resolveTables was pending, losing first-sync writes Changes: - useQuery: Conditionally pass skipToken when streams haven't synced; suspense queries always get the real queryFn - useQueries: Same skipToken approach per query entry; add streamsHaveSynced to deps - usePowerSyncQueries: Add tablesInitialized ref to rescue data lost during the []->[tables] transition; add streamsHaveSynced to return memo deps
730b80b to
379fbea
Compare
Contributor
Author
|
Hi @christiaanjourneyapps (Christiaan Landman), could you please review this fix when you have a chance? Feedback is very welcome. Also, thanks for the awesome packages! 🚀 |
Contributor
Author
|
Correct handle: @Chriztiaan (sorry about the typo above!) |
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
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.
Problem
PowerSync's
useQueryanduseQuerieshooks override the user'senabledoption by forcingenabled: streamsHaveSyncedat the end of the spread. Users who need conditional query control (e.g.,enabled: !!userId) lose that ability — the query always runs once streams are synced, regardless of their condition.Additionally, two secondary issues were discovered:
Stale
streamsHaveSynced— TheusePowerSyncQueriesfinaluseMemowas missingstreamsHaveSyncedin its dependency array, causing the returned value to stay stale when onlystreamsHaveSyncedchanged.Race condition on first table resolution —
resolveTablesis async. The change listener attaches watching[](empty) tables, so any write landing beforeresolveTablesresolves is silently dropped. The listener that later attaches with real tables was created after the write, so it never sees it.Solution
Replace the
enabledoverride pattern with TanStack'sskipToken. When streams haven't synced, thequeryFnis set toTanstack.skipToken, preventing query execution without modifying the user'senabledoption.For
useSuspenseQuery,skipTokenis not passed (TanStack rejects it for suspense). Suspense queries always receive the realqueryFn, which is correct — suspense queries must resolve.Race condition fix: A
tablesInitializedref tracks each query's[] -> [tables]transition. On the first transition, an explicitqueryClient.invalidateQueries()rescues any data that was written and dropped during the pendingresolveTableswindow.Changes
src/hooks/useQuery.tsskipTokenwhen streams haven't synced (and not a suspense query); removeenabledoverridesrc/hooks/useQueries.tsskipTokenper-query; removeenabledoverride; addstreamsHaveSyncedto depssrc/hooks/usePowerSyncQueries.tstablesInitializedref with rescue invalidation; addstreamsHaveSyncedto return memo depstests/enabled.test.tsxenabled: falseis respected foruseQuery,useQueries, anduseSuspenseQuerytests/usePowerSyncQueries.test.tsxstreamsHaveSynceddep update + race condition rescueTesting
All 41 tests pass (5 test files, 40 passed, 1 pre-existing skip).