-
Notifications
You must be signed in to change notification settings - Fork 158
Fix offline mutations data loss on restart #1124
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
Conversation
The changes field was not included in SerializedMutation, causing it to
be lost during serialization. On deserialization, changes was hardcoded
to {} with a comment "Will be recalculated" but was never actually
recalculated.
This caused any sync function using mutation.changes to receive an empty
object, leading to server writes failing with missing data after app
restart.
The fix:
- Add changes field to SerializedMutation interface
- Serialize changes in serializeMutation using serializeValue
- Deserialize changes in deserializeMutation using deserializeValue
🦋 Changeset detectedLatest commit: af0f614 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 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 |
More templates
@tanstack/angular-db
@tanstack/db
@tanstack/db-ivm
@tanstack/electric-db-collection
@tanstack/offline-transactions
@tanstack/powersync-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: 0 B Total Size: 90.6 kB ℹ️ View Unchanged
|
|
Size Change: 0 B Total Size: 3.7 kB ℹ️ View Unchanged
|
- Add fallback for deserializing data saved before changes field existed - Use Object.prototype.hasOwnProperty.call for safer property checks - Prefix unused JSON callback params with underscore Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Based on this explanation we can simplify this code: changes: data.changes !== undefined
? this.deserializeValue(data.changes)
: {},to this: changes: this.deserializeValue(data.changes) ?? {}, |
Apply Kevin's suggestion to use nullish coalescing for cleaner code:
`this.deserializeValue(data.changes) ?? {}`
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
🎉 This PR has been released! Thank you for your contribution! |
Summary
Fix
mutation.changesbeing lost when offline transactions are persisted and restored. After app restart, sync functions that rely onmutation.changesfor partial updates would receive an empty object{}, causing server writes to fail with missing data.Root Cause
The
changesfield was never added to the serialization flow:SerializedMutationinterface was missing thechangesfieldserializeMutation()didn't serializechangesdeserializeMutation()hardcodedchanges: {}with a misleading comment "Will be recalculated"The comment was wrong—
changeswas never recalculated anywhere. This meant any mutation function using the common patternapi.update(id, mutation.changes)would send empty updates after restart.Approach
Add
changesto the serialization round-trip, mirroring howmodifiedandoriginalare already handled:The legacy fallback handles data serialized before this fix—without it,
deserializeValue(undefined)would returnundefined, causingTypeErrorwhen downstream code accesses properties onchanges.Key Invariants
mutation.changesmust survive the serialize → persist → deserialize cycle unchangedchangesfield) must deserialize without errorsNon-goals
{}matches the previous (broken) behavior, so existing data continues to work as beforeOutboxManager—that's pre-existing and out of scopeVerification
All 26 tests pass. The existing "replays persisted transactions on startup" e2e test exercises this code path.
Files Changed
types.tschanges: anytoSerializedMutationinterfaceTransactionSerializer.tschangesfield with legacy fallbackTransactionSerializer.tshasOwnProperty, unused param prefixes