mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-07 16:40:05 +00:00
## Summary Major refactoring of browser tests to improve reliability, maintainability, and type safety. ## Changes ### Test Infrastructure Decomposition - Decomposed `ComfyPage.ts` (~1000 lines) into focused helpers: - `CanvasHelper`, `DebugHelper`, `SubgraphHelper`, `NodeOperationsHelper` - `SettingsHelper`, `WorkflowHelper`, `ClipboardHelper`, `KeyboardHelper` - Created `ContextMenu` page object, `BaseDialog` base class, and `BottomPanel` page object - Extracted `DefaultGraphPositions` constants ### Locator Stability - Added `data-testid` attributes to Vue components (sidebar, dialogs, node library) - Created centralized `selectors.ts` with test ID constants - Replaced fragile CSS selectors (`.nth()`, `:nth-child()`) with `getByTestId`/`getByRole` ### Performance & Reliability - Removed `setTimeout` anti-patterns (replaced with `waitForFunction`) - Replaced `waitForTimeout` with retrying assertions - Replaced hardcoded coordinates with computed `NodeReference` positions - Enforced LF line endings for all text files ### Type Safety - Enabled `no-explicit-any` lint rule for browser_tests via oxlint - Purged `as any` casts from browser_tests - Added Window type augmentation for standardized window access - Added proper type annotations throughout ### Bug Fixes - Restored `ExtensionManager` API contract - Removed test-only settings from production schema - Fixed flaky selectors and missing test setup ## Testing - All browser tests pass - Typecheck passes <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Tests** * Overhauled browser E2E test infrastructure with many new helpers/fixtures, updated test APIs, and CI test container image bumped for consistency. * **Chores** * Standardized line endings and applied stricter lint rules for browser tests; workspace dependency version updated. * **Documentation** * Updated Playwright and TypeScript testing guidance and test-run commands. * **UI** * Added stable data-testids to multiple components to improve testability. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: GitHub Action <action@github.com> Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
219 lines
6.5 KiB
TypeScript
219 lines
6.5 KiB
TypeScript
import type { Locator, Page } from '@playwright/test'
|
|
|
|
import type { WorkspaceStore } from '../../types/globals'
|
|
|
|
export class Topbar {
|
|
private readonly menuLocator: Locator
|
|
private readonly menuTrigger: Locator
|
|
|
|
constructor(public readonly page: Page) {
|
|
this.menuLocator = page.locator('.comfy-command-menu')
|
|
this.menuTrigger = page.locator('.comfy-menu-button-wrapper')
|
|
}
|
|
|
|
async getTabNames(): Promise<string[]> {
|
|
return await this.page
|
|
.locator('.workflow-tabs .workflow-label')
|
|
.allInnerTexts()
|
|
}
|
|
|
|
async getActiveTabName(): Promise<string> {
|
|
return this.page
|
|
.locator('.workflow-tabs .p-togglebutton-checked')
|
|
.innerText()
|
|
}
|
|
|
|
/**
|
|
* Get a menu item by its label, optionally within a specific parent container
|
|
*/
|
|
getMenuItem(itemLabel: string, parent?: Locator): Locator {
|
|
if (parent) {
|
|
return parent.locator(`.p-tieredmenu-item:has-text("${itemLabel}")`)
|
|
}
|
|
|
|
return this.page.locator(`.p-menubar-item-label:text-is("${itemLabel}")`)
|
|
}
|
|
|
|
/**
|
|
* Get the visible submenu (last visible submenu in case of nested menus)
|
|
*/
|
|
getVisibleSubmenu(): Locator {
|
|
return this.page.locator('.p-tieredmenu-submenu:visible').last()
|
|
}
|
|
|
|
/**
|
|
* Check if a menu item has an active checkmark
|
|
*/
|
|
async isMenuItemActive(menuItem: Locator): Promise<boolean> {
|
|
const checkmark = menuItem.locator('.pi-check')
|
|
const classes = await checkmark.getAttribute('class')
|
|
return classes ? !classes.includes('invisible') : false
|
|
}
|
|
|
|
getWorkflowTab(tabName: string): Locator {
|
|
return this.page
|
|
.locator(`.workflow-tabs .workflow-label:has-text("${tabName}")`)
|
|
.locator('..')
|
|
}
|
|
|
|
async closeWorkflowTab(tabName: string) {
|
|
const tab = this.getWorkflowTab(tabName)
|
|
await tab.getByRole('button', { name: 'Close' }).click({ force: true })
|
|
}
|
|
|
|
getSaveDialog(): Locator {
|
|
return this.page.locator('.p-dialog-content input')
|
|
}
|
|
|
|
saveWorkflow(workflowName: string): Promise<void> {
|
|
return this._saveWorkflow(workflowName, 'Save')
|
|
}
|
|
|
|
saveWorkflowAs(workflowName: string): Promise<void> {
|
|
return this._saveWorkflow(workflowName, 'Save As')
|
|
}
|
|
|
|
exportWorkflow(workflowName: string): Promise<void> {
|
|
return this._saveWorkflow(workflowName, 'Export')
|
|
}
|
|
|
|
async _saveWorkflow(
|
|
workflowName: string,
|
|
command: 'Save' | 'Save As' | 'Export'
|
|
) {
|
|
await this.triggerTopbarCommand(['File', command])
|
|
await this.getSaveDialog().fill(workflowName)
|
|
await this.page.keyboard.press('Enter')
|
|
|
|
// Wait for workflow service to finish saving
|
|
await this.page.waitForFunction(
|
|
() => !(window.app!.extensionManager as WorkspaceStore).workflow.isBusy,
|
|
undefined,
|
|
{ timeout: 3000 }
|
|
)
|
|
// Wait for the dialog to close.
|
|
await this.getSaveDialog().waitFor({ state: 'hidden', timeout: 500 })
|
|
|
|
// Check if a confirmation dialog appeared (e.g., "Overwrite existing file?")
|
|
// If so, return early to let the test handle the confirmation
|
|
const confirmationDialog = this.page.locator(
|
|
'.p-dialog:has-text("Overwrite")'
|
|
)
|
|
if (await confirmationDialog.isVisible()) {
|
|
return
|
|
}
|
|
}
|
|
|
|
async openTopbarMenu() {
|
|
// If menu is already open, close it first to reset state
|
|
const isAlreadyOpen = await this.menuLocator.isVisible()
|
|
if (isAlreadyOpen) {
|
|
// Click outside the menu to close it properly
|
|
await this.page.locator('body').click({ position: { x: 500, y: 300 } })
|
|
await this.menuLocator.waitFor({ state: 'hidden', timeout: 1000 })
|
|
}
|
|
|
|
await this.menuTrigger.click()
|
|
await this.menuLocator.waitFor({ state: 'visible' })
|
|
return this.menuLocator
|
|
}
|
|
|
|
/**
|
|
* Close the topbar menu by clicking outside
|
|
*/
|
|
async closeTopbarMenu() {
|
|
await this.page.locator('body').click({ position: { x: 300, y: 10 } })
|
|
await this.menuLocator.waitFor({ state: 'hidden' })
|
|
}
|
|
|
|
/**
|
|
* Navigate to a submenu by hovering over a menu item
|
|
*/
|
|
async openSubmenu(menuItemLabel: string): Promise<Locator> {
|
|
const menuItem = this.getMenuItem(menuItemLabel)
|
|
await menuItem.hover()
|
|
const submenu = this.getVisibleSubmenu()
|
|
await submenu.waitFor({ state: 'visible' })
|
|
return submenu
|
|
}
|
|
|
|
/**
|
|
* Get theme menu items and interact with theme switching
|
|
*/
|
|
async getThemeMenuItems() {
|
|
const themeSubmenu = await this.openSubmenu('Theme')
|
|
return {
|
|
submenu: themeSubmenu,
|
|
darkTheme: this.getMenuItem('Dark (Default)', themeSubmenu),
|
|
lightTheme: this.getMenuItem('Light', themeSubmenu)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Switch to a specific theme
|
|
*/
|
|
async switchTheme(theme: 'dark' | 'light') {
|
|
const { darkTheme, lightTheme } = await this.getThemeMenuItems()
|
|
const themeItem = theme === 'dark' ? darkTheme : lightTheme
|
|
const themeLabel = themeItem.locator('.p-menubar-item-label')
|
|
await themeLabel.click()
|
|
}
|
|
|
|
async triggerTopbarCommand(path: string[]) {
|
|
if (path.length < 1) {
|
|
throw new Error('Path cannot be empty')
|
|
}
|
|
|
|
const menu = await this.openTopbarMenu()
|
|
const tabName = path[0]
|
|
const topLevelMenuItem = this.getMenuItem(tabName)
|
|
const topLevelMenu = menu
|
|
.locator('.p-tieredmenu-item')
|
|
.filter({ has: topLevelMenuItem })
|
|
await topLevelMenu.waitFor({ state: 'visible' })
|
|
|
|
// Handle top-level commands (like "New")
|
|
if (path.length === 1) {
|
|
await topLevelMenuItem.click()
|
|
return
|
|
}
|
|
|
|
await topLevelMenu.hover()
|
|
|
|
// Hover over top-level menu with retry logic for flaky submenu appearance
|
|
const submenu = this.getVisibleSubmenu()
|
|
try {
|
|
await submenu.waitFor({ state: 'visible', timeout: 1000 })
|
|
} catch {
|
|
// Click outside to reset, then reopen menu
|
|
await this.page.locator('body').click({ position: { x: 500, y: 300 } })
|
|
await this.menuLocator.waitFor({ state: 'hidden', timeout: 1000 })
|
|
await this.menuTrigger.click()
|
|
await this.menuLocator.waitFor({ state: 'visible' })
|
|
// Re-hover on top-level menu to trigger submenu
|
|
await topLevelMenu.hover()
|
|
await submenu.waitFor({ state: 'visible', timeout: 1000 })
|
|
}
|
|
|
|
let currentMenu = topLevelMenu
|
|
for (let i = 1; i < path.length; i++) {
|
|
const commandName = path[i]
|
|
const menuItem = submenu
|
|
.locator(`.p-tieredmenu-item:has-text("${commandName}")`)
|
|
.first()
|
|
await menuItem.waitFor({ state: 'visible' })
|
|
|
|
// For the last item, click it
|
|
if (i === path.length - 1) {
|
|
await menuItem.click()
|
|
return
|
|
}
|
|
|
|
// Otherwise, hover to open nested submenu
|
|
await menuItem.hover()
|
|
currentMenu = menuItem
|
|
}
|
|
await currentMenu.click()
|
|
}
|
|
}
|