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
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import { expect } from '@playwright/test'

import enMessages from '@/locales/en/main.json' with { type: 'json' }

import { waitForCloudApp } from '@e2e/fixtures/cloudAppFixture'
import { agentTest as test } from '@e2e/tests/agent/agentPanelMocks'

test.describe(
'Agent composer draft survives a page refresh',
{ tag: ['@cloud', '@ui'] },
() => {
test('restores an unsent draft after a reload, but not one discarded by New Chat', async ({
agentPanel,
page
}, testInfo) => {
await agentPanel.open()
const draft = 'Make the background a sunset over the ocean'

await test.step('an unsent draft is still in the composer after a reload', async () => {
await agentPanel.composer.fill(draft)
await expect(agentPanel.composer).toHaveText(draft)

await page.reload()
await waitForCloudApp(page)
await agentPanel.open()
await expect(agentPanel.composer).toHaveText(draft)
await testInfo.attach('draft-restored-after-reload', {
body: await agentPanel.root.screenshot({
path: testInfo.outputPath('draft-restored-after-reload.png')
}),
contentType: 'image/png'
})
})

await test.step('New Chat leaves the composer empty after a reload', async () => {
await agentPanel.root
.getByRole('button', { name: enMessages.agent.newChat })
.click()
await expect(agentPanel.composer).toHaveText('')

await page.reload()
await waitForCloudApp(page)
await agentPanel.open()
await expect(
agentPanel.root.getByText(enMessages.agent.placeholder, {
exact: true
})
).toBeVisible()
await expect(agentPanel.composer).toHaveText('')
await testInfo.attach('new-chat-empty-after-reload', {
body: await agentPanel.root.screenshot({
path: testInfo.outputPath('new-chat-empty-after-reload.png')
}),
contentType: 'image/png'
})
})
})
}
)
3 changes: 2 additions & 1 deletion src/platform/workflow/persistence/base/storageIO.ts
Original file line number Diff line number Diff line change
Expand Up @@ -664,7 +664,8 @@ export function clearAllWorkspaceStorage(): void {
StorageKeys.prefixes.agentThread,
StorageKeys.prefixes.agentWorkflowTabBindings,
StorageKeys.prefixes.agentChatTitles,
StorageKeys.prefixes.agentDeletedThreads
StorageKeys.prefixes.agentDeletedThreads,
StorageKeys.prefixes.agentComposerDraft
]
)
}
7 changes: 6 additions & 1 deletion src/platform/workflow/persistence/base/storageKeys.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ export const StorageKeys = {
return `Comfy.Agent.DeletedThreads:${workspaceId}`
},

agentComposerDraft(workspaceId: string): string {
return `Comfy.Agent.ComposerDraft:${workspaceId}`
},

/**
* localStorage copies of tab pointers for cross-session restore.
* sessionStorage is per-tab (correct for in-session use) but lost
Expand All @@ -117,6 +121,7 @@ export const StorageKeys = {
agentThread: 'Comfy.Agent.ThreadId:',
agentWorkflowTabBindings: 'Comfy.Agent.WorkflowTabBindings:',
agentChatTitles: 'Comfy.Agent.ChatTitles:',
agentDeletedThreads: 'Comfy.Agent.DeletedThreads:'
agentDeletedThreads: 'Comfy.Agent.DeletedThreads:',
agentComposerDraft: 'Comfy.Agent.ComposerDraft:'
}
} as const
4 changes: 4 additions & 0 deletions src/workbench/extensions/agent/AgentPanelRoot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2282,6 +2282,10 @@ start({
(agentPanelStore.view.selection.status === 'idle' &&
threadId.value === agentPanelStore.view.previousThreadId)
})
watch(threadId, composerStore.trackDraftThread, {
immediate: true,
flush: 'sync'
})

watch(() => canvasStore.currentGraph, canvasStore.stopNodePicking, {
flush: 'sync'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { getActivePinia } from 'pinia'
import { assert, describe, expect, it, vi } from 'vitest'
import { nextTick } from 'vue'

import {
getWorkspaceId,
StorageKeys
} from '@/platform/workflow/persistence/base/storageKeys'
import { createMockLoadedWorkflow } from '@/utils/__tests__/litegraphTestUtils'

import { useAgentComposerStore } from './agentComposerStore'
Expand Down Expand Up @@ -380,6 +386,95 @@ describe('composer draft presence', () => {
})
})

describe('composer draft persistence (PM-2002)', () => {
async function reloadPage() {
await nextTick()
const store = useAgentComposerStore()
store.$dispose()
delete getActivePinia()?.state.value[store.$id]
return useAgentComposerStore()
}

it('does not restore a draft into a different chat', async () => {
const store = useAgentComposerStore()
store.trackDraftThread('thread-a')
store.setText('Only for thread A')

const otherChat = await reloadPage()
otherChat.trackDraftThread('thread-b')
expect(otherChat.hasDraft).toBe(false)
})

it('restores text and workflow references, dropping node references and attachments', async () => {
const store = useAgentComposerStore()
store.trackDraftThread('thread-a')
store.setText('Use as the style')
store.setWorkflowReferences([
{ id: 'wf-portrait', name: 'portrait', textOffset: 4 }
])
store.setNodeScope('tab-1')
store.setNodes([{ id: '7', title: 'KSampler' }])
store.addAttachment({ id: 'a-1', name: 'cat.png', ref: 'cat.png' })
const text = store.draft

const restored = await reloadPage()
restored.trackDraftThread('thread-a')
expect(restored.prompt).toEqual({
text,
references: [
{ kind: 'workflow', id: 'wf-portrait', name: 'portrait', textOffset: 4 }
]
})
expect(restored.attachments).toEqual([])
})

it.for([
{ threadId: null, text: null, workflowReferences: [] },
{ threadId: null, text: 'Hi', workflowReferences: null },
{ threadId: null, text: 'Hi', workflowReferences: [{ id: 'wf' }] },
{ threadId: null, text: 'Hi', workflowReferences: ['wf'] }
])(
'discards a malformed saved draft %j and keeps the composer usable',
async (saved) => {
const key = StorageKeys.agentComposerDraft(getWorkspaceId())
localStorage.setItem(key, JSON.stringify(saved))

const store = useAgentComposerStore()
expect(() => store.trackDraftThread(null)).not.toThrow()
expect(store.hasDraft).toBe(false)
await nextTick()
expect(localStorage.getItem(key)).toBeNull()

store.setText('Make it blue')
expect(store.prompt).toEqual({ text: 'Make it blue', references: [] })
}
)

it('forgets the draft once it is sent or cleared', async () => {
const sent = useAgentComposerStore()
sent.trackDraftThread(null)
sent.setText('Make it blue')
await nextTick()
const id = sent.startSubmission({
prompt: sent.prompt,
attachments: [],
nodes: [],
target: createMockLoadedWorkflow({ path: 'workflows/target.json' })
})
sent.settleSubmission(id, true)
const afterSend = await reloadPage()
afterSend.trackDraftThread(null)
expect(afterSend.hasDraft).toBe(false)

afterSend.setText('Make it red')
await nextTick()
afterSend.clearDraft()
const afterClear = await reloadPage()
afterClear.trackDraftThread(null)
expect(afterClear.hasDraft).toBe(false)
})
})

describe('composer prompt origin (PM-1474 F11)', () => {
it('starts out typed and stays typed while the user writes', () => {
const store = useAgentComposerStore()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
import { StorageSerializers, useLocalStorage } from '@vueuse/core'
import { defineStore } from 'pinia'
import { computed, onScopeDispose, ref, shallowReactive, shallowRef } from 'vue'

import {
computed,
onScopeDispose,
ref,
shallowReactive,
shallowRef,
watch
} from 'vue'
import { z } from 'zod'

import {
getWorkspaceId,
StorageKeys
} from '@/platform/workflow/persistence/base/storageKeys'
import { getMediaTypeFromFilename } from '@/utils/formatUtil'

import type { AgentInputMethod } from '@comfyorg/telemetry/types'
Expand Down Expand Up @@ -45,6 +58,19 @@ function composerReferencePosition(reference: ComposerReference): string {
return `${composerReferenceKey(reference)}@${reference.textOffset}`
}

const zSavedDraft = z.object({
threadId: z.string().nullable(),
text: z.string(),
workflowReferences: z.array(
z.object({
id: z.string(),
name: z.string(),
unavailable: z.boolean().optional(),
textOffset: z.number()
Comment thread
christian-byrne marked this conversation as resolved.
Resolved
})
)
})

interface SubmittedDraft {
attachments: ComposerAttachment[]
nodes: SelectedNode[]
Expand Down Expand Up @@ -606,6 +632,36 @@ export const useAgentComposerStore = defineStore('agentComposer', () => {
releaseUnusedAssets()
}

const savedDraft = useLocalStorage<unknown>(
StorageKeys.agentComposerDraft(getWorkspaceId()),
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
null,
{ serializer: StorageSerializers.object }
)
const draftThreadId = ref<string | null>()

watch([draftState, draftThreadId], ([state, threadId]) => {
if (threadId === undefined) return
const references = workflowReferences.value
savedDraft.value =
state.text.trim() !== '' || references.length > 0
? { threadId, text: state.text, workflowReferences: references }
: null
})

function trackDraftThread(threadId: string | null): void {
if (draftThreadId.value === undefined) {
const saved = zSavedDraft.nullable().safeParse(savedDraft.value)
if (!saved.success) savedDraft.value = null
else if (saved.data?.threadId === threadId && !hasDraft.value)
replaceDraft({
text: saved.data.text,
workflowReferences: saved.data.workflowReferences,
attachments: []
})
}
draftThreadId.value = threadId
}

return {
draftState,
draft,
Expand Down Expand Up @@ -648,6 +704,7 @@ export const useAgentComposerStore = defineStore('agentComposer', () => {
settleSubmission,
takeFailedSubmission,
invalidateSubmission,
clearDraft
clearDraft,
trackDraftThread
}
})
Loading