Skip to content

Fix select() to handle direct ref returns as spreads#1276

Closed
KyleAMathews wants to merge 2 commits intomainfrom
claude/fix-spread-operator-ref-C3Sol
Closed

Fix select() to handle direct ref returns as spreads#1276
KyleAMathews wants to merge 2 commits intomainfrom
claude/fix-spread-operator-ref-C3Sol

Conversation

@KyleAMathews
Copy link
Collaborator

🎯 Changes

Fixed a common pitfall in the select() query builder where returning a ref directly (e.g., select(({ users }) => users)) would produce ref/proxy metadata instead of actual row data.

The fix detects when a callback returns a RefProxy directly and automatically treats it as if the user had spread it (e.g., select(({ users }) => ({ ...users }))). This is accomplished by:

  1. Adding an isRefProxy() check in the select() method
  2. Converting direct ref returns into a sentinel-based spread object that the existing buildNestedSelect() logic already handles correctly
  3. This preserves all existing behavior for explicit spreads while fixing the implicit case

✅ Checklist

  • I have tested this code locally with pnpm test.

🚀 Release Impact

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

Test Coverage: Added three comprehensive test cases covering:

  • Basic direct ref returns projecting full rows
  • Nested object field preservation with direct ref returns
  • Live update handling with direct ref returns

https://claude.ai/code/session_01KAGFqbqFxY2YYV4uTVTBa8

… operator

When a RefProxy is returned directly from the select callback
(e.g. `.select(({ users }) => users)`), convert it to a spread sentinel
so it behaves identically to the spread form
(`.select(({ users }) => ({ ...users }))`).

Previously, the direct return form would pass a RefProxy through
buildNestedSelect → toExpr, producing a PropRef whose own properties
(type, path) were iterated by the compiler instead of the actual row
data — yielding ref metadata objects instead of the real data.

The fix detects RefProxy at the top level of select() and synthesizes
the equivalent spread sentinel before handing off to buildNestedSelect.

https://claude.ai/code/session_01KAGFqbqFxY2YYV4uTVTBa8
@changeset-bot
Copy link

changeset-bot bot commented Feb 19, 2026

⚠️ No Changeset found

Latest commit: 1b1bf62

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 19, 2026

More templates

@tanstack/angular-db

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

@tanstack/db

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

@tanstack/db-ivm

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

@tanstack/electric-db-collection

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

@tanstack/offline-transactions

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

@tanstack/powersync-db-collection

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

@tanstack/query-db-collection

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

@tanstack/react-db

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

@tanstack/rxdb-db-collection

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

@tanstack/solid-db

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

@tanstack/svelte-db

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

@tanstack/trailbase-db-collection

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

@tanstack/vue-db

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

commit: 1b1bf62

@github-actions
Copy link
Contributor

Size Change: +54 B (+0.06%)

Total Size: 92.1 kB

Filename Size Change
./packages/db/dist/esm/query/builder/index.js 4.14 kB +54 B (+1.32%)
ℹ️ View Unchanged
Filename Size
./packages/db/dist/esm/collection/change-events.js 1.39 kB
./packages/db/dist/esm/collection/changes.js 1.22 kB
./packages/db/dist/esm/collection/events.js 388 B
./packages/db/dist/esm/collection/index.js 3.32 kB
./packages/db/dist/esm/collection/indexes.js 1.1 kB
./packages/db/dist/esm/collection/lifecycle.js 1.75 kB
./packages/db/dist/esm/collection/mutations.js 2.34 kB
./packages/db/dist/esm/collection/state.js 3.49 kB
./packages/db/dist/esm/collection/subscription.js 3.71 kB
./packages/db/dist/esm/collection/sync.js 2.41 kB
./packages/db/dist/esm/deferred.js 207 B
./packages/db/dist/esm/errors.js 4.7 kB
./packages/db/dist/esm/event-emitter.js 748 B
./packages/db/dist/esm/index.js 2.69 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 2.17 kB
./packages/db/dist/esm/indexes/lazy-index.js 1.1 kB
./packages/db/dist/esm/indexes/reverse-index.js 538 B
./packages/db/dist/esm/local-only.js 808 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/ref-proxy.js 1.05 kB
./packages/db/dist/esm/query/compiler/evaluators.js 1.43 kB
./packages/db/dist/esm/query/compiler/expressions.js 430 B
./packages/db/dist/esm/query/compiler/group-by.js 1.81 kB
./packages/db/dist/esm/query/compiler/index.js 2.02 kB
./packages/db/dist/esm/query/compiler/joins.js 2.11 kB
./packages/db/dist/esm/query/compiler/order-by.js 1.45 kB
./packages/db/dist/esm/query/compiler/select.js 1.06 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-config-builder.js 5.44 kB
./packages/db/dist/esm/query/live/collection-registry.js 264 B
./packages/db/dist/esm/query/live/collection-subscriber.js 2.42 kB
./packages/db/dist/esm/query/live/internal.js 145 B
./packages/db/dist/esm/query/optimizer.js 2.62 kB
./packages/db/dist/esm/query/predicate-utils.js 2.97 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.3 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 924 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 952 B
./packages/db/dist/esm/utils/cursor.js 457 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

Size Change: 0 B

Total Size: 3.7 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.34 kB
./packages/react-db/dist/esm/useLiveSuspenseQuery.js 559 B
./packages/react-db/dist/esm/usePacedMutations.js 401 B

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

Copy link
Collaborator

@samwillis samwillis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to validate that the ref proxy is for a spreadable object. At the moment we can't support a user returning a single literal value, like a string or number.

@samwillis
Copy link
Collaborator

Other than that, looking good. Needs a changeset

@samwillis
Copy link
Collaborator

Closing this in favor of the work that landed in #1384.

We did incorporate the useful part of this PR, but in a narrower form.

What we kept:

  • support for returning a top-level alias ref directly, e.g. select(({ users }) => users), so it behaves like the spread form and projects the full row instead of ref metadata

What we intentionally did not keep:

  • the broader “any direct RefProxy return becomes a spread” behavior

The reason is that we needed to land scalar child selects for toArray(...) / concat(toArray(...)), and that requires leaf refs like:

select(({ c }) => c.text)

to remain genuine scalar selections, not be rewritten as spread-like object projections.

So the behavior now is:

  • top-level alias/object ref returns are treated as spread-equivalent
  • scalar leaf refs are left alone

That gives us the safe/fixed case this PR was targeting, without conflicting with the scalar-select work in #1384 and the follow-up boundary tightening there.

Because of that, this PR is effectively superseded by the narrower implementation on that branch, so I’m closing this one.

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