update() silently corrupts custom class instances in fields the callback doesn't touch
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.9k
- Forks
- 266
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 55
Description
- I've validated the bug against the latest version of DB packages
update()'s draft is built via a deepClone() that only preserves the prototype for a fixed allowlist of types (Date, RegExp, Array, typed arrays, Map, Set, Temporal.*). Any other class instance is cloned into a plain {} with the same properties but no prototype.
A field the callback assigns directly is fine (the value is stored as-is, bypassing deepClone). But any sibling field the callback doesn't touch is silently replaced by a prototype-less clone, so editing one field on a row corrupts every other field which contains a custom class instance, even though nothing about it changed.
This is easy to miss (the corrupted value still looks more or less right in a debugger, since the shape matches) and tends to surface later, e.g. as an instanceof check failing once the value is serialized and re-validated. That's how I found it: a zod z.custom(v => v instanceof MyClass) check started failing on partial updates, for a field the update never touched.
update()'s draft is documented as "Immer-style," and this is a divergence from Immer's actual behavior for such values: un-marked values (any class instance without immerable) are simply not drafted. Immer leaves them alone, by reference, untouched.
Reproduction
import { createCollection, localOnlyCollectionOptions } from "@tanstack/db";
class Money {
constructor(public cents: number) {}
}
const collection = createCollection(
localOnlyCollectionOptions({
getKey: (item: { id: string; price: Money; name: string }) => item.id,
initialData: [{ id: "x", price: new Money(500), name: "Widget" }],
})
);
collection.update("x", (draft) => {
draft.name = "Gadget"; // doesn't touch `price`
});
const after = collection.get("x")!;
console.log(after.price instanceof Money); // false — expected true
console.log(after.price); // { cents: 500 } — prototype gone
Expected vs actual
Expected: after.price is unchanged and still instanceof Money.
Actual: after.price is a plain object with matching properties but no prototype.
Impact
Any collection with a custom class instance as a field value — a value object, a domain type, anything outside the built-in allowlist — silently loses that value's type on any update() that doesn't happen to also reassign it. In my case this broke partial edits to a row with multiple class-instance fields, and only surfaced as a downstream validation error, not at the point of corruption.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the collection update() implementation and its deepClone() path, then reproduce the issue with the Money example from the report. Verify that updating name leaves price as the original class instance, including its prototype, and add or run coverage for this partial-update case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- database
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100