Skip to content
Source
Sign inSign up
TanStack/db

Add getOptimisticInfo() method to track optimistic state per record #660

ClosedKyleAMathews(GitHub profile, opens in a new tab)wants to merge 2 commits intomain fromadd-getOptimisticInfoopened

Summary

Implements collection.getOptimisticInfo(id) to provide rich metadata about optimistic state for a given record.

Returns:

  • isOptimistic: boolean flag indicating if record has active mutations
  • original: pre-mutation state (for updates)
  • modified: current state including optimistic changes
  • changes: delta of modifications (for updates)
  • mutations: array of all active mutations affecting the record

Usage:

const info = collection.getOptimisticInfo(todoId)
if (info?.isOptimistic) {
  return <Badge>Saving...</Badge>
}

// Or for diff views:
if (info?.changes) {
  showDiff(info.original, info.modified, info.changes)
}

This provides everything needed for UI states like loading badges, diff views, and rollback UI while keeping records pure (no __optimistic field polluting user data).

Closes #20

Test plan

  • ✅ Comprehensive test coverage (12 new tests)
  • ✅ All existing tests pass (69 test files, 1289 tests)
    1. 🦋 Changeset detected

      Latest commit: 96e987eb7abf03263490a73d1058addc4e23dfe2

      The changes in this PR will be included in the next version bump.

      This PR includes changesets to release 12 packages
      NameType
      @tanstack/dbPatch
      @tanstack/angular-dbPatch
      @tanstack/electric-db-collectionPatch
      @tanstack/query-db-collectionPatch
      @tanstack/react-dbPatch
      @tanstack/rxdb-db-collectionPatch
      @tanstack/solid-dbPatch
      @tanstack/svelte-dbPatch
      @tanstack/trailbase-db-collectionPatch
      @tanstack/vue-dbPatch
      todosPatch
      @tanstack/db-example-react-todoPatch

      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

    2. More templates

      @tanstack/angular-db

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

      @tanstack/db

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

      @tanstack/db-ivm

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

      @tanstack/electric-db-collection

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

      @tanstack/query-db-collection

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

      @tanstack/react-db

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

      @tanstack/rxdb-db-collection

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

      @tanstack/solid-db

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

      @tanstack/svelte-db

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

      @tanstack/trailbase-db-collection

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

      @tanstack/vue-db

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

      commit: 96e987e

    3. Size Change: +464 B (+0.61%)

      Total Size: 76.9 kB

      FilenameSizeChange
      ./packages/db/dist/esm/collection/index.js3.59 kB+286 B (+8.65%)🔍
      ./packages/db/dist/esm/collection/state.js4 kB+178 B (+4.65%)🔍
      ℹ️ View Unchanged
      FilenameSize
      ./packages/db/dist/esm/collection/change-events.js963 B
      ./packages/db/dist/esm/collection/changes.js1.01 kB
      ./packages/db/dist/esm/collection/events.js660 B
      ./packages/db/dist/esm/collection/indexes.js1.16 kB
      ./packages/db/dist/esm/collection/lifecycle.js1.82 kB
      ./packages/db/dist/esm/collection/mutations.js2.52 kB
      ./packages/db/dist/esm/collection/subscription.js1.83 kB
      ./packages/db/dist/esm/collection/sync.js1.65 kB
      ./packages/db/dist/esm/deferred.js230 B
      ./packages/db/dist/esm/errors.js3.1 kB
      ./packages/db/dist/esm/index.js1.58 kB
      ./packages/db/dist/esm/indexes/auto-index.js828 B
      ./packages/db/dist/esm/indexes/base-index.js835 B
      ./packages/db/dist/esm/indexes/btree-index.js2 kB
      ./packages/db/dist/esm/indexes/lazy-index.js1.21 kB
      ./packages/db/dist/esm/indexes/reverse-index.js577 B
      ./packages/db/dist/esm/local-only.js967 B
      ./packages/db/dist/esm/local-storage.js2.33 kB
      ./packages/db/dist/esm/optimistic-action.js294 B
      ./packages/db/dist/esm/proxy.js3.86 kB
      ./packages/db/dist/esm/query/builder/functions.js615 B
      ./packages/db/dist/esm/query/builder/index.js4.04 kB
      ./packages/db/dist/esm/query/builder/ref-proxy.js938 B
      ./packages/db/dist/esm/query/compiler/evaluators.js1.55 kB
      ./packages/db/dist/esm/query/compiler/expressions.js760 B
      ./packages/db/dist/esm/query/compiler/group-by.js2.04 kB
      ./packages/db/dist/esm/query/compiler/index.js2.04 kB
      ./packages/db/dist/esm/query/compiler/joins.js2.52 kB
      ./packages/db/dist/esm/query/compiler/order-by.js1.21 kB
      ./packages/db/dist/esm/query/compiler/select.js1.28 kB
      ./packages/db/dist/esm/query/ir.js785 B
      ./packages/db/dist/esm/query/live-query-collection.js340 B
      ./packages/db/dist/esm/query/live/collection-config-builder.js2.69 kB
      ./packages/db/dist/esm/query/live/collection-subscriber.js1.92 kB
      ./packages/db/dist/esm/query/optimizer.js3.08 kB
      ./packages/db/dist/esm/SortedMap.js1.24 kB
      ./packages/db/dist/esm/transactions.js3 kB
      ./packages/db/dist/esm/utils.js1.01 kB
      ./packages/db/dist/esm/utils/browser-polyfills.js365 B
      ./packages/db/dist/esm/utils/btree.js6.01 kB
      ./packages/db/dist/esm/utils/comparison.js754 B
      ./packages/db/dist/esm/utils/index-optimization.js1.73 kB
      compressed-size-action::db-package-size
    4. Size Change: 0 B

      Total Size: 1.47 kB

      ℹ️ View Unchanged
      FilenameSize
      ./packages/react-db/dist/esm/index.js152 B
      ./packages/react-db/dist/esm/useLiveQuery.js1.32 kB
      compressed-size-action::react-db-package-size
    5. Closing this for now — @samwillis pointed out that using this in a component is problematic as the component doesn't necessarily re-render when a record goes from optimistic to synced so there needs to be a way to query a $status field on the record (or some similar design) so it's properly reactive.

      This isn't a priority atm so we'll pick this up later.

Sign in to join this conversation.