Auto append to static queryKey when in on-demand mode for Query Collection #800
+341
−1
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
… mode When using a static queryKey with syncMode: 'on-demand', the system now automatically appends serialized LoadSubsetOptions to create unique cache keys for different predicate combinations. This fixes an issue where static queryKeys in on-demand mode would cause all live queries with different predicates to share the same cache entry, defeating the purpose of predicate push-down. Changes: - Added serialization utilities for LoadSubsetOptions (serializeLoadSubsetOptions, serializeExpression, serializeValue) - Modified createQueryFromOpts to automatically append serialized predicates when queryKey is static and syncMode is 'on-demand' - Function-based queryKeys continue to work as before - Eager mode with static queryKeys unchanged (no automatic serialization) Tests: - Added comprehensive test suite for static queryKey with on-demand mode - Tests verify different predicates create separate cache entries - Tests verify identical predicates reuse the same cache entry - Tests verify eager mode behavior unchanged - All existing tests pass
🦋 Changeset detectedLatest commit: 41d5a86 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 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/angular-db
@tanstack/db
@tanstack/db-ivm
@tanstack/electric-db-collection
@tanstack/offline-transactions
@tanstack/powersync-db-collection
@tanstack/query-db-collection
@tanstack/react-db
@tanstack/rxdb-db-collection
@tanstack/solid-db
@tanstack/svelte-db
@tanstack/trailbase-db-collection
@tanstack/vue-db
commit: |
Contributor
|
Size Change: 0 B Total Size: 86 kB ℹ️ View Unchanged
|
Contributor
|
Size Change: 0 B Total Size: 3.34 kB ℹ️ View Unchanged
|
kevin-dp
approved these changes
Nov 13, 2025
| * Serializes LoadSubsetOptions into a stable, hashable format for query keys | ||
| * @internal | ||
| */ | ||
| function serializeLoadSubsetOptions( |
Contributor
There was a problem hiding this comment.
Let's move all the serialization functions into a utility file
| result.orderBy = options.orderBy.map((clause) => ({ | ||
| expression: serializeExpression(clause.expression), | ||
| direction: clause.compareOptions.direction, | ||
| nulls: clause.compareOptions.nulls, |
Contributor
There was a problem hiding this comment.
This object only contains the direction and nulls but is missing the other options from StringCollationConfig:
export type CompareOptions = StringCollationConfig & {
direction: OrderByDirection
nulls: `first` | `last`
}| */ | ||
| function serializeLoadSubsetOptions( | ||
| options: LoadSubsetOptions | undefined | ||
| ): unknown { |
Contributor
There was a problem hiding this comment.
Why is the return type typed as unknown ? Shouldn't this be string | null.
Actually, i'm wondering why we return null instead of undefined. I think the code would be slightly simplier if we return undefined. So the return type would be string | undefined`.
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.
When using a static queryKey with syncMode: 'on-demand', the system now automatically appends serialized LoadSubsetOptions to create unique cache keys for different predicate combinations.
This fixes an issue where static queryKeys in on-demand mode would cause all live queries with different predicates to share the same cache entry, defeating the purpose of predicate push-down.
Changes:
Tests:
🎯 Changes
✅ Checklist
pnpm test:pr.🚀 Release Impact