mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-25 15:15:47 +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>
134 lines
3.4 KiB
TypeScript
134 lines
3.4 KiB
TypeScript
import { render, screen } from '@testing-library/vue'
|
|
import userEvent from '@testing-library/user-event'
|
|
import { nextTick } from 'vue'
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import TextTicker from './TextTicker.vue'
|
|
|
|
function mockScrollWidth(el: HTMLElement, scrollWidth: number) {
|
|
Object.defineProperty(el, 'scrollWidth', {
|
|
value: scrollWidth,
|
|
configurable: true
|
|
})
|
|
}
|
|
|
|
describe(TextTicker, () => {
|
|
let rafCallbacks: ((time: number) => void)[]
|
|
let user: ReturnType<typeof userEvent.setup>
|
|
let cleanup: (() => void) | undefined
|
|
|
|
beforeEach(() => {
|
|
vi.useFakeTimers()
|
|
rafCallbacks = []
|
|
vi.spyOn(window, 'requestAnimationFrame').mockImplementation((cb) => {
|
|
rafCallbacks.push(cb)
|
|
return rafCallbacks.length
|
|
})
|
|
vi.spyOn(window, 'cancelAnimationFrame').mockImplementation(() => {})
|
|
user = userEvent.setup({ advanceTimers: vi.advanceTimersByTime })
|
|
})
|
|
|
|
afterEach(() => {
|
|
cleanup?.()
|
|
vi.useRealTimers()
|
|
vi.restoreAllMocks()
|
|
})
|
|
|
|
it('renders slot content', () => {
|
|
const { unmount } = render(TextTicker, {
|
|
slots: { default: 'Hello World' }
|
|
})
|
|
cleanup = unmount
|
|
expect(screen.getByText('Hello World')).toBeInTheDocument()
|
|
})
|
|
|
|
it('scrolls on hover after delay', async () => {
|
|
const { unmount } = render(TextTicker, {
|
|
slots: { default: 'Very long text that overflows' },
|
|
props: { speed: 100 }
|
|
})
|
|
cleanup = unmount
|
|
|
|
const el = screen.getByText('Very long text that overflows')
|
|
mockScrollWidth(el, 300)
|
|
|
|
await nextTick()
|
|
await user.hover(el)
|
|
await nextTick()
|
|
|
|
expect(rafCallbacks.length).toBe(0)
|
|
|
|
vi.advanceTimersByTime(350)
|
|
await nextTick()
|
|
expect(rafCallbacks.length).toBeGreaterThan(0)
|
|
|
|
rafCallbacks[0](performance.now() + 500)
|
|
expect(el.scrollLeft).toBeGreaterThan(0)
|
|
})
|
|
|
|
it('cancels delayed scroll on mouse leave before delay elapses', async () => {
|
|
const { unmount } = render(TextTicker, {
|
|
slots: { default: 'Very long text that overflows' },
|
|
props: { speed: 100 }
|
|
})
|
|
cleanup = unmount
|
|
|
|
const el = screen.getByText('Very long text that overflows')
|
|
mockScrollWidth(el, 300)
|
|
|
|
await nextTick()
|
|
await user.hover(el)
|
|
await nextTick()
|
|
|
|
vi.advanceTimersByTime(200)
|
|
await user.unhover(el)
|
|
await nextTick()
|
|
|
|
vi.advanceTimersByTime(350)
|
|
await nextTick()
|
|
expect(rafCallbacks.length).toBe(0)
|
|
})
|
|
|
|
it('resets scroll position on mouse leave', async () => {
|
|
const { unmount } = render(TextTicker, {
|
|
slots: { default: 'Very long text that overflows' },
|
|
props: { speed: 100 }
|
|
})
|
|
cleanup = unmount
|
|
|
|
const el = screen.getByText('Very long text that overflows')
|
|
mockScrollWidth(el, 300)
|
|
|
|
await nextTick()
|
|
await user.hover(el)
|
|
await nextTick()
|
|
vi.advanceTimersByTime(350)
|
|
await nextTick()
|
|
|
|
rafCallbacks[0](performance.now() + 500)
|
|
expect(el.scrollLeft).toBeGreaterThan(0)
|
|
|
|
await user.unhover(el)
|
|
await nextTick()
|
|
|
|
expect(el.scrollLeft).toBe(0)
|
|
})
|
|
|
|
it('does not scroll when content fits', async () => {
|
|
const { unmount } = render(TextTicker, {
|
|
slots: { default: 'Short' }
|
|
})
|
|
cleanup = unmount
|
|
|
|
const el = screen.getByText('Short')
|
|
|
|
await nextTick()
|
|
await user.hover(el)
|
|
await nextTick()
|
|
vi.advanceTimersByTime(350)
|
|
await nextTick()
|
|
|
|
expect(rafCallbacks.length).toBe(0)
|
|
})
|
|
})
|