fix(tanstack-react-query): use skipToken instead of overriding enabled option#994
fix(tanstack-react-query): use skipToken instead of overriding enabled option#994msvargas wants to merge 2 commits into
Conversation
🦋 Changeset detectedLatest commit: 3864737 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
730b80b to
379fbea
Compare
|
Hi @Chriztiaan, could you please review this fix when you have a chance? Feedback is very welcome. Also, thanks for the awesome packages! 🚀 |
|
Hey @msvargas, I have a few changes I'd like to push to your branch. Could you give me write permissions to your fork? Alternatively, you could apply the changes yourself - commit here: barvaz-engineering@833436e |
|
Thanks for the review @Chriztiaan! I've applied all your suggested changes from commit 833436e locally — they look great. I wasn't able to give you write permissions to the fork, but please feel free to close this PR and open a new one with your changes if you'd prefer to take it from here. Many thanks for the help! |
…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
379fbea to
0890392
Compare
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).