-
Notifications
You must be signed in to change notification settings - Fork 99
Add acceptMutations utility for local collections in manual transactions #638
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
KyleAMathews
wants to merge
6
commits into
main
Choose a base branch
from
fix-local-collections-manual-transactions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #446 Local-only and local-storage collections now expose `utils.acceptMutations(transaction, collection)` that must be called in manual transaction `mutationFn` to persist mutations. This provides explicit control over when local mutations are persisted, following the pattern established by query-db-collection. Changes: - Add acceptMutations to LocalOnlyCollectionUtils interface - Add acceptMutations to LocalStorageCollectionUtils interface - Include JSON serialization validation in local-storage acceptMutations - Update documentation with manual transaction usage examples 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
🦋 Changeset detectedLatest commit: dbfe4c8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
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 |
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Replace `unknown` with `Record<string, unknown>` in PendingMutation type parameters and related generics to satisfy the `T extends object` constraint. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
More templates
@tanstack/angular-db
@tanstack/db
@tanstack/db-ivm
@tanstack/electric-db-collection
@tanstack/query-db-collection
@tanstack/react-db
@tanstack/rxdb-db-collection
@tanstack/solid-db
@tanstack/svelte-db
@tanstack/trailbase-db-collection
@tanstack/vue-db
commit: |
Size Change: +242 B (+0.32%) Total Size: 75.4 kB
ℹ️ View Unchanged
|
Size Change: 0 B Total Size: 1.47 kB ℹ️ View Unchanged
|
…-manual-transactions
Add LocalOnlyCollectionUtils type parameter to createCollection call to satisfy type constraints after merge. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
utils.acceptMutations(transaction, collection)
to local-only and local-storage collectionsContext
Manual transactions with local-only and local-storage collections were losing changes because these collections rely on their mutation handlers (
onInsert
/onUpdate
/onDelete
) being called to persist data. When operations occur insidetx.mutate()
, handlers aren't automatically called - only the outer transaction'smutationFn
runs.Solution
Following the pattern from
@tanstack/query-db-collection
, both collection types now expose autils.acceptMutations(transaction, collection)
method that users explicitly call in their transaction'smutationFn
to persist local mutations:Changes
acceptMutations
toLocalOnlyCollectionUtils
interfaceacceptMutations
toLocalStorageCollectionUtils
interfaceTest plan
🤖 Generated with Claude Code