[backport core/1.41] fix: mask editor save shows blank image in Load Image node (#10018)

Backport of #9984 to `core/1.41`

Automatically created by backport workflow.

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-10018-backport-core-1-41-fix-mask-editor-save-shows-blank-image-in-Load-Image-node-3256d73d36508171b35be14661860168)
by [Unito](https://www.unito.io)

Co-authored-by: Dante <bunggl@naver.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Comfy Org PR Bot
2026-03-16 18:11:27 +09:00
committed by GitHub
parent 9f5b21d5d0
commit f9812a17df
2 changed files with 191 additions and 3 deletions

View File

@@ -0,0 +1,183 @@
import { createTestingPinia } from '@pinia/testing'
import { setActivePinia } from 'pinia'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import type { LGraphNode } from '@/lib/litegraph/src/litegraph'
import { app } from '@/scripts/app'
import { api } from '@/scripts/api'
import { useNodeOutputStore } from '@/stores/nodeOutputStore'
import { useMaskEditorSaver } from './useMaskEditorSaver'
// ---- Module Mocks ----
const mockDataStore: Record<string, unknown> = {
sourceNode: null,
inputData: null,
outputData: null
}
vi.mock('@/stores/maskEditorDataStore', () => ({
useMaskEditorDataStore: vi.fn(() => mockDataStore)
}))
function createMockCtx(): CanvasRenderingContext2D {
return {
drawImage: vi.fn(),
getImageData: vi.fn(() => ({
data: new Uint8ClampedArray(4 * 4 * 4),
width: 4,
height: 4
})),
putImageData: vi.fn(),
globalCompositeOperation: 'source-over'
} as unknown as CanvasRenderingContext2D
}
function createMockCanvas(): HTMLCanvasElement {
return {
width: 4,
height: 4,
getContext: vi.fn(() => createMockCtx()),
toBlob: vi.fn((cb: BlobCallback) => {
cb(new Blob(['x'], { type: 'image/png' }))
}),
toDataURL: vi.fn(() => 'data:image/png;base64,mock')
} as unknown as HTMLCanvasElement
}
const mockEditorStore: Record<string, HTMLCanvasElement | null> = {
maskCanvas: null,
rgbCanvas: null,
imgCanvas: null
}
vi.mock('@/stores/maskEditorStore', () => ({
useMaskEditorStore: vi.fn(() => mockEditorStore)
}))
vi.mock('@/scripts/api', () => ({
api: {
fetchApi: vi.fn(),
apiURL: vi.fn((route: string) => `http://localhost:8188${route}`)
}
}))
vi.mock('@/scripts/app', () => ({
app: {
canvas: { setDirty: vi.fn() },
nodeOutputs: {} as Record<string, unknown>,
nodePreviewImages: {} as Record<string, string[]>,
getPreviewFormatParam: vi.fn(() => ''),
getRandParam: vi.fn(() => '')
}
}))
vi.mock('@/platform/distribution/types', () => ({ isCloud: false }))
vi.mock('@/platform/workflow/management/stores/workflowStore', () => ({
useWorkflowStore: vi.fn(() => ({
nodeIdToNodeLocatorId: vi.fn((id: string | number) => String(id)),
nodeToNodeLocatorId: vi.fn((node: { id: number }) => String(node.id))
}))
}))
vi.mock('@/utils/graphTraversalUtil', () => ({
executionIdToNodeLocatorId: vi.fn((_rootGraph: unknown, id: string) => id)
}))
describe('useMaskEditorSaver', () => {
let mockNode: LGraphNode
const originalCreateElement = document.createElement.bind(document)
beforeEach(() => {
setActivePinia(createTestingPinia({ stubActions: false }))
vi.clearAllMocks()
app.nodeOutputs = {}
app.nodePreviewImages = {}
mockNode = {
id: 42,
type: 'LoadImage',
images: [],
imgs: undefined,
widgets: [
{ name: 'image', value: 'original.png [input]', callback: vi.fn() }
],
widgets_values: ['original.png [input]'],
properties: { image: 'original.png [input]' },
graph: { setDirtyCanvas: vi.fn() }
} as unknown as LGraphNode
mockDataStore.sourceNode = mockNode
mockDataStore.inputData = {
baseLayer: { image: {} as HTMLImageElement, url: 'base.png' },
maskLayer: { image: {} as HTMLImageElement, url: 'mask.png' },
sourceRef: { filename: 'original.png', subfolder: '', type: 'input' },
nodeId: 42
}
mockDataStore.outputData = null
mockEditorStore.maskCanvas = createMockCanvas()
mockEditorStore.rgbCanvas = createMockCanvas()
mockEditorStore.imgCanvas = createMockCanvas()
vi.mocked(api.fetchApi).mockResolvedValue({
ok: true,
json: () =>
Promise.resolve({
name: 'clipspace-painted-masked-123.png',
subfolder: 'clipspace',
type: 'input'
})
} as Response)
vi.spyOn(document, 'createElement').mockImplementation(
(tagName: string, options?: ElementCreationOptions) => {
if (tagName === 'canvas')
return createMockCanvas() as unknown as HTMLCanvasElement
return originalCreateElement(tagName, options)
}
)
// Mock Image constructor so loadImageFromUrl resolves
vi.stubGlobal(
'Image',
class MockImage {
crossOrigin = ''
onload: ((ev: Event) => void) | null = null
onerror: ((ev: unknown) => void) | null = null
private _src = ''
get src() {
return this._src
}
set src(value: string) {
this._src = value
queueMicrotask(() => this.onload?.(new Event('load')))
}
}
)
})
afterEach(() => {
vi.restoreAllMocks()
})
it('registers node outputs in store after save for node without prior execution outputs', async () => {
const store = useNodeOutputStore()
const locatorId = String(mockNode.id)
// Precondition: node has never been executed, no outputs exist
expect(app.nodeOutputs[locatorId]).toBeUndefined()
const { save } = useMaskEditorSaver()
await save()
// After mask editor save, the node must have outputs in the store
// so the image preview displays correctly (not blank).
// Bug: the old code used updateNodeImages which silently no-ops
// when there are no pre-existing outputs for the node.
expect(store.nodeOutputs[locatorId]).toBeDefined()
expect(store.nodeOutputs[locatorId]?.images?.length).toBeGreaterThan(0)
})
})

View File

@@ -9,6 +9,7 @@ import type {
import { isCloud } from '@/platform/distribution/types'
import { api } from '@/scripts/api'
import { app } from '@/scripts/app'
import { createAnnotatedPath } from '@/utils/createAnnotatedPath'
import type { LGraphNode } from '@/lib/litegraph/src/litegraph'
// Private layer filename functions
@@ -347,11 +348,15 @@ export function useMaskEditorSaver() {
node.widgets_values[widgetIndex] = widgetValue
}
}
imageWidget.callback?.(widgetValue)
}
nodeOutputStore.updateNodeImages(node)
node.imgs = undefined
const annotatedPath = createAnnotatedPath(mainRef.filename, {
subfolder: mainRef.subfolder,
rootFolder: mainRef.type
})
nodeOutputStore.setNodeOutputs(node, annotatedPath, { folder: 'input' })
node.graph?.setDirtyCanvas(true)
}
function loadImageFromUrl(url: string): Promise<HTMLImageElement> {