mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-26 01:34:07 +00:00
fix: sync DOM widget values to widgetValueStore on registration (#9166)
## Summary Override `setNodeId` in `BaseDOMWidgetImpl` to sync the DOM-resolved value into the widget value store, fixing empty system prompts in Vue nodes (Nodes 2.0). ## Changes - **What**: DOM widgets (e.g. textarea for Gemini system_prompt) resolve their value through `options.getValue()` / DOM elements, not `_state.value`. When `BaseWidget.setNodeId` registers with the store, it spreads `_state.value` which is `undefined` for DOM widgets. The override captures the DOM-resolved value before registration and syncs it into the store afterward — keeping the fix in the DOM widget layer where the mismatch originates, leaving `BaseWidget` unchanged. ## Review Focus - Whether capturing `this.value` before `super.setNodeId()` and writing it after is the right sequencing - Whether this correctly handles all DOM widget subtypes (`DOMWidgetImpl`, `ComponentWidgetImpl`) Supersedes #9164 ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-9166-fix-sync-DOM-widget-values-to-widgetValueStore-on-registration-3116d73d3650816f8cece866a9272baa) by [Unito](https://www.unito.io)
This commit is contained in:
@@ -7,6 +7,7 @@ import {
|
||||
LegacyWidget,
|
||||
LiteGraph
|
||||
} from '@/lib/litegraph/src/litegraph'
|
||||
import type { NodeId } from '@/lib/litegraph/src/litegraph'
|
||||
import type {
|
||||
IBaseWidget,
|
||||
IWidgetOptions
|
||||
@@ -14,6 +15,7 @@ import type {
|
||||
import type { InputSpec } from '@/schemas/nodeDef/nodeDefSchemaV2'
|
||||
import { useDomWidgetStore } from '@/stores/domWidgetStore'
|
||||
import { usePromotionStore } from '@/stores/promotionStore'
|
||||
import { useWidgetValueStore } from '@/stores/widgetValueStore'
|
||||
import { generateUUID } from '@/utils/formatUtil'
|
||||
|
||||
export interface BaseDOMWidget<
|
||||
@@ -150,6 +152,18 @@ abstract class BaseDOMWidgetImpl<V extends object | string>
|
||||
this.callback?.(this.value)
|
||||
}
|
||||
|
||||
override setNodeId(nodeId: NodeId): void {
|
||||
// Capture the DOM-resolved value before registration, since the base class
|
||||
// registers _state.value which is undefined for DOM widgets (their value
|
||||
// lives in the DOM element / options.getValue).
|
||||
const resolvedValue = this.value
|
||||
super.setNodeId(nodeId)
|
||||
const graphId = this.node.graph?.rootGraph.id
|
||||
if (!graphId) return
|
||||
const state = useWidgetValueStore().getWidget(graphId, nodeId, this.name)
|
||||
if (state) state.value = resolvedValue
|
||||
}
|
||||
|
||||
get margin(): number {
|
||||
return this.options.margin ?? BaseDOMWidgetImpl.DEFAULT_MARGIN
|
||||
}
|
||||
|
||||
48
src/scripts/domWidgetStore.test.ts
Normal file
48
src/scripts/domWidgetStore.test.ts
Normal file
@@ -0,0 +1,48 @@
|
||||
import { createTestingPinia } from '@pinia/testing'
|
||||
import { setActivePinia } from 'pinia'
|
||||
import { beforeEach, describe, expect, it } from 'vitest'
|
||||
|
||||
import { LGraph, LGraphNode } from '@/lib/litegraph/src/litegraph'
|
||||
import { DOMWidgetImpl } from '@/scripts/domWidget'
|
||||
import { useWidgetValueStore } from '@/stores/widgetValueStore'
|
||||
|
||||
describe('DOMWidgetImpl store integration', () => {
|
||||
let graph: LGraph
|
||||
let node: LGraphNode
|
||||
let store: ReturnType<typeof useWidgetValueStore>
|
||||
|
||||
beforeEach(() => {
|
||||
setActivePinia(createTestingPinia({ stubActions: false }))
|
||||
store = useWidgetValueStore()
|
||||
graph = new LGraph()
|
||||
node = new LGraphNode('TestNode')
|
||||
node.id = 1
|
||||
graph.add(node)
|
||||
})
|
||||
|
||||
it('registers DOM-resolved value in store via setNodeId', () => {
|
||||
const defaultValue = 'You are an expert image-generation engine.'
|
||||
const element = document.createElement('textarea')
|
||||
element.value = defaultValue
|
||||
|
||||
const widget = new DOMWidgetImpl({
|
||||
node,
|
||||
name: 'system_prompt',
|
||||
type: 'customtext',
|
||||
element,
|
||||
options: {
|
||||
getValue: () => element.value as string,
|
||||
setValue: (v: string) => {
|
||||
element.value = v
|
||||
const state = store.getWidget(graph.id, node.id, 'system_prompt')
|
||||
if (state) state.value = v
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
widget.setNodeId(node.id)
|
||||
|
||||
const state = store.getWidget(graph.id, node.id, 'system_prompt')
|
||||
expect(state?.value).toBe(defaultValue)
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user