mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-25 23:25:02 +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>
136 lines
3.5 KiB
TypeScript
136 lines
3.5 KiB
TypeScript
import { render } from '@testing-library/vue'
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
|
|
import { nextTick } from 'vue'
|
|
|
|
import DesktopCloudNotificationController from './DesktopCloudNotificationController.vue'
|
|
|
|
const settingState = {
|
|
shown: false
|
|
}
|
|
|
|
const settingStore = {
|
|
load: vi.fn<() => Promise<void>>(),
|
|
get: vi.fn((key: string) =>
|
|
key === 'Comfy.Desktop.CloudNotificationShown'
|
|
? settingState.shown
|
|
: undefined
|
|
),
|
|
set: vi.fn(async (_key: string, value: boolean) => {
|
|
settingState.shown = value
|
|
})
|
|
}
|
|
|
|
const dialogService = {
|
|
showCloudNotification: vi.fn<() => Promise<void>>()
|
|
}
|
|
|
|
const electron = {
|
|
getPlatform: vi.fn(() => 'darwin')
|
|
}
|
|
|
|
vi.mock('@/platform/distribution/types', () => ({
|
|
isDesktop: true
|
|
}))
|
|
|
|
vi.mock('@/platform/settings/settingStore', () => ({
|
|
useSettingStore: () => settingStore
|
|
}))
|
|
|
|
vi.mock('@/services/dialogService', () => ({
|
|
useDialogService: () => dialogService
|
|
}))
|
|
|
|
vi.mock('@/utils/envUtil', () => ({
|
|
electronAPI: () => electron
|
|
}))
|
|
|
|
function createDeferred() {
|
|
let resolve!: () => void
|
|
const promise = new Promise<void>((res) => {
|
|
resolve = res
|
|
})
|
|
|
|
return { promise, resolve }
|
|
}
|
|
|
|
describe('DesktopCloudNotificationController', () => {
|
|
beforeEach(() => {
|
|
vi.useFakeTimers()
|
|
vi.clearAllMocks()
|
|
|
|
settingState.shown = false
|
|
electron.getPlatform.mockReturnValue('darwin')
|
|
settingStore.load.mockResolvedValue(undefined)
|
|
settingStore.set.mockImplementation(
|
|
async (_key: string, value: boolean) => {
|
|
settingState.shown = value
|
|
}
|
|
)
|
|
dialogService.showCloudNotification.mockResolvedValue(undefined)
|
|
})
|
|
|
|
afterEach(() => {
|
|
vi.useRealTimers()
|
|
})
|
|
|
|
it('waits for settings to load before deciding whether to show the notification', async () => {
|
|
const loadSettings = createDeferred()
|
|
settingStore.load.mockImplementation(() => loadSettings.promise)
|
|
|
|
const { unmount } = render(DesktopCloudNotificationController)
|
|
await nextTick()
|
|
|
|
settingState.shown = true
|
|
loadSettings.resolve()
|
|
|
|
await vi.advanceTimersByTimeAsync(0)
|
|
await vi.advanceTimersByTimeAsync(2000)
|
|
|
|
expect(dialogService.showCloudNotification).not.toHaveBeenCalled()
|
|
|
|
unmount()
|
|
})
|
|
|
|
it('does not schedule or show the notification after unmounting before settings load resolves', async () => {
|
|
const loadSettings = createDeferred()
|
|
settingStore.load.mockImplementation(() => loadSettings.promise)
|
|
|
|
const { unmount } = render(DesktopCloudNotificationController)
|
|
await nextTick()
|
|
|
|
unmount()
|
|
loadSettings.resolve()
|
|
|
|
await vi.advanceTimersByTimeAsync(0)
|
|
await vi.advanceTimersByTimeAsync(2000)
|
|
|
|
expect(settingStore.set).not.toHaveBeenCalled()
|
|
expect(dialogService.showCloudNotification).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('marks the notification as shown before awaiting dialog close', async () => {
|
|
const dialogOpen = createDeferred()
|
|
dialogService.showCloudNotification.mockImplementation(
|
|
() => dialogOpen.promise
|
|
)
|
|
|
|
const { unmount } = render(DesktopCloudNotificationController)
|
|
|
|
await vi.advanceTimersByTimeAsync(0)
|
|
await vi.advanceTimersByTimeAsync(2000)
|
|
|
|
expect(settingStore.set).toHaveBeenCalledWith(
|
|
'Comfy.Desktop.CloudNotificationShown',
|
|
true
|
|
)
|
|
expect(settingStore.set.mock.invocationCallOrder[0]).toBeLessThan(
|
|
dialogService.showCloudNotification.mock.invocationCallOrder[0]
|
|
)
|
|
|
|
dialogOpen.resolve()
|
|
await vi.advanceTimersByTimeAsync(0)
|
|
|
|
unmount()
|
|
})
|
|
})
|