Skip to content
Source
Sign inSign up
TanStack/db

fix(offline): fence individual outbox clear deletions #1836

Mergedtannerlinsleymerged 1 commit intomain fromrefs/pull/1836/headmerged by tannerlinsley

tannerlinsleycommented

Clearing multiple outbox entries now records each successful deletion immediately. Previously an overlapping read could return an already-deleted transaction while another deletion was pending, or after another deletion failed.

Reuse removeMany() so clear has the same per-entry removal fencing as normal acknowledgments. This closes the remaining clear/read boundary from #1822.

Validation: both new regression cases fail before the fix and pass afterward; all 148 offline transaction tests pass, along with standalone TypeScript, changed-file lint, and formatting. Includes a patch changeset.

Summary by CodeRabbit

  • Bug Fixes
    • Improved offline transaction clearing to prevent overlapping reads from returning transactions that were successfully removed.
    • Ensured clearing remains consistent when another transaction deletion is still pending or encounters an error.
    • Improved error handling so failed clearing operations are reported correctly.
    1. Review Change StackReview Change Stack

      No actionable comments were generated in the recent review. 🎉

      ℹ️ Recent review info
      ⚙️ Run configuration

      Configuration used: defaults

      Review profile: CHILL

      Plan: Advanced

      Run ID: 6f0ffaa0-7aab-4f38-a20d-50e927ae0f74

      📥 Commits

      Reviewing files that changed from the base of the PR and between 179d003a14a13ddf48ffacd22b15c25087f7c5f4 and b7b32407ef3549362cead6e0727155f9d0eaba6f.

      📒 Files selected for processing (3)
      • .changeset/fix-outbox-clear-removal-fence.md
      • packages/offline-transactions/src/outbox/OutboxManager.ts
      • packages/offline-transactions/tests/leadership-replay.property.test.ts

      Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.


      📝 Walkthrough

      Walkthrough

      OutboxManager.clear now removes transactions individually through removeMany. A property test verifies that successful deletions fence overlapping reads while peer deletion is pending or fails. A patch changeset documents the fix.

      Changes

      Outbox clear fencing

      Layer / File(s)Summary
      Individual clear deletions
      packages/offline-transactions/src/outbox/OutboxManager.ts, packages/offline-transactions/tests/leadership-replay.property.test.ts, .changeset/fix-outbox-clear-removal-fence.md
      OutboxManager.clear delegates removals to removeMany. The parameterized property test covers pending and failed peer deletions and verifies that in-flight reads exclude successfully removed rows. The changeset records the patch.

      Priority: ⬇️ Low

      Estimated code review effort: 2 (Simple) | ~10 minutes

      Change: Bug fix

      Suggested reviewers: kyleamathews

      Merge Risk: ⚪ Minimal · up to b7b32

      Clear operations now fence each successfully deleted transaction without hiding transactions whose deletion is still pending or failed. No actionable merge risk remains.

      🚥 Pre-merge checks | ✅ 5
      ✅ Passed checks (5 passed)
      Check nameStatusExplanation
      Title check✅ PassedThe title clearly and concisely describes the main change: fencing individual outbox clear deletions.
      Description check✅ PassedThe description explains the change, motivation, validation, test results, and patch changeset. It does not use the template headings or checklist format, but it contains the required information and …
      Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 2…
      Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
      Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
      ✨ 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 `codex/outbox-clear-removal-fence`

      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@1836

      @tanstack/browser-db-sqlite-persistence

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

      @tanstack/capacitor-db-sqlite-persistence

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

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

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

      @tanstack/db

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

      @tanstack/db-ivm

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

      @tanstack/db-sqlite-persistence-core

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

      @tanstack/electric-db-collection

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

      @tanstack/electron-db-sqlite-persistence

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

      @tanstack/expo-db-sqlite-persistence

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

      @tanstack/node-db-sqlite-persistence

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

      @tanstack/offline-transactions

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

      @tanstack/powersync-db-collection

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

      @tanstack/query-db-collection

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

      @tanstack/react-db

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

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

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

      @tanstack/react-router-with-db

      npm i https://pkg.pr.new/@tanstack/react-router-with-db@1836

      @tanstack/rxdb-db-collection

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

      @tanstack/solid-db

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

      @tanstack/svelte-db

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

      @tanstack/tauri-db-sqlite-persistence

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

      @tanstack/trailbase-db-collection

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

      @tanstack/vue-db

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

      commit: b7b3240

    3. Size Change: 0 B

      Total Size: 165 kB

      ℹ️ View Unchanged
      FilenameSize
      packages/db/dist/esm/client.js3.66 kB
      packages/db/dist/esm/collection-options.js236 B
      packages/db/dist/esm/collection/change-events.js1.44 kB
      packages/db/dist/esm/collection/changes.js2.23 kB
      packages/db/dist/esm/collection/cleanup-queue.js794 B
      packages/db/dist/esm/collection/events.js481 B
      packages/db/dist/esm/collection/index.js4.58 kB
      packages/db/dist/esm/collection/indexes.js1.99 kB
      packages/db/dist/esm/collection/lifecycle.js2.15 kB
      packages/db/dist/esm/collection/mutations.js2.53 kB
      packages/db/dist/esm/collection/state.js6.44 kB
      packages/db/dist/esm/collection/subscription.js8.72 kB
      packages/db/dist/esm/collection/sync.js4.62 kB
      packages/db/dist/esm/collection/transaction-metadata.js144 B
      packages/db/dist/esm/deferred.js207 B
      packages/db/dist/esm/errors.js5.26 kB
      packages/db/dist/esm/event-emitter.js964 B
      packages/db/dist/esm/index.js3.68 kB
      packages/db/dist/esm/indexes/auto-index.js829 B
      packages/db/dist/esm/indexes/base-index.js1.14 kB
      packages/db/dist/esm/indexes/basic-index.js2.07 kB
      packages/db/dist/esm/indexes/btree-index.js2.26 kB
      packages/db/dist/esm/indexes/index-registry.js820 B
      packages/db/dist/esm/indexes/reverse-index.js376 B
      packages/db/dist/esm/live-query-adapter.js318 B
      packages/db/dist/esm/live-query-observer.js3.69 kB
      packages/db/dist/esm/live-query-options.js702 B
      packages/db/dist/esm/live-query-window-controller.js4.36 kB
      packages/db/dist/esm/local-only.js975 B
      packages/db/dist/esm/local-storage.js2.15 kB
      packages/db/dist/esm/optimistic-action.js359 B
      packages/db/dist/esm/paced-mutations.js496 B
      packages/db/dist/esm/proxy.js3.32 kB
      packages/db/dist/esm/query/builder/functions.js1.47 kB
      packages/db/dist/esm/query/builder/index.js6.69 kB
      packages/db/dist/esm/query/builder/query-ir.js116 B
      packages/db/dist/esm/query/builder/ref-proxy.js1.24 kB
      packages/db/dist/esm/query/compiler/evaluators.js1.92 kB
      packages/db/dist/esm/query/compiler/expressions.js560 B
      packages/db/dist/esm/query/compiler/group-by.js4.13 kB
      packages/db/dist/esm/query/compiler/index.js9.06 kB
      packages/db/dist/esm/query/compiler/joins.js3 kB
      packages/db/dist/esm/query/compiler/lazy-targets.js1.1 kB
      packages/db/dist/esm/query/compiler/order-by.js1.91 kB
      packages/db/dist/esm/query/compiler/parent-routes.js319 B
      packages/db/dist/esm/query/compiler/route-metadata.js1.24 kB
      packages/db/dist/esm/query/compiler/select.js1.58 kB
      packages/db/dist/esm/query/effect.js4.6 kB
      packages/db/dist/esm/query/equality-value-identity.js591 B
      packages/db/dist/esm/query/expression-helpers.js1.43 kB
      packages/db/dist/esm/query/ir-stable-identity.js4.04 kB
      packages/db/dist/esm/query/ir.js1.59 kB
      packages/db/dist/esm/query/live-query-collection.js391 B
      packages/db/dist/esm/query/live/bucket-facade-adapter.js2.73 kB
      packages/db/dist/esm/query/live/collection-config-builder.js6.97 kB
      packages/db/dist/esm/query/live/collection-registry.js264 B
      packages/db/dist/esm/query/live/collection-subscriber.js2.25 kB
      packages/db/dist/esm/query/live/internal.js145 B
      packages/db/dist/esm/query/live/materialized-pipeline.js2.32 kB
      packages/db/dist/esm/query/live/ordered-source-loader.js3.14 kB
      packages/db/dist/esm/query/live/subset-demand-controller.js1.26 kB
      packages/db/dist/esm/query/live/utils.js1.14 kB
      packages/db/dist/esm/query/optimizer.js2.91 kB
      packages/db/dist/esm/query/query-once.js359 B
      packages/db/dist/esm/query/runtime-reference-identity.js572 B
      packages/db/dist/esm/query/subset-dedupe.js486 B
      packages/db/dist/esm/scheduler.js1.34 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.51 kB
      packages/db/dist/esm/utils.js1.01 kB
      packages/db/dist/esm/utils/array-utils.js270 B
      packages/db/dist/esm/utils/browser-polyfills.js304 B
      packages/db/dist/esm/utils/btree.js4.51 kB
      packages/db/dist/esm/utils/callbacks.js174 B
      packages/db/dist/esm/utils/comparison.js1.49 kB
      packages/db/dist/esm/utils/cursor.js676 B
      packages/db/dist/esm/utils/error.js167 B
      packages/db/dist/esm/utils/get-or-create.js155 B
      packages/db/dist/esm/utils/index-optimization.js2.42 kB
      packages/db/dist/esm/utils/type-guards.js230 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: 7.34 kB

      ℹ️ View Unchanged
      FilenameSize
      packages/react-db/dist/esm/DbProvider.js317 B
      packages/react-db/dist/esm/HydrationBoundary.js263 B
      packages/react-db/dist/esm/index.js330 B
      packages/react-db/dist/esm/live-query-internals.js282 B
      packages/react-db/dist/esm/useLiveInfiniteQuery.js1.9 kB
      packages/react-db/dist/esm/useLiveQuery.js2.68 kB
      packages/react-db/dist/esm/useLiveQueryEffect.js355 B
      packages/react-db/dist/esm/useLiveSuspenseQuery.js812 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

    6. tannerlinsley merged this09776a8

    7. tannerlinsley closed this

Sign in to join this conversation.