mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-22 05:19:03 +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>
124 lines
3.8 KiB
TypeScript
124 lines
3.8 KiB
TypeScript
import { render, screen } from '@testing-library/vue'
|
|
import userEvent from '@testing-library/user-event'
|
|
import { describe, expect, it, vi } from 'vitest'
|
|
import { createI18n } from 'vue-i18n'
|
|
|
|
import QueueOverlayActive from './QueueOverlayActive.vue'
|
|
import * as tooltipConfig from '@/composables/useTooltipConfig'
|
|
|
|
const i18n = createI18n({
|
|
legacy: false,
|
|
locale: 'en',
|
|
messages: {
|
|
en: {
|
|
sideToolbar: {
|
|
queueProgressOverlay: {
|
|
total: 'Total: {percent}',
|
|
currentNode: 'Current node:',
|
|
running: 'running',
|
|
interruptAll: 'Interrupt all running jobs',
|
|
queuedSuffix: 'queued',
|
|
clearQueued: 'Clear queued',
|
|
viewAllJobs: 'View all jobs',
|
|
cancelJobTooltip: 'Cancel job',
|
|
clearQueueTooltip: 'Clear queue'
|
|
}
|
|
}
|
|
}
|
|
}
|
|
})
|
|
|
|
const tooltipDirectiveStub = {
|
|
mounted: vi.fn(),
|
|
updated: vi.fn()
|
|
}
|
|
|
|
const defaultProps = {
|
|
totalProgressStyle: { width: '65%' },
|
|
currentNodeProgressStyle: { width: '40%' },
|
|
totalPercentFormatted: '65%',
|
|
currentNodePercentFormatted: '40%',
|
|
currentNodeName: 'Sampler',
|
|
runningCount: 1,
|
|
queuedCount: 2,
|
|
bottomRowClass: 'flex custom-bottom-row'
|
|
}
|
|
|
|
const renderComponent = (props: Record<string, unknown> = {}) =>
|
|
render(QueueOverlayActive, {
|
|
props: { ...defaultProps, ...props },
|
|
global: {
|
|
plugins: [i18n],
|
|
directives: {
|
|
tooltip: tooltipDirectiveStub
|
|
}
|
|
}
|
|
})
|
|
|
|
describe('QueueOverlayActive', () => {
|
|
it('renders progress metrics and emits actions when buttons clicked', async () => {
|
|
const user = userEvent.setup()
|
|
const interruptAllSpy = vi.fn()
|
|
const clearQueuedSpy = vi.fn()
|
|
const viewAllJobsSpy = vi.fn()
|
|
|
|
const { container } = renderComponent({
|
|
runningCount: 2,
|
|
queuedCount: 3,
|
|
onInterruptAll: interruptAllSpy,
|
|
onClearQueued: clearQueuedSpy,
|
|
onViewAllJobs: viewAllJobsSpy
|
|
})
|
|
|
|
// eslint-disable-next-line testing-library/no-container, testing-library/no-node-access
|
|
const progressBars = container.querySelectorAll('.absolute.inset-0')
|
|
expect(progressBars[0]).toHaveStyle({ width: '65%' })
|
|
expect(progressBars[1]).toHaveStyle({ width: '40%' })
|
|
|
|
expect(screen.getByText('65%')).toBeInTheDocument()
|
|
|
|
expect(screen.getByText('2')).toBeInTheDocument()
|
|
expect(screen.getByText('running')).toBeInTheDocument()
|
|
expect(screen.getByText('3')).toBeInTheDocument()
|
|
expect(screen.getByText('queued')).toBeInTheDocument()
|
|
|
|
expect(screen.getByText('Current node:')).toBeInTheDocument()
|
|
expect(screen.getByText('Sampler')).toBeInTheDocument()
|
|
expect(screen.getByText('40%')).toBeInTheDocument()
|
|
|
|
await user.click(
|
|
screen.getByRole('button', { name: 'Interrupt all running jobs' })
|
|
)
|
|
expect(interruptAllSpy).toHaveBeenCalledOnce()
|
|
|
|
await user.click(screen.getByRole('button', { name: 'Clear queued' }))
|
|
expect(clearQueuedSpy).toHaveBeenCalledOnce()
|
|
|
|
await user.click(screen.getByRole('button', { name: 'View all jobs' }))
|
|
expect(viewAllJobsSpy).toHaveBeenCalledOnce()
|
|
|
|
// eslint-disable-next-line testing-library/no-container, testing-library/no-node-access
|
|
expect(container.querySelector('.custom-bottom-row')).toBeTruthy()
|
|
})
|
|
|
|
it('hides action buttons when counts are zero', () => {
|
|
renderComponent({ runningCount: 0, queuedCount: 0 })
|
|
|
|
expect(
|
|
screen.queryByRole('button', { name: 'Interrupt all running jobs' })
|
|
).not.toBeInTheDocument()
|
|
expect(
|
|
screen.queryByRole('button', { name: 'Clear queued' })
|
|
).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('builds tooltip configs with translated strings', () => {
|
|
const spy = vi.spyOn(tooltipConfig, 'buildTooltipConfig')
|
|
|
|
renderComponent()
|
|
|
|
expect(spy).toHaveBeenCalledWith('Cancel job')
|
|
expect(spy).toHaveBeenCalledWith('Clear queue')
|
|
})
|
|
})
|