mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-03 04:31:58 +00:00
3043b181d7
## Summary Extract internal logic from the 2 remaining VTU holdout components into composables, enabling full VTL migration. ## Changes - **What**: Extract `useProcessedWidgets` from `NodeWidgets.vue` (486→135 LOC) and `useWidgetSelectItems`/`useWidgetSelectActions` from `WidgetSelectDropdown.vue` (563→170 LOC). Rewrite both component test files as composable unit tests + slim behavioral VTL tests. Remove `@vue/test-utils` devDependency. - **Dependencies**: Removes `@vue/test-utils` ## Review Focus - Composable extraction is mechanical — no logic changes, just moving code into testable units - `useProcessedWidgets` handles widget deduplication, promotion border styling, error detection, and identity resolution (~290 LOC) - `useWidgetSelectItems` handles the full computed chain from widget values → dropdown items including cloud asset mode and multi-output job resolution (~350 LOC) - `useWidgetSelectActions` handles selection resolution and file upload (~120 LOC) - 40 new composable-level unit tests replace 13 `wrapper.vm.*` accesses across the 2 holdout files ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-10966-refactor-extract-composables-from-VTU-holdout-components-complete-VTL-migration-33c6d73d36508148a3a4ccf346722d6d) by [Unito](https://www.unito.io) --------- Co-authored-by: Amp <amp@ampcode.com>
53 lines
2.3 KiB
Markdown
53 lines
2.3 KiB
Markdown
# ComfyUI Frontend Testing Guide
|
|
|
|
This guide provides an overview of testing approaches used in the ComfyUI Frontend codebase. These guides are meant to document any particularities or nuances of writing tests in this codebase, rather than being a comprehensive guide to testing in general. By reading these guides first, you may save yourself some time when encountering issues.
|
|
|
|
## Testing Documentation
|
|
|
|
Documentation for unit tests is organized into three guides:
|
|
|
|
- [Component Testing](./component-testing.md) - How to test Vue components
|
|
- [Unit Testing](./unit-testing.md) - How to test utility functions, composables, and other non-component code
|
|
- [Store Testing](./store-testing.md) - How to test Pinia stores specifically
|
|
|
|
## Testing Structure
|
|
|
|
The ComfyUI Frontend project uses **colocated tests** - test files are placed alongside their source files:
|
|
|
|
- **Component Tests**: Located directly alongside their components (e.g., `MyComponent.test.ts` next to `MyComponent.vue`)
|
|
- **Unit Tests**: Located alongside their source files (e.g., `myUtil.test.ts` next to `myUtil.ts`)
|
|
- **Store Tests**: Located in `src/stores/` alongside their store files
|
|
- **Browser Tests**: Located in the `browser_tests/` directory (see dedicated README there)
|
|
|
|
### Test File Naming
|
|
|
|
- Use `.test.ts` extension for test files
|
|
- Name tests after their source file: `sourceFile.test.ts`
|
|
|
|
## Test Frameworks and Libraries
|
|
|
|
Our tests use the following frameworks and libraries:
|
|
|
|
- [Vitest](https://vitest.dev/) - Test runner and assertion library
|
|
- [@testing-library/vue](https://testing-library.com/docs/vue-testing-library/intro/) - Preferred for user-centric component testing
|
|
- [@testing-library/user-event](https://testing-library.com/docs/user-event/intro/) - Realistic user interaction simulation
|
|
- [@vue/test-utils](https://test-utils.vuejs.org/) - Vue component testing utilities (legacy; new tests must use @testing-library/vue)
|
|
- [Pinia](https://pinia.vuejs.org/cookbook/testing.html) - For store testing
|
|
|
|
## Getting Started
|
|
|
|
To run the tests locally:
|
|
|
|
```bash
|
|
# Run unit tests
|
|
pnpm test:unit
|
|
|
|
# Run a specific test file
|
|
pnpm test:unit -- src/path/to/file.test.ts
|
|
|
|
# Run unit tests in watch mode
|
|
pnpm test:unit -- --watch
|
|
```
|
|
|
|
Refer to the specific guides for more detailed information on each testing type.
|