diff --git a/src/composables/node/usePromotedPreviews.test.ts b/src/composables/node/usePromotedPreviews.test.ts index 3bfc875398b..3cd16b6e8fc 100644 --- a/src/composables/node/usePromotedPreviews.test.ts +++ b/src/composables/node/usePromotedPreviews.test.ts @@ -38,16 +38,24 @@ function addInteriorNode( return node } -function seedOutputs(subgraphId: string, nodeIds: Array) { +function seedOutputs( + subgraphId: string, + nodeIds: Array, + filename = 'output.png' +) { const store = useNodeOutputStore() for (const nodeId of nodeIds) { const locatorId = createNodeLocatorId(subgraphId, toNodeId(nodeId)) store.nodeOutputs[locatorId] = { - images: [{ filename: 'output.png' }] + images: [{ filename }] } } } +function outputItems(...filenames: string[]) { + return filenames.map((filename) => expect.objectContaining({ filename })) +} + function seedPreviewImages( subgraphId: string, entries: Array<{ nodeId: number | string; urls: string[] }> @@ -77,21 +85,16 @@ function exposePreview( interface ArrangeOptions { id?: number previewMediaType?: 'image' | 'video' | 'audio' | 'model' - urls?: string[] + filename?: string } function arrangePromotedPreview(options: ArrangeOptions = {}) { - const { - id = 10, - previewMediaType, - urls = ['/view?filename=output.png'] - } = options + const { id = 10, previewMediaType, filename = 'output.png' } = options const setup = createSetup() addInteriorNode(setup, { id, previewMediaType }) exposePreview(setup, String(id)) - seedOutputs(setup.subgraph.id, [id]) - vi.mocked(useNodeOutputStore().getNodeImageUrls).mockReturnValue(urls) - return { setup, urls } + seedOutputs(setup.subgraph.id, [id], filename) + return { setup, items: outputItems(filename) } } describe(usePromotedPreviews, () => { @@ -127,7 +130,7 @@ describe(usePromotedPreviews, () => { }) it('returns image preview for promoted $$ widget with outputs', () => { - const { setup, urls } = arrangePromotedPreview({ + const { setup, items } = arrangePromotedPreview({ previewMediaType: 'image' }) @@ -137,62 +140,71 @@ describe(usePromotedPreviews, () => { sourceNodeId: '10', sourceWidgetName: CANVAS_IMAGE_PREVIEW_WIDGET, type: 'image', - urls + items } ]) }) + it('returns video type when interior node has video previewMediaType', () => { + const { setup } = arrangePromotedPreview({ + previewMediaType: 'video', + filename: 'output.webm' + }) + + const { promotedPreviews } = usePromotedPreviews(() => setup.subgraphNode) + expect(promotedPreviews.value[0].type).toBe('video') + }) + it.for([ - ['video', '/view?filename=output.webm'], - ['audio', '/view?filename=output.mp3'] - ] as const)( - 'returns %s type when interior node has %s previewMediaType', - ([mediaType, url]) => { - const { setup } = arrangePromotedPreview({ - previewMediaType: mediaType, - urls: [url] - }) + { bucket: 'video', filename: 'output.webm', expected: 'video' }, + { bucket: 'audio', filename: 'output.flac', expected: 'audio' } + ])( + 'infers promoted $expected output without a node media hint', + ({ bucket, filename, expected }) => { + const setup = createSetup() + addInteriorNode(setup) + exposePreview(setup, '10') + useNodeOutputStore().nodeOutputs[ + createNodeLocatorId(setup.subgraph.id, toNodeId(10)) + ] = { + [bucket]: [{ filename }] + } const { promotedPreviews } = usePromotedPreviews(() => setup.subgraphNode) - expect(promotedPreviews.value[0].type).toBe(mediaType) + + expect(promotedPreviews.value).toEqual([ + expect.objectContaining({ + type: expected, + items: outputItems(filename) + }) + ]) } ) it('defaults preview type to image when previewMediaType is unset', () => { - const { setup, urls } = arrangePromotedPreview() + const { setup, items } = arrangePromotedPreview() const { promotedPreviews } = usePromotedPreviews(() => setup.subgraphNode) expect(promotedPreviews.value).toEqual([ - expect.objectContaining({ type: 'image', urls }) + expect.objectContaining({ type: 'image', items }) ]) }) it('returns separate entries for multiple promoted $$ widgets', () => { const setup = createSetup() - const node10 = addInteriorNode(setup, { - id: 10, - previewMediaType: 'image' - }) - const node20 = addInteriorNode(setup, { - id: 20, - previewMediaType: 'image' - }) + addInteriorNode(setup, { id: 10, previewMediaType: 'image' }) + addInteriorNode(setup, { id: 20, previewMediaType: 'image' }) exposePreview(setup, '10') exposePreview(setup, '20') - seedOutputs(setup.subgraph.id, [10, 20]) - vi.mocked(useNodeOutputStore().getNodeImageUrls).mockImplementation( - (node: LGraphNode) => { - if (node === node10) return ['/view?a=1'] - if (node === node20) return ['/view?b=2'] - return undefined - } - ) + seedOutputs(setup.subgraph.id, [10], 'a.png') + seedOutputs(setup.subgraph.id, [20], 'b.png') const { promotedPreviews } = usePromotedPreviews(() => setup.subgraphNode) - expect(promotedPreviews.value).toHaveLength(2) - expect(promotedPreviews.value[0].urls).toEqual(['/view?a=1']) - expect(promotedPreviews.value[1].urls).toEqual(['/view?b=2']) + expect(promotedPreviews.value).toEqual([ + expect.objectContaining({ items: outputItems('a.png') }), + expect.objectContaining({ items: outputItems('b.png') }) + ]) }) it('returns preview when only nodePreviewImages exist (e.g. GLSL live preview)', () => { @@ -204,19 +216,31 @@ describe(usePromotedPreviews, () => { seedPreviewImages(setup.subgraph.id, [ { nodeId: toNodeId(10), urls: [blobUrl] } ]) - vi.mocked(useNodeOutputStore().getNodeImageUrls).mockReturnValue([blobUrl]) const { promotedPreviews } = usePromotedPreviews(() => setup.subgraphNode) expect(promotedPreviews.value).toEqual([ { sourceNodeId: '10', sourceWidgetName: CANVAS_IMAGE_PREVIEW_WIDGET, - type: 'image', - urls: [blobUrl] + type: 'preview', + url: blobUrl } ]) }) + it('prefers the live preview over saved outputs of the same node', () => { + const { setup } = arrangePromotedPreview({ previewMediaType: 'image' }) + const blobUrl = 'blob:http://localhost/live' + seedPreviewImages(setup.subgraph.id, [ + { nodeId: toNodeId(10), urls: ['blob:http://localhost/stale', blobUrl] } + ]) + + const { promotedPreviews } = usePromotedPreviews(() => setup.subgraphNode) + expect(promotedPreviews.value).toEqual([ + expect.objectContaining({ type: 'preview', url: blobUrl }) + ]) + }) + it('recomputes when preview images are populated after first evaluation', () => { const setup = createSetup() addInteriorNode(setup, { id: 10, previewMediaType: 'image' }) @@ -229,14 +253,13 @@ describe(usePromotedPreviews, () => { seedPreviewImages(setup.subgraph.id, [ { nodeId: toNodeId(10), urls: [blobUrl] } ]) - vi.mocked(useNodeOutputStore().getNodeImageUrls).mockReturnValue([blobUrl]) expect(promotedPreviews.value).toEqual([ { sourceNodeId: '10', sourceWidgetName: CANVAS_IMAGE_PREVIEW_WIDGET, - type: 'image', - urls: [blobUrl] + type: 'preview', + url: blobUrl } ]) }) @@ -286,11 +309,7 @@ describe(usePromotedPreviews, () => { sourcePreviewName: CANVAS_IMAGE_PREVIEW_WIDGET }) - const mockUrls = ['/view?filename=leaf.png'] - seedOutputs(innerSetup.subgraph.id, [leafNode.id]) - vi.mocked(useNodeOutputStore().getNodeImageUrls).mockImplementation( - (node: LGraphNode) => (node === leafNode ? mockUrls : []) - ) + seedOutputs(innerSetup.subgraph.id, [leafNode.id], 'leaf.png') const { promotedPreviews } = usePromotedPreviews( () => outerSetup.subgraphNode @@ -300,7 +319,7 @@ describe(usePromotedPreviews, () => { sourceNodeId: '10', sourceWidgetName: CANVAS_IMAGE_PREVIEW_WIDGET, type: 'image', - urls: mockUrls + items: outputItems('leaf.png') } ]) }) @@ -347,21 +366,14 @@ describe(usePromotedPreviews, () => { return undefined } ) - vi.mocked(outputStore.getNodeImageUrlsByExecutionId).mockImplementation( - (executionId) => { - if (executionId === firstLeafExecutionId) return ['blob:first'] - if (executionId === secondLeafExecutionId) return ['blob:second'] - return undefined - } - ) expect(usePromotedPreviews(() => firstHost).promotedPreviews.value).toEqual( [ { sourceNodeId: '10', sourceWidgetName: CANVAS_IMAGE_PREVIEW_WIDGET, - type: 'image', - urls: ['blob:first'] + type: 'preview', + url: 'blob:first' } ] ) @@ -371,8 +383,8 @@ describe(usePromotedPreviews, () => { { sourceNodeId: '10', sourceWidgetName: CANVAS_IMAGE_PREVIEW_WIDGET, - type: 'image', - urls: ['blob:second'] + type: 'preview', + url: 'blob:second' } ]) }) diff --git a/src/composables/node/usePromotedPreviews.ts b/src/composables/node/usePromotedPreviews.ts index 04346d34058..7d4f1406eed 100644 --- a/src/composables/node/usePromotedPreviews.ts +++ b/src/composables/node/usePromotedPreviews.ts @@ -4,11 +4,14 @@ import { computed, toValue } from 'vue' import type { LGraphNode } from '@/lib/litegraph/src/LGraphNode' import { SubgraphNode } from '@/lib/litegraph/src/subgraph/SubgraphNode' import type { UUID } from '@/utils/uuid' +import type { NodeExecutionOutput } from '@comfyorg/api-client/executionTypes' import { useNodeOutputStore } from '@/stores/nodeOutputStore' import { getPreviewExposureHostLocator, usePreviewExposureStore } from '@/stores/previewExposureStore' +import type { AugmentedResultItem } from '@/utils/resultItem' +import { isAudioResult, isVideoResult } from '@/utils/resultItem' import type { NodeId } from '@comfyorg/graph-model/nodeId' import { appendNodeExecutionId, @@ -16,23 +19,26 @@ import { } from '@comfyorg/graph-model/nodeIdentification' import type { NodeExecutionId } from '@comfyorg/graph-model/nodeIdentification' -interface PromotedPreview { - sourceNodeId: NodeId - sourceWidgetName: string +type PromotedOutput = { type: 'image' | 'video' | 'audio' - urls: string[] + items: AugmentedResultItem[] } +type PromotedLivePreview = { type: 'preview'; url: string } +type PromotedContent = PromotedOutput | PromotedLivePreview -const PREVIEW_TYPES_BY_MEDIA = { - video: 'video', - audio: 'audio' -} as const satisfies Partial> +type PromotedPreview = PromotedContent & { + sourceNodeId: NodeId + sourceWidgetName: string +} -function getPreviewMediaType(node: LGraphNode): PromotedPreview['type'] { +function getPreviewMediaType( + node: LGraphNode, + items: AugmentedResultItem[] +): PromotedOutput['type'] { const media = node.previewMediaType - if (media && media in PREVIEW_TYPES_BY_MEDIA) { - return PREVIEW_TYPES_BY_MEDIA[media as keyof typeof PREVIEW_TYPES_BY_MEDIA] - } + if (media === 'image' || media === 'video' || media === 'audio') return media + if (items.some(isVideoResult)) return 'video' + if (items.some(isAudioResult)) return 'audio' return 'image' } @@ -42,36 +48,37 @@ export function usePromotedPreviews( const previewExposureStore = usePreviewExposureStore() const nodeOutputStore = useNodeOutputStore() - /** Touches reactive sources for Vue tracking; `getNodeImageUrls` reads non-reactive app state. */ - function readReactivePreviewUrls( + function toPromotedContent( + node: LGraphNode, + previews: string[] | undefined, + outputs: NodeExecutionOutput | undefined + ): PromotedContent | undefined { + const url = previews?.at(-1) + if (url) return { type: 'preview', url } + if (!outputs) return undefined + const items = nodeOutputStore.getNodeOutputItems(node, outputs) + if (items.length) return { type: getPreviewMediaType(node, items), items } + return undefined + } + + function readPromotedContent( leafHost: SubgraphNode, - leafSourceNodeId: NodeId, - leafExecutionId: NodeExecutionId, + sourceNodeId: NodeId, + executionId: NodeExecutionId, interiorNode: LGraphNode - ): string[] | undefined { - const locatorId = createNodeLocatorId( - leafHost.subgraph.id, - leafSourceNodeId - ) - if (!locatorId) return undefined - - const reactiveOutputs = nodeOutputStore.nodeOutputs[locatorId] - const reactivePreviews = nodeOutputStore.nodePreviewImages[locatorId] - const reactiveExecutionOutputs = - nodeOutputStore.getNodeOutputByExecutionId(leafExecutionId) - const reactiveExecutionPreviews = - nodeOutputStore.getNodePreviewImagesByExecutionId(leafExecutionId) - const hasAnySource = - reactiveOutputs?.images?.length || - reactivePreviews?.length || - reactiveExecutionOutputs?.images?.length || - reactiveExecutionPreviews?.length - if (!hasAnySource) return undefined + ): PromotedContent | undefined { + const locatorId = createNodeLocatorId(leafHost.subgraph.id, sourceNodeId) return ( - nodeOutputStore.getNodeImageUrlsByExecutionId( - leafExecutionId, - interiorNode - ) ?? nodeOutputStore.getNodeImageUrls(interiorNode) + toPromotedContent( + interiorNode, + nodeOutputStore.getNodePreviewImagesByExecutionId(executionId), + nodeOutputStore.getNodeOutputByExecutionId(executionId) + ) ?? + toPromotedContent( + interiorNode, + nodeOutputStore.nodePreviewImages[locatorId], + nodeOutputStore.nodeOutputs[locatorId] + ) ) } @@ -142,20 +149,19 @@ export function usePromotedPreviews( ) if (!leafExecutionId) return [] - const urls = readReactivePreviewUrls( + const content = readPromotedContent( leafHost, leaf.sourceNodeId, leafExecutionId, interiorNode ) - if (!urls?.length) return [] + if (!content) return [] return [ { + ...content, sourceNodeId: leaf.sourceNodeId, - sourceWidgetName: leaf.sourcePreviewName, - type: getPreviewMediaType(interiorNode), - urls + sourceWidgetName: leaf.sourcePreviewName } ] }) diff --git a/src/renderer/extensions/vueNodes/VideoPreview.agentReset.test.ts b/src/renderer/extensions/vueNodes/VideoPreview.agentReset.test.ts index 3bf46f04e2e..764a17771ce 100644 --- a/src/renderer/extensions/vueNodes/VideoPreview.agentReset.test.ts +++ b/src/renderer/extensions/vueNodes/VideoPreview.agentReset.test.ts @@ -19,6 +19,7 @@ import { LGraph, LGraphNode, LiteGraph } from '@/lib/litegraph/src/litegraph' import type { ISerialisedGraph } from '@comfyorg/graph-model/serialisation' import enMessages from '@/locales/en/main.json' with { type: 'json' } import { useNodeDataStore } from '@/stores/nodeDataStore' +import type { AugmentedResultItem } from '@/utils/resultItem' import { graphScopeOf } from '@comfyorg/graph-model/graphScopeId' import { AgentCrdtProjection } from '@/workbench/extensions/agent/crdt/agentCrdtProjection' import { FollowerDoc } from '@/workbench/extensions/agent/crdt/followerDoc' @@ -114,6 +115,17 @@ function videoUrlFor(nodeId: string | number): string { return `/api/view?filename=clip-${nodeId}.mp4&type=output` } +function videoItemFor(nodeId: string | number): AugmentedResultItem { + return { + filename: `clip-${nodeId}.mp4`, + subfolder: '', + type: 'output', + mediaType: 'video', + nodeId, + previewUrl: videoUrlFor(nodeId) + } +} + /** * `GraphCanvas`'s store-backed, id-keyed node list, rendering the production * `NodeContent` so the real `VideoPreview` owns the `