docs: add comprehensive testing guide for TanStack DB by KyleAMathews · Pull Request #1389 · TanStack/db

KyleAMathews · 2026-03-19T13:55:25Z

🎯 Changes

Added a comprehensive testing guide for TanStack DB that covers:

Test setup: Vitest configuration with jsdom environment and framework-specific setup files
Mock collections: Pattern for creating collections with controlled sync behavior for testing
Framework-specific testing patterns:
- React: renderHook and waitFor from @testing-library/react
- Vue: nextTick() with timing for reactivity updates
- Svelte: $effect.root and flushSync() from Svelte 5
- Solid: renderHook and waitFor from @solidjs/testing-library
- Angular: TestBed.runInInjectionContext for injection context
Testing mutations: Insert, update, delete operations and createOptimisticAction
Virtual props handling: Techniques for stripping or ignoring TanStack DB's internal properties in assertions
Best practices and common mistakes: Tips for avoiding state leakage, proper reactivity flushing, and collection lifecycle management

Also added a corresponding skill document (db-core/testing/SKILL.md) that provides a quick reference guide with decision trees, access patterns for each framework, and a test suite overview.

Updated docs/config.json to include the new testing guide in the documentation navigation.

✅ Checklist

This change is docs-only (no release).

🚀 Release Impact

This change is docs/CI/dev-only (no release).

https://claude.ai/code/session_01EsJdvoefdRVjyFXLazdn73

Adds a comprehensive testing docs page covering mock collection creation, framework-specific testing patterns (React, Vue, Svelte, Solid, Angular), mutation testing, and virtual prop handling. Also adds a db-core/testing skill for AI agent assistance with testing questions. https://claude.ai/code/session_01EsJdvoefdRVjyFXLazdn73

- Add `user-invocable: false` since this is background knowledge, not a command - Expand description with trigger phrases ("when writing tests", "debugging test failures") - Extract test inventory into references/test-inventory.md supporting file (keeps SKILL.md focused, per "under 500 lines" guidance) - Add cross-references from SKILL.md to the reference file https://claude.ai/code/session_01EsJdvoefdRVjyFXLazdn73

pkg-pr-new · 2026-03-19T13:59:48Z

More templates

@tanstack/angular-db

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

@tanstack/db

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

@tanstack/db-browser-wa-sqlite-persisted-collection

npm i https://pkg.pr.new/TanStack/db/@tanstack/db-browser-wa-sqlite-persisted-collection@1389

@tanstack/db-electron-sqlite-persisted-collection

npm i https://pkg.pr.new/TanStack/db/@tanstack/db-electron-sqlite-persisted-collection@1389

@tanstack/db-ivm

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

@tanstack/db-node-sqlite-persisted-collection

npm i https://pkg.pr.new/TanStack/db/@tanstack/db-node-sqlite-persisted-collection@1389

@tanstack/db-react-native-sqlite-persisted-collection

npm i https://pkg.pr.new/TanStack/db/@tanstack/db-react-native-sqlite-persisted-collection@1389

@tanstack/db-sqlite-persisted-collection-core

npm i https://pkg.pr.new/TanStack/db/@tanstack/db-sqlite-persisted-collection-core@1389

@tanstack/electric-db-collection

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

@tanstack/offline-transactions

npm i https://pkg.pr.new/TanStack/db/@tanstack/offline-transactions@1389

@tanstack/powersync-db-collection

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

@tanstack/query-db-collection

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

@tanstack/react-db

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

@tanstack/rxdb-db-collection

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

@tanstack/solid-db

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

@tanstack/svelte-db

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

@tanstack/trailbase-db-collection

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

@tanstack/vue-db

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

commit: ea5a58a

github-actions · 2026-03-19T14:00:26Z

Size Change: 0 B

Total Size: 110 kB

ℹ️ View Unchanged

Filename	Size
`./packages/db/dist/esm/collection/change-events.js`	1.39 kB
`./packages/db/dist/esm/collection/changes.js`	1.38 kB
`./packages/db/dist/esm/collection/cleanup-queue.js`	810 B
`./packages/db/dist/esm/collection/events.js`	434 B
`./packages/db/dist/esm/collection/index.js`	3.69 kB
`./packages/db/dist/esm/collection/indexes.js`	2.35 kB
`./packages/db/dist/esm/collection/lifecycle.js`	1.76 kB
`./packages/db/dist/esm/collection/mutations.js`	2.47 kB
`./packages/db/dist/esm/collection/state.js`	5.2 kB
`./packages/db/dist/esm/collection/subscription.js`	3.71 kB
`./packages/db/dist/esm/collection/sync.js`	2.43 kB
`./packages/db/dist/esm/collection/transaction-metadata.js`	144 B
`./packages/db/dist/esm/deferred.js`	207 B
`./packages/db/dist/esm/errors.js`	4.83 kB
`./packages/db/dist/esm/event-emitter.js`	748 B
`./packages/db/dist/esm/index.js`	2.85 kB
`./packages/db/dist/esm/indexes/auto-index.js`	777 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.24 kB
`./packages/db/dist/esm/indexes/reverse-index.js`	538 B
`./packages/db/dist/esm/local-only.js`	890 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`	792 B
`./packages/db/dist/esm/query/builder/index.js`	5.15 kB
`./packages/db/dist/esm/query/builder/ref-proxy.js`	1.05 kB
`./packages/db/dist/esm/query/compiler/evaluators.js`	1.62 kB
`./packages/db/dist/esm/query/compiler/expressions.js`	430 B
`./packages/db/dist/esm/query/compiler/group-by.js`	2.69 kB
`./packages/db/dist/esm/query/compiler/index.js`	3.62 kB
`./packages/db/dist/esm/query/compiler/joins.js`	2.11 kB
`./packages/db/dist/esm/query/compiler/order-by.js`	1.5 kB
`./packages/db/dist/esm/query/compiler/select.js`	1.11 kB
`./packages/db/dist/esm/query/effect.js`	4.78 kB
`./packages/db/dist/esm/query/expression-helpers.js`	1.43 kB
`./packages/db/dist/esm/query/ir.js`	784 B
`./packages/db/dist/esm/query/live-query-collection.js`	360 B
`./packages/db/dist/esm/query/live/collection-config-builder.js`	7.63 kB
`./packages/db/dist/esm/query/live/collection-registry.js`	264 B
`./packages/db/dist/esm/query/live/collection-subscriber.js`	1.94 kB
`./packages/db/dist/esm/query/live/internal.js`	145 B
`./packages/db/dist/esm/query/live/utils.js`	1.57 kB
`./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/query-once.js`	359 B
`./packages/db/dist/esm/query/subset-dedupe.js`	960 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`	927 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`	1.05 kB
`./packages/db/dist/esm/utils/cursor.js`	457 B
`./packages/db/dist/esm/utils/index-optimization.js`	1.54 kB
`./packages/db/dist/esm/utils/type-guards.js`	157 B
`./packages/db/dist/esm/virtual-props.js`	360 B

_{compressed-size-action::db-package-size}

github-actions · 2026-03-19T14:01:05Z

Size Change: 0 B

Total Size: 4.23 kB

ℹ️ View Unchanged

Filename	Size
`./packages/react-db/dist/esm/index.js`	249 B
`./packages/react-db/dist/esm/useLiveInfiniteQuery.js`	1.32 kB
`./packages/react-db/dist/esm/useLiveQuery.js`	1.34 kB
`./packages/react-db/dist/esm/useLiveQueryEffect.js`	355 B
`./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}

claude and others added 3 commits March 19, 2026 13:23

ci: apply automated fixes

ea5a58a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add comprehensive testing guide for TanStack DB#1389

docs: add comprehensive testing guide for TanStack DB#1389
KyleAMathews wants to merge 3 commits intomainfrom
claude/add-builtin-tests-docs-3CCwc

KyleAMathews commented Mar 19, 2026

Uh oh!

pkg-pr-new bot commented Mar 19, 2026

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

KyleAMathews commented Mar 19, 2026

🎯 Changes

✅ Checklist

🚀 Release Impact

Uh oh!

pkg-pr-new bot commented Mar 19, 2026

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants