mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-03-13 17:10:06 +00:00
## Summary Adds handling for entering app mode with an empty graph prompting the user to load a template as a starting point ## Changes - **What**: - app mode handle empty workflows, disable builder button, show different message - fix fitView when switching from app mode to graph ## Review Focus Moving the fitView since the canvas is hidden in app mode until after the workflow is loaded and the mode has been switched back to graph, I don't see how this could cause any issues but worth a closer eye ## Screenshots (if applicable) <img width="1057" height="916" alt="image" src="https://github.com/user-attachments/assets/2ffe2b6d-9ce1-4218-828a-b7bc336c365a" /> ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-9393-feat-App-mode-empty-graph-handling-3196d73d3650812cab0ce878109ed5c9) by [Unito](https://www.unito.io)
310 lines
9.0 KiB
TypeScript
310 lines
9.0 KiB
TypeScript
import { createTestingPinia } from '@pinia/testing'
|
|
import { setActivePinia } from 'pinia'
|
|
import { nextTick } from 'vue'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import type { LGraphNode, NodeId } from '@/lib/litegraph/src/LGraphNode'
|
|
import type { LoadedComfyWorkflow } from '@/platform/workflow/management/stores/comfyWorkflow'
|
|
import { ComfyWorkflow as ComfyWorkflowClass } from '@/platform/workflow/management/stores/comfyWorkflow'
|
|
import { useWorkflowStore } from '@/platform/workflow/management/stores/workflowStore'
|
|
import { app } from '@/scripts/app'
|
|
import type { ChangeTracker } from '@/scripts/changeTracker'
|
|
import { createMockChangeTracker } from '@/utils/__tests__/litegraphTestUtils'
|
|
|
|
const mockEmptyWorkflowDialog = vi.hoisted(() => {
|
|
let lastOptions: { onEnterBuilder: () => void; onDismiss: () => void }
|
|
return {
|
|
show: vi.fn((options: typeof lastOptions) => {
|
|
lastOptions = options
|
|
}),
|
|
get lastOptions() {
|
|
return lastOptions
|
|
}
|
|
}
|
|
})
|
|
|
|
vi.mock('@/scripts/app', () => ({
|
|
app: {
|
|
rootGraph: { extra: {}, nodes: [{ id: 1 }] }
|
|
}
|
|
}))
|
|
|
|
const mockResolveNode = vi.hoisted(() =>
|
|
vi.fn<(id: NodeId) => LGraphNode | undefined>(() => undefined)
|
|
)
|
|
vi.mock('@/utils/litegraphUtil', async (importOriginal) => ({
|
|
...(await importOriginal()),
|
|
resolveNode: mockResolveNode
|
|
}))
|
|
|
|
vi.mock('@/renderer/core/canvas/canvasStore', () => ({
|
|
useCanvasStore: () => ({
|
|
getCanvas: () => ({ read_only: false })
|
|
})
|
|
}))
|
|
|
|
vi.mock('@/components/builder/useEmptyWorkflowDialog', () => ({
|
|
useEmptyWorkflowDialog: () => mockEmptyWorkflowDialog
|
|
}))
|
|
|
|
import { useAppModeStore } from './appModeStore'
|
|
|
|
function createBuilderWorkflow(
|
|
activeMode: string = 'builder:inputs'
|
|
): LoadedComfyWorkflow {
|
|
const workflow = new ComfyWorkflowClass({
|
|
path: 'workflows/test.json',
|
|
modified: Date.now(),
|
|
size: 100
|
|
})
|
|
workflow.changeTracker = createMockChangeTracker()
|
|
workflow.content = '{}'
|
|
workflow.originalContent = '{}'
|
|
workflow.activeMode = activeMode as LoadedComfyWorkflow['activeMode']
|
|
return workflow as LoadedComfyWorkflow
|
|
}
|
|
|
|
describe('appModeStore', () => {
|
|
let workflowStore: ReturnType<typeof useWorkflowStore>
|
|
let store: ReturnType<typeof useAppModeStore>
|
|
|
|
beforeEach(() => {
|
|
setActivePinia(createTestingPinia({ stubActions: false }))
|
|
vi.mocked(app.rootGraph).extra = {}
|
|
mockResolveNode.mockReturnValue(undefined)
|
|
vi.mocked(app.rootGraph).nodes = [{ id: 1 } as LGraphNode]
|
|
workflowStore = useWorkflowStore()
|
|
store = useAppModeStore()
|
|
vi.clearAllMocks()
|
|
})
|
|
|
|
describe('enterBuilder', () => {
|
|
it('navigates to builder:arrange when in app mode with outputs', () => {
|
|
workflowStore.activeWorkflow = createBuilderWorkflow('app')
|
|
store.selectedOutputs.push(1)
|
|
|
|
store.enterBuilder()
|
|
|
|
expect(workflowStore.activeWorkflow!.activeMode).toBe('builder:arrange')
|
|
})
|
|
|
|
it('navigates to builder:inputs when in app mode without outputs', () => {
|
|
workflowStore.activeWorkflow = createBuilderWorkflow('app')
|
|
|
|
store.enterBuilder()
|
|
|
|
expect(workflowStore.activeWorkflow!.activeMode).toBe('builder:inputs')
|
|
})
|
|
|
|
it('navigates to builder:inputs when in graph mode with outputs', () => {
|
|
workflowStore.activeWorkflow = createBuilderWorkflow('graph')
|
|
store.selectedOutputs.push(1)
|
|
|
|
store.enterBuilder()
|
|
|
|
expect(workflowStore.activeWorkflow!.activeMode).toBe('builder:inputs')
|
|
})
|
|
|
|
it('navigates to builder:inputs when in graph mode without outputs', () => {
|
|
workflowStore.activeWorkflow = createBuilderWorkflow('graph')
|
|
|
|
store.enterBuilder()
|
|
|
|
expect(workflowStore.activeWorkflow!.activeMode).toBe('builder:inputs')
|
|
})
|
|
|
|
it('shows empty workflow dialog when graph has no nodes', () => {
|
|
vi.mocked(app.rootGraph).nodes = []
|
|
workflowStore.activeWorkflow = createBuilderWorkflow('graph')
|
|
|
|
store.enterBuilder()
|
|
|
|
expect(mockEmptyWorkflowDialog.show).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
onEnterBuilder: expect.any(Function),
|
|
onDismiss: expect.any(Function)
|
|
})
|
|
)
|
|
expect(workflowStore.activeWorkflow!.activeMode).toBe('graph')
|
|
})
|
|
})
|
|
|
|
describe('empty workflow dialog callbacks', () => {
|
|
function getDialogOptions(nodes: LGraphNode[] = []) {
|
|
vi.mocked(app.rootGraph).nodes = nodes
|
|
workflowStore.activeWorkflow = createBuilderWorkflow('graph')
|
|
store.enterBuilder()
|
|
return mockEmptyWorkflowDialog.lastOptions
|
|
}
|
|
|
|
it('onDismiss sets graph mode', () => {
|
|
const options = getDialogOptions()
|
|
|
|
// Move to builder so onDismiss must actually transition back
|
|
workflowStore.activeWorkflow!.activeMode = 'builder:inputs'
|
|
|
|
options.onDismiss()
|
|
|
|
expect(workflowStore.activeWorkflow!.activeMode).toBe('graph')
|
|
})
|
|
|
|
it('onEnterBuilder enters builder when nodes exist', () => {
|
|
const options = getDialogOptions([{ id: 1 } as LGraphNode])
|
|
|
|
options.onEnterBuilder()
|
|
|
|
expect(workflowStore.activeWorkflow!.activeMode).toBe('builder:inputs')
|
|
})
|
|
|
|
it('onEnterBuilder shows dialog again when no nodes', () => {
|
|
const options = getDialogOptions()
|
|
|
|
mockEmptyWorkflowDialog.show.mockClear()
|
|
options.onEnterBuilder()
|
|
|
|
expect(mockEmptyWorkflowDialog.show).toHaveBeenCalled()
|
|
})
|
|
})
|
|
|
|
describe('loadSelections pruning', () => {
|
|
function mockNode(id: number) {
|
|
return { id }
|
|
}
|
|
|
|
function workflowWithLinearData(
|
|
inputs: [number, string][],
|
|
outputs: number[]
|
|
) {
|
|
const workflow = createBuilderWorkflow('app')
|
|
workflow.changeTracker = createMockChangeTracker({
|
|
activeState: {
|
|
last_node_id: 0,
|
|
last_link_id: 0,
|
|
nodes: [],
|
|
links: [],
|
|
groups: [],
|
|
config: {},
|
|
version: 0.4,
|
|
extra: { linearData: { inputs, outputs } }
|
|
}
|
|
} as unknown as Partial<ChangeTracker>)
|
|
return workflow
|
|
}
|
|
|
|
it('removes inputs referencing deleted nodes on load', async () => {
|
|
const node1 = mockNode(1)
|
|
mockResolveNode.mockImplementation((id) =>
|
|
id == 1 ? (node1 as unknown as LGraphNode) : undefined
|
|
)
|
|
|
|
workflowStore.activeWorkflow = workflowWithLinearData(
|
|
[
|
|
[1, 'prompt'],
|
|
[99, 'width']
|
|
],
|
|
[]
|
|
)
|
|
await nextTick()
|
|
|
|
expect(store.selectedInputs).toEqual([[1, 'prompt']])
|
|
})
|
|
|
|
it('keeps inputs for existing nodes even if widget is missing', async () => {
|
|
const node1 = mockNode(1)
|
|
mockResolveNode.mockImplementation((id) =>
|
|
id == 1 ? (node1 as unknown as LGraphNode) : undefined
|
|
)
|
|
|
|
workflowStore.activeWorkflow = workflowWithLinearData(
|
|
[
|
|
[1, 'prompt'],
|
|
[1, 'deleted_widget']
|
|
],
|
|
[]
|
|
)
|
|
await nextTick()
|
|
|
|
expect(store.selectedInputs).toEqual([
|
|
[1, 'prompt'],
|
|
[1, 'deleted_widget']
|
|
])
|
|
})
|
|
|
|
it('removes outputs referencing deleted nodes on load', async () => {
|
|
const node1 = mockNode(1)
|
|
mockResolveNode.mockImplementation((id) =>
|
|
id == 1 ? (node1 as unknown as LGraphNode) : undefined
|
|
)
|
|
|
|
workflowStore.activeWorkflow = workflowWithLinearData([], [1, 99])
|
|
await nextTick()
|
|
|
|
expect(store.selectedOutputs).toEqual([1])
|
|
})
|
|
|
|
it('hasOutputs is false when all output nodes are deleted', async () => {
|
|
mockResolveNode.mockReturnValue(undefined)
|
|
|
|
workflowStore.activeWorkflow = workflowWithLinearData([], [10, 20])
|
|
await nextTick()
|
|
|
|
expect(store.selectedOutputs).toEqual([])
|
|
expect(store.hasOutputs).toBe(false)
|
|
})
|
|
})
|
|
|
|
describe('linearData sync watcher', () => {
|
|
it('writes linearData to rootGraph.extra when in builder mode', async () => {
|
|
workflowStore.activeWorkflow = createBuilderWorkflow()
|
|
await nextTick()
|
|
|
|
store.selectedOutputs.push(1)
|
|
await nextTick()
|
|
|
|
expect(app.rootGraph.extra.linearData).toEqual({
|
|
inputs: [],
|
|
outputs: [1]
|
|
})
|
|
})
|
|
|
|
it('does not write linearData when not in builder mode', async () => {
|
|
workflowStore.activeWorkflow = createBuilderWorkflow('graph')
|
|
await nextTick()
|
|
|
|
store.selectedOutputs.push(1)
|
|
await nextTick()
|
|
|
|
expect(app.rootGraph.extra.linearData).toBeUndefined()
|
|
})
|
|
|
|
it('does not write when rootGraph is null', async () => {
|
|
workflowStore.activeWorkflow = createBuilderWorkflow()
|
|
await nextTick()
|
|
|
|
const originalRootGraph = app.rootGraph
|
|
Object.defineProperty(app, 'rootGraph', { value: null, writable: true })
|
|
|
|
store.selectedOutputs.push(1)
|
|
await nextTick()
|
|
|
|
Object.defineProperty(app, 'rootGraph', {
|
|
value: originalRootGraph,
|
|
writable: true
|
|
})
|
|
})
|
|
|
|
it('reflects input changes in linearData', async () => {
|
|
workflowStore.activeWorkflow = createBuilderWorkflow()
|
|
await nextTick()
|
|
|
|
store.selectedInputs.push([42, 'prompt'])
|
|
await nextTick()
|
|
|
|
expect(app.rootGraph.extra.linearData).toEqual({
|
|
inputs: [[42, 'prompt']],
|
|
outputs: []
|
|
})
|
|
})
|
|
})
|
|
})
|