Files
ComfyUI_frontend/src/renderer/extensions/vueNodes/components/NodeHeader.test.ts
2025-09-28 15:33:29 -07:00

273 lines
8.3 KiB
TypeScript

import { mount } from '@vue/test-utils'
import { createPinia, setActivePinia } from 'pinia'
import PrimeVue from 'primevue/config'
import InputText from 'primevue/inputtext'
import { describe, expect, it, vi } from 'vitest'
import { createI18n } from 'vue-i18n'
import type { VueNodeData } from '@/composables/graph/useGraphNodeManager'
import enMessages from '@/locales/en/main.json'
import { useSettingStore } from '@/platform/settings/settingStore'
import type { Settings } from '@/schemas/apiSchema'
import type { ComfyNodeDef } from '@/schemas/nodeDefSchema'
import { ComfyNodeDefImpl, useNodeDefStore } from '@/stores/nodeDefStore'
import NodeHeader from './NodeHeader.vue'
const makeNodeData = (overrides: Partial<VueNodeData> = {}): VueNodeData => ({
id: '1',
title: 'KSampler',
type: 'KSampler',
mode: 0,
selected: false,
executing: false,
widgets: [],
inputs: [],
outputs: [],
flags: { collapsed: false },
...overrides
})
const setupMockStores = () => {
const pinia = createPinia()
setActivePinia(pinia)
const settingStore = useSettingStore()
const nodeDefStore = useNodeDefStore()
// Mock tooltip delay setting
vi.spyOn(settingStore, 'get').mockImplementation(
<K extends keyof Settings>(key: K): Settings[K] => {
switch (key) {
case 'Comfy.EnableTooltips':
return true as Settings[K]
case 'LiteGraph.Node.TooltipDelay':
return 500 as Settings[K]
default:
return undefined as Settings[K]
}
}
)
// Mock node definition store
const baseMockNodeDef: ComfyNodeDef = {
name: 'KSampler',
display_name: 'KSampler',
category: 'sampling',
python_module: 'test_module',
description: 'Advanced sampling node for diffusion models',
input: {
required: {
model: ['MODEL', {}],
positive: ['CONDITIONING', {}],
negative: ['CONDITIONING', {}]
},
optional: {},
hidden: {}
},
output: ['LATENT'],
output_is_list: [false],
output_name: ['samples'],
output_node: false,
deprecated: false,
experimental: false
}
const mockNodeDef = new ComfyNodeDefImpl(baseMockNodeDef)
vi.spyOn(nodeDefStore, 'nodeDefsByName', 'get').mockReturnValue({
KSampler: mockNodeDef
})
return { settingStore, nodeDefStore, pinia }
}
const createMountConfig = () => {
const i18n = createI18n({
legacy: false,
locale: 'en',
messages: { en: enMessages }
})
const { pinia } = setupMockStores()
return {
global: {
plugins: [PrimeVue, i18n, pinia],
components: { InputText },
directives: {
tooltip: {
mounted: vi.fn(),
updated: vi.fn(),
unmounted: vi.fn()
}
},
provide: {
tooltipContainer: { value: document.createElement('div') }
}
}
}
}
const mountHeader = (
props?: Partial<InstanceType<typeof NodeHeader>['$props']>
) => {
const config = createMountConfig()
return mount(NodeHeader, {
...config,
props: {
nodeData: makeNodeData(),
readonly: false,
collapsed: false,
...props
}
})
}
describe('NodeHeader.vue', () => {
it('emits collapse when collapse button is clicked', async () => {
const wrapper = mountHeader()
const btn = wrapper.get('[data-testid="node-collapse-button"]')
await btn.trigger('click')
expect(wrapper.emitted('collapse')).toBeTruthy()
})
it('shows the current node title and updates when prop changes', async () => {
const wrapper = mountHeader({
nodeData: makeNodeData({ title: 'Original' })
})
// Title visible via EditableText in view mode
expect(wrapper.get('[data-testid="node-title"]').text()).toContain(
'Original'
)
// Update prop title; should sync displayTitle
await wrapper.setProps({ nodeData: makeNodeData({ title: 'Updated' }) })
expect(wrapper.get('[data-testid="node-title"]').text()).toContain(
'Updated'
)
})
it('allows renaming via double click and emits update:title on confirm', async () => {
const wrapper = mountHeader({ nodeData: makeNodeData({ title: 'Start' }) })
// Enter edit mode
await wrapper.get('[data-testid="node-header-1"]').trigger('dblclick')
// Edit and confirm (EditableText uses blur or enter to emit)
const input = wrapper.get('[data-testid="node-title-input"]')
await input.setValue('My Custom Sampler')
await input.trigger('keyup.enter')
await input.trigger('blur')
// NodeHeader should emit update:title with trimmed value
const e = wrapper.emitted('update:title')
expect(e).toBeTruthy()
expect(e?.[0]).toEqual(['My Custom Sampler'])
})
it('cancels rename on escape and keeps previous title', async () => {
const wrapper = mountHeader({ nodeData: makeNodeData({ title: 'KeepMe' }) })
await wrapper.get('[data-testid="node-header-1"]').trigger('dblclick')
const input = wrapper.get('[data-testid="node-title-input"]')
await input.setValue('Should Not Save')
await input.trigger('keyup.escape')
// Should not emit update:title
expect(wrapper.emitted('update:title')).toBeFalsy()
// Title remains the original
expect(wrapper.get('[data-testid="node-title"]').text()).toContain('KeepMe')
})
it('honors readonly: hides collapse button and prevents editing', async () => {
const wrapper = mountHeader({ readonly: true })
// Collapse button should be hidden
const btn = wrapper.find('[data-testid="node-collapse-button"]')
expect(btn.exists()).toBe(true)
// v-show hides via display:none
expect((btn.element as HTMLButtonElement).style.display).toBe('none')
// In unit test, presence is fine; simulate double click should not create input
await wrapper.get('[data-testid="node-header-1"]').trigger('dblclick')
const input = wrapper.find('[data-testid="node-title-input"]')
expect(input.exists()).toBe(false)
})
it('renders correct chevron icon based on collapsed prop', async () => {
const wrapper = mountHeader({ collapsed: false })
const expandedIcon = wrapper.get('i')
expect(expandedIcon.classes()).toContain('pi-chevron-down')
await wrapper.setProps({ collapsed: true })
const collapsedIcon = wrapper.get('i')
expect(collapsedIcon.classes()).toContain('pi-chevron-right')
})
describe('Tooltips', () => {
it('applies tooltip directive to node title with correct configuration', () => {
const wrapper = mountHeader({
nodeData: makeNodeData({ type: 'KSampler' })
})
const titleElement = wrapper.find('[data-testid="node-title"]')
expect(titleElement.exists()).toBe(true)
// Check that v-tooltip directive was applied
const directive = wrapper.vm.$el.querySelector(
'[data-testid="node-title"]'
)
expect(directive).toBeTruthy()
})
it('disables tooltip when in readonly mode', () => {
const wrapper = mountHeader({
readonly: true,
nodeData: makeNodeData({ type: 'KSampler' })
})
const titleElement = wrapper.find('[data-testid="node-title"]')
expect(titleElement.exists()).toBe(true)
})
it('disables tooltip when editing is active', async () => {
const wrapper = mountHeader({
nodeData: makeNodeData({ type: 'KSampler' })
})
// Enter edit mode
await wrapper.get('[data-testid="node-header-1"]').trigger('dblclick')
// Tooltip should be disabled during editing
const titleElement = wrapper.find('[data-testid="node-title"]')
expect(titleElement.exists()).toBe(true)
})
it('creates tooltip configuration when component mounts', () => {
const wrapper = mountHeader({
nodeData: makeNodeData({ type: 'KSampler' })
})
// Verify tooltip directive is applied to the title element
const titleElement = wrapper.find('[data-testid="node-title"]')
expect(titleElement.exists()).toBe(true)
// The tooltip composable should be initialized
expect(wrapper.vm).toBeDefined()
})
it('uses tooltip container from provide/inject', () => {
const wrapper = mountHeader({
nodeData: makeNodeData({ type: 'KSampler' })
})
expect(wrapper.exists()).toBe(true)
// Container should be provided through inject
const titleElement = wrapper.find('[data-testid="node-title"]')
expect(titleElement.exists()).toBe(true)
})
})
})