mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-01 19:51:54 +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>
122 lines
3.3 KiB
TypeScript
122 lines
3.3 KiB
TypeScript
import { render, screen } from '@testing-library/vue'
|
|
import { nextTick } from 'vue'
|
|
import { afterEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import TextTickerMultiLine from './TextTickerMultiLine.vue'
|
|
|
|
type Callback = () => void
|
|
|
|
const resizeCallbacks: Callback[] = []
|
|
const mutationCallbacks: Callback[] = []
|
|
|
|
vi.mock('@vueuse/core', async () => {
|
|
const actual = await vi.importActual('@vueuse/core')
|
|
return {
|
|
...actual,
|
|
useResizeObserver: (_target: unknown, cb: Callback) => {
|
|
resizeCallbacks.push(cb)
|
|
return { stop: vi.fn() }
|
|
},
|
|
useMutationObserver: (_target: unknown, cb: Callback) => {
|
|
mutationCallbacks.push(cb)
|
|
return { stop: vi.fn() }
|
|
}
|
|
}
|
|
})
|
|
|
|
function mockElementSize(
|
|
el: HTMLElement,
|
|
clientWidth: number,
|
|
scrollWidth: number
|
|
) {
|
|
Object.defineProperty(el, 'clientWidth', {
|
|
value: clientWidth,
|
|
configurable: true
|
|
})
|
|
Object.defineProperty(el, 'scrollWidth', {
|
|
value: scrollWidth,
|
|
configurable: true
|
|
})
|
|
}
|
|
|
|
describe(TextTickerMultiLine, () => {
|
|
let unmountFn: () => void
|
|
|
|
afterEach(() => {
|
|
unmountFn?.()
|
|
resizeCallbacks.length = 0
|
|
mutationCallbacks.length = 0
|
|
})
|
|
|
|
function renderComponent(text: string) {
|
|
const result = render(TextTickerMultiLine, {
|
|
slots: { default: text }
|
|
})
|
|
unmountFn = result.unmount
|
|
return {
|
|
...result,
|
|
container: result.container as HTMLElement
|
|
}
|
|
}
|
|
|
|
function getMeasureEl(container: HTMLElement): HTMLElement {
|
|
// eslint-disable-next-line testing-library/no-node-access
|
|
return container.querySelector('[aria-hidden="true"]') as HTMLElement
|
|
}
|
|
|
|
function getVisibleLines(container: HTMLElement): HTMLElement[] {
|
|
/* eslint-disable testing-library/no-node-access */
|
|
return Array.from(
|
|
container.querySelectorAll<HTMLElement>(
|
|
'div.overflow-hidden:not([aria-hidden])'
|
|
)
|
|
)
|
|
/* eslint-enable testing-library/no-node-access */
|
|
}
|
|
|
|
async function triggerSplitLines() {
|
|
resizeCallbacks.forEach((cb) => cb())
|
|
await nextTick()
|
|
}
|
|
|
|
it('renders slot content', () => {
|
|
renderComponent('Load Checkpoint')
|
|
expect(
|
|
screen.getAllByText('Load Checkpoint').length
|
|
).toBeGreaterThanOrEqual(1)
|
|
})
|
|
|
|
it('renders a single line when text fits', async () => {
|
|
const { container } = renderComponent('Short')
|
|
mockElementSize(getMeasureEl(container), 200, 100)
|
|
await triggerSplitLines()
|
|
|
|
expect(getVisibleLines(container)).toHaveLength(1)
|
|
})
|
|
|
|
it('renders two lines when text overflows', async () => {
|
|
const { container } = renderComponent('Load Checkpoint Loader Simple')
|
|
mockElementSize(getMeasureEl(container), 100, 300)
|
|
await triggerSplitLines()
|
|
|
|
expect(getVisibleLines(container)).toHaveLength(2)
|
|
})
|
|
|
|
it('splits text at word boundary when overflowing', async () => {
|
|
const { container } = renderComponent('Load Checkpoint Loader')
|
|
mockElementSize(getMeasureEl(container), 100, 200)
|
|
await triggerSplitLines()
|
|
|
|
const lines = getVisibleLines(container)
|
|
expect(lines[0].textContent).toBe('Load')
|
|
expect(lines[1].textContent).toBe('Checkpoint Loader')
|
|
})
|
|
|
|
it('has hidden measurement element with aria-hidden', () => {
|
|
const { container } = renderComponent('Test')
|
|
const measureEl = getMeasureEl(container)
|
|
expect(measureEl).toBeInTheDocument()
|
|
expect(measureEl).toHaveClass('invisible')
|
|
})
|
|
})
|