mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-04-20 14:30:41 +00:00
## Summary
Internalize `nextFrame()` calls into fixture/helper methods so spec
authors don't need to remember to call it after common operations.
`nextFrame()` waits for one `requestAnimationFrame` (~16ms) — an extra
call is always safe, making this a low-risk refactor.
## Changes
### Phase 1: `SettingsHelper.setSetting()`
`setSetting()` now calls `nextFrame()` internally. Removed 15 redundant
calls across 7 files.
### Phase 2: `CommandHelper.executeCommand()`
`executeCommand()` now calls `nextFrame()` internally. Removed 15
redundant calls across 7 files, including the now-redundant call in
`AppModeHelper.toggleAppMode()`.
### Phase 3: `WorkflowHelper.loadGraphData()`
New helper wraps `page.evaluate(loadGraphData)` + `nextFrame()`.
Migrated `SubgraphHelper.serializeAndReload()` and `groupNode.spec.ts`.
### Phase 4: `NodeReference` cleanup
Removed redundant `nextFrame()` from `copy()`, `convertToGroupNode()`,
`resizeNode()`, `dragTextEncodeNode2()`, and
`convertDefaultKSamplerToSubgraph()`. Removed 6 spec-level calls after
`node.click('title')`.
### Phase 5: `KeyboardHelper.press()` and `delete()`
New convenience methods that press a key and wait one frame. Converted
40 `canvas.press(key)` + `nextFrame()` pairs across 13 spec files.
### Phase 6: `ComfyPage.expectScreenshot()`
New helper combines `nextFrame()` + `toHaveScreenshot()`. Converted 45
pairs across 12 spec files.
## Total impact
- **~130 redundant `nextFrame()` calls eliminated** across ~35
spec/helper files
- **3 new helper methods** added (`loadGraphData`, `press`/`delete`,
`expectScreenshot`)
- **2 existing methods** enhanced (`setSetting`, `executeCommand`)
## What was NOT changed
- `performance.spec.ts` frame-counting loops (intentional)
- `ComfyMouse.ts` / `CanvasHelper.ts` (already internalized)
- `SubgraphHelper.packAllInteriorNodes()` (deliberate orchestration)
- Builder helpers (already internalized)
┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-11166-refactor-internalize-nextFrame-into-fixture-helper-methods-33f6d73d3650817bb5f6fb46e396085e)
by [Unito](https://www.unito.io)
---------
Co-authored-by: Amp <amp@ampcode.com>
147 lines
4.7 KiB
TypeScript
147 lines
4.7 KiB
TypeScript
import { expect } from '@playwright/test'
|
|
|
|
import type { ComfyPage } from '@e2e/fixtures/ComfyPage'
|
|
import { comfyPageFixture as test } from '@e2e/fixtures/ComfyPage'
|
|
|
|
test.describe('Sidebar splitter width independence', () => {
|
|
test.beforeEach(async ({ comfyPage }) => {
|
|
await comfyPage.settings.setSetting('Comfy.Sidebar.UnifiedWidth', true)
|
|
await comfyPage.settings.setSetting('Comfy.NodeLibrary.NewDesign', false)
|
|
})
|
|
|
|
async function dismissToasts(comfyPage: ComfyPage) {
|
|
const buttons = await comfyPage.page.locator('.p-toast-close-button').all()
|
|
for (const btn of buttons) {
|
|
await btn.click({ timeout: 2000 }).catch(() => {})
|
|
}
|
|
// Brief wait for animations
|
|
await comfyPage.nextFrame()
|
|
}
|
|
|
|
async function dragGutter(comfyPage: ComfyPage, deltaX: number) {
|
|
const gutter = comfyPage.page
|
|
.locator('.p-splitter-gutter:not(.hidden)')
|
|
.first()
|
|
await expect(gutter).toBeVisible()
|
|
await expect.poll(() => gutter.boundingBox()).not.toBeNull()
|
|
const box = (await gutter.boundingBox())!
|
|
const centerX = box.x + box.width / 2
|
|
const centerY = box.y + box.height / 2
|
|
await comfyPage.page.mouse.move(centerX, centerY)
|
|
await comfyPage.page.mouse.down()
|
|
await comfyPage.page.mouse.move(centerX + deltaX, centerY, { steps: 10 })
|
|
await comfyPage.page.mouse.up()
|
|
await comfyPage.nextFrame()
|
|
}
|
|
|
|
async function openSidebarAt(
|
|
comfyPage: ComfyPage,
|
|
location: 'left' | 'right'
|
|
) {
|
|
await comfyPage.settings.setSetting('Comfy.Sidebar.Location', location)
|
|
await dismissToasts(comfyPage)
|
|
await comfyPage.menu.nodeLibraryTab.open()
|
|
}
|
|
|
|
test('left and right sidebars use separate localStorage keys', async ({
|
|
comfyPage
|
|
}) => {
|
|
// Open sidebar on the left and resize it
|
|
await openSidebarAt(comfyPage, 'left')
|
|
await dragGutter(comfyPage, 100)
|
|
|
|
// Read the sidebar panel width after resize
|
|
const leftSidebar = comfyPage.page.locator('.side-bar-panel').first()
|
|
const leftWidth = (await leftSidebar.boundingBox())!.width
|
|
|
|
// Close sidebar, switch to right, open again
|
|
await comfyPage.menu.nodeLibraryTab.close()
|
|
await openSidebarAt(comfyPage, 'right')
|
|
|
|
// Right sidebar should use its default width, not the left's resized width
|
|
const rightSidebar = comfyPage.page.locator('.side-bar-panel').first()
|
|
await expect(rightSidebar).toBeVisible()
|
|
|
|
// The right sidebar should NOT match the left's resized width.
|
|
// We dragged the left sidebar 100px wider, so there should be a noticeable
|
|
// difference between the left (resized) and right (default) widths.
|
|
await expect
|
|
.poll(async () => {
|
|
const b = await rightSidebar.boundingBox()
|
|
return b ? Math.abs(b.width - leftWidth) : -1
|
|
})
|
|
.toBeGreaterThan(50)
|
|
})
|
|
|
|
test('localStorage keys include sidebar location', async ({ comfyPage }) => {
|
|
// Open sidebar on the left and resize
|
|
await openSidebarAt(comfyPage, 'left')
|
|
await dragGutter(comfyPage, 50)
|
|
|
|
// Left-only sidebar should use the legacy key (no location suffix)
|
|
await expect
|
|
.poll(() =>
|
|
comfyPage.page.evaluate(() => localStorage.getItem('unified-sidebar'))
|
|
)
|
|
.not.toBeNull()
|
|
|
|
// Switch to right and resize
|
|
await comfyPage.menu.nodeLibraryTab.close()
|
|
await openSidebarAt(comfyPage, 'right')
|
|
await dragGutter(comfyPage, -50)
|
|
|
|
// Right sidebar should use a different key with location suffix
|
|
await expect
|
|
.poll(() =>
|
|
comfyPage.page.evaluate(() =>
|
|
localStorage.getItem('unified-sidebar-right')
|
|
)
|
|
)
|
|
.not.toBeNull()
|
|
|
|
// Both keys should exist independently
|
|
await expect
|
|
.poll(() =>
|
|
comfyPage.page.evaluate(() => localStorage.getItem('unified-sidebar'))
|
|
)
|
|
.not.toBeNull()
|
|
})
|
|
|
|
test('normalized panel sizes sum to approximately 100%', async ({
|
|
comfyPage
|
|
}) => {
|
|
await openSidebarAt(comfyPage, 'left')
|
|
await dragGutter(comfyPage, 80)
|
|
|
|
// Check that saved sizes sum to ~100%
|
|
const getSidebarSizes = () =>
|
|
comfyPage.page.evaluate(() => {
|
|
const raw = localStorage.getItem('unified-sidebar')
|
|
return raw ? (JSON.parse(raw) as number[]) : null
|
|
})
|
|
|
|
await expect
|
|
.poll(async () => {
|
|
const sizes = await getSidebarSizes()
|
|
return Array.isArray(sizes)
|
|
})
|
|
.toBe(true)
|
|
|
|
await expect
|
|
.poll(async () => {
|
|
const sizes = await getSidebarSizes()
|
|
if (!sizes) return 0
|
|
return sizes.reduce((a, b) => a + b, 0)
|
|
})
|
|
.toBeGreaterThan(99)
|
|
|
|
await expect
|
|
.poll(async () => {
|
|
const sizes = await getSidebarSizes()
|
|
if (!sizes) return Infinity
|
|
return sizes.reduce((a, b) => a + b, 0)
|
|
})
|
|
.toBeLessThanOrEqual(101)
|
|
})
|
|
})
|