mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-11 16:30:57 +00:00
a1e6fb36d2
## Summary Harden the `ChangeTracker` lifecycle to eliminate the class of bugs where an inactive workflow's tracker silently captures the wrong graph state. Renames `checkState()` to `captureCanvasState()` with a self-defending assertion, introduces `deactivate()` and `prepareForSave()` lifecycle methods, and closes a latent undo-history corruption bug discovered during code review. ## Background ComfyUI supports multiple workflows open as tabs, but only one canvas (`app.rootGraph`) exists at a time. When the user switches tabs, the old workflow's graph is unloaded and the new one is loaded into this shared canvas. The old `checkState()` method serialized `app.rootGraph` into `activeState` to track changes for undo/redo. It had no awareness of *which* workflow it belonged to -- if called on an inactive tab's tracker, it would capture the active tab's graph data and silently overwrite the inactive workflow's state. This caused permanent data loss (fixed in PR #10745 with caller-side `isActive` guards). The caller-side guards were fragile: every new call site had to remember to add the guard, and forgetting would reintroduce the same silent data corruption. Additionally, `beforeLoadNewGraph` only called `store()` (viewport/outputs) without `checkState()`, meaning canvas state could be stale if a tab switch happened without a preceding mouseup event. ### Before (fragile) ``` saveWorkflow(workflow): if (isActive(workflow)) <-- caller must remember this guard workflow.changeTracker.checkState() <-- name implies "read", actually writes ... beforeLoadNewGraph(): activeWorkflow.changeTracker.store() <-- only saves viewport, NOT graph state ``` ### After (self-defending) ``` saveWorkflow(workflow): workflow.changeTracker.prepareForSave() <-- handles active/inactive internally ... beforeLoadNewGraph(): activeWorkflow.changeTracker.deactivate() <-- captures graph + viewport together ``` ## Changes - Rename `checkState` to `captureCanvasState` with active-tracker assertion - Add `deactivate()` and `prepareForSave()` lifecycle methods - Fix undo-history corruption: `captureCanvasState()` guarded by `_restoringState` - Fix viewport regression during undo: `deactivate()` skips `captureCanvasState()` during undo/redo but always calls `store()` to preserve viewport (regression from PR #10247) - Log inactive tracker warnings unconditionally at warn level (not DEV-only) - Deprecated `checkState()` wrapper for extension compatibility - Rename `checkState` to `captureCanvasState` in `useWidgetSelectActions` composable - Add `appModeStore.ts` to manual call sites documentation - Add `checkState()` deprecation note to architecture docs - Add 16 unit tests covering all guard conditions, lifecycle methods, and undo behavior - Add E2E test: "Undo preserves viewport offset" ## New ChangeTracker Public API | Method | Caller | Purpose | |--------|--------|---------| | `captureCanvasState()` | Event handlers, UI interactions | Snapshots canvas into activeState, pushes undo. Asserts active tracker. | | `deactivate()` | `beforeLoadNewGraph` only | `captureCanvasState()` (skipped during undo/redo) + `store()`. Freezes state for tab switch. | | `prepareForSave()` | Save paths only | Active: `captureCanvasState()`. Inactive: no-op. | | `checkState()` | **Deprecated** -- extensions only | Wrapper that delegates to `captureCanvasState()` with deprecation warning. | | `store()` | Internal to `deactivate()` | Saves viewport, outputs, subgraph navigation. | | `restore()` | `afterLoadNewGraph` | Restores viewport, outputs, subgraph navigation. | | `reset()` | `afterLoadNewGraph`, save | Resets initial state (marks as "clean"). | ## Test plan - [x] Unit tests: 16 tests covering all guard conditions, state capture, undo queue behavior - [x] E2E test: "Undo preserves viewport offset" verifies no viewport drift on undo - [x] E2E test: "Prevents captureCanvasState from corrupting workflow state during tab switch" - [x] Existing E2E: "Closing an inactive tab with save preserves its own content" - [ ] Manual: rapidly switch tabs during undo/redo, verify no viewport drift - [ ] Manual: verify extensions calling `checkState()` see deprecation warning in console
63 lines
2.4 KiB
TypeScript
63 lines
2.4 KiB
TypeScript
import {
|
|
comfyExpect as expect,
|
|
comfyPageFixture as test
|
|
} from '@e2e/fixtures/ComfyPage'
|
|
import type { WorkspaceStore } from '@e2e/types/globals'
|
|
|
|
test.describe(
|
|
'Change Tracker - isLoadingGraph guard',
|
|
{ tag: '@workflow' },
|
|
() => {
|
|
test.beforeEach(async ({ comfyPage }) => {
|
|
await comfyPage.workflow.setupWorkflowsDirectory({})
|
|
})
|
|
|
|
test('Prevents captureCanvasState from corrupting workflow state during tab switch', async ({
|
|
comfyPage
|
|
}) => {
|
|
// Tab 0: default workflow (7 nodes)
|
|
await expect.poll(() => comfyPage.nodeOps.getGraphNodesCount()).toBe(7)
|
|
|
|
// Save tab 0 so it has a unique name for tab switching
|
|
await comfyPage.menu.topbar.saveWorkflow('workflow-a')
|
|
|
|
// Register an extension that forces captureCanvasState during graph loading.
|
|
// This simulates the bug scenario where a user clicks during graph loading
|
|
// which triggers a captureCanvasState call on the wrong graph, corrupting the activeState.
|
|
await comfyPage.page.evaluate(() => {
|
|
window.app!.registerExtension({
|
|
name: 'TestCheckStateDuringLoad',
|
|
afterConfigureGraph() {
|
|
const workflow = (window.app!.extensionManager as WorkspaceStore)
|
|
.workflow.activeWorkflow
|
|
if (!workflow) throw new Error('No workflow found')
|
|
// Bypass the guard to reproduce the corruption bug:
|
|
// ; (workflow.changeTracker.constructor as unknown as { isLoadingGraph: boolean }).isLoadingGraph = false
|
|
|
|
// Simulate the user clicking during graph loading
|
|
workflow.changeTracker.captureCanvasState()
|
|
}
|
|
})
|
|
})
|
|
|
|
// Create tab 1: blank workflow (0 nodes)
|
|
await comfyPage.menu.topbar.triggerTopbarCommand(['New'])
|
|
await expect.poll(() => comfyPage.nodeOps.getGraphNodesCount()).toBe(0)
|
|
|
|
// Switch back to tab 0 (workflow-a).
|
|
const tab0 = comfyPage.menu.topbar.getWorkflowTab('workflow-a')
|
|
await tab0.click()
|
|
await expect.poll(() => comfyPage.nodeOps.getGraphNodesCount()).toBe(7)
|
|
|
|
// switch to blank tab and back to verify no corruption
|
|
const tab1 = comfyPage.menu.topbar.getWorkflowTab('Unsaved Workflow')
|
|
await tab1.click()
|
|
await expect.poll(() => comfyPage.nodeOps.getGraphNodesCount()).toBe(0)
|
|
|
|
// switch again and verify no corruption
|
|
await tab0.click()
|
|
await expect.poll(() => comfyPage.nodeOps.getGraphNodesCount()).toBe(7)
|
|
})
|
|
}
|
|
)
|