Implement disposeFiber for fiber tree disposal

Add disposeFiber() function that performs bottom-up teardown of fiber
subtrees: recursively disposes children before parents, calls
host.finalizeInstance for per-instance cleanup, invokes signal disposers,
and clears fiber state. Idempotent via disposed flag. Does NOT call
host.removeChild (that's the commit phase's job).

- Add disposeFiber + HostLike to src/host/fiber.ts
- Add finalizeInstance to HostConfig interface
- Add disposed boolean to Fiber interface
- Export disposeFiber and HostLike from barrel
- Add 7 tests for disposeFiber (3-level tree, idempotency, signal cleanup, etc.)
This commit is contained in:
2026-05-18 17:22:05 +00:00
parent 1e0abb0900
commit 95995f4602
7 changed files with 279 additions and 3 deletions

View File

@@ -30,6 +30,7 @@ export interface HostConfig<TTag extends string, Instance, RootCtx> {
ctx: RootCtx, ctx: RootCtx,
): void; ): void;
emit?(type: string, id: string, payload: unknown): void; emit?(type: string, id: string, payload: unknown): void;
finalizeInstance?(instance: Instance, ctx: RootCtx): void;
} }
export interface Root<TTag extends string, Instance, RootCtx> { export interface Root<TTag extends string, Instance, RootCtx> {
@@ -70,6 +71,7 @@ export function createRoot<TTag extends string, Instance, RootCtx>(
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
if (parentFiber) parentFiber.children.push(fiber); if (parentFiber) parentFiber.children.push(fiber);
return fiber; return fiber;
@@ -106,6 +108,7 @@ export function createRoot<TTag extends string, Instance, RootCtx>(
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
for (const child of el.children) { for (const child of el.children) {
@@ -132,6 +135,7 @@ export function createRoot<TTag extends string, Instance, RootCtx>(
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
} }
@@ -158,6 +162,7 @@ export function createRoot<TTag extends string, Instance, RootCtx>(
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
for (const child of el.children) { for (const child of el.children) {
@@ -281,6 +286,7 @@ export function createRoot<TTag extends string, Instance, RootCtx>(
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
const payloadChildren = isURoot(node) ? (node as URoot).children : [node]; const payloadChildren = isURoot(node) ? (node as URoot).children : [node];
for (const child of payloadChildren) { for (const child of payloadChildren) {

View File

@@ -8,10 +8,34 @@ export interface Fiber<I> {
effect: Effect<I> | null; effect: Effect<I> | null;
signalDisposers: (() => void)[]; signalDisposers: (() => void)[];
prevProps: Record<string, unknown> | null; prevProps: Record<string, unknown> | null;
disposed: boolean;
} }
export type Effect<I> = export type Effect<I> =
| { type: "update"; payload: unknown } | { type: "update"; payload: unknown }
| { type: "insert"; before: Fiber<I> | null } | { type: "insert"; before: Fiber<I> | null }
| { type: "move"; before: Fiber<I> | null } | { type: "move"; before: Fiber<I> | null }
| { type: "remove" }; | { type: "remove" };
export interface HostLike<I, Ctx> {
finalizeInstance?(instance: I, ctx: Ctx): void;
}
export function disposeFiber<I, Ctx>(fiber: Fiber<I>, host: HostLike<I, Ctx>, ctx: Ctx): void {
if (fiber.disposed) return;
for (const child of fiber.children) {
disposeFiber(child, host, ctx);
}
host.finalizeInstance?.(fiber.instance, ctx);
for (const disposer of fiber.signalDisposers) {
disposer();
}
fiber.signalDisposers = [];
fiber.parent = null;
fiber.effect = null;
fiber.disposed = true;
}

View File

@@ -19,7 +19,8 @@ export { ValuePointer, selectNode, setNode } from "./core/pointer.js";
export { createRoot as createHostRoot } from "./host/config.js"; export { createRoot as createHostRoot } from "./host/config.js";
export type { HostConfig, Root } from "./host/config.js"; export type { HostConfig, Root } from "./host/config.js";
export type { Fiber, Effect } from "./host/fiber.js"; export { disposeFiber } from "./host/fiber.js";
export type { Fiber, Effect, HostLike } from "./host/fiber.js";
export { scheduleUpdate, flushUpdates, reconcileProps, commitEffects, commitMutations, wireSignalToFiber, resetUpdateQueue, reconcileChildren, longestIncreasingSubsequence } from "./host/reconcile.js"; export { scheduleUpdate, flushUpdates, reconcileProps, commitEffects, commitMutations, wireSignalToFiber, resetUpdateQueue, reconcileChildren, longestIncreasingSubsequence } from "./host/reconcile.js";
export type { MatchedChild, ChildClassification, CommitContext } from "./host/reconcile.js"; export type { MatchedChild, ChildClassification, CommitContext } from "./host/reconcile.js";

View File

@@ -210,6 +210,7 @@ describe("commitMutations direct", () => {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
} }

View File

@@ -1,5 +1,6 @@
import { describe, it, expect, expectTypeOf } from "vitest"; import { describe, it, expect, expectTypeOf } from "vitest";
import type { Fiber, Effect } from "../src/host/fiber.js"; import type { Fiber, Effect, HostLike } from "../src/host/fiber.js";
import { disposeFiber } from "../src/host/fiber.js";
describe("Fiber<I> interface", () => { describe("Fiber<I> interface", () => {
it("has all required fields", () => { it("has all required fields", () => {
@@ -13,6 +14,7 @@ describe("Fiber<I> interface", () => {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
expect(fiber.instance).toBe("inst-1"); expect(fiber.instance).toBe("inst-1");
expect(fiber.tag).toBe("div"); expect(fiber.tag).toBe("div");
@@ -36,6 +38,7 @@ describe("Fiber<I> interface", () => {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
expect(fiber.key).toBeUndefined(); expect(fiber.key).toBeUndefined();
}); });
@@ -51,6 +54,7 @@ describe("Fiber<I> interface", () => {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
const child: Fiber<string> = { const child: Fiber<string> = {
instance: "child-inst", instance: "child-inst",
@@ -62,6 +66,7 @@ describe("Fiber<I> interface", () => {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
parent.children.push(child); parent.children.push(child);
expect(child.parent).toBe(parent); expect(child.parent).toBe(parent);
@@ -80,6 +85,7 @@ describe("Fiber<I> interface", () => {
effect: null, effect: null,
signalDisposers: [() => disposed.push("a"), () => disposed.push("b")], signalDisposers: [() => disposed.push("a"), () => disposed.push("b")],
prevProps: null, prevProps: null,
disposed: false,
}; };
fiber.signalDisposers.forEach((d) => d()); fiber.signalDisposers.forEach((d) => d());
expect(disposed).toEqual(["a", "b"]); expect(disposed).toEqual(["a", "b"]);
@@ -109,6 +115,7 @@ describe("Effect<I> union type", () => {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
const effect: Effect<string> = { type: "insert", before }; const effect: Effect<string> = { type: "insert", before };
expect(effect.type).toBe("insert"); expect(effect.type).toBe("insert");
@@ -126,6 +133,7 @@ describe("Effect<I> union type", () => {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
const effect: Effect<string> = { type: "move", before }; const effect: Effect<string> = { type: "move", before };
expect(effect.type).toBe("move"); expect(effect.type).toBe("move");
@@ -153,6 +161,7 @@ describe("Effect<I> union type", () => {
effect: { type: "update", payload: "x" }, effect: { type: "update", payload: "x" },
signalDisposers: [], signalDisposers: [],
prevProps: {}, prevProps: {},
disposed: false,
}; };
expect(fiber.effect!.type).toBe("update"); expect(fiber.effect!.type).toBe("update");
@@ -184,9 +193,242 @@ describe("Fiber re-export from barrel", () => {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
const _effect: _EffectCheck = { type: "remove" }; const _effect: _EffectCheck = { type: "remove" };
expect(_fiber.instance).toBe("inst"); expect(_fiber.instance).toBe("inst");
expect(_effect.type).toBe("remove"); expect(_effect.type).toBe("remove");
}); });
});
describe("disposeFiber", () => {
it("disposes a 3-level tree bottom-up: children before parent", () => {
const finalized: string[] = [];
const disposed: string[] = [];
const ctx = {};
const host: HostLike<string, typeof ctx> = {
finalizeInstance(instance, _ctx) {
finalized.push(instance);
},
};
const grandchild: Fiber<string> = {
instance: "gc",
tag: "span",
props: {},
key: undefined,
children: [],
parent: null as unknown as Fiber<string>,
effect: null,
signalDisposers: [() => disposed.push("gc-signal")],
prevProps: null,
disposed: false,
};
const child: Fiber<string> = {
instance: "child",
tag: "div",
props: {},
key: undefined,
children: [grandchild],
parent: null as unknown as Fiber<string>,
effect: { type: "update", payload: null },
signalDisposers: [() => disposed.push("child-signal")],
prevProps: null,
disposed: false,
};
const root: Fiber<string> = {
instance: "root",
tag: "root",
props: {},
key: undefined,
children: [child],
parent: null,
effect: null,
signalDisposers: [() => disposed.push("root-signal")],
prevProps: null,
disposed: false,
};
child.parent = root;
grandchild.parent = child;
disposeFiber(root, host, ctx);
expect(finalized).toEqual(["gc", "child", "root"]);
expect(disposed).toEqual(["gc-signal", "child-signal", "root-signal"]);
});
it("idempotent: double-dispose does not error or double-call", () => {
const finalized: string[] = [];
const disposed: string[] = [];
const ctx = {};
const host: HostLike<string, typeof ctx> = {
finalizeInstance(instance) {
finalized.push(instance);
},
};
const fiber: Fiber<string> = {
instance: "inst",
tag: "div",
props: {},
key: undefined,
children: [],
parent: null,
effect: { type: "update", payload: null },
signalDisposers: [() => disposed.push("sig")],
prevProps: null,
disposed: false,
};
disposeFiber(fiber, host, ctx);
disposeFiber(fiber, host, ctx);
expect(finalized).toEqual(["inst"]);
expect(disposed).toEqual(["sig"]);
expect(fiber.signalDisposers).toEqual([]);
expect(fiber.parent).toBeNull();
expect(fiber.effect).toBeNull();
});
it("signal subscriptions are cleaned up (effect no longer fires after dispose)", () => {
let callCount = 0;
const ctx = {};
const host: HostLike<string, typeof ctx> = {};
const disposer = () => { callCount = -1; };
const fiber: Fiber<string> = {
instance: "inst",
tag: "div",
props: {},
key: undefined,
children: [],
parent: null,
effect: null,
signalDisposers: [disposer],
prevProps: null,
disposed: false,
};
disposeFiber(fiber, host, ctx);
expect(fiber.signalDisposers).toEqual([]);
expect(callCount).toBe(-1);
});
it("does not call removeChild on host", () => {
const ctx = {};
const operations: string[] = [];
const host: HostLike<string, typeof ctx> = {
finalizeInstance() {
operations.push("finalizeInstance");
},
};
const fiber: Fiber<string> = {
instance: "inst",
tag: "div",
props: {},
key: undefined,
children: [],
parent: null,
effect: null,
signalDisposers: [],
prevProps: null,
disposed: false,
};
disposeFiber(fiber, host, ctx);
expect(operations).toEqual(["finalizeInstance"]);
});
it("works when finalizeInstance is undefined (no host cleanup)", () => {
const disposed: string[] = [];
const ctx = {};
const host: HostLike<string, typeof ctx> = {};
const fiber: Fiber<string> = {
instance: "inst",
tag: "div",
props: {},
key: undefined,
children: [],
parent: null,
effect: null,
signalDisposers: [() => disposed.push("sig")],
prevProps: null,
disposed: false,
};
expect(() => disposeFiber(fiber, host, ctx)).not.toThrow();
expect(disposed).toEqual(["sig"]);
});
it("clears fiber.parent after disposal", () => {
const ctx = {};
const host: HostLike<string, typeof ctx> = {};
const parent: Fiber<string> = {
instance: "parent",
tag: "div",
props: {},
key: undefined,
children: [],
parent: null,
effect: null,
signalDisposers: [],
prevProps: null,
disposed: false,
};
const child: Fiber<string> = {
instance: "child",
tag: "span",
props: {},
key: undefined,
children: [],
parent,
effect: null,
signalDisposers: [],
prevProps: null,
disposed: false,
};
parent.children.push(child);
disposeFiber(child, host, ctx);
expect(child.parent).toBeNull();
});
it("clears fiber.effect after disposal", () => {
const ctx = {};
const host: HostLike<string, typeof ctx> = {};
const fiber: Fiber<string> = {
instance: "inst",
tag: "div",
props: {},
key: undefined,
children: [],
parent: null,
effect: { type: "update", payload: "x" },
signalDisposers: [],
prevProps: null,
disposed: false,
};
disposeFiber(fiber, host, ctx);
expect(fiber.effect).toBeNull();
});
}); });

View File

@@ -14,6 +14,7 @@ function makeFiber(key: string | undefined, tag: string): Fiber<string> {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
} }

View File

@@ -14,6 +14,7 @@ function makeFiber(key: string | undefined, tag: string): Fiber<string> {
effect: null, effect: null,
signalDisposers: [], signalDisposers: [],
prevProps: null, prevProps: null,
disposed: false,
}; };
} }