From 75cac4d224f87a14ef7ba35b150e92fd3f5a4629 Mon Sep 17 00:00:00 2001 From: Terry Jia Date: Sat, 5 Sep 2026 03:06:28 -0400 Subject: [PATCH] [backport core/1.53] feat(widgets): add RESOLUTION_PREVIEW readout widget (#16511) Display-only widget for the ResolutionSelector node showing the width/height computed from the sibling aspect_ratio/megapixels/multiple widgets, updating live as they change. Reads sibling values reactively via widgetValueStore and mirrors the backend rounding math. Follows the CURVE/VIDEO_EDIT rails: input spec in nodeDefSchemaV2, constructor in widgets.ts map, Vue component via widgetRegistry. The widget sets serialize=false on both the widget (widgets_values) and its options (API prompt), so workflow files and prompts are unchanged. Need BE https://github.com/Comfy-Org/ComfyUI/pull/16013 ## Backport notes Conflict in nodeDefSchemaV2.ts: main's trailing type guards (isColorInputSpec / isTextareaInputSpec / isGalleriaInputSpec) are not on core/1.53, so only isResolutionPreviewInputSpec was added. --- src/lib/litegraph/src/types/widgets.ts | 16 ++ src/locales/en/main.json | 1 + .../WidgetResolutionPreview.test.ts | 213 ++++++++++++++++++ .../components/WidgetResolutionPreview.vue | 106 +++++++++ .../composables/useResolutionPreviewWidget.ts | 35 +++ .../widgets/registry/widgetRegistry.ts | 11 + src/schemas/nodeDef/nodeDefSchemaV2.ts | 19 ++ src/scripts/widgets.ts | 4 + 8 files changed, 405 insertions(+) create mode 100644 src/renderer/extensions/vueNodes/widgets/components/WidgetResolutionPreview.test.ts create mode 100644 src/renderer/extensions/vueNodes/widgets/components/WidgetResolutionPreview.vue create mode 100644 src/renderer/extensions/vueNodes/widgets/composables/useResolutionPreviewWidget.ts diff --git a/src/lib/litegraph/src/types/widgets.ts b/src/lib/litegraph/src/types/widgets.ts index e2998ba3df5..8f228e1f289 100644 --- a/src/lib/litegraph/src/types/widgets.ts +++ b/src/lib/litegraph/src/types/widgets.ts @@ -150,6 +150,7 @@ export type IWidget = | ICompositorWidget | IRangeWidget | IVideoEditWidget + | IResolutionPreviewWidget | IBoundingBoxesWidget | IColorsWidget @@ -424,6 +425,21 @@ export interface IVideoEditWidget extends IBaseWidget< value: VideoEditValue } +export interface IWidgetResolutionPreviewOptions extends IWidgetOptions { + ratio_widget?: string + megapixels_widget?: string + multiple_widget?: string +} + +export interface IResolutionPreviewWidget extends IBaseWidget< + null, + 'resolutionpreview', + IWidgetResolutionPreviewOptions +> { + type: 'resolutionpreview' + value: null +} + /** * Valid widget types. TS cannot provide easily extensible type safety for this at present. * Override linkedWidgets[] diff --git a/src/locales/en/main.json b/src/locales/en/main.json index 30d0df19b4e..3c7e26f572c 100644 --- a/src/locales/en/main.json +++ b/src/locales/en/main.json @@ -1,6 +1,7 @@ { "g": { "shortcutSuffix": " ({shortcut})", + "megapixelsValue": "{count} MP", "user": "User", "you": "You", "currentUser": "Current user", diff --git a/src/renderer/extensions/vueNodes/widgets/components/WidgetResolutionPreview.test.ts b/src/renderer/extensions/vueNodes/widgets/components/WidgetResolutionPreview.test.ts new file mode 100644 index 00000000000..30d2429955f --- /dev/null +++ b/src/renderer/extensions/vueNodes/widgets/components/WidgetResolutionPreview.test.ts @@ -0,0 +1,213 @@ +import { createTestingPinia } from '@pinia/testing' +import { render, screen } from '@testing-library/vue' +import { setActivePinia } from 'pinia' +import type { Pinia } from 'pinia' +import { beforeEach, describe, expect, it, vi } from 'vitest' +import { nextTick } from 'vue' +import { createI18n } from 'vue-i18n' + +const resolveNodeMock = vi.hoisted(() => vi.fn()) +vi.mock('@/utils/litegraphUtil', () => ({ resolveNode: resolveNodeMock })) + +import type { IWidgetResolutionPreviewOptions } from '@/lib/litegraph/src/types/widgets' +import { useWidgetValueStore } from '@/stores/widgetValueStore' +import { toNodeId } from '@/types/nodeId' +import type { SimplifiedWidget } from '@/types/simplifiedWidget' +import { widgetId } from '@/types/widgetId' + +import WidgetResolutionPreview from './WidgetResolutionPreview.vue' + +const GRAPH_ID = 'test-graph' +const NODE_ID = toNodeId(1) + +const i18n = createI18n({ + legacy: false, + locale: 'en', + messages: { + en: { + g: { megapixelsValue: '{count} MP' } + } + } +}) + +let pinia: Pinia + +beforeEach(() => { + pinia = createTestingPinia({ stubActions: false }) + setActivePinia(pinia) + resolveNodeMock.mockReturnValue({ + id: NODE_ID, + graph: { rootGraph: { id: GRAPH_ID } } + }) +}) + +function registerSibling(name: string, type: string, value: unknown) { + useWidgetValueStore().registerWidget(widgetId(GRAPH_ID, NODE_ID, name), { + type, + value: value as never, + options: {} + }) +} + +function registerDefaultSiblings( + aspectRatio: string, + megapixels: number, + multiple: number +) { + registerSibling('aspect_ratio', 'combo', aspectRatio) + registerSibling('megapixels', 'number', megapixels) + registerSibling('multiple', 'number', multiple) +} + +function renderPreview(options: IWidgetResolutionPreviewOptions = {}) { + const widget: SimplifiedWidget = { + name: 'preview', + type: 'resolutionpreview', + value: null, + options + } + return render(WidgetResolutionPreview, { + props: { widget, nodeId: NODE_ID }, + global: { plugins: [pinia, i18n] } + }) +} + +function displayedValue(): string { + return screen.getByTestId('resolution-preview-value').textContent.trim() +} + +describe('WidgetResolutionPreview', () => { + // Expected values generated from ResolutionSelector.execute in + // comfy_extras/nodes_resolution.py (Comfy-Org/ComfyUI#16013) — the + // backend contract tests in that repo pin the same formula. + it.for([ + ['1:1 (Square)', '1024 × 1024'], + ['2:3 (Portrait Photo)', '840 × 1256'], + ['3:2 (Photo)', '1256 × 840'], + ['3:4 (Portrait Standard)', '888 × 1184'], + ['4:3 (Standard)', '1184 × 888'], + ['9:16 (Portrait Widescreen)', '768 × 1368'], + ['16:9 (Widescreen)', '1368 × 768'], + ['21:9 (Ultrawide)', '1568 × 672'] + ] as const)( + 'matches the backend for %s at 1.0 MP ×8', + ([label, expected]) => { + registerDefaultSiblings(label, 1.0, 8) + renderPreview() + + expect(displayedValue()).toBe(expected) + } + ) + + it('matches the backend for a non-default multiple', () => { + registerDefaultSiblings('3:4 (Portrait Standard)', 2.0, 32) + renderPreview() + + expect(displayedValue()).toBe('1248 × 1664') + }) + + it('rounds half-ties to even like Python round()', () => { + // scale is exactly 1028 here, so width/multiple is an exact 128.5 tie: + // Math.round would produce 1032, the backend produces 1024. + registerDefaultSiblings('1:1 (Square)', 1.0078277587890625, 8) + renderPreview() + + expect(displayedValue()).toBe('1024 × 1024') + }) + + it('supports non-integer ratio labels', () => { + registerDefaultSiblings('1.85:1 (Cinema)', 1.0, 8) + renderPreview() + + expect(displayedValue()).toBe('1392 × 752') + }) + + it('updates live when a sibling value changes in the store', async () => { + registerDefaultSiblings('1:1 (Square)', 1.0, 8) + renderPreview() + expect(displayedValue()).toBe('1024 × 1024') + + useWidgetValueStore().setValue( + widgetId(GRAPH_ID, NODE_ID, 'aspect_ratio'), + '16:9 (Widescreen)' + ) + await nextTick() + + expect(displayedValue()).toBe('1368 × 768') + }) + + it('reads siblings through the configured widget names', () => { + registerSibling('ratio', 'combo', '16:9 (Widescreen)') + registerSibling('mp', 'number', 0.4) + registerSibling('resolution_steps', 'number', 32) + renderPreview({ + ratio_widget: 'ratio', + megapixels_widget: 'mp', + multiple_widget: 'resolution_steps' + }) + + expect(displayedValue()).toBe('864 × 480') + }) + + it('renders the placeholder when siblings are not registered', () => { + renderPreview() + + expect(screen.queryByTestId('resolution-preview-value')).toBeNull() + expect(screen.getByText('—')).toBeTruthy() + }) + + it('renders the placeholder instead of guessing a missing multiple', () => { + registerSibling('aspect_ratio', 'combo', '1:1 (Square)') + registerSibling('megapixels', 'number', 1.0) + renderPreview() + + expect(screen.queryByTestId('resolution-preview-value')).toBeNull() + expect(screen.getByText('—')).toBeTruthy() + }) + + it.for([ + { desc: 'a malformed ratio label', ratio: 'Square', mp: 1.0, multiple: 8 }, + { + desc: 'a zero-component ratio', + ratio: '0:1 (Degenerate)', + mp: 1.0, + multiple: 8 + }, + { + desc: 'non-positive megapixels', + ratio: '1:1 (Square)', + mp: 0, + multiple: 8 + }, + { + desc: 'a non-numeric megapixels value', + ratio: '1:1 (Square)', + mp: '1.0', + multiple: 8 + }, + { + desc: 'a non-positive multiple', + ratio: '1:1 (Square)', + mp: 1.0, + multiple: 0 + } + ])('renders the placeholder for $desc', ({ ratio, mp, multiple }) => { + registerSibling('aspect_ratio', 'combo', ratio) + registerSibling('megapixels', 'number', mp) + registerSibling('multiple', 'number', multiple) + renderPreview() + + expect(screen.queryByTestId('resolution-preview-value')).toBeNull() + expect(screen.getByText('—')).toBeTruthy() + }) + + it('shows a preview once siblings become registered', async () => { + renderPreview() + expect(screen.queryByTestId('resolution-preview-value')).toBeNull() + + registerDefaultSiblings('1:1 (Square)', 1.0, 8) + await nextTick() + + expect(displayedValue()).toBe('1024 × 1024') + }) +}) diff --git a/src/renderer/extensions/vueNodes/widgets/components/WidgetResolutionPreview.vue b/src/renderer/extensions/vueNodes/widgets/components/WidgetResolutionPreview.vue new file mode 100644 index 00000000000..184bf4aafd3 --- /dev/null +++ b/src/renderer/extensions/vueNodes/widgets/components/WidgetResolutionPreview.vue @@ -0,0 +1,106 @@ + + + diff --git a/src/renderer/extensions/vueNodes/widgets/composables/useResolutionPreviewWidget.ts b/src/renderer/extensions/vueNodes/widgets/composables/useResolutionPreviewWidget.ts new file mode 100644 index 00000000000..0603b2c1950 --- /dev/null +++ b/src/renderer/extensions/vueNodes/widgets/composables/useResolutionPreviewWidget.ts @@ -0,0 +1,35 @@ +import type { LGraphNode } from '@/lib/litegraph/src/litegraph' +import type { + IResolutionPreviewWidget, + IWidgetResolutionPreviewOptions +} from '@/lib/litegraph/src/types/widgets' +import { isResolutionPreviewInputSpec } from '@/schemas/nodeDef/nodeDefSchemaV2' +import type { InputSpec as InputSpecV2 } from '@/schemas/nodeDef/nodeDefSchemaV2' +import type { ComfyWidgetConstructorV2 } from '@/scripts/widgets' + +export const useResolutionPreviewWidget = (): ComfyWidgetConstructorV2 => { + return ( + node: LGraphNode, + inputSpec: InputSpecV2 + ): IResolutionPreviewWidget => { + const spec = isResolutionPreviewInputSpec(inputSpec) ? inputSpec : undefined + const options: IWidgetResolutionPreviewOptions = { + serialize: false, + canvasOnly: false, + hideInPanel: true, + ratio_widget: spec?.ratio_widget, + megapixels_widget: spec?.megapixels_widget, + multiple_widget: spec?.multiple_widget + } + const rawWidget = node.addWidget( + 'resolutionpreview', + inputSpec.name, + null, + () => {}, + options + ) + rawWidget.serialize = false + + return rawWidget as IResolutionPreviewWidget + } +} diff --git a/src/renderer/extensions/vueNodes/widgets/registry/widgetRegistry.ts b/src/renderer/extensions/vueNodes/widgets/registry/widgetRegistry.ts index 60a6b21f12d..acc87d6d3db 100644 --- a/src/renderer/extensions/vueNodes/widgets/registry/widgetRegistry.ts +++ b/src/renderer/extensions/vueNodes/widgets/registry/widgetRegistry.ts @@ -88,6 +88,9 @@ const WidgetVideoEdit = defineAsyncComponent( const WidgetColors = defineAsyncComponent( () => import('@/components/palette/WidgetColors.vue') ) +const WidgetResolutionPreview = defineAsyncComponent( + () => import('../components/WidgetResolutionPreview.vue') +) export const FOR_TESTING = { WidgetButton, @@ -286,6 +289,14 @@ const coreWidgetDefinitions: Array<[string, WidgetDefinition]> = [ aliases: ['COLORS'], essential: false } + ], + [ + 'resolutionpreview', + { + component: WidgetResolutionPreview, + aliases: ['RESOLUTION_PREVIEW'], + essential: false + } ] ] diff --git a/src/schemas/nodeDef/nodeDefSchemaV2.ts b/src/schemas/nodeDef/nodeDefSchemaV2.ts index 191a6fb63d5..f2fd5e83697 100644 --- a/src/schemas/nodeDef/nodeDefSchemaV2.ts +++ b/src/schemas/nodeDef/nodeDefSchemaV2.ts @@ -214,6 +214,15 @@ const zVideoEditInputSpec = zBaseInputOptions.extend({ default: zVideoEditValue.optional() }) +const zResolutionPreviewInputSpec = zBaseInputOptions.extend({ + type: z.literal('RESOLUTION_PREVIEW'), + name: z.string(), + isOptional: z.boolean().optional(), + ratio_widget: z.string().optional(), + megapixels_widget: z.string().optional(), + multiple_widget: z.string().optional() +}) + const zCustomInputSpec = zBaseInputOptions.extend({ type: z.string(), name: z.string(), @@ -239,6 +248,7 @@ const zInputSpec = z.union([ zCurveInputSpec, zRangeInputSpec, zVideoEditInputSpec, + zResolutionPreviewInputSpec, zCustomInputSpec ]) @@ -288,6 +298,9 @@ export type TextareaInputSpec = z.infer export type CurveInputSpec = z.infer export type RangeInputSpec = z.infer export type VideoEditInputSpec = z.infer +export type ResolutionPreviewInputSpec = z.infer< + typeof zResolutionPreviewInputSpec +> export type CustomInputSpec = z.infer export type InputSpec = z.infer @@ -329,3 +342,9 @@ export const isChartInputSpec = ( ): inputSpec is ChartInputSpec => { return inputSpec.type === 'CHART' } + +export const isResolutionPreviewInputSpec = ( + inputSpec: InputSpec +): inputSpec is ResolutionPreviewInputSpec => { + return inputSpec.type === 'RESOLUTION_PREVIEW' +} diff --git a/src/scripts/widgets.ts b/src/scripts/widgets.ts index 3c1cced108d..64a98bf3b71 100644 --- a/src/scripts/widgets.ts +++ b/src/scripts/widgets.ts @@ -25,6 +25,7 @@ import { useIntWidget } from '@/renderer/extensions/vueNodes/widgets/composables import { useMarkdownWidget } from '@/renderer/extensions/vueNodes/widgets/composables/useMarkdownWidget' import { usePainterWidget } from '@/renderer/extensions/vueNodes/widgets/composables/usePainterWidget' import { useRangeWidget } from '@/renderer/extensions/vueNodes/widgets/composables/useRangeWidget' +import { useResolutionPreviewWidget } from '@/renderer/extensions/vueNodes/widgets/composables/useResolutionPreviewWidget' import { useStringWidget } from '@/renderer/extensions/vueNodes/widgets/composables/useStringWidget' import { useTextareaWidget } from '@/renderer/extensions/vueNodes/widgets/composables/useTextareaWidget' import { useVideoEditWidget } from '@/renderer/extensions/vueNodes/widgets/composables/useVideoEditWidget' @@ -240,6 +241,9 @@ export const ComfyWidgets = { CURVE: transformWidgetConstructorV2ToV1(useCurveWidget()), RANGE: transformWidgetConstructorV2ToV1(useRangeWidget()), VIDEO_EDIT: transformWidgetConstructorV2ToV1(useVideoEditWidget()), + RESOLUTION_PREVIEW: transformWidgetConstructorV2ToV1( + useResolutionPreviewWidget() + ), BOUNDING_BOXES: transformWidgetConstructorV2ToV1(useBoundingBoxesWidget()), COLORS: transformWidgetConstructorV2ToV1(useColorsWidget()), ...dynamicWidgets