Skip to content
Source
Sign inSign up
TanStack/db

test(conformance): parametrize how adapters surface query errors #1639

Mergedkevin-dp(GitHub profile, opens in a new tab)merged 1 commit intomain fromrefs/pull/1639/headmerged by kevin-dp(GitHub profile, opens in a new tab)

Follow-up #3 of 3 to the conformance suite (#1636), resolving the Solid error-status knownGap.

Base: stacked on test/live-query-conformance-suite (#1636). Re-target to main once #1636 lands.

Not a bug — a legitimate framework difference

Unlike the Svelte (#1637) and Angular (#1638) follow-ups, this one isn't an adapter fix. The suite flagged that Solid surfaces query errors differently: it routes them through createResource/Suspense, so reading an errored query throws CollectionStateError (for an <ErrorBoundary> to catch) rather than exposing a readable isError/status === 'error' flag like React/Vue/Svelte/Angular.

That's idiomatic Solid, not something to "fix." So instead of forcing Solid into the flag model, the suite is parametrized to assert whichever model an adapter declares.

Confirmed behavior (probe): the errored collection reaches error status, mount does not throw, and reading the result throws Collection is in error state.

Change

  • contract.ts: add driver.errorSurface?: 'flag' | 'throw' (default flag).
  • suite.ts: the error-status scenario now asserts:
    • flag → isError === true / status === 'error' (readable), or
    • throw → reading the errored result throws (boundary model).
  • solid-db driver: declares errorSurface: 'throw', clears its error-status knownGap.
  • React / Vue / Svelte / Angular keep the default flag assertions unchanged.

Verification

All five conformance suites pass 24/24. Solid's error-status now passes via the boundary branch; the other four via the flag branch. Test-infra only — no published-package changes, so no changeset.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Bug Fixes
    • Improved how live-query errors are surfaced, so errored results can now either be marked as errors or thrown for error-boundary handling.
    • Updated conformance coverage to verify both error-reporting behaviors, including the throw-based flow used by Solid.
    1. Review Change Stack

      Caution

      Review failed

      The pull request is closed.

      ℹ️ Recent review info
      ⚙️ Run configuration

      Configuration used: defaults

      Review profile: CHILL

      Plan: Pro

      Run ID: 823b04bb-6f6b-4a79-bb6c-4419e9f39f4d

      📥 Commits

      Reviewing files that changed from the base of the PR and between 3ec3e7ae1b2fa5ab9fee3ebaebb6d97c9487d29b and c9845725cb91908c0b081e88362398e4253c9484.

      📒 Files selected for processing (3)
      • packages/db/tests/conformance/contract.ts
      • packages/db/tests/conformance/suite.ts
      • packages/solid-db/tests/conformance.test.tsx

      📝 Walkthrough

      Walkthrough

      Adds an optional errorSurface property to the LiveQueryDriver conformance contract, allowing adapters to declare whether errored query results surface via a readable status flag or by throwing. Updates the error-status scenario to branch accordingly, and configures the Solid driver to use throw-based surfacing.

      Changes

      Error surface conformance support

      Layer / File(s)Summary
      Add errorSurface contract and scenario handling
      packages/db/tests/conformance/contract.ts, packages/db/tests/conformance/suite.ts
      Adds optional errorSurface?: 'flag' | 'throw' to LiveQueryDriver and updates the error-status scenario to expect h.current() to throw when set to 'throw', otherwise assert status === 'error' and isError === true.
      Configure Solid driver for throw-based errors
      packages/solid-db/tests/conformance.test.tsx
      Sets errorSurface: 'throw' on solidDriver, clears knownGaps (removing 'error-status'), and updates the related comment to reference ErrorBoundary-based validation.

      Estimated code review effort: 1 (Trivial) | ~5 minutes

      ✨ Finishing Touches
      📝 Generate docstrings
      • Create stacked PR
      • Commit on current branch
      🧪 Generate unit tests (beta)
      • Create PR with unit tests
      • Commit unit tests in branch `fix/conformance-error-surfacing`

      Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

      ❤️ Share
      Comment `@coderabbitai help` to get the list of available commands.
    2. More templates

      @tanstack/angular-db

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

      @tanstack/browser-db-sqlite-persistence

      npm i https://pkg.pr.new/@tanstack/browser-db-sqlite-persistence@1639

      @tanstack/capacitor-db-sqlite-persistence

      npm i https://pkg.pr.new/@tanstack/capacitor-db-sqlite-persistence@1639

      @tanstack/cloudflare-durable-objects-db-sqlite-persistence

      npm i https://pkg.pr.new/@tanstack/cloudflare-durable-objects-db-sqlite-persistence@1639

      @tanstack/db

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

      @tanstack/db-ivm

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

      @tanstack/db-sqlite-persistence-core

      npm i https://pkg.pr.new/@tanstack/db-sqlite-persistence-core@1639

      @tanstack/electric-db-collection

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

      @tanstack/electron-db-sqlite-persistence

      npm i https://pkg.pr.new/@tanstack/electron-db-sqlite-persistence@1639

      @tanstack/expo-db-sqlite-persistence

      npm i https://pkg.pr.new/@tanstack/expo-db-sqlite-persistence@1639

      @tanstack/node-db-sqlite-persistence

      npm i https://pkg.pr.new/@tanstack/node-db-sqlite-persistence@1639

      @tanstack/offline-transactions

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

      @tanstack/powersync-db-collection

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

      @tanstack/query-db-collection

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

      @tanstack/react-db

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

      @tanstack/react-native-db-sqlite-persistence

      npm i https://pkg.pr.new/@tanstack/react-native-db-sqlite-persistence@1639

      @tanstack/rxdb-db-collection

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

      @tanstack/solid-db

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

      @tanstack/svelte-db

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

      @tanstack/tauri-db-sqlite-persistence

      npm i https://pkg.pr.new/@tanstack/tauri-db-sqlite-persistence@1639

      @tanstack/trailbase-db-collection

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

      @tanstack/vue-db

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

      commit: c984572

    3. Size Change: 0 B

      Total Size: 125 kB

      ℹ️ View Unchanged
      FilenameSize
      packages/db/dist/esm/collection/change-events.js1.43 kB
      packages/db/dist/esm/collection/changes.js1.38 kB
      packages/db/dist/esm/collection/cleanup-queue.js810 B
      packages/db/dist/esm/collection/events.js434 B
      packages/db/dist/esm/collection/index.js3.62 kB
      packages/db/dist/esm/collection/indexes.js1.99 kB
      packages/db/dist/esm/collection/lifecycle.js1.69 kB
      packages/db/dist/esm/collection/mutations.js2.47 kB
      packages/db/dist/esm/collection/state.js5.4 kB
      packages/db/dist/esm/collection/subscription.js3.74 kB
      packages/db/dist/esm/collection/sync.js2.88 kB
      packages/db/dist/esm/collection/transaction-metadata.js144 B
      packages/db/dist/esm/deferred.js207 B
      packages/db/dist/esm/errors.js5.1 kB
      packages/db/dist/esm/event-emitter.js748 B
      packages/db/dist/esm/index.js3.1 kB
      packages/db/dist/esm/indexes/auto-index.js829 B
      packages/db/dist/esm/indexes/base-index.js767 B
      packages/db/dist/esm/indexes/basic-index.js2.06 kB
      packages/db/dist/esm/indexes/btree-index.js2.19 kB
      packages/db/dist/esm/indexes/index-registry.js820 B
      packages/db/dist/esm/indexes/reverse-index.js557 B
      packages/db/dist/esm/local-only.js916 B
      packages/db/dist/esm/local-storage.js2.12 kB
      packages/db/dist/esm/optimistic-action.js359 B
      packages/db/dist/esm/paced-mutations.js496 B
      packages/db/dist/esm/proxy.js3.75 kB
      packages/db/dist/esm/query/builder/functions.js1.47 kB
      packages/db/dist/esm/query/builder/index.js5.84 kB
      packages/db/dist/esm/query/builder/ref-proxy.js1.24 kB
      packages/db/dist/esm/query/compiler/evaluators.js1.89 kB
      packages/db/dist/esm/query/compiler/expressions.js430 B
      packages/db/dist/esm/query/compiler/group-by.js3.56 kB
      packages/db/dist/esm/query/compiler/index.js6.67 kB
      packages/db/dist/esm/query/compiler/joins.js2.5 kB
      packages/db/dist/esm/query/compiler/lazy-targets.js923 B
      packages/db/dist/esm/query/compiler/order-by.js1.74 kB
      packages/db/dist/esm/query/compiler/select.js1.53 kB
      packages/db/dist/esm/query/effect.js4.77 kB
      packages/db/dist/esm/query/expression-helpers.js1.43 kB
      packages/db/dist/esm/query/ir.js1.25 kB
      packages/db/dist/esm/query/live-query-collection.js360 B
      packages/db/dist/esm/query/live/collection-config-builder.js9.1 kB
      packages/db/dist/esm/query/live/collection-registry.js264 B
      packages/db/dist/esm/query/live/collection-subscriber.js1.93 kB
      packages/db/dist/esm/query/live/internal.js145 B
      packages/db/dist/esm/query/live/utils.js1.81 kB
      packages/db/dist/esm/query/optimizer.js2.92 kB
      packages/db/dist/esm/query/predicate-utils.js2.97 kB
      packages/db/dist/esm/query/query-once.js359 B
      packages/db/dist/esm/query/subset-dedupe.js960 B
      packages/db/dist/esm/scheduler.js1.3 kB
      packages/db/dist/esm/SortedMap.js1.3 kB
      packages/db/dist/esm/strategies/debounceStrategy.js247 B
      packages/db/dist/esm/strategies/queueStrategy.js428 B
      packages/db/dist/esm/strategies/throttleStrategy.js246 B
      packages/db/dist/esm/transactions.js3.04 kB
      packages/db/dist/esm/utils.js927 B
      packages/db/dist/esm/utils/array-utils.js273 B
      packages/db/dist/esm/utils/browser-polyfills.js304 B
      packages/db/dist/esm/utils/btree.js5.61 kB
      packages/db/dist/esm/utils/comparison.js1.11 kB
      packages/db/dist/esm/utils/cursor.js457 B
      packages/db/dist/esm/utils/index-optimization.js2.39 kB
      packages/db/dist/esm/utils/type-guards.js157 B
      packages/db/dist/esm/utils/uuid.js449 B
      packages/db/dist/esm/virtual-props.js360 B
      compressed-size-action::db-package-size
    4. Size Change: 0 B

      Total Size: 4.26 kB

      ℹ️ View Unchanged
      FilenameSize
      packages/react-db/dist/esm/index.js249 B
      packages/react-db/dist/esm/useLiveInfiniteQuery.js1.32 kB
      packages/react-db/dist/esm/useLiveQuery.js1.37 kB
      packages/react-db/dist/esm/useLiveQueryEffect.js355 B
      packages/react-db/dist/esm/useLiveSuspenseQuery.js567 B
      packages/react-db/dist/esm/usePacedMutations.js401 B
      compressed-size-action::react-db-package-size
    5. KyleAMathews(GitHub profile, opens in a new tab) approved these changes

Sign in to join this conversation.