File size: 6,913 Bytes
eb9ca51
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
// @ts-check
/// <reference path="../node_modules/@types/jest/index.d.ts" />
const { start } = require("../utils");
const lg = require("../utils/litegraph");

describe("extensions", () => {
	beforeEach(() => {
		lg.setup(global);
	});

	afterEach(() => {
		lg.teardown(global);
	});

	it("calls each extension hook", async () => {
		const mockExtension = {
			name: "TestExtension",
			init: jest.fn(),
			setup: jest.fn(),
			addCustomNodeDefs: jest.fn(),
			getCustomWidgets: jest.fn(),
			beforeRegisterNodeDef: jest.fn(),
			registerCustomNodes: jest.fn(),
			loadedGraphNode: jest.fn(),
			nodeCreated: jest.fn(),
			beforeConfigureGraph: jest.fn(),
			afterConfigureGraph: jest.fn(),
		};

		const { app, ez, graph } = await start({
			async preSetup(app) {
				app.registerExtension(mockExtension);
			},
		});

		// Basic initialisation hooks should be called once, with app
		expect(mockExtension.init).toHaveBeenCalledTimes(1);
		expect(mockExtension.init).toHaveBeenCalledWith(app);

		// Adding custom node defs should be passed the full list of nodes
		expect(mockExtension.addCustomNodeDefs).toHaveBeenCalledTimes(1);
		expect(mockExtension.addCustomNodeDefs.mock.calls[0][1]).toStrictEqual(app);
		const defs = mockExtension.addCustomNodeDefs.mock.calls[0][0];
		expect(defs).toHaveProperty("KSampler");
		expect(defs).toHaveProperty("LoadImage");

		// Get custom widgets is called once and should return new widget types
		expect(mockExtension.getCustomWidgets).toHaveBeenCalledTimes(1);
		expect(mockExtension.getCustomWidgets).toHaveBeenCalledWith(app);

		// Before register node def will be called once per node type
		const nodeNames = Object.keys(defs);
		const nodeCount = nodeNames.length;
		expect(mockExtension.beforeRegisterNodeDef).toHaveBeenCalledTimes(nodeCount);
		for (let i = 0; i < 10; i++) {
			// It should be send the JS class and the original JSON definition
			const nodeClass = mockExtension.beforeRegisterNodeDef.mock.calls[i][0];
			const nodeDef = mockExtension.beforeRegisterNodeDef.mock.calls[i][1];

			expect(nodeClass.name).toBe("ComfyNode");
			expect(nodeClass.comfyClass).toBe(nodeNames[i]);
			expect(nodeDef.name).toBe(nodeNames[i]);
			expect(nodeDef).toHaveProperty("input");
			expect(nodeDef).toHaveProperty("output");
		}

		// Register custom nodes is called once after registerNode defs to allow adding other frontend nodes
		expect(mockExtension.registerCustomNodes).toHaveBeenCalledTimes(1);

		// Before configure graph will be called here as the default graph is being loaded
		expect(mockExtension.beforeConfigureGraph).toHaveBeenCalledTimes(1);
		// it gets sent the graph data that is going to be loaded
		const graphData = mockExtension.beforeConfigureGraph.mock.calls[0][0];

		// A node created is fired for each node constructor that is called
		expect(mockExtension.nodeCreated).toHaveBeenCalledTimes(graphData.nodes.length);
		for (let i = 0; i < graphData.nodes.length; i++) {
			expect(mockExtension.nodeCreated.mock.calls[i][0].type).toBe(graphData.nodes[i].type);
		}

		// Each node then calls loadedGraphNode to allow them to be updated
		expect(mockExtension.loadedGraphNode).toHaveBeenCalledTimes(graphData.nodes.length);
		for (let i = 0; i < graphData.nodes.length; i++) {
			expect(mockExtension.loadedGraphNode.mock.calls[i][0].type).toBe(graphData.nodes[i].type);
		}

		// After configure is then called once all the setup is done
		expect(mockExtension.afterConfigureGraph).toHaveBeenCalledTimes(1);

		expect(mockExtension.setup).toHaveBeenCalledTimes(1);
		expect(mockExtension.setup).toHaveBeenCalledWith(app);

		// Ensure hooks are called in the correct order
		const callOrder = [
			"init",
			"addCustomNodeDefs",
			"getCustomWidgets",
			"beforeRegisterNodeDef",
			"registerCustomNodes",
			"beforeConfigureGraph",
			"nodeCreated",
			"loadedGraphNode",
			"afterConfigureGraph",
			"setup",
		];
		for (let i = 1; i < callOrder.length; i++) {
			const fn1 = mockExtension[callOrder[i - 1]];
			const fn2 = mockExtension[callOrder[i]];
			expect(fn1.mock.invocationCallOrder[0]).toBeLessThan(fn2.mock.invocationCallOrder[0]);
		}

		graph.clear();

		// Ensure adding a new node calls the correct callback
		ez.LoadImage();
		expect(mockExtension.loadedGraphNode).toHaveBeenCalledTimes(graphData.nodes.length);
		expect(mockExtension.nodeCreated).toHaveBeenCalledTimes(graphData.nodes.length + 1);
		expect(mockExtension.nodeCreated.mock.lastCall[0].type).toBe("LoadImage");

		// Reload the graph to ensure correct hooks are fired
		await graph.reload();

		// These hooks should not be fired again
		expect(mockExtension.init).toHaveBeenCalledTimes(1);
		expect(mockExtension.addCustomNodeDefs).toHaveBeenCalledTimes(1);
		expect(mockExtension.getCustomWidgets).toHaveBeenCalledTimes(1);
		expect(mockExtension.registerCustomNodes).toHaveBeenCalledTimes(1);
		expect(mockExtension.beforeRegisterNodeDef).toHaveBeenCalledTimes(nodeCount);
		expect(mockExtension.setup).toHaveBeenCalledTimes(1);

		// These should be called again
		expect(mockExtension.beforeConfigureGraph).toHaveBeenCalledTimes(2);
		expect(mockExtension.nodeCreated).toHaveBeenCalledTimes(graphData.nodes.length + 2);
		expect(mockExtension.loadedGraphNode).toHaveBeenCalledTimes(graphData.nodes.length + 1);
		expect(mockExtension.afterConfigureGraph).toHaveBeenCalledTimes(2);
	}, 15000);

	it("allows custom nodeDefs and widgets to be registered", async () => {
		const widgetMock = jest.fn((node, inputName, inputData, app) => {
			expect(node.constructor.comfyClass).toBe("TestNode");
			expect(inputName).toBe("test_input");
			expect(inputData[0]).toBe("CUSTOMWIDGET");
			expect(inputData[1]?.hello).toBe("world");
			expect(app).toStrictEqual(app);

			return {
				widget: node.addWidget("button", inputName, "hello", () => {}),
			};
		});

		// Register our extension that adds a custom node + widget type
		const mockExtension = {
			name: "TestExtension",
			addCustomNodeDefs: (nodeDefs) => {
				nodeDefs["TestNode"] = {
					output: [],
					output_name: [],
					output_is_list: [],
					name: "TestNode",
					display_name: "TestNode",
					category: "Test",
					input: {
						required: {
							test_input: ["CUSTOMWIDGET", { hello: "world" }],
						},
					},
				};
			},
			getCustomWidgets: jest.fn(() => {
				return {
					CUSTOMWIDGET: widgetMock,
				};
			}),
		};

		const { graph, ez } = await start({
			async preSetup(app) {
				app.registerExtension(mockExtension);
			},
		});

		expect(mockExtension.getCustomWidgets).toBeCalledTimes(1);

		graph.clear();
		expect(widgetMock).toBeCalledTimes(0);
		const node = ez.TestNode();
		expect(widgetMock).toBeCalledTimes(1);

		// Ensure our custom widget is created
		expect(node.inputs.length).toBe(0);
		expect(node.widgets.length).toBe(1);
		const w = node.widgets[0].widget;
		expect(w.name).toBe("test_input");
		expect(w.type).toBe("button");
	});
});