Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions browser_tests/assets/agent/restart_node_refresh.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"last_node_id": 1,
"last_link_id": 0,
"nodes": [
{
"id": 1,
"type": "BrowserProofNode",
"pos": [0, 30],
"size": {
"0": 315,
"1": 262
},
"flags": {},
"order": 0,
"mode": 0,
"inputs": [
{
"name": "model",
"type": "MODEL",
"link": null
},
{
"name": "positive",
"type": "CONDITIONING",
"link": null
},
{
"name": "negative",
"type": "CONDITIONING",
"link": null
},
{
"name": "latent_image",
"type": "LATENT",
"link": null
}
],
"outputs": [
{
"name": "LATENT",
"type": "LATENT",
"links": [],
"slot_index": 0
}
],
"properties": {
"Node name for S&R": "BrowserProofNode"
},
"widgets_values": [
156680208700286,
"randomize",
20,
8,
"euler",
"normal",
1
]
}
],
"links": [],
"groups": [],
"config": {},
"extra": {
"ds": {
"scale": 1,
"offset": [0, 0]
}
},
"version": 0.4
}
150 changes: 150 additions & 0 deletions browser_tests/tests/agent/agentRestartNodeRefresh.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
import { expect, mergeTests } from '@playwright/test'

import { toNodeId } from '@/types/nodeId'
import type { AgentWsEvent } from '@/workbench/extensions/agent/schemas/agentApiSchema'

import { webSocketFixture } from '@e2e/fixtures/ws'
import { agentReplayNodeDefs } from '@e2e/fixtures/data/agentReplayNodeDefs'
import { jsonRoute } from '@e2e/fixtures/utils/jsonRoute'
import { agentTest, pushAgentEvent } from '@e2e/tests/agent/agentPanelMocks'

const test = mergeTests(agentTest, webSocketFixture)
const browserProofNodeId = toNodeId(1)

test.describe(
'Agent restart node refresh',
{ tag: ['@cloud', '@agent', '@canvas', '@node'] },
() => {
test.use({ connectWebSocketToServer: false, objectInfo: 'server' })

let restarted = false

test.beforeEach(async ({ comfyPage }) => {
const page = comfyPage.page
restarted = false
await page.route('**/object_info', async (route) => {
await route.fulfill(
jsonRoute(
restarted
? {
...agentReplayNodeDefs,
BrowserProofNode: {
...agentReplayNodeDefs.KSampler,
name: 'BrowserProofNode',
display_name: 'Browser Proof Node'
}
}
: agentReplayNodeDefs
)
)
})

await comfyPage.workflow.loadWorkflow('agent/restart_node_refresh')
await expect
.poll(() =>
page.evaluate((nodeId) => {
const node = window.app!.graph.getNodeById(nodeId)
return {
type: node?.type,
hasErrors: node?.has_errors === true,
hasStepsWidget: node?.widgets?.some(
(widget) => widget.name === 'steps'
)
}
}, browserProofNodeId)
)
.toEqual({
type: 'BrowserProofNode',
hasErrors: true,
hasStepsWidget: false
})
})

// The restart report and ComfyUI's reconnect travel on different sockets,
// so the page must recover in either order.
for (const reportFirst of [true, false]) {
test(`refreshes node definitions and reloads the active workflow when ${
reportFirst ? 'the restart report' : 'the ComfyUI reconnect'
} arrives first`, async ({
agentPanel,
comfyPage,
getAgentSocket,
getWebSocket,
nextWebSocket
}) => {
test.setTimeout(60_000)
const page = comfyPage.page

await agentPanel.open()
await agentPanel.selectWorkflow('restart_node_refresh')

const deliverRestartReport = () =>
test.step('deliver the agent restart report', async () => {
const ws = await getAgentSocket()
const restart: AgentWsEvent = {
type: 'agent_tool_call',
data: {
tool_call_id: 'call-restart-browser-proof',
tool_name: 'restart_comfyui',
status: 'success',
message_id: 'message-restart-browser-proof',
thread_id: 'thread-restart-browser-proof'
}
}
pushAgentEvent(ws, restart)
})

const restartComfy = () =>
test.step('restart ComfyUI with the new node loaded', async () => {
const comfySocket = await getWebSocket()
const pageReconnected = await page.evaluateHandle(() => ({
done: new Promise<void>((resolve) =>
window.app!.api.addEventListener(
'reconnected',
() => resolve(),
{ once: true }
)
)
}))
const reconnected = nextWebSocket()
restarted = true
await comfySocket.close()
await reconnected
await pageReconnected.evaluate(({ done }) => done)
})

if (reportFirst) {
await deliverRestartReport()
await restartComfy()
} else {
await restartComfy()
await deliverRestartReport()
}

await test.step('verify the active workflow was reconstructed', async () => {
await expect
.poll(() =>
page.evaluate((nodeId) => {
const node = window.app!.graph.getNodeById(nodeId)
return {
type: node?.type,
hasErrors: node?.has_errors === true,
hasStepsWidget: node?.widgets?.some(
(widget) => widget.name === 'steps'
),
seed: node?.widgets?.find((widget) => widget.name === 'seed')
?.value
}
}, browserProofNodeId)
)
.toEqual({
type: 'BrowserProofNode',
hasErrors: false,
hasStepsWidget: true,
seed: 156680208700286
})
})
})
}
}
)
7 changes: 6 additions & 1 deletion src/workbench/extensions/agent/AgentPanelRoot.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6241,7 +6241,7 @@ describe('AgentPanelRoot node definition refresh', () => {
vi.useFakeTimers()
})

it('refreshes node definitions when the agent restarts ComfyUI while the panel is open', async () => {
it('refreshes node definitions when ComfyUI reconnects after the agent restarts it while the panel is open', async () => {
const refreshNodeDefinitions = vi.fn()
useCommandStore().registerCommand({
id: 'Comfy.RefreshNodeDefinitions',
Expand All @@ -6251,6 +6251,10 @@ describe('AgentPanelRoot node definition refresh', () => {

ws.emit('agent_tool_call', restartSucceeded)
await vi.advanceTimersByTimeAsync(0)
expect(refreshNodeDefinitions).not.toHaveBeenCalled()

ws.emit('reconnected')
await vi.advanceTimersByTimeAsync(0)

expect(refreshNodeDefinitions).toHaveBeenCalledOnce()
})
Expand All @@ -6265,6 +6269,7 @@ describe('AgentPanelRoot node definition refresh', () => {

unmount()
ws.emit('agent_tool_call', restartSucceeded)
ws.emit('reconnected')
await vi.advanceTimersByTimeAsync(0)

expect(refreshNodeDefinitions).not.toHaveBeenCalled()
Expand Down
17 changes: 11 additions & 6 deletions src/workbench/extensions/agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@ The panel speaks one contract on the cloud and on the local agent:
socket connects again. A rejected credential is not retried until the
account changes.
- **ComfyUI restart** (`stores/agent/agentNodeDefinitionRefreshStore.ts`). A
successful `restart_comfyui` tool call refreshes node definitions and then
reloads the open workflow; the refresh shows its own "Update requested" and
"Node definitions updated" toasts. A failed refresh runs again only when
ComfyUI's `/ws` reconnects later; until then definitions stay stale, and
**Refresh Node Definitions** recovers them. A restart made while the panel is
closed is not observed.
successful `restart_comfyui` tool call means ComfyUI restarts once the turn
ends. Every `/ws` reconnect within 10 minutes of that call, before or after
it, refreshes node definitions and then reloads the open workflow, because
the call and the reconnect arrive on different sockets in either order. An
unrelated reconnect in that window refreshes too and leaves the restart's
own reconnect to refresh again. The refresh shows its own "Update requested"
and "Node definitions updated" toasts. A failed refresh runs again on the
next reconnect in the window. A reconnect outside the window does nothing, so
if none comes within it the store does nothing, and **Refresh Node
Definitions** recovers definitions. A restart made while the panel is closed
is not observed.
- **Saved workflows, `GET /api/workflows`**. Saved tabs resolve through the
saved-workflow index on every backend.
- **Credential** (`services/agent/agentAuth.ts`). In the cloud, agent requests
Expand Down
Loading
Loading