Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 57 additions & 11 deletions src/components/graph/NodeTooltip.test.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { render, screen } from '@testing-library/vue'
import { cloneDeep } from 'es-toolkit'
import userEvent from '@testing-library/user-event'
import { nextTick } from 'vue'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'

import { i18n, te } from '@/i18n'
import { i18n, mergeCustomNodesI18n } from '@/i18n'
import type * as LiteGraphModule from '@/lib/litegraph/src/litegraph'
import { useSettingStore } from '@/platform/settings/settingStore'
import type { Settings } from '@/schemas/apiSchema'
Expand All @@ -12,6 +13,7 @@ import { useNodeDefStore } from '@/stores/nodeDefStore'

import NodeTooltip from './NodeTooltip.vue'

const enMessages = cloneDeep(i18n.global.getLocaleMessage('en'))
type HitTest = (
node: MockNode,
x: number,
Expand Down Expand Up @@ -80,17 +82,12 @@ vi.mock('@/scripts/domWidget', () => ({
const jsonTooltip =
'Positive point prompts as JSON [{"x": int, "y": int}, ...] (pixel coords)'

const positiveCoordsTooltipKey =
'nodeDefs.SAM3_Detect.inputs.positive_coords.tooltip'

const outputTooltipKey = 'nodeDefs.SAM3_Detect.outputs.0.tooltip'

const sam3DetectNodeDef: ComfyNodeDef = {
name: 'SAM3_Detect',
display_name: 'SAM3 Detect',
category: 'detection/',
python_module: 'comfy_extras.nodes_sam3',
description: '',
description: 'Frontend description',
input: {
required: {},
optional: {
Expand Down Expand Up @@ -135,6 +132,14 @@ function mergeOutputTooltipMessage(tooltip: string | null) {
})
}

function mergeInputTooltipMessage(tooltip: string | null) {
i18n.global.mergeLocaleMessage('en', {
nodeDefs: {
SAM3_Detect: { inputs: { positive_coords: { tooltip } } }
}
})
}

async function renderAndHoverCanvas() {
const user = userEvent.setup({ advanceTimers: vi.advanceTimersByTime })

Expand Down Expand Up @@ -173,7 +178,23 @@ describe('NodeTooltip', () => {
})

afterEach(() => {
mergeOutputTooltipMessage(null)
mergeCustomNodesI18n({})
i18n.global.setLocaleMessage('en', cloneDeep(enMessages))
})

it('resolves the node description shown over the title', async () => {
mergeCustomNodesI18n({
en: {
nodeDefs: {
SAM3_Detect: { description: 'Localized description' }
}
}
})
mockCanvas.graph_mouse[1] = -1

await renderAndHoverCanvas()

expect(screen.getByText('Localized description')).toBeInTheDocument()
})

it('shows input slot JSON tooltips without i18n placeholder errors', async () => {
Expand All @@ -182,7 +203,6 @@ describe('NodeTooltip', () => {

await renderAndHoverCanvas()

expect(te(positiveCoordsTooltipKey)).toBe(true)
expect(screen.getByText(jsonTooltip)).toBeInTheDocument()
expect(consoleError).not.toHaveBeenCalled()
})
Expand All @@ -193,7 +213,6 @@ describe('NodeTooltip', () => {

await renderAndHoverCanvas()

expect(te(outputTooltipKey)).toBe(true)
expect(screen.getByText(jsonTooltip)).toBeInTheDocument()
expect(consoleError).not.toHaveBeenCalled()
})
Expand All @@ -206,8 +225,35 @@ describe('NodeTooltip', () => {

await renderAndHoverCanvas()

expect(te(positiveCoordsTooltipKey)).toBe(true)
expect(screen.getByText(jsonTooltip)).toBeInTheDocument()
expect(consoleError).not.toHaveBeenCalled()
})

describe('when the bundled snapshot has gone stale', () => {
const staleInputTooltip = 'stale bundled input tooltip'
const staleOutputTooltip = 'stale bundled output tooltip'

beforeEach(() => {
mergeInputTooltipMessage(staleInputTooltip)
mergeOutputTooltipMessage(staleOutputTooltip)
})

it('shows the live backend input slot tooltip', async () => {
vi.mocked(mockIsOverNodeInput).mockReturnValue(0)

await renderAndHoverCanvas()

expect(screen.getByText(jsonTooltip)).toBeInTheDocument()
expect(screen.queryByText(staleInputTooltip)).not.toBeInTheDocument()
})

it('shows the live backend output slot tooltip', async () => {
vi.mocked(mockIsOverNodeOutput).mockReturnValue(0)

await renderAndHoverCanvas()

expect(screen.getByText(jsonTooltip)).toBeInTheDocument()
expect(screen.queryByText(staleOutputTooltip)).not.toBeInTheDocument()
})
})
})
40 changes: 25 additions & 15 deletions src/components/graph/NodeTooltip.vue
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import { useEventListener } from '@vueuse/core'
import { nextTick, ref } from 'vue'

import { stRaw } from '@/i18n'
import { resolveNodeDefSlotText, resolveNodeDefText } from '@/i18n'
import {
LiteGraph,
isOverNodeInput,
Expand All @@ -23,7 +23,6 @@ import { useSettingStore } from '@/platform/settings/settingStore'
import { app as comfyApp } from '@/scripts/app'
import { isDOMWidget } from '@/scripts/domWidget'
import { useNodeDefStore } from '@/stores/nodeDefStore'
import { normalizeI18nKey } from '@/utils/formatUtil'

let idleTimeout: number
const nodeDefStore = useNodeDefStore()
Expand Down Expand Up @@ -65,13 +64,16 @@ function onIdle() {
if (!node || node.flags?.ghost) return

const ctor = node.constructor as { title_mode?: 0 | 1 | 2 | 3 }
const nodeDef = nodeDefStore.nodeDefsByName[node.type ?? '']
const nodeType = node.type ?? ''
const nodeDef = nodeDefStore.nodeDefsByName[nodeType]

if (
ctor.title_mode !== LiteGraph.NO_TITLE &&
canvas.graph_mouse[1] < node.pos[1] // If we are over a node, but not within the node then we are on its title
) {
return showTooltip(nodeDef?.description)
return showTooltip(
resolveNodeDefText('description', nodeType, nodeDef?.description)
)
}

if (node.flags?.collapsed) return
Expand All @@ -84,11 +86,14 @@ function onIdle() {
)
if (inputSlot !== -1) {
const inputName = node.inputs[inputSlot].name
const translatedTooltip = stRaw(
`nodeDefs.${normalizeI18nKey(node.type ?? '')}.inputs.${normalizeI18nKey(inputName)}.tooltip`,
nodeDef?.inputs[inputName]?.tooltip ?? ''
return showTooltip(
resolveNodeDefSlotText(
'tooltip',
nodeType,
inputName,
nodeDef?.inputs[inputName]?.tooltip
)
)
return showTooltip(translatedTooltip)
}

const outputSlot = isOverNodeOutput(
Expand All @@ -98,19 +103,24 @@ function onIdle() {
[0, 0]
)
if (outputSlot !== -1) {
const translatedTooltip = stRaw(
`nodeDefs.${normalizeI18nKey(node.type ?? '')}.outputs.${outputSlot}.tooltip`,
nodeDef?.outputs[outputSlot]?.tooltip ?? ''
return showTooltip(
resolveNodeDefSlotText(
'tooltip',
nodeType,
outputSlot,
nodeDef?.outputs[outputSlot]?.tooltip
)
)
return showTooltip(translatedTooltip)
}

const widget = comfyApp.canvas.getWidgetAtCursor()
// Dont show for DOM widgets, these use native browser tooltips as we dont get proper mouse events on these
if (widget && !isDOMWidget(widget)) {
const translatedTooltip = stRaw(
`nodeDefs.${normalizeI18nKey(node.type ?? '')}.inputs.${normalizeI18nKey(widget.name)}.tooltip`,
nodeDef?.inputs[widget.name]?.tooltip ?? ''
const translatedTooltip = resolveNodeDefSlotText(
'tooltip',
nodeType,
widget.name,
nodeDef?.inputs[widget.name]?.tooltip
)
// Widget tooltip can be set dynamically, current translation collection does not support this.
return showTooltip(widget.tooltip ?? translatedTooltip)
Expand Down
Loading
Loading