diff --git a/packages/api-client/src/jobTypes.ts b/packages/api-client/src/jobTypes.ts index ec67a0ad152..ec1ee8b1a78 100644 --- a/packages/api-client/src/jobTypes.ts +++ b/packages/api-client/src/jobTypes.ts @@ -6,12 +6,14 @@ * Jobs API provides a memory-optimized alternative to history API. */ -import { zJobEntry } from '@comfyorg/ingest-types/zod' +import { zJobEntry, zJobExecutionMetaEntry } from '@comfyorg/ingest-types/zod' import { z } from 'zod' import { resultItemType } from './resultItemTypeSchema' import { zTaskOutput } from './executionTypes' +export { zJobExecutionMetaEntry } + const zJobStatus = z.enum([ 'pending', 'in_progress', diff --git a/src/composables/useReconnectQueueRefresh.test.ts b/src/composables/useReconnectQueueRefresh.test.ts index 54eaf13c8ea..b1ee3a9dbac 100644 --- a/src/composables/useReconnectQueueRefresh.test.ts +++ b/src/composables/useReconnectQueueRefresh.test.ts @@ -144,6 +144,152 @@ describe('useReconnectQueueRefresh', () => { ]) }) + it('sends an expanded node output to the node it is displayed on', async () => { + followRun('job-1') + vi.mocked(api.getJobDetail).mockResolvedValue({ + ...makeJob('job-1', 'completed'), + outputs: { + '15.0.0.3': { images: [image] }, + '9': { images: [image] } + }, + execution_meta: { + '15.0.0.3': { + node_id: '15.0.0.3', + display_node: '15', + parent_node: '15', + real_node_id: '5' + }, + '9': { node_id: '9', display_node: '9' }, + '4': null + } + }) + + await useReconnectQueueRefresh()() + + expect(replayedExecutedFrames()).toEqual([ + ['executed', expect.objectContaining({ node: '9', display_node: '9' })], + [ + 'executed', + expect.objectContaining({ node: '15.0.0.3', display_node: '15' }) + ] + ]) + }) + + it.for([ + ['no metadata', undefined], + ['malformed metadata', 'not-an-object'], + [ + 'metadata without a display node', + { '15.0.0.3': { node_id: '15.0.0.3' } } + ] + ] as const)( + 'falls back to the output key when the job detail has %s', + async ([, executionMeta]) => { + followRun('job-1') + vi.mocked(api.getJobDetail).mockResolvedValue({ + ...makeJob('job-1', 'completed'), + outputs: { '15.0.0.3': { images: [image] } }, + execution_meta: executionMeta + }) + + await useReconnectQueueRefresh()() + + expect(replayedExecutedFrames()).toEqual([ + [ + 'executed', + expect.objectContaining({ + node: '15.0.0.3', + display_node: '15.0.0.3' + }) + ] + ]) + } + ) + + it('replays a display node output before the expanded output, as live', async () => { + const own = { images: [{ ...image, filename: 'own.png' }] } + const child = { images: [{ ...image, filename: 'child.png' }] } + followRun('job-1') + vi.mocked(api.getJobDetail).mockResolvedValue({ + ...makeJob('job-1', 'completed'), + outputs: { '17:15.0.0.3': child, '17:15': own }, + execution_meta: { + '17:15': { node_id: '17:15', display_node: '17:15' }, + '17:15.0.0.3': { + node_id: '17:15.0.0.3', + display_node: '17:15', + parent_node: '17:15' + } + } + }) + + await useReconnectQueueRefresh()() + + expect(replayedExecutedFrames()).toEqual([ + [ + 'executed', + expect.objectContaining({ + node: '17:15', + display_node: '17:15', + output: own + }) + ], + [ + 'executed', + expect.objectContaining({ + node: '17:15.0.0.3', + display_node: '17:15', + output: child + }) + ] + ]) + }) + + it('keeps a cached output on its own node when its metadata names the node that first ran it', async () => { + followRun('job-1') + vi.mocked(api.getJobDetail).mockResolvedValue({ + ...makeJob('job-1', 'completed'), + outputs: { '7': { images: [image] } }, + execution_meta: { '7': { node_id: '4', display_node: '4' } } + }) + + await useReconnectQueueRefresh()() + + expect(replayedExecutedFrames()).toEqual([ + ['executed', expect.objectContaining({ node: '7', display_node: '7' })] + ]) + }) + + it('falls back to the output key when the display node is not a node id', async () => { + followRun('job-1') + vi.mocked(api.getJobDetail).mockResolvedValue({ + ...makeJob('job-1', 'completed'), + outputs: { '7': { images: [image] } }, + execution_meta: { '7': { node_id: '7', display_node: ':' } } + }) + + await useReconnectQueueRefresh()() + + expect(replayedExecutedFrames()).toEqual([ + ['executed', expect.objectContaining({ node: '7', display_node: '7' })] + ]) + }) + + it('ignores execution_meta that comes back as a list', async () => { + followRun('job-1') + vi.mocked(api.getJobDetail).mockResolvedValue({ + ...makeJob('job-1', 'completed'), + outputs: { '0': { images: [image] } }, + execution_meta: [{ display_node: '9' }] + }) + + await useReconnectQueueRefresh()() + + expect(replayedExecutedFrames()).toEqual([ + ['executed', expect.objectContaining({ node: '0', display_node: '0' })] + ]) + }) + it('lets the terminal event clear the run after its output event', async () => { followRun('job-1') vi.mocked(api.getJobDetail).mockResolvedValue(finishedJob) diff --git a/src/composables/useReconnectQueueRefresh.ts b/src/composables/useReconnectQueueRefresh.ts index 6f4e04d34a6..2bd9320315c 100644 --- a/src/composables/useReconnectQueueRefresh.ts +++ b/src/composables/useReconnectQueueRefresh.ts @@ -1,6 +1,8 @@ -import { Semaphore, delay, withTimeout } from 'es-toolkit' +import { tryNormalizeNodeExecutionId } from '@comfyorg/graph-model/nodeIdentification' +import { Semaphore, delay, partition, withTimeout } from 'es-toolkit' import { t } from '@/i18n' +import { zJobExecutionMetaEntry } from '@comfyorg/api-client/jobTypes' import type { ExecutionError, JobDetail } from '@comfyorg/api-client/jobTypes' import { api } from '@/scripts/api' import { useExecutionStore } from '@/stores/executionStore' @@ -19,6 +21,7 @@ type JobOutcome = state: 'ended' status: EndedStatus outputs?: TaskOutput + displayNodes?: Map executionError?: ExecutionError timestamp: number } @@ -41,6 +44,13 @@ function unknownExecutionError(): ExecutionError { } } +function ownDisplayNode(node: string, metaEntry: unknown) { + const entry = zJobExecutionMetaEntry.safeParse(metaEntry) + if (!entry.success || !entry.data.display_node) return null + const { node_id: metaNode = node, display_node: displayNode } = entry.data + return metaNode === node ? tryNormalizeNodeExecutionId(displayNode) : null +} + /** * Returns the handler for the `reconnected` api event. */ @@ -83,6 +93,19 @@ export function useReconnectQueueRefresh() { return historyTask.outputs } + function displayNodesOf(detail: JobDetail | undefined) { + const meta = detail?.execution_meta + if (meta == null || typeof meta !== 'object' || Array.isArray(meta)) { + return undefined + } + const displayNodes = new Map() + for (const [node, entry] of Object.entries(meta)) { + const displayNode = ownDisplayNode(node, entry) + if (displayNode) displayNodes.set(node, displayNode) + } + return displayNodes + } + function completedOutcome( detail: JobDetail | undefined, historyTask: TaskItemImpl | undefined @@ -93,6 +116,7 @@ export function useReconnectQueueRefresh() { state: 'ended', status: 'completed', outputs, + displayNodes: displayNodesOf(detail), timestamp: outcomeTimestamp(detail, historyTask) } } @@ -137,11 +161,24 @@ export function useReconnectQueueRefresh() { return readOutcome(jobId, historyTask) } - function replayOutputs(jobId: JobId, outputs: TaskOutput) { - for (const [node, output] of Object.entries(outputs)) { + function replayOutputs( + jobId: JobId, + outputs: TaskOutput, + displayNodes: Map | undefined + ) { + const frames = Object.entries(outputs).map(([node, output]) => ({ + node, + output, + displayNode: displayNodes?.get(node) ?? node + })) + const [own, expanded] = partition( + frames, + ({ node, displayNode }) => node === displayNode + ) + for (const { node, output, displayNode } of [...own, ...expanded]) { api.dispatchCustomEvent('executed', { node, - display_node: node, + display_node: displayNode, output, prompt_id: jobId }) @@ -215,7 +252,9 @@ export function useReconnectQueueRefresh() { function replayOutcome(jobId: JobId, outcome: JobOutcome) { if (outcome.state !== 'ended' || !isFollowed(jobId)) return - if (outcome.outputs) replayOutputs(jobId, outcome.outputs) + if (outcome.outputs) { + replayOutputs(jobId, outcome.outputs, outcome.displayNodes) + } dispatchTerminal(jobId, outcome) }