-
Notifications
You must be signed in to change notification settings - Fork 152
Prevent JavaScript in query selections #1021
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
KyleAMathews
wants to merge
9
commits into
main
Choose a base branch
from
claude/prevent-js-in-queries-KeUA5
base: main
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.
Open
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
Adds detection and helpful error messages when users mistakenly use JavaScript operators (||, &&, ??) in query callbacks. These operators are evaluated at query construction time, not execution time, causing silent unexpected behavior. Changes: - Add JavaScriptOperatorInQueryError with helpful suggestions - Add Symbol.toPrimitive trap to RefProxy for primitive coercion - Add checkCallbackForJsOperators() to detect operators in callbacks - Integrate checks into select(), where(), and having() methods - Add comprehensive tests for the new error detection - Fix existing tests that incorrectly used JS operators
🦋 Changeset detectedLatest commit: 3f71f8e The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 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: +1.05 kB (+1.17%) Total Size: 91.1 kB
ℹ️ View Unchanged
|
Contributor
|
Size Change: 0 B Total Size: 3.35 kB ℹ️ View Unchanged
|
- Add ternary operator (?:) detection to JS operator patterns - Add tests for ternary detection and regex literal edge case - Fix e2e test to use coalesce() instead of ?? - Add changeset 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Cast coalesce result to string to satisfy lower() type requirement 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
LOWER(NULL) LIKE '%x%' is NULL (falsy) in SQL, so coalesce isn't needed when using OR with a title match that will find results. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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.
Summary
Adds detection and helpful error messages when users accidentally use JavaScript operators (
||,&&,??,?:) in query callbacks. These operators are evaluated at query construction time rather than execution time, causing silent incorrect behavior.User-visible impact: Developers now get clear, actionable errors when making this common mistake, instead of silently broken queries.
Root Cause
Query callbacks like
.select(),.where(), and.having()receive RefProxy objects that record property access paths. When users write:The
||operator evaluates immediately at construction time. Sinceuser.nameis a RefProxy object (truthy), it always returns the RefProxy, ignoring'default'. The query silently produces unexpected results.Approach
Two-layer detection strategy:
.toString()and detect operator patterns after stripping string literals and commentsKey Invariants
?.) must NOT trigger false positivesNon-goals
/a||b/) will trigger false positives. This is documented as a known limitation since regex literals are rarely used in query callbacks.===,>,<) - These are handled separately in PR Fix QueryCompilationError with undefined expression type #1082Trade-offs
||/&&/??which return objectsThe dual approach catches the broadest range of mistakes with minimal overhead.
Verification
Files Changed
src/errors.tsJavaScriptOperatorInQueryErrorwith helpful message and examplessrc/query/builder/ref-proxy.tsSymbol.toPrimitivetrap,checkCallbackForJsOperators(), operator patternssrc/query/builder/index.tscheckCallbackForJsOperatorsinselect(),where(),having()tests/query/builder/ref-proxy.test.tstests/query/scheduler.test.tscoalesce()instead of??tests/query/live-query-collection.test.ts!assertion instead of??packages/db-collection-e2e/.../predicates.suite.ts!assertion