Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

fix(workflow): stop dropping unsaved edits when collaboration never c… (#39579)

Benjamin75c54bd40b76
diff --git a/web/app/components/workflow-app/hooks/__tests__/use-nodes-sync-draft.spec.ts b/web/app/components/workflow-app/hooks/__tests__/use-nodes-sync-draft.spec.ts
index 27a475f093e..a0ce5c1d2e1 100644
--- a/web/app/components/workflow-app/hooks/__tests__/use-nodes-sync-draft.spec.ts
+++ b/web/app/components/workflow-app/hooks/__tests__/use-nodes-sync-draft.spec.ts
@@ -14,6 +14,7 @@ const mockCollaborationGetIsLeader = vi.fn()
const mockCollaborationRequestWorkflowSync = vi.fn()
const mockCollaborationCanPersistLocalGraph = vi.fn()
const mockCollaborationCanFlushGraphOnPageClose = vi.fn()
+const mockCollaborationCanUseLocalDraftFallback = vi.fn()
let isCollaborationEnabled = false
let reactFlowState: {
@@ -72,6 +73,8 @@ vi.mock('@/app/components/workflow/collaboration/core/collaboration-manager', ()
canPersistLocalGraph: (...args: unknown[]) => mockCollaborationCanPersistLocalGraph(...args),
canFlushGraphOnPageClose: (...args: unknown[]) =>
mockCollaborationCanFlushGraphOnPageClose(...args),
+ canUseLocalDraftFallback: (...args: unknown[]) =>
+ mockCollaborationCanUseLocalDraftFallback(...args),
},
}))
@@ -139,6 +142,7 @@ describe('useNodesSyncDraft — handleRefreshWorkflowDraft(true) on 409', () =>
mockCollaborationGetIsLeader.mockReturnValue(true)
mockCollaborationCanPersistLocalGraph.mockReturnValue(true)
mockCollaborationCanFlushGraphOnPageClose.mockReturnValue(true)
+ mockCollaborationCanUseLocalDraftFallback.mockReturnValue(false)
mockCollaborationRequestWorkflowSync.mockResolvedValue({
hash: 'remote-hash',
updatedAt: 2,
@@ -610,6 +614,7 @@ describe('useNodesSyncDraft — handleRefreshWorkflowDraft(true) on 409', () =>
isCollaborationEnabled = true
mockCollaborationIsConnected.mockReturnValue(true)
mockCollaborationGetIsLeader.mockReturnValue(false)
+ mockCollaborationCanFlushGraphOnPageClose.mockReturnValue(false)
const { result } = renderUseNodesSyncDraft()
@@ -634,4 +639,37 @@ describe('useNodesSyncDraft — handleRefreshWorkflowDraft(true) on 409', () =>
expect(mockPostWithKeepalive).toHaveBeenCalledTimes(1)
})
+
+ it('should still flush with keepalive on page close when collaboration is enabled but never connected', () => {
+ // Without a connection there is no leader election, so the collaborative flush guard can never
+ // be satisfied. Skipping the save here would silently drop the edits made before leaving.
+ isCollaborationEnabled = true
+ mockCollaborationIsConnected.mockReturnValue(false)
+ mockCollaborationGetIsLeader.mockReturnValue(false)
+ mockCollaborationCanFlushGraphOnPageClose.mockReturnValue(false)
+ mockCollaborationCanUseLocalDraftFallback.mockReturnValue(true)
+
+ const { result } = renderUseNodesSyncDraft()
+
+ act(() => {
+ result.current.syncWorkflowDraftWhenPageClose()
+ })
+
+ expect(mockPostWithKeepalive).toHaveBeenCalledTimes(1)
+ })
+
+ it('should not flush an untrusted graph after an established collaboration disconnects', () => {
+ isCollaborationEnabled = true
+ mockCollaborationIsConnected.mockReturnValue(false)
+ mockCollaborationCanFlushGraphOnPageClose.mockReturnValue(false)
+ mockCollaborationCanUseLocalDraftFallback.mockReturnValue(false)
+
+ const { result } = renderUseNodesSyncDraft()
+
+ act(() => {
+ result.current.syncWorkflowDraftWhenPageClose()
+ })
+
+ expect(mockPostWithKeepalive).not.toHaveBeenCalled()
+ })
})
diff --git a/web/app/components/workflow-app/hooks/use-nodes-sync-draft.ts b/web/app/components/workflow-app/hooks/use-nodes-sync-draft.ts
index 028907cba4a..df0a623188a 100644
--- a/web/app/components/workflow-app/hooks/use-nodes-sync-draft.ts
+++ b/web/app/components/workflow-app/hooks/use-nodes-sync-draft.ts
@@ -129,14 +129,11 @@ const useNodesSyncDraftBase = (getNodesReadOnly: () => boolean) => {
const syncWorkflowDraftWhenPageClose = useCallback(() => {
if (getNodesReadOnly()) return
- if (isCollaborationEnabled && !collaborationManager.canFlushGraphOnPageClose()) return
-
- const isFollower =
- isCollaborationEnabled &&
- collaborationManager.isConnected() &&
- !collaborationManager.getIsLeader()
-
- if (isFollower) return
+ const canPersistOnPageClose =
+ !isCollaborationEnabled ||
+ collaborationManager.canFlushGraphOnPageClose() ||
+ collaborationManager.canUseLocalDraftFallback()
+ if (!canPersistOnPageClose) return
const postParams = getPostParams()
diff --git a/web/app/components/workflow/__tests__/workflow-edge-events.spec.tsx b/web/app/components/workflow/__tests__/workflow-edge-events.spec.tsx
index ac8e4c9ef29..05403cf4889 100644
--- a/web/app/components/workflow/__tests__/workflow-edge-events.spec.tsx
+++ b/web/app/components/workflow/__tests__/workflow-edge-events.spec.tsx
@@ -26,6 +26,8 @@ const reactFlowBridge = vi.hoisted(() => ({
const collaborationBridge = vi.hoisted(() => ({
canFlushGraphOnPageClose: vi.fn(),
+ canUseLocalDraftFallback: vi.fn(),
+ isConnected: vi.fn(),
graphImportHandler: null as null | ((payload: { nodes: Node[]; edges: Edge[] }) => void),
historyActionHandler: null as null | ((payload: unknown) => void),
restoreIntentHandler: null as
@@ -83,6 +85,7 @@ const workflowHookMocks = vi.hoisted(() => ({
handleSelectionContextMenu: vi.fn(),
handlePaneContextMenu: vi.fn(),
handleSyncWorkflowDraft: vi.fn(),
+ syncWorkflowDraftWhenPageClose: vi.fn(),
fetchInspectVars: vi.fn(),
isValidConnection: vi.fn(),
useShortcuts: vi.fn(),
@@ -199,6 +202,8 @@ vi.mock('@langgenius/dify-ui/toast', () => ({
vi.mock('../collaboration/core/collaboration-manager', () => ({
collaborationManager: {
canFlushGraphOnPageClose: collaborationBridge.canFlushGraphOnPageClose,
+ canUseLocalDraftFallback: collaborationBridge.canUseLocalDraftFallback,
+ isConnected: collaborationBridge.isConnected,
onGraphImport: (handler: (payload: { nodes: Node[]; edges: Edge[] }) => void) => {
collaborationBridge.graphImportHandler = handler
return vi.fn()
@@ -421,7 +426,7 @@ vi.mock('../hooks/use-workflow', () => ({
vi.mock('../hooks/use-nodes-sync-draft', () => ({
useNodesSyncDraft: () => ({
handleSyncWorkflowDraft: workflowHookMocks.handleSyncWorkflowDraft,
- syncWorkflowDraftWhenPageClose: vi.fn(),
+ syncWorkflowDraftWhenPageClose: workflowHookMocks.syncWorkflowDraftWhenPageClose,
}),
}))
@@ -557,6 +562,8 @@ describe('Workflow edge event wiring', () => {
beforeEach(() => {
vi.clearAllMocks()
collaborationBridge.canFlushGraphOnPageClose.mockReturnValue(true)
+ collaborationBridge.canUseLocalDraftFallback.mockReturnValue(false)
+ collaborationBridge.isConnected.mockReturnValue(true)
eventEmitterState.subscription = null
reactFlowBridge.store = null
collaborationBridge.graphImportHandler = null
@@ -711,6 +718,40 @@ describe('Workflow edge event wiring', () => {
expect(toastErrorMock).not.toHaveBeenCalled()
})
+ it('should still save on unmount when collaboration is enabled but never connected', () => {
+ // No connection means no leader election, so the collaborative flush guard can never be
+ // satisfied. Skipping the save here would silently discard unsaved edits.
+ collaborationBridge.isConnected.mockReturnValue(false)
+ collaborationBridge.canFlushGraphOnPageClose.mockReturnValue(false)
+ collaborationBridge.canUseLocalDraftFallback.mockReturnValue(true)
+
+ const { unmount } = renderSubject({
+ initialStoreState: { isWorkflowDataLoaded: true },
+ isCollaborationEnabled: true,
+ })
+
+ unmount()
+
+ expect(workflowHookMocks.syncWorkflowDraftWhenPageClose).toHaveBeenCalledTimes(1)
+ expect(workflowHookMocks.handleSyncWorkflowDraft).not.toHaveBeenCalled()
+ })
+
+ it('should skip the unmount save after an established collaboration disconnects', () => {
+ collaborationBridge.isConnected.mockReturnValue(false)
+ collaborationBridge.canFlushGraphOnPageClose.mockReturnValue(false)
+ collaborationBridge.canUseLocalDraftFallback.mockReturnValue(false)
+
+ const { unmount } = renderSubject({
+ initialStoreState: { isWorkflowDataLoaded: true },
+ isCollaborationEnabled: true,
+ })
+
+ unmount()
+
+ expect(workflowHookMocks.syncWorkflowDraftWhenPageClose).not.toHaveBeenCalled()
+ expect(workflowHookMocks.handleSyncWorkflowDraft).not.toHaveBeenCalled()
+ })
+
it('should render confirm description and clear showConfirm when cancelled', async () => {
const onConfirm = vi.fn()
const { store } = renderSubject({
diff --git a/web/app/components/workflow/collaboration/core/__tests__/collaboration-manager.socket-and-subscriptions.spec.ts b/web/app/components/workflow/collaboration/core/__tests__/collaboration-manager.socket-and-subscriptions.spec.ts
index 6151329104d..4e3fa225dc9 100644
--- a/web/app/components/workflow/collaboration/core/__tests__/collaboration-manager.socket-and-subscriptions.spec.ts
+++ b/web/app/components/workflow/collaboration/core/__tests__/collaboration-manager.socket-and-subscriptions.spec.ts
@@ -161,6 +161,23 @@ describe('CollaborationManager socket and subscription behavior', () => {
vi.clearAllMocks()
})
+ it('allows local draft fallback only before the first collaboration connection', () => {
+ const { manager, internals } = setupManagerWithDoc()
+ const socket = createMockSocket('socket-fallback')
+
+ internals.currentAppId = 'app-fallback'
+ vi.spyOn(webSocketClient, 'isConnected').mockReturnValue(false)
+ internals.setupSocketEventListeners(socket as unknown as Socket)
+
+ expect(manager.canUseLocalDraftFallback()).toBe(true)
+
+ socket.trigger('connect')
+ expect(manager.canUseLocalDraftFallback()).toBe(false)
+
+ socket.trigger('disconnect', 'transport close')
+ expect(manager.canUseLocalDraftFallback()).toBe(false)
+ })
+
it('emits cursor/sync/workflow events via collaboration_event when connected', async () => {
const { manager, internals } = setupManagerWithDoc()
const socket = createMockSocket('socket-connected')
diff --git a/web/app/components/workflow/collaboration/core/collaboration-manager.ts b/web/app/components/workflow/collaboration/core/collaboration-manager.ts
index 0ecf487cf00..5b2c45a20af 100644
--- a/web/app/components/workflow/collaboration/core/collaboration-manager.ts
+++ b/web/app/components/workflow/collaboration/core/collaboration-manager.ts
@@ -179,6 +179,7 @@ export class CollaborationManager {
private graphViewSequence = 0
private visibilityListenerAttached = false
private crdtTrusted = false
+ private hasEstablishedConnection = false
private rebuildCrdtOnNextConnect = false
private reconnectedWithFreshDoc = false
private awaitingSnapshotImport = false
@@ -635,11 +636,13 @@ export class CollaborationManager {
// Only disconnect if switching to a different app
if (this.currentAppId && this.currentAppId !== appId) this.forceDisconnect()
+ this.hasEstablishedConnection = false
this.currentAppId = appId
// Only set store if provided
if (reactFlowStore) this.reactFlowStore = reactFlowStore
const socket = webSocketClient.connect(appId)
+ this.hasEstablishedConnection = socket.connected
// Setup event listeners BEFORE any other operations
this.setupSocketEventListeners(socket)
@@ -725,6 +728,11 @@ export class CollaborationManager {
return this.currentAppId ? webSocketClient.isConnected(this.currentAppId) : false
}
+ canUseLocalDraftFallback(): boolean {
+ // A graph from a previously connected session must recover through collaboration before saving.
+ return !this.isConnected() && !this.hasEstablishedConnection
+ }
+
getNodes(): Node[] {
if (!this.nodesMap) return []
return Array.from(this.nodesMap.keys()).map((id) => this.exportNode(id as string))
@@ -1838,6 +1846,7 @@ export class CollaborationManager {
})
socket.on('connect', () => {
+ this.hasEstablishedConnection = true
if (this.rebuildCrdtOnNextConnect) {
this.initializeCrdt(socket)
this.rebuildCrdtOnNextConnect = false
diff --git a/web/app/components/workflow/index.tsx b/web/app/components/workflow/index.tsx
index 30fb9578b13..7c325a8237f 100644
--- a/web/app/components/workflow/index.tsx
+++ b/web/app/components/workflow/index.tsx
@@ -373,6 +373,12 @@ export const Workflow: FC<WorkflowProps> = memo(
const syncWorkflowDraftOnUnmount = useEffectEvent(() => {
if (!workflowStore.getState().isWorkflowDataLoaded) return
+
+ if (isCollaborationEnabled && collaborationManager.canUseLocalDraftFallback()) {
+ syncWorkflowDraftWhenPageClose()
+ return
+ }
+
if (isCollaborationEnabled && !collaborationManager.canFlushGraphOnPageClose()) return
handleSyncWorkflowDraft(true, true, {