Skip to content

Conversation

@KyleAMathews
Copy link
Collaborator

For live queries using on-demand sync mode, the collection was being marked as ready immediately when source collections were ready, even though the initial loadSubset hadn't completed yet. This meant isLoading was false while data was still being fetched.

This fix ensures that:

  1. Live queries with on-demand sources track the initial loadSubset promise and show isLoading: true until it completes
  2. The collection status remains loading until the first data load finishes
  3. Subsequent loadSubset calls (pagination/windowing) do NOT affect the ready status - only the first load matters

Changes:

  • Add hasMarkedReady and hasSetupLoadingListener flags to track initial ready state in CollectionConfigBuilder
  • Modify updateLiveQueryStatus() to wait for first loadSubset to complete before calling markReady()
  • Update subscribeToMatchingChanges() in CollectionSubscriber to track the initial loadSubset promise for on-demand sources
  • Add comprehensive tests for the new behavior

🎯 Changes

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

…sync

For live queries using on-demand sync mode, the collection was being
marked as ready immediately when source collections were ready, even
though the initial loadSubset hadn't completed yet. This meant
`isLoading` was false while data was still being fetched.

This fix ensures that:
1. Live queries with on-demand sources track the initial loadSubset
   promise and show `isLoading: true` until it completes
2. The collection status remains `loading` until the first data load
   finishes
3. Subsequent loadSubset calls (pagination/windowing) do NOT affect
   the ready status - only the first load matters

Changes:
- Add `hasMarkedReady` and `hasSetupLoadingListener` flags to track
  initial ready state in CollectionConfigBuilder
- Modify `updateLiveQueryStatus()` to wait for first loadSubset to
  complete before calling `markReady()`
- Update `subscribeToMatchingChanges()` in CollectionSubscriber to
  track the initial loadSubset promise for on-demand sources
- Add comprehensive tests for the new behavior
@changeset-bot
Copy link

changeset-bot bot commented Dec 3, 2025

🦋 Changeset detected

Latest commit: 3c50df6

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

This PR includes changesets to release 13 packages
Name Type
@tanstack/db Patch
@tanstack/angular-db Patch
@tanstack/db-collection-e2e Patch
@tanstack/electric-db-collection Patch
@tanstack/offline-transactions Patch
@tanstack/powersync-db-collection Patch
@tanstack/query-db-collection Patch
@tanstack/react-db Patch
@tanstack/rxdb-db-collection Patch
@tanstack/solid-db Patch
@tanstack/svelte-db Patch
@tanstack/trailbase-db-collection Patch
@tanstack/vue-db 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

@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 3, 2025

More templates

@tanstack/angular-db

npm i https://pkg.pr.new/@tanstack/angular-db@962

@tanstack/db

npm i https://pkg.pr.new/@tanstack/db@962

@tanstack/db-ivm

npm i https://pkg.pr.new/@tanstack/db-ivm@962

@tanstack/electric-db-collection

npm i https://pkg.pr.new/@tanstack/electric-db-collection@962

@tanstack/offline-transactions

npm i https://pkg.pr.new/@tanstack/offline-transactions@962

@tanstack/powersync-db-collection

npm i https://pkg.pr.new/@tanstack/powersync-db-collection@962

@tanstack/query-db-collection

npm i https://pkg.pr.new/@tanstack/query-db-collection@962

@tanstack/react-db

npm i https://pkg.pr.new/@tanstack/react-db@962

@tanstack/rxdb-db-collection

npm i https://pkg.pr.new/@tanstack/rxdb-db-collection@962

@tanstack/solid-db

npm i https://pkg.pr.new/@tanstack/solid-db@962

@tanstack/svelte-db

npm i https://pkg.pr.new/@tanstack/svelte-db@962

@tanstack/trailbase-db-collection

npm i https://pkg.pr.new/@tanstack/trailbase-db-collection@962

@tanstack/vue-db

npm i https://pkg.pr.new/@tanstack/vue-db@962

commit: 3c50df6

@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 2025

Size Change: +163 B (+0.19%)

Total Size: 87.3 kB

Filename Size Change
./packages/db/dist/esm/query/live/collection-config-builder.js 5.43 kB +102 B (+1.92%)
./packages/db/dist/esm/query/live/collection-subscriber.js 1.8 kB +61 B (+3.51%)
ℹ️ View Unchanged
Filename Size
./packages/db/dist/esm/collection/change-events.js 1.39 kB
./packages/db/dist/esm/collection/changes.js 977 B
./packages/db/dist/esm/collection/events.js 388 B
./packages/db/dist/esm/collection/index.js 3.24 kB
./packages/db/dist/esm/collection/indexes.js 1.1 kB
./packages/db/dist/esm/collection/lifecycle.js 1.67 kB
./packages/db/dist/esm/collection/mutations.js 2.31 kB
./packages/db/dist/esm/collection/state.js 3.43 kB
./packages/db/dist/esm/collection/subscription.js 2.55 kB
./packages/db/dist/esm/collection/sync.js 2.37 kB
./packages/db/dist/esm/deferred.js 207 B
./packages/db/dist/esm/errors.js 4.19 kB
./packages/db/dist/esm/event-emitter.js 748 B
./packages/db/dist/esm/index.js 2.64 kB
./packages/db/dist/esm/indexes/auto-index.js 742 B
./packages/db/dist/esm/indexes/base-index.js 766 B
./packages/db/dist/esm/indexes/btree-index.js 1.87 kB
./packages/db/dist/esm/indexes/lazy-index.js 1.1 kB
./packages/db/dist/esm/indexes/reverse-index.js 513 B
./packages/db/dist/esm/local-only.js 837 B
./packages/db/dist/esm/local-storage.js 2.1 kB
./packages/db/dist/esm/optimistic-action.js 359 B
./packages/db/dist/esm/paced-mutations.js 496 B
./packages/db/dist/esm/proxy.js 3.75 kB
./packages/db/dist/esm/query/builder/functions.js 733 B
./packages/db/dist/esm/query/builder/index.js 3.96 kB
./packages/db/dist/esm/query/builder/ref-proxy.js 917 B
./packages/db/dist/esm/query/compiler/evaluators.js 1.35 kB
./packages/db/dist/esm/query/compiler/expressions.js 430 B
./packages/db/dist/esm/query/compiler/group-by.js 1.8 kB
./packages/db/dist/esm/query/compiler/index.js 1.96 kB
./packages/db/dist/esm/query/compiler/joins.js 2 kB
./packages/db/dist/esm/query/compiler/order-by.js 1.25 kB
./packages/db/dist/esm/query/compiler/select.js 1.07 kB
./packages/db/dist/esm/query/expression-helpers.js 1.43 kB
./packages/db/dist/esm/query/ir.js 673 B
./packages/db/dist/esm/query/live-query-collection.js 360 B
./packages/db/dist/esm/query/live/collection-registry.js 264 B
./packages/db/dist/esm/query/live/internal.js 130 B
./packages/db/dist/esm/query/optimizer.js 2.56 kB
./packages/db/dist/esm/query/predicate-utils.js 2.91 kB
./packages/db/dist/esm/query/subset-dedupe.js 921 B
./packages/db/dist/esm/scheduler.js 1.3 kB
./packages/db/dist/esm/SortedMap.js 1.18 kB
./packages/db/dist/esm/strategies/debounceStrategy.js 247 B
./packages/db/dist/esm/strategies/queueStrategy.js 428 B
./packages/db/dist/esm/strategies/throttleStrategy.js 246 B
./packages/db/dist/esm/transactions.js 2.9 kB
./packages/db/dist/esm/utils.js 881 B
./packages/db/dist/esm/utils/browser-polyfills.js 304 B
./packages/db/dist/esm/utils/btree.js 5.61 kB
./packages/db/dist/esm/utils/comparison.js 852 B
./packages/db/dist/esm/utils/index-optimization.js 1.51 kB
./packages/db/dist/esm/utils/type-guards.js 157 B

compressed-size-action::db-package-size

@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 2025

Size Change: 0 B

Total Size: 3.35 kB

ℹ️ View Unchanged
Filename Size
./packages/react-db/dist/esm/index.js 225 B
./packages/react-db/dist/esm/useLiveInfiniteQuery.js 1.17 kB
./packages/react-db/dist/esm/useLiveQuery.js 1.12 kB
./packages/react-db/dist/esm/useLiveSuspenseQuery.js 431 B
./packages/react-db/dist/esm/usePacedMutations.js 401 B

compressed-size-action::react-db-package-size

Update test to wait for the initial loadSubset promise to resolve
before checking the live query status. This is needed after the fix
that makes live queries show loading status during initial on-demand
data fetch.
@samwillis samwillis mentioned this pull request Dec 3, 2025
…romise: true

For on-demand sync mode, the default includeInitialState path calls
requestSnapshot with trackLoadSubsetPromise: false, which doesn't track
the loading state. This change manually calls requestSnapshot with
trackLoadSubsetPromise: true for on-demand sources to ensure the
subscription status changes from 'loadingSubset' to 'ready' when data
arrives.

Also updates query-db-collection tests to use eager mode since they test
TanStack Query cache behavior, not on-demand loading status.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants