Compare commits

...

5 Commits

Author SHA1 Message Date
GitHub Action
26cef70453 [automated] Apply ESLint and Oxfmt fixes 2026-03-12 15:59:41 +00:00
bymyself
c57d4f5da8 fix: restore setNodeLocatorResolver call dropped during rebase
The call to setNodeLocatorResolver was lost when resolving merge
conflicts during rebase onto main. Re-adds it in the bootstrap
sequence before comfyApp.setup().
2026-03-12 08:55:29 -07:00
GitHub Action
695ec64752 [automated] Apply ESLint and Oxfmt fixes 2026-03-12 08:48:50 -07:00
bymyself
7cd10ccd88 fix: deep-freeze DEFAULT_STATE nested arrays to prevent shared mutation
Amp-Thread-ID: https://ampcode.com/threads/T-019cbd94-a928-7610-b468-2583f4816262
2026-03-12 08:48:35 -07:00
bymyself
6da7c896c9 feat: centralize node image rendering state in NodeImageStore
Introduce useNodeImageStore — a Pinia store keyed by NodeLocatorId that
owns imgs, imageIndex, imageRects, pointerDown, and overIndex state.

LGraphNode properties delegate to the store via Object.defineProperty
getters/setters installed in LGraph.add(), so all existing consumer code
(~18 files) continues to read/write node.imgs, node.imageIndex, etc.
unchanged.

Key design decisions:
- Plain Map (not reactive) avoids Vue proxy overhead in the canvas
  render hot path.
- peekState() + frozen DEFAULT_STATE for read-only access prevents
  unbounded Map growth from getter-only calls.
- Module-scoped setNodeLocatorResolver() breaks circular dependency
  (LGraph → store → workflowStore → app → litegraph).
- imgs getter returns undefined when empty to preserve node.imgs?.length
  optional chaining semantics.

Cleanup is wired into removeNodeOutputs (per-node) and
resetAllOutputsAndPreviews (bulk clear).

Fixes #9242

Amp-Thread-ID: https://ampcode.com/threads/T-019cbd88-ca30-76ec-abfa-38949748ba3d
2026-03-12 08:48:35 -07:00
5 changed files with 521 additions and 0 deletions

View File

@@ -177,6 +177,7 @@ import { shouldIgnoreCopyPaste } from '@/workbench/eventHelpers'
import { storeToRefs } from 'pinia'
import { useBootstrapStore } from '@/stores/bootstrapStore'
import { setNodeLocatorResolver } from '@/stores/nodeImageStore'
import { useCommandStore } from '@/stores/commandStore'
import { useExecutionStore } from '@/stores/executionStore'
import { useExecutionErrorStore } from '@/stores/executionErrorStore'
@@ -510,6 +511,8 @@ onMounted(async () => {
)
}
setNodeLocatorResolver(workflowStore.nodeToNodeLocatorId)
// @ts-expect-error fixme ts strict error
await comfyApp.setup(canvasRef.value)
canvasStore.canvas = comfyApp.canvas

View File

@@ -1,4 +1,5 @@
import { toString } from 'es-toolkit/compat'
import { getActivePinia } from 'pinia'
import {
SUBGRAPH_INPUT_ID,
@@ -9,6 +10,7 @@ import type { UUID } from '@/lib/litegraph/src/utils/uuid'
import { createUuidv4, zeroUuid } from '@/lib/litegraph/src/utils/uuid'
import { useLayoutMutations } from '@/renderer/core/layout/operations/layoutMutations'
import { LayoutSource } from '@/renderer/core/layout/types'
import { useNodeImageStore } from '@/stores/nodeImageStore'
import { usePromotionStore } from '@/stores/promotionStore'
import { useWidgetValueStore } from '@/stores/widgetValueStore'
import { forEachNode } from '@/utils/graphTraversalUtil'
@@ -985,6 +987,13 @@ export class LGraph
}
}
// Install property projection so node.imgs, node.imageIndex, etc.
// delegate to the centralized NodeImageStore.
// Guarded because Pinia may not be initialized in unit tests.
if (getActivePinia()) {
useNodeImageStore().installPropertyProjection(node)
}
this._nodes.push(node)
this._nodes_by_id[node.id] = node

View File

@@ -0,0 +1,350 @@
import { createTestingPinia } from '@pinia/testing'
import { setActivePinia } from 'pinia'
import { beforeEach, describe, expect, it, vi } from 'vitest'
import type { LGraphNode } from '@/lib/litegraph/src/litegraph'
import type { NodeLocatorId } from '@/types/nodeIdentification'
import { setNodeLocatorResolver, useNodeImageStore } from './nodeImageStore'
const mockNodeToNodeLocatorId = vi.fn()
function createMockNode(overrides: Record<string, unknown> = {}): LGraphNode {
return {
id: 1,
type: 'TestNode',
...overrides
} as Partial<LGraphNode> as LGraphNode
}
describe(useNodeImageStore, () => {
let store: ReturnType<typeof useNodeImageStore>
const locatorA = '42' as NodeLocatorId
const locatorB = 'abc-123:42' as NodeLocatorId
beforeEach(() => {
setActivePinia(createTestingPinia({ stubActions: false }))
store = useNodeImageStore()
vi.clearAllMocks()
setNodeLocatorResolver(mockNodeToNodeLocatorId)
})
describe('getState', () => {
it('returns default state for new locatorId', () => {
const state = store.getState(locatorA)
expect(state).toEqual({
imgs: [],
imageIndex: null,
imageRects: [],
pointerDown: null,
overIndex: null
})
})
it('returns same state for same locatorId', () => {
const first = store.getState(locatorA)
first.overIndex = 42
const second = store.getState(locatorA)
expect(second.overIndex).toBe(42)
})
it('returns different references for different locatorIds', () => {
const a = store.getState(locatorA)
const b = store.getState(locatorB)
expect(a).not.toBe(b)
})
})
describe('clearState', () => {
it('removes entry for locatorId', () => {
const state = store.getState(locatorA)
state.overIndex = 5
store.clearState(locatorA)
const fresh = store.getState(locatorA)
expect(fresh.overIndex).toBeNull()
})
})
describe('clearAll', () => {
it('removes all entries', () => {
store.getState(locatorA).overIndex = 1
store.getState(locatorB).overIndex = 2
store.clearAll()
expect(store.getState(locatorA).overIndex).toBeNull()
expect(store.getState(locatorB).overIndex).toBeNull()
})
})
describe('installPropertyProjection', () => {
it('projects imageRects reads/writes to store', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
node.imageRects = [[10, 20, 30, 40]]
expect(store.getState(locatorA).imageRects).toEqual([[10, 20, 30, 40]])
expect(node.imageRects).toEqual([[10, 20, 30, 40]])
})
it('projects pointerDown reads/writes to store', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
node.pointerDown = { index: 3, pos: [100, 200] }
expect(store.getState(locatorA).pointerDown).toEqual({
index: 3,
pos: [100, 200]
})
expect(node.pointerDown).toEqual({ index: 3, pos: [100, 200] })
})
it('projects overIndex reads/writes to store', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
node.overIndex = 7
expect(store.getState(locatorA).overIndex).toBe(7)
expect(node.overIndex).toBe(7)
})
it('projects imageIndex reads/writes to store', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
node.imageIndex = 5
expect(store.getState(locatorA).imageIndex).toBe(5)
expect(node.imageIndex).toBe(5)
})
it('preserves existing values when installing projection', () => {
const node = createMockNode({ overIndex: 3, imageIndex: 2 })
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
expect(node.overIndex).toBe(3)
expect(node.imageIndex).toBe(2)
expect(store.getState(locatorA).overIndex).toBe(3)
expect(store.getState(locatorA).imageIndex).toBe(2)
})
it('returns undefined when node has no locatorId', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(undefined)
store.installPropertyProjection(node)
expect(node.overIndex).toBeUndefined()
expect(node.imageIndex).toBeUndefined()
})
it('silently drops writes when node has no locatorId', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(undefined)
store.installPropertyProjection(node)
node.overIndex = 5
expect(node.overIndex).toBeUndefined()
})
it('is idempotent when called twice on the same node', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
node.overIndex = 3
node.imageIndex = 7
node.imgs = [new Image()]
store.installPropertyProjection(node)
expect(node.overIndex).toBe(3)
expect(node.imageIndex).toBe(7)
expect(node.imgs).toHaveLength(1)
expect(store.getState(locatorA).overIndex).toBe(3)
})
})
describe('imgs projection', () => {
it('returns undefined when store array is empty', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
expect(node.imgs).toBeUndefined()
})
it('returns the array when store has images', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
const img = new Image()
node.imgs = [img]
expect(node.imgs).toEqual([img])
expect(store.getState(locatorA).imgs).toEqual([img])
})
it('converts undefined assignment to empty array in store', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
node.imgs = [new Image()]
node.imgs = undefined
expect(node.imgs).toBeUndefined()
expect(store.getState(locatorA).imgs).toEqual([])
})
it('preserves existing imgs when installing projection', () => {
const img = new Image()
const node = createMockNode({ imgs: [img] })
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
expect(node.imgs).toEqual([img])
expect(store.getState(locatorA).imgs).toEqual([img])
})
it('supports optional chaining pattern (node.imgs?.length)', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
expect(node.imgs?.length).toBeUndefined()
node.imgs = [new Image(), new Image()]
expect(node.imgs?.length).toBe(2)
})
})
describe('subgraph isolation', () => {
it('isolates image state across subgraph instances', () => {
const locator1 = 'uuid-instance-1:42' as NodeLocatorId
const locator2 = 'uuid-instance-2:42' as NodeLocatorId
const img1 = new Image()
const img2 = new Image()
store.getState(locator1).imgs = [img1]
store.getState(locator2).imgs = [img2]
expect(store.getState(locator1).imgs).toEqual([img1])
expect(store.getState(locator2).imgs).toEqual([img2])
})
it('isolates imageIndex across subgraph instances', () => {
const locator1 = 'uuid-instance-1:42' as NodeLocatorId
const locator2 = 'uuid-instance-2:42' as NodeLocatorId
store.getState(locator1).imageIndex = 0
store.getState(locator2).imageIndex = 3
expect(store.getState(locator1).imageIndex).toBe(0)
expect(store.getState(locator2).imageIndex).toBe(3)
})
it('projects to correct store entry based on locatorId', () => {
const locator1 = 'uuid-instance-1:42' as NodeLocatorId
const locator2 = 'uuid-instance-2:42' as NodeLocatorId
const node1 = createMockNode({ id: 42, _locator: locator1 })
const node2 = createMockNode({ id: 42, _locator: locator2 })
mockNodeToNodeLocatorId.mockImplementation(
(n: Record<string, unknown>) => n._locator
)
store.installPropertyProjection(node1)
store.installPropertyProjection(node2)
node1.overIndex = 1
node2.overIndex = 9
expect(store.getState(locator1).overIndex).toBe(1)
expect(store.getState(locator2).overIndex).toBe(9)
})
})
describe('multiple nodes have independent state', () => {
it('imageIndex is independent per node', () => {
const nodeA = createMockNode({ id: 1, _locator: '1' })
const nodeB = createMockNode({ id: 2, _locator: '2' })
const locA = '1' as NodeLocatorId
const locB = '2' as NodeLocatorId
mockNodeToNodeLocatorId.mockImplementation(
(n: Record<string, unknown>) => n._locator
)
store.installPropertyProjection(nodeA)
store.installPropertyProjection(nodeB)
nodeA.imageIndex = 0
nodeB.imageIndex = 5
expect(nodeA.imageIndex).toBe(0)
expect(nodeB.imageIndex).toBe(5)
expect(store.getState(locA).imageIndex).toBe(0)
expect(store.getState(locB).imageIndex).toBe(5)
})
})
describe('DEFAULT_STATE immutability', () => {
it('default imageRects is frozen and cannot be mutated', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
// Read default imageRects without triggering state creation
const nodeB = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorB)
store.installPropertyProjection(nodeB)
// Default arrays should be frozen (no state entry exists yet)
expect(() => {
;(nodeB.imageRects as unknown[]).push([0, 0, 10, 10])
}).toThrow()
})
})
describe('null-to-null transitions', () => {
it('imageIndex null → null works', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
expect(node.imageIndex).toBeNull()
node.imageIndex = null
expect(node.imageIndex).toBeNull()
})
it('pointerDown null → null works', () => {
const node = createMockNode()
mockNodeToNodeLocatorId.mockReturnValue(locatorA)
store.installPropertyProjection(node)
expect(node.pointerDown).toBeNull()
node.pointerDown = null
expect(node.pointerDown).toBeNull()
})
})
})

View File

@@ -0,0 +1,155 @@
import { defineStore } from 'pinia'
import type { LGraphNode } from '@/lib/litegraph/src/litegraph'
import type { Point, Rect } from '@/lib/litegraph/src/interfaces'
import type { NodeLocatorId } from '@/types/nodeIdentification'
interface PointerDownState {
index: number | null
pos: Point
}
interface NodeImageState {
imgs: HTMLImageElement[]
imageIndex: number | null
imageRects: Rect[]
pointerDown: PointerDownState | null
overIndex: number | null
}
function createDefaultState(): NodeImageState {
return {
imgs: [],
imageIndex: null,
imageRects: [],
pointerDown: null,
overIndex: null
}
}
const DEFAULT_STATE: Readonly<NodeImageState> = Object.freeze({
...createDefaultState(),
imgs: Object.freeze([]) as unknown as HTMLImageElement[],
imageRects: Object.freeze([]) as unknown as Rect[]
})
/**
* Module-scoped resolver for converting nodes to locator IDs.
* Set once during app bootstrap via {@link setNodeLocatorResolver} to
* avoid a circular dependency: LGraph → nodeImageStore → workflowStore → app → litegraph.
*/
let _nodeLocatorResolver:
| ((node: LGraphNode) => NodeLocatorId | undefined)
| undefined
export function setNodeLocatorResolver(
resolver: (node: LGraphNode) => NodeLocatorId | undefined
): void {
_nodeLocatorResolver = resolver
}
function getNodeLocatorId(node: LGraphNode): NodeLocatorId | undefined {
return _nodeLocatorResolver?.(node)
}
export const useNodeImageStore = defineStore('nodeImage', () => {
const state = new Map<NodeLocatorId, NodeImageState>()
function getState(locatorId: NodeLocatorId): NodeImageState {
const existing = state.get(locatorId)
if (existing) return existing
const entry = createDefaultState()
state.set(locatorId, entry)
return entry
}
function peekState(locatorId: NodeLocatorId): NodeImageState | undefined {
return state.get(locatorId)
}
function clearState(locatorId: NodeLocatorId): void {
state.delete(locatorId)
}
function clearAll(): void {
state.clear()
}
function setStateProperty<K extends keyof NodeImageState>(
locatorId: NodeLocatorId,
prop: K,
value: NodeImageState[K]
): void {
getState(locatorId)[prop] = value
}
function installPropertyProjection(node: LGraphNode): void {
const simpleProperties: (keyof NodeImageState)[] = [
'imageRects',
'pointerDown',
'overIndex',
'imageIndex'
]
const nodeRecord = node as unknown as Record<string, unknown>
for (const prop of simpleProperties) {
const existingValue = nodeRecord[prop]
Object.defineProperty(node, prop, {
get() {
const locatorId = getNodeLocatorId(node)
if (!locatorId) return undefined
return (peekState(locatorId) ?? DEFAULT_STATE)[prop]
},
set(value: unknown) {
const locatorId = getNodeLocatorId(node)
if (!locatorId) return
setStateProperty(
locatorId,
prop,
value as NodeImageState[typeof prop]
)
},
configurable: true,
enumerable: true
})
if (existingValue !== undefined) {
nodeRecord[prop] = existingValue
}
}
// imgs needs special handling: return undefined when empty to preserve
// node.imgs?.length optional chaining semantics
const existingImgs = node.imgs
Object.defineProperty(node, 'imgs', {
get() {
const locatorId = getNodeLocatorId(node)
if (!locatorId) return undefined
const s = peekState(locatorId)
return s?.imgs.length ? s.imgs : undefined
},
set(value: HTMLImageElement[] | undefined) {
const locatorId = getNodeLocatorId(node)
if (!locatorId) return
getState(locatorId).imgs = value ?? []
},
configurable: true,
enumerable: true
})
if (existingImgs !== undefined) {
node.imgs = existingImgs
}
}
return {
getState,
clearState,
clearAll,
installPropertyProjection
}
})

View File

@@ -14,6 +14,7 @@ import { api } from '@/scripts/api'
import { app } from '@/scripts/app'
import { clone } from '@/scripts/utils'
import type { NodeLocatorId } from '@/types/nodeIdentification'
import { useNodeImageStore } from '@/stores/nodeImageStore'
import { parseFilePath } from '@/utils/formatUtil'
import { isAnimatedOutput, isVideoNode } from '@/utils/litegraphUtil'
import {
@@ -359,6 +360,8 @@ export const useNodeOutputStore = defineStore('nodeOutput', () => {
delete nodePreviewImages.value[nodeLocatorId]
}
useNodeImageStore().clearState(nodeLocatorId)
return hadOutputs
}
@@ -407,6 +410,7 @@ export const useNodeOutputStore = defineStore('nodeOutput', () => {
app.nodeOutputs = {}
nodeOutputs.value = {}
revokeAllPreviews()
useNodeImageStore().clearAll()
}
/**