mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-04-19 22:09:37 +00:00
## Summary Migrate 132 test files from `@vue/test-utils` (VTU) to `@testing-library/vue` (VTL) with `@testing-library/user-event`, adopting user-centric behavioral testing patterns across the codebase. ## Changes - **What**: Systematic migration of component/unit tests from VTU's `mount`/`wrapper` API to VTL's `render`/`screen`/`userEvent` API across 132 files in `src/` - **Breaking**: None — test-only changes, no production code affected ### Migration breakdown | Batch | Files | Description | |-------|-------|-------------| | 1 | 19 | Simple render/assert tests | | 2A | 16 | Interactive tests with user events | | 2B-1 | 14 | Interactive tests (continued) | | 2B-2 | 32 | Interactive tests (continued) | | 3A–3E | 51 | Complex tests (stores, composables, heavy mocking) | | Lint fix | 7 | `await` on `fireEvent` calls for `no-floating-promises` | | Review fixes | 15 | Address CodeRabbit feedback (3 rounds) | ### Review feedback addressed - Removed class-based assertions (`text-ellipsis`, `pr-3`, `.pi-save`, `.skeleton`, `.bg-black\/15`, Tailwind utilities) in favor of behavioral/accessible queries - Added null guards before `querySelector` casts - Added `expect(roots).toHaveLength(N)` guards before indexed NodeList access - Wrapped fake timer tests in `try/finally` for guaranteed cleanup - Split double-render tests into focused single-render tests - Replaced CSS class selectors with `screen.getByText`/`screen.getByRole` queries - Updated stubs to use semantic `role`/`aria-label` instead of CSS classes - Consolidated redundant edge-case tests - Removed manual `document.body.appendChild` in favor of VTL container management - Used distinct mock return values to verify command wiring ### VTU holdouts (2 files) These files intentionally retain `@vue/test-utils` because their components use `<script setup>` without `defineExpose`, making internal computed properties and methods inaccessible via VTL: 1. **`NodeWidgets.test.ts`** — partial VTU for `vm.processedWidgets` 2. **`WidgetSelectDropdown.test.ts`** — full VTU for heavy `wrapper.vm.*` access ## Follow-up Deferred items (`ComponentProps` typing, camelCase listener props) tracked in #10966. ## Review Focus - Test correctness: all migrated tests preserve original behavioral coverage - VTL idioms: proper use of `screen` queries, `userEvent`, and accessibility-based selectors - The 2 VTU holdout files are intentional, not oversights ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-10965-test-migrate-132-test-files-from-vue-test-utils-to-testing-library-vue-33c6d73d36508199a6a7e513cf5d8296) by [Unito](https://www.unito.io) --------- Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: Christian Byrne <cbyrne@comfy.org>
156 lines
3.8 KiB
TypeScript
156 lines
3.8 KiB
TypeScript
import { render, screen } from '@testing-library/vue'
|
|
import userEvent from '@testing-library/user-event'
|
|
import { describe, expect, it } from 'vitest'
|
|
import { nextTick, ref } from 'vue'
|
|
import { createI18n } from 'vue-i18n'
|
|
|
|
import MultiSelect from './MultiSelect.vue'
|
|
|
|
const i18n = createI18n({
|
|
legacy: false,
|
|
locale: 'en',
|
|
messages: {
|
|
en: {
|
|
g: {
|
|
multiSelectDropdown: 'Multi-select dropdown',
|
|
noResultsFound: 'No results found',
|
|
search: 'Search',
|
|
clearAll: 'Clear all',
|
|
itemsSelected: 'Items selected'
|
|
}
|
|
}
|
|
}
|
|
})
|
|
|
|
const options = [
|
|
{ name: 'Option A', value: 'a' },
|
|
{ name: 'Option B', value: 'b' },
|
|
{ name: 'Option C', value: 'c' }
|
|
]
|
|
|
|
function renderInParent(
|
|
multiSelectProps: Record<string, unknown> = {},
|
|
modelValue: { name: string; value: string }[] = []
|
|
) {
|
|
const parentEscapeCount = { value: 0 }
|
|
|
|
const Parent = {
|
|
template:
|
|
'<div @keydown.escape="onEsc"><MultiSelect v-model="sel" :options="options" v-bind="extraProps" /></div>',
|
|
components: { MultiSelect },
|
|
setup() {
|
|
return {
|
|
sel: ref(modelValue),
|
|
options,
|
|
extraProps: multiSelectProps,
|
|
onEsc: () => {
|
|
parentEscapeCount.value++
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
const { unmount } = render(Parent, {
|
|
container: document.body.appendChild(document.createElement('div')),
|
|
global: { plugins: [i18n] }
|
|
})
|
|
|
|
return { unmount, parentEscapeCount }
|
|
}
|
|
|
|
function dispatchEscape(element: Element) {
|
|
element.dispatchEvent(
|
|
new KeyboardEvent('keydown', {
|
|
key: 'Escape',
|
|
code: 'Escape',
|
|
bubbles: true
|
|
})
|
|
)
|
|
}
|
|
|
|
function findContentElement(): HTMLElement | null {
|
|
return document.querySelector('[data-dismissable-layer]')
|
|
}
|
|
|
|
describe('MultiSelect', () => {
|
|
it('keeps open-state border styling available while the dropdown is open', async () => {
|
|
const user = userEvent.setup()
|
|
const { unmount } = renderInParent()
|
|
|
|
const trigger = screen.getByRole('button')
|
|
|
|
expect(trigger).toHaveClass(
|
|
'data-[state=open]:border-node-component-border'
|
|
)
|
|
expect(trigger).toHaveAttribute('aria-expanded', 'false')
|
|
|
|
await user.click(trigger)
|
|
await nextTick()
|
|
|
|
expect(trigger).toHaveAttribute('aria-expanded', 'true')
|
|
expect(trigger).toHaveAttribute('data-state', 'open')
|
|
|
|
unmount()
|
|
})
|
|
|
|
describe('Escape key propagation', () => {
|
|
it('stops Escape from propagating to parent when popover is open', async () => {
|
|
const user = userEvent.setup()
|
|
const { unmount, parentEscapeCount } = renderInParent()
|
|
|
|
const trigger = screen.getByRole('button')
|
|
await user.click(trigger)
|
|
await nextTick()
|
|
|
|
const content = findContentElement()
|
|
expect(content).not.toBeNull()
|
|
|
|
dispatchEscape(content!)
|
|
await nextTick()
|
|
|
|
expect(parentEscapeCount.value).toBe(0)
|
|
|
|
unmount()
|
|
})
|
|
|
|
it('closes the popover when Escape is pressed', async () => {
|
|
const user = userEvent.setup()
|
|
const { unmount } = renderInParent()
|
|
|
|
const trigger = screen.getByRole('button')
|
|
await user.click(trigger)
|
|
await nextTick()
|
|
expect(trigger).toHaveAttribute('data-state', 'open')
|
|
|
|
const content = findContentElement()
|
|
dispatchEscape(content!)
|
|
await nextTick()
|
|
|
|
expect(trigger).toHaveAttribute('data-state', 'closed')
|
|
|
|
unmount()
|
|
})
|
|
})
|
|
|
|
describe('selected count badge', () => {
|
|
it('shows selected count when items are selected', () => {
|
|
const { unmount } = renderInParent({}, [
|
|
{ name: 'Option A', value: 'a' },
|
|
{ name: 'Option B', value: 'b' }
|
|
])
|
|
|
|
expect(screen.getByText('2')).toBeInTheDocument()
|
|
|
|
unmount()
|
|
})
|
|
|
|
it('does not show count badge when no items are selected', () => {
|
|
const { unmount } = renderInParent()
|
|
|
|
expect(screen.queryByText(/^\d+$/)).not.toBeInTheDocument()
|
|
|
|
unmount()
|
|
})
|
|
})
|
|
})
|