-
Notifications
You must be signed in to change notification settings - Fork 67
Fix: Live query collections stuck in initialCommit
status when source collections are preloaded after creation
#395
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
Open
samwillis
wants to merge
3
commits into
samwillis/fix-ready
Choose a base branch
from
samwillis/fix-preload-race
base: samwillis/fix-ready
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
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
🦋 Changeset detectedLatest commit: 8b6bfd8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 8 packages
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 |
More templates
@tanstack/db
@tanstack/db-ivm
@tanstack/electric-db-collection
@tanstack/query-db-collection
@tanstack/react-db
@tanstack/solid-db
@tanstack/svelte-db
@tanstack/trailbase-db-collection
@tanstack/vue-db
commit: |
Size Change: -5 B (-0.01%) Total Size: 58.5 kB
ℹ️ View Unchanged
|
Size Change: 0 B Total Size: 1.05 kB ℹ️ View Unchanged
|
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.
stacked on #390, fairly sure that it fixes #391
Problem
Live query collections were getting stuck in
initialCommit
status instead of transitioning toready
status when their source collections were preloaded after the live query collection was created. This caused issues where:initialCommit
statuscollection.status === 'ready'
would not update properlyready
when mutations/remote updates occurredThis matches the user report: "if I don't preload the collection before rendering, It won't update after being loaded. It'll only update, when some mutation/remote update happens"
Root Cause
The issue was in the
markReady()
method inpackages/db/src/collection.ts
. When a collection became ready for the first time, it would only emit an empty ready event if the collection was empty AND had change listeners:This condition was too restrictive. Live query collections that depend on source collections often have data but still need to emit the ready event to properly transition their status.
Solution
Changed the condition to emit the ready event whenever there are change listeners, regardless of collection size:
This ensures that any collection with active subscribers will properly emit the ready event when it transitions to ready status, allowing dependent live query collections to also transition to ready status.
Testing
Added a comprehensive test case that reproduces the exact scenario:
startSync: false
preload()
promise before the source collection is readyready
statusThe test uses explicit promise control instead of flaky timeouts to ensure reliable reproduction of the issue.
Impact
This fix ensures that live query collections properly transition to
ready
status when their source collections are preloaded after the live query is created, resolving the issue where components would not update properly until mutations occurred.