Compare commits
No commits in common. '624d0c5a6d45a9d579b1577db5159510628228dd' and '177e2f2739f0185f87917f32cc37e772b33e6eb6' have entirely different histories.
624d0c5a6d
...
177e2f2739
@ -1,340 +0,0 @@ |
|||||||
import { describe, it, expect } from "vitest"; |
|
||||||
import { deepSignal, DeepPatch, DeepSignalOptions } from "../deepSignal"; |
|
||||||
import { watch } from "../watch"; |
|
||||||
|
|
||||||
describe("deepSignal options", () => { |
|
||||||
describe("custom ID generator", () => { |
|
||||||
it("uses custom ID generator for objects without @id", async () => { |
|
||||||
let counter = 1000; |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
idGenerator: () => `custom-${counter++}`, |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ data: {} as any }, options); |
|
||||||
const patches: DeepPatch[][] = []; |
|
||||||
const { stopListening: stop } = watch(state, ({ patches: batch }) => |
|
||||||
patches.push(batch) |
|
||||||
); |
|
||||||
|
|
||||||
state.data.user = { name: "Alice" }; |
|
||||||
await Promise.resolve(); |
|
||||||
|
|
||||||
// Check that @id was assigned
|
|
||||||
expect((state.data.user as any)["@id"]).toBe("custom-1000"); |
|
||||||
|
|
||||||
// Check that patch was emitted for @id
|
|
||||||
const flat = patches.flat().map((p) => p.path.join(".")); |
|
||||||
expect(flat).toContain("data.user.@id"); |
|
||||||
|
|
||||||
stop(); |
|
||||||
}); |
|
||||||
|
|
||||||
it("respects existing @id on objects", async () => { |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
idGenerator: () => "should-not-be-used", |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ items: [] as any[] }, options); |
|
||||||
|
|
||||||
state.items.push({ "@id": "existing-123", value: 42 }); |
|
||||||
|
|
||||||
// Should use the existing @id
|
|
||||||
expect((state.items[0] as any)["@id"]).toBe("existing-123"); |
|
||||||
}); |
|
||||||
|
|
||||||
it("uses @id property from objects added to Sets", async () => { |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
idGenerator: () => "fallback-id", |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ s: new Set<any>() }, options); |
|
||||||
const patches: DeepPatch[][] = []; |
|
||||||
const { stopListening: stop } = watch(state, ({ patches: batch }) => |
|
||||||
patches.push(batch) |
|
||||||
); |
|
||||||
|
|
||||||
const obj = { "@id": "set-entry-1", data: "test" }; |
|
||||||
state.s.add(obj); |
|
||||||
|
|
||||||
await Promise.resolve(); |
|
||||||
|
|
||||||
const flat = patches.flat().map((p) => p.path.join(".")); |
|
||||||
// Path should use the @id as synthetic key
|
|
||||||
expect(flat.some((p) => p.startsWith("s.set-entry-1"))).toBe(true); |
|
||||||
|
|
||||||
stop(); |
|
||||||
}); |
|
||||||
}); |
|
||||||
|
|
||||||
describe("addIdToObjects option", () => { |
|
||||||
it("adds @id to all nested objects when enabled", async () => { |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ root: {} as any }, options); |
|
||||||
const patches: DeepPatch[][] = []; |
|
||||||
const { stopListening: stop } = watch(state, ({ patches: batch }) => |
|
||||||
patches.push(batch) |
|
||||||
); |
|
||||||
|
|
||||||
state.root.level1 = { |
|
||||||
level2: { |
|
||||||
level3: { value: "deep" }, |
|
||||||
}, |
|
||||||
}; |
|
||||||
|
|
||||||
await Promise.resolve(); |
|
||||||
|
|
||||||
// Check all levels have @id
|
|
||||||
expect((state.root.level1 as any)["@id"]).toBeDefined(); |
|
||||||
expect((state.root.level1.level2 as any)["@id"]).toBeDefined(); |
|
||||||
expect( |
|
||||||
(state.root.level1.level2.level3 as any)["@id"] |
|
||||||
).toBeDefined(); |
|
||||||
|
|
||||||
// Check patches were emitted for all @id fields
|
|
||||||
const flat = patches.flat().map((p) => p.path.join(".")); |
|
||||||
expect(flat).toContain("root.level1.@id"); |
|
||||||
expect(flat).toContain("root.level1.level2.@id"); |
|
||||||
expect(flat).toContain("root.level1.level2.level3.@id"); |
|
||||||
|
|
||||||
stop(); |
|
||||||
}); |
|
||||||
|
|
||||||
it("does not add @id when option is false", () => { |
|
||||||
const state = deepSignal({ data: { nested: {} } }); |
|
||||||
|
|
||||||
// Should not have @id
|
|
||||||
expect("@id" in (state.data as any)).toBe(false); |
|
||||||
expect("@id" in (state.data.nested as any)).toBe(false); |
|
||||||
}); |
|
||||||
|
|
||||||
it("adds @id to objects in arrays", async () => { |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ items: [] as any[] }, options); |
|
||||||
const patches: DeepPatch[][] = []; |
|
||||||
const { stopListening: stop } = watch(state, ({ patches: batch }) => |
|
||||||
patches.push(batch) |
|
||||||
); |
|
||||||
|
|
||||||
state.items.push({ name: "Item 1" }, { name: "Item 2" }); |
|
||||||
|
|
||||||
await Promise.resolve(); |
|
||||||
|
|
||||||
// Both items should have @id
|
|
||||||
expect((state.items[0] as any)["@id"]).toBeDefined(); |
|
||||||
expect((state.items[1] as any)["@id"]).toBeDefined(); |
|
||||||
|
|
||||||
// Check patches
|
|
||||||
const flat = patches.flat().map((p) => p.path.join(".")); |
|
||||||
expect(flat).toContain("items.0.@id"); |
|
||||||
expect(flat).toContain("items.1.@id"); |
|
||||||
|
|
||||||
stop(); |
|
||||||
}); |
|
||||||
|
|
||||||
it("adds @id to objects in Sets", async () => { |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
idGenerator: () => |
|
||||||
`gen-${Math.random().toString(36).substr(2, 9)}`, |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ s: new Set<any>() }, options); |
|
||||||
const patches: DeepPatch[][] = []; |
|
||||||
const { stopListening: stop } = watch(state, ({ patches: batch }) => |
|
||||||
patches.push(batch) |
|
||||||
); |
|
||||||
|
|
||||||
const obj1 = { value: 1 }; |
|
||||||
const obj2 = { value: 2 }; |
|
||||||
state.s.add(obj1); |
|
||||||
state.s.add(obj2); |
|
||||||
|
|
||||||
await Promise.resolve(); |
|
||||||
|
|
||||||
// Get proxied objects from Set
|
|
||||||
const proxiedObjs = Array.from(state.s); |
|
||||||
expect((proxiedObjs[0] as any)["@id"]).toBeDefined(); |
|
||||||
expect((proxiedObjs[1] as any)["@id"]).toBeDefined(); |
|
||||||
|
|
||||||
// @id should be used as synthetic key in paths
|
|
||||||
const flat = patches.flat().map((p) => p.path.join(".")); |
|
||||||
const obj1Id = (proxiedObjs[0] as any)["@id"]; |
|
||||||
const obj2Id = (proxiedObjs[1] as any)["@id"]; |
|
||||||
expect(flat.some((p) => p.startsWith(`s.${obj1Id}`))).toBe(true); |
|
||||||
expect(flat.some((p) => p.startsWith(`s.${obj2Id}`))).toBe(true); |
|
||||||
|
|
||||||
stop(); |
|
||||||
}); |
|
||||||
}); |
|
||||||
|
|
||||||
describe("@id property behavior", () => { |
|
||||||
it("makes @id readonly", () => { |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ obj: {} as any }, options); |
|
||||||
state.obj.data = { value: 1 }; |
|
||||||
|
|
||||||
// Attempting to modify @id should throw
|
|
||||||
expect(() => { |
|
||||||
(state.obj.data as any)["@id"] = "new-id"; |
|
||||||
}).toThrow("Cannot modify readonly property '@id'"); |
|
||||||
}); |
|
||||||
|
|
||||||
it("makes @id enumerable", () => { |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ obj: {} as any }, options); |
|
||||||
state.obj.data = { value: 1 }; |
|
||||||
|
|
||||||
// @id should show up in Object.keys()
|
|
||||||
const keys = Object.keys(state.obj.data); |
|
||||||
expect(keys).toContain("@id"); |
|
||||||
}); |
|
||||||
|
|
||||||
it("emits patches for @id even on objects with existing @id", async () => { |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ container: {} as any }, options); |
|
||||||
const patches: DeepPatch[][] = []; |
|
||||||
const { stopListening: stop } = watch(state, ({ patches: batch }) => |
|
||||||
patches.push(batch) |
|
||||||
); |
|
||||||
|
|
||||||
// Object already has @id before being added
|
|
||||||
const objWithId = { "@id": "pre-existing", data: "test" }; |
|
||||||
state.container.item = objWithId; |
|
||||||
|
|
||||||
await Promise.resolve(); |
|
||||||
|
|
||||||
const flat = patches.flat().map((p) => p.path.join(".")); |
|
||||||
// Patch should still be emitted for @id
|
|
||||||
expect(flat).toContain("container.item.@id"); |
|
||||||
|
|
||||||
// Verify the value in the patch
|
|
||||||
const idPatch = patches |
|
||||||
.flat() |
|
||||||
.find((p) => p.path.join(".") === "container.item.@id"); |
|
||||||
expect((idPatch as any).value).toBe("pre-existing"); |
|
||||||
|
|
||||||
stop(); |
|
||||||
}); |
|
||||||
}); |
|
||||||
|
|
||||||
describe("options inheritance", () => { |
|
||||||
it("child objects inherit options from root", async () => { |
|
||||||
let idCounter = 5000; |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
idGenerator: () => `inherited-${idCounter++}`, |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ root: {} as any }, options); |
|
||||||
|
|
||||||
// Add nested structure
|
|
||||||
state.root.child = { |
|
||||||
grandchild: { |
|
||||||
value: "nested", |
|
||||||
}, |
|
||||||
}; |
|
||||||
|
|
||||||
// All should have IDs generated by the custom generator
|
|
||||||
expect((state.root.child as any)["@id"]).toMatch(/^inherited-/); |
|
||||||
expect((state.root.child.grandchild as any)["@id"]).toMatch( |
|
||||||
/^inherited-/ |
|
||||||
); |
|
||||||
}); |
|
||||||
|
|
||||||
it("objects added to Sets inherit options", async () => { |
|
||||||
let counter = 9000; |
|
||||||
const options: DeepSignalOptions = { |
|
||||||
idGenerator: () => `set-child-${counter++}`, |
|
||||||
addIdToObjects: true, |
|
||||||
}; |
|
||||||
|
|
||||||
const state = deepSignal({ s: new Set<any>() }, options); |
|
||||||
|
|
||||||
const obj = { nested: { value: 1 } }; |
|
||||||
state.s.add(obj); |
|
||||||
|
|
||||||
// Iterate to get proxied object
|
|
||||||
const proxied = Array.from(state.s)[0]; |
|
||||||
|
|
||||||
// Object and nested object should have custom IDs
|
|
||||||
expect((proxied as any)["@id"]).toMatch(/^set-child-/); |
|
||||||
expect((proxied.nested as any)["@id"]).toMatch(/^set-child-/); |
|
||||||
}); |
|
||||||
}); |
|
||||||
|
|
||||||
describe("backward compatibility", () => { |
|
||||||
it("still works without options", async () => { |
|
||||||
const state = deepSignal({ data: { value: 1 } }); |
|
||||||
const patches: DeepPatch[][] = []; |
|
||||||
const { stopListening: stop } = watch(state, ({ patches: batch }) => |
|
||||||
patches.push(batch) |
|
||||||
); |
|
||||||
|
|
||||||
state.data.value = 2; |
|
||||||
await Promise.resolve(); |
|
||||||
|
|
||||||
expect(patches.flat().length).toBeGreaterThan(0); |
|
||||||
stop(); |
|
||||||
}); |
|
||||||
|
|
||||||
// TODO: Delete duplicate logic for `id`. Only accept @id.
|
|
||||||
it("objects with id property still work for Sets", async () => { |
|
||||||
const state = deepSignal({ s: new Set<any>() }); |
|
||||||
const patches: DeepPatch[][] = []; |
|
||||||
const { stopListening: stop } = watch(state, ({ patches: batch }) => |
|
||||||
patches.push(batch) |
|
||||||
); |
|
||||||
|
|
||||||
state.s.add({ id: "legacy-id", value: 1 }); |
|
||||||
await Promise.resolve(); |
|
||||||
|
|
||||||
const flat = patches.flat().map((p) => p.path.join(".")); |
|
||||||
// Should use id as synthetic key
|
|
||||||
expect(flat.some((p) => p.startsWith("s.legacy-id"))).toBe(true); |
|
||||||
|
|
||||||
stop(); |
|
||||||
}); |
|
||||||
|
|
||||||
it("@id takes precedence over id property", async () => { |
|
||||||
const state = deepSignal({ s: new Set<any>() }); |
|
||||||
const patches: DeepPatch[][] = []; |
|
||||||
const { stopListening: stop } = watch(state, ({ patches: batch }) => |
|
||||||
patches.push(batch) |
|
||||||
); |
|
||||||
|
|
||||||
state.s.add({ |
|
||||||
id: "should-not-use", |
|
||||||
"@id": "should-use", |
|
||||||
value: 1, |
|
||||||
}); |
|
||||||
await Promise.resolve(); |
|
||||||
|
|
||||||
const flat = patches.flat().map((p) => p.path.join(".")); |
|
||||||
// Should use @id, not id
|
|
||||||
expect(flat.some((p) => p.startsWith("s.should-use"))).toBe(true); |
|
||||||
expect(flat.some((p) => p.startsWith("s.should-not-use"))).toBe( |
|
||||||
false |
|
||||||
); |
|
||||||
|
|
||||||
stop(); |
|
||||||
}); |
|
||||||
}); |
|
||||||
}); |
|
||||||
Loading…
Reference in new issue