Files
Will Miao 1f58e78717 fix(loaders): migrate backslash values on subgraph boundary widgets (#1149)
Promoted combo widgets on a subgraph boundary hold their own store-backed
copy of the interior widget's value, seeded from the workflow's serialized
widgets_values, so migrating the interior loader widget never reached them:
the boundary combo kept the old backslash spelling, the frontend flagged it
as a missing model on load, and the error entry (keyed to the host node)
survived the interior node's onWidgetChanged.

- migrateWidgetValue generalizes the separator migration to any widget.
- applyToAllNodes now also migrates the projected boundary widgets of every
  subgraph node; their value setter writes through to the frontend's widget
  store, and firing the host node's onWidgetChanged clears the host-keyed
  error entries. Fixing the values before the post-load missing-model scan
  means the flags are never raised at all.
- The per-node onConfigure hook schedules a boundary sweep via
  queueMicrotask so pasted subgraph nodes (which bypass the graph-level
  configure hook) get covered once the paste settles.
2026-10-23 08:46:12 +08:00

502 lines
15 KiB
JavaScript

import { describe, it, expect, beforeEach, vi } from "vitest";
const state = vi.hoisted(() => {
const APP_MODULE = new URL("../../../scripts/app.js", import.meta.url).pathname;
const API_MODULE = new URL("../../../scripts/api.js", import.meta.url).pathname;
return {
APP_MODULE,
API_MODULE,
graph: { onConfigure: null, nodes: [] },
registerExtension: vi.fn(),
fetchApi: vi.fn(),
};
});
vi.mock(state.APP_MODULE, () => ({
app: {
registerExtension: state.registerExtension,
graph: state.graph,
},
}));
vi.mock(state.API_MODULE, () => ({
api: {
fetchApi: state.fetchApi,
},
}));
const { sanitizeControlWidget } = await import(
"../../../web/comfyui/random_loader_control.js"
);
const CONTROL_VALUES = [
"fixed",
"increment",
"decrement",
"randomize",
"increment-wrap",
];
const DTYPE_VALUES = ["default", "fp8_e4m3fn", "fp8_e4m3fn_fast", "fp8_e5m2"];
function makeUnetNode(overrides = {}) {
return {
comfyClass: "Unet Loader (LoraManager)",
widgets: [
{
name: "unet_name",
type: "combo",
value: "model.safetensors",
options: { values: ["model.safetensors"] },
},
{
// Real ComfyUI names the control widget after the string option
// (e.g. 'fixed'), not 'control_after_generate'.
name: "fixed",
type: "combo",
value: "fixed",
options: { values: CONTROL_VALUES },
},
{ name: "control_filter_list", type: "string", value: "", options: {} },
{
name: "weight_dtype",
type: "combo",
value: "default",
options: { values: DTYPE_VALUES },
},
{ name: "base_model", type: "combo", value: "Any", options: { values: ["Any"] } },
],
...overrides,
};
}
function makeCheckpointNode(overrides = {}) {
return {
comfyClass: "Checkpoint Loader (LoraManager)",
widgets: [
{
name: "ckpt_name",
type: "combo",
value: "model.safetensors",
options: { values: ["model.safetensors"] },
},
{
// Real ComfyUI names the control widget after the string option
// (e.g. 'fixed'), not 'control_after_generate'.
name: "fixed",
type: "combo",
value: "fixed",
options: { values: CONTROL_VALUES },
},
{ name: "control_filter_list", type: "string", value: "", options: {} },
{ name: "base_model", type: "combo", value: "Any", options: { values: ["Any"] } },
],
...overrides,
};
}
function controlWidget(node) {
return node.widgets.find(
(widget) =>
widget.name === "control_after_generate" ||
(widget.type === "combo" &&
Array.isArray(widget.options?.values) &&
widget.options.values.length > 0 &&
widget.options.values.every((v) => CONTROL_VALUES.includes(v)))
);
}
function dtypeWidget(node) {
return node.widgets.find((widget) => widget.name === "weight_dtype");
}
beforeEach(() => {
state.graph.onConfigure = null;
state.graph.nodes = [];
state.graph.__loraManagerConfigureHooked = false;
state.fetchApi.mockReset();
state.fetchApi.mockResolvedValue({
ok: true,
json: async () => ({
items: [{ name: "model.safetensors", base_model: "Any" }],
}),
});
});
describe("sanitizeControlWidget", () => {
it("hands the shifted weight_dtype value back and resets control to fixed", () => {
const node = makeUnetNode();
controlWidget(node).value = "fp8_e4m3fn";
dtypeWidget(node).value = "default";
sanitizeControlWidget(node, {
modelWidget: "unet_name",
subType: "diffusion_model",
dtypeWidget: "weight_dtype",
});
expect(dtypeWidget(node).value).toBe("fp8_e4m3fn");
expect(controlWidget(node).value).toBe("fixed");
});
it("resets control when the shifted value is the dtype default itself", () => {
const node = makeUnetNode();
controlWidget(node).value = "default";
dtypeWidget(node).value = "default";
sanitizeControlWidget(node, {
modelWidget: "unet_name",
subType: "diffusion_model",
dtypeWidget: "weight_dtype",
});
expect(dtypeWidget(node).value).toBe("default");
expect(controlWidget(node).value).toBe("fixed");
});
it("leaves valid control modes untouched", () => {
const node = makeUnetNode();
controlWidget(node).value = "randomize";
dtypeWidget(node).value = "fp8_e4m3fn";
sanitizeControlWidget(node, {
modelWidget: "unet_name",
subType: "diffusion_model",
dtypeWidget: "weight_dtype",
});
expect(controlWidget(node).value).toBe("randomize");
expect(dtypeWidget(node).value).toBe("fp8_e4m3fn");
});
it("does not overwrite a weight_dtype that is not at its default", () => {
const node = makeUnetNode();
controlWidget(node).value = "fp8_e4m3fn";
dtypeWidget(node).value = "fp8_e5m2";
sanitizeControlWidget(node, {
modelWidget: "unet_name",
subType: "diffusion_model",
dtypeWidget: "weight_dtype",
});
expect(dtypeWidget(node).value).toBe("fp8_e5m2");
expect(controlWidget(node).value).toBe("fixed");
});
it("only resets the control mode for nodes without a dtype widget", () => {
const node = makeCheckpointNode();
controlWidget(node).value = "default";
sanitizeControlWidget(node, {
modelWidget: "ckpt_name",
subType: "checkpoint",
});
expect(controlWidget(node).value).toBe("fixed");
});
it("is a no-op when the node has no control widget", () => {
const node = makeUnetNode();
node.widgets = node.widgets.filter(
(widget) => widget.name !== "control_after_generate"
);
expect(() =>
sanitizeControlWidget(node, {
modelWidget: "unet_name",
subType: "diffusion_model",
dtypeWidget: "weight_dtype",
})
).not.toThrow();
});
it("falls back to the known control modes when options.values is missing", () => {
const node = makeUnetNode();
const control = controlWidget(node);
// Standard ComfyUI name, so the widget is found by name while its
// options.values is gone (exercises the CONTROL_MODES fallback).
control.name = "control_after_generate";
control.value = "randomize";
control.options = {};
sanitizeControlWidget(node, {
modelWidget: "unet_name",
subType: "diffusion_model",
dtypeWidget: "weight_dtype",
});
expect(controlWidget(node).value).toBe("randomize");
});
});
describe("extension graph configure hook", () => {
it("sanitizes loader nodes after graph configure", async () => {
const extension = state.registerExtension.mock.calls.map(
(call) => call[0]
)[0];
await extension.setup();
const node = makeUnetNode();
controlWidget(node).value = "fp8_e4m3fn";
dtypeWidget(node).value = "default";
state.graph.nodes = [node];
const nodeType = { comfyClass: "Unet Loader (LoraManager)", prototype: {} };
extension.beforeRegisterNodeDef(nodeType, {});
nodeType.prototype.onAdded.call({ graph: state.graph });
state.graph.onConfigure({});
await new Promise((resolve) => setTimeout(resolve, 0));
expect(controlWidget(node).value).toBe("fixed");
expect(dtypeWidget(node).value).toBe("fp8_e4m3fn");
});
});
describe("model widget value migration", () => {
function modelWidget(node, name) {
return node.widgets.find((widget) => widget.name === name);
}
async function loadGraphWith(nodes) {
const extension = state.registerExtension.mock.calls.map(
(call) => call[0]
)[0];
await extension.setup();
state.graph.nodes = nodes;
for (const node of nodes) {
const nodeType = { comfyClass: node.comfyClass, prototype: {} };
extension.beforeRegisterNodeDef(nodeType, {});
nodeType.prototype.onAdded?.call({ graph: state.graph });
}
state.graph.onConfigure({});
await new Promise((resolve) => setTimeout(resolve, 0));
}
beforeEach(() => {
state.fetchApi.mockResolvedValue({
ok: true,
json: async () => ({
items: [
{ name: "aaa/first.safetensors", base_model: "Any" },
{ name: "dir/model.safetensors", base_model: "Any" },
],
}),
});
});
it("migrates a backslash-spelled value instead of resetting to the first model", async () => {
const node = makeCheckpointNode();
modelWidget(node, "ckpt_name").value = "dir\\model.safetensors";
await loadGraphWith([node]);
expect(modelWidget(node, "ckpt_name").value).toBe("dir/model.safetensors");
});
it("still resets to the first model when the normalized value is unknown", async () => {
const node = makeCheckpointNode();
modelWidget(node, "ckpt_name").value = "dir\\unknown.safetensors";
await loadGraphWith([node]);
expect(modelWidget(node, "ckpt_name").value).toBe("aaa/first.safetensors");
});
it("migrates wired widgets without touching their option list", async () => {
const node = makeCheckpointNode();
node.inputs = [{ widget: { name: "ckpt_name" }, link: 1 }];
const widget = modelWidget(node, "ckpt_name");
widget.value = "dir\\model.safetensors";
widget.options.values = ["model.safetensors"];
await loadGraphWith([node]);
expect(widget.value).toBe("dir/model.safetensors");
expect(widget.options.values).toEqual(["model.safetensors"]);
});
it("leaves an already-valid forward-slash value untouched", async () => {
const node = makeCheckpointNode();
modelWidget(node, "ckpt_name").value = "dir/model.safetensors";
await loadGraphWith([node]);
expect(modelWidget(node, "ckpt_name").value).toBe("dir/model.safetensors");
});
it("migrates nodes nested inside subgraphs", async () => {
const inner = makeCheckpointNode();
modelWidget(inner, "ckpt_name").value = "dir\\model.safetensors";
const subgraphNode = {
comfyClass: "MySubgraph",
widgets: [],
subgraph: { nodes: [inner] },
};
// A root-level loader node installs the graph configure hook.
const root = makeCheckpointNode();
await loadGraphWith([root, subgraphNode]);
expect(modelWidget(inner, "ckpt_name").value).toBe("dir/model.safetensors");
});
it("fires onWidgetChanged so the frontend clears the stale error flag", async () => {
const node = makeCheckpointNode();
const widget = modelWidget(node, "ckpt_name");
widget.value = "dir\\model.safetensors";
node.onWidgetChanged = vi.fn();
await loadGraphWith([node]);
expect(node.onWidgetChanged).toHaveBeenCalledWith(
"ckpt_name",
"dir/model.safetensors",
"dir\\model.safetensors",
widget
);
});
it("migrates values restored through node.onConfigure (paste)", async () => {
const extension = state.registerExtension.mock.calls.map(
(call) => call[0]
)[0];
await extension.setup();
const nodeType = {
comfyClass: "Checkpoint Loader (LoraManager)",
prototype: {},
};
extension.beforeRegisterNodeDef(nodeType, {});
const node = makeCheckpointNode();
modelWidget(node, "ckpt_name").value = "dir\\model.safetensors";
nodeType.prototype.onConfigure.call(node, {});
expect(modelWidget(node, "ckpt_name").value).toBe("dir/model.safetensors");
});
});
describe("subgraph boundary widget migration", () => {
function makeSubgraphNode(boundaryWidgets, innerNodes = []) {
return {
comfyClass: "MySubgraph",
widgets: boundaryWidgets,
subgraph: { nodes: innerNodes },
onWidgetChanged: vi.fn(),
};
}
function makeBoundaryWidget(value) {
return {
name: "ckpt_name",
type: "combo",
value,
options: { values: ["aaa/first.safetensors", "dir/model.safetensors"] },
};
}
async function loadGraphWith(nodes) {
const extension = state.registerExtension.mock.calls.map(
(call) => call[0]
)[0];
await extension.setup();
state.graph.nodes = nodes;
for (const node of nodes) {
const nodeType = { comfyClass: node.comfyClass, prototype: {} };
extension.beforeRegisterNodeDef(nodeType, {});
nodeType.prototype.onAdded?.call({ graph: state.graph });
}
state.graph.onConfigure({});
await new Promise((resolve) => setTimeout(resolve, 0));
}
beforeEach(() => {
state.fetchApi.mockResolvedValue({
ok: true,
json: async () => ({
items: [
{ name: "aaa/first.safetensors", base_model: "Any" },
{ name: "dir/model.safetensors", base_model: "Any" },
],
}),
});
});
it("migrates a promoted boundary widget that keeps its own stale copy", async () => {
const boundary = makeBoundaryWidget("dir\\model.safetensors");
const subgraphNode = makeSubgraphNode([boundary]);
const root = makeCheckpointNode();
await loadGraphWith([root, subgraphNode]);
expect(boundary.value).toBe("dir/model.safetensors");
});
it("fires the host node's onWidgetChanged so host-keyed errors clear", async () => {
const boundary = makeBoundaryWidget("dir\\model.safetensors");
const subgraphNode = makeSubgraphNode([boundary]);
// A root-level loader node installs the graph configure hook.
const root = makeCheckpointNode();
await loadGraphWith([root, subgraphNode]);
expect(subgraphNode.onWidgetChanged).toHaveBeenCalledWith(
"ckpt_name",
"dir/model.safetensors",
"dir\\model.safetensors",
boundary
);
});
it("leaves a boundary widget alone when the normalized value is unknown", async () => {
const boundary = makeBoundaryWidget("dir\\unknown.safetensors");
const subgraphNode = makeSubgraphNode([boundary]);
const root = makeCheckpointNode();
await loadGraphWith([root, subgraphNode]);
expect(boundary.value).toBe("dir\\unknown.safetensors");
expect(subgraphNode.onWidgetChanged).not.toHaveBeenCalled();
});
it("leaves an already-valid boundary value untouched", async () => {
const boundary = makeBoundaryWidget("dir/model.safetensors");
const subgraphNode = makeSubgraphNode([boundary]);
const root = makeCheckpointNode();
await loadGraphWith([root, subgraphNode]);
expect(boundary.value).toBe("dir/model.safetensors");
expect(subgraphNode.onWidgetChanged).not.toHaveBeenCalled();
});
it("sweeps boundary widgets after a pasted loader node configures", async () => {
const extension = state.registerExtension.mock.calls.map(
(call) => call[0]
)[0];
await extension.setup();
const boundary = makeBoundaryWidget("dir\\model.safetensors");
const subgraphNode = makeSubgraphNode([boundary]);
state.graph.nodes = [subgraphNode];
const nodeType = {
comfyClass: "Checkpoint Loader (LoraManager)",
prototype: {},
};
extension.beforeRegisterNodeDef(nodeType, {});
const node = makeCheckpointNode();
nodeType.prototype.onConfigure.call(node, {});
await new Promise((resolve) => setTimeout(resolve, 0));
expect(boundary.value).toBe("dir/model.safetensors");
});
});