-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Expand file tree
/
Copy pathuse-execution-stream.ts
More file actions
497 lines (456 loc) · 16 KB
/
Copy pathuse-execution-stream.ts
File metadata and controls
497 lines (456 loc) · 16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
import { useCallback } from 'react'
import { createLogger } from '@sim/logger'
import { getErrorMessage } from '@sim/utils/errors'
import { readSSEEvents } from '@/lib/core/utils/sse'
import type {
BlockChildWorkflowStartedData,
BlockCompletedData,
BlockErrorData,
BlockStartedData,
ExecutionCancelledData,
ExecutionCompletedData,
ExecutionErrorData,
ExecutionEvent,
ExecutionPausedData,
ExecutionStartedData,
StreamChunkData,
StreamChunkResetData,
StreamDoneData,
StreamThinkingData,
StreamToolData,
} from '@/lib/workflows/executor/execution-events'
import type { SerializableExecutionState } from '@/executor/execution/types'
const logger = createLogger('useExecutionStream')
export class ExecutionStreamHttpError extends Error {
constructor(
message: string,
public readonly httpStatus: number
) {
super(message)
this.name = 'ExecutionStreamHttpError'
}
}
export function isExecutionStreamHttpError(error: unknown): error is ExecutionStreamHttpError {
return error instanceof ExecutionStreamHttpError
}
export class SSEEventHandlerError extends Error {
constructor(
message: string,
public readonly eventType: string,
public readonly eventId: number | undefined,
public readonly executionId: string | undefined,
public readonly originalError: unknown
) {
super(message)
this.name = 'SSEEventHandlerError'
}
}
export class SSEStreamInterruptedError extends Error {
constructor(
message: string,
public readonly executionId: string | undefined,
public readonly originalError: unknown
) {
super(message)
this.name = 'SSEStreamInterruptedError'
}
}
/**
* Detects errors caused by the browser killing a fetch (page refresh, navigation, tab close).
* These should be treated as clean disconnects, not execution errors.
*/
function isClientDisconnectError(error: any): boolean {
return error.name === 'AbortError'
}
function isRecoverableStreamError(error: any): boolean {
if (isClientDisconnectError(error)) return false
const msg = (error.message ?? '').toLowerCase()
return (
msg.includes('network error') || msg.includes('failed to fetch') || msg.includes('load failed')
)
}
/**
* Processes SSE events from a response body and invokes appropriate callbacks.
* Exported for use by standalone (non-hook) execution paths like executeWorkflowWithFullLogging.
*/
export async function processSSEStream(
reader: ReadableStreamDefaultReader<Uint8Array>,
callbacks: ExecutionStreamCallbacks,
logPrefix: string
): Promise<void> {
try {
await readSSEEvents<ExecutionEvent>(reader, {
onParseError: (data, error) => {
logger.error('Failed to parse SSE event:', error, { data })
},
onEvent: async (event) => {
try {
switch (event.type) {
case 'execution:started':
await callbacks.onExecutionStarted?.(event.data)
break
case 'execution:completed':
await callbacks.onExecutionCompleted?.(event.data)
break
case 'execution:paused':
await callbacks.onExecutionPaused?.(event.data)
break
case 'execution:error':
await callbacks.onExecutionError?.(event.data)
break
case 'execution:cancelled':
await callbacks.onExecutionCancelled?.(event.data)
break
case 'block:started':
await callbacks.onBlockStarted?.(event.data)
break
case 'block:completed':
await callbacks.onBlockCompleted?.(event.data)
break
case 'block:error':
await callbacks.onBlockError?.(event.data)
break
case 'block:childWorkflowStarted':
await callbacks.onBlockChildWorkflowStarted?.(event.data)
break
case 'stream:chunk':
await callbacks.onStreamChunk?.(event.data)
break
case 'stream:chunk_reset':
await callbacks.onStreamChunkReset?.(event.data)
break
case 'stream:done':
await callbacks.onStreamDone?.(event.data)
break
case 'stream:thinking':
await callbacks.onStreamThinking?.(event.data)
break
case 'stream:tool':
await callbacks.onStreamTool?.(event.data)
break
default:
logger.warn('Unknown event type:', (event as any).type)
}
if (event.eventId != null) {
await callbacks.onEventId?.(event.eventId)
}
} catch (error) {
logger.error('SSE event handler failed:', error, {
eventType: event.type,
eventId: event.eventId,
})
const message = getErrorMessage(error)
throw new SSEEventHandlerError(
message,
event.type,
event.eventId,
event.executionId,
error
)
}
},
})
logger.debug(`${logPrefix} stream completed`)
} finally {
reader.releaseLock()
}
}
export interface ExecutionStreamCallbacks {
onExecutionStarted?: (data: ExecutionStartedData) => void | Promise<void>
onExecutionCompleted?: (data: ExecutionCompletedData) => void | Promise<void>
onExecutionPaused?: (data: ExecutionPausedData) => void | Promise<void>
onExecutionError?: (data: ExecutionErrorData) => void | Promise<void>
onExecutionCancelled?: (data: ExecutionCancelledData) => void | Promise<void>
onBlockStarted?: (data: BlockStartedData) => void | Promise<void>
onBlockCompleted?: (data: BlockCompletedData) => void | Promise<void>
onBlockError?: (data: BlockErrorData) => void | Promise<void>
onBlockChildWorkflowStarted?: (data: BlockChildWorkflowStartedData) => void | Promise<void>
onStreamChunk?: (data: StreamChunkData) => void | Promise<void>
onStreamChunkReset?: (data: StreamChunkResetData) => void | Promise<void>
onStreamDone?: (data: StreamDoneData) => void | Promise<void>
onStreamThinking?: (data: StreamThinkingData) => void | Promise<void>
onStreamTool?: (data: StreamToolData) => void | Promise<void>
onEventId?: (eventId: number) => void | Promise<void>
}
export interface ExecuteStreamOptions {
workflowId: string
input?: any
workflowInput?: any
currentBlockStates?: Record<string, any>
envVarValues?: Record<string, string>
workflowVariables?: Record<string, any>
selectedOutputs?: string[]
executionId?: string
startBlockId?: string
triggerType?: string
useDraftState?: boolean
isClientSession?: boolean
workflowStateOverride?: {
blocks: Record<string, any>
edges: any[]
loops?: Record<string, any>
parallels?: Record<string, any>
}
stopAfterBlockId?: string
onExecutionId?: (executionId: string) => void
callbacks?: ExecutionStreamCallbacks
}
export interface ExecuteFromBlockOptions {
workflowId: string
startBlockId: string
sourceSnapshot: SerializableExecutionState
input?: any
onExecutionId?: (executionId: string) => void
callbacks?: ExecutionStreamCallbacks
}
export interface ReconnectStreamOptions {
workflowId: string
executionId: string
fromEventId?: number
callbacks?: ExecutionStreamCallbacks
}
/**
* Module-level map shared across all hook instances.
* Ensures ANY instance can cancel streams started by ANY other instance,
* which is critical for SPA navigation where the original hook instance unmounts
* but the SSE stream must be cancellable from the new instance.
*/
const sharedAbortControllers = new Map<string, AbortController>()
function executeStreamKey(workflowId: string): string {
return `${workflowId}:execute`
}
function reconnectStreamKey(workflowId: string, executionId: string): string {
return `${workflowId}:reconnect:${executionId}`
}
function abortStream(key: string): void {
const controller = sharedAbortControllers.get(key)
if (!controller) return
controller.abort()
sharedAbortControllers.delete(key)
}
function abortWorkflowStreams(workflowId: string): void {
const prefix = `${workflowId}:`
for (const [key, controller] of sharedAbortControllers) {
if (!key.startsWith(prefix)) continue
controller.abort()
sharedAbortControllers.delete(key)
}
}
/**
* Hook for executing workflows via server-side SSE streaming.
* Supports concurrent executions via per-workflow AbortController maps.
*/
export function useExecutionStream() {
const execute = useCallback(async (options: ExecuteStreamOptions) => {
const { workflowId, callbacks = {}, onExecutionId, ...payload } = options
abortWorkflowStreams(workflowId)
const abortController = new AbortController()
const streamKey = executeStreamKey(workflowId)
sharedAbortControllers.set(streamKey, abortController)
let serverExecutionId: string | undefined
try {
// boundary-raw-fetch: workflow execute endpoint returns an SSE stream consumed via response.body.getReader() and processSSEStream; also reads the X-Execution-Id response header
const response = await fetch(`/api/workflows/${workflowId}/execute`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({ ...payload, stream: true }),
signal: abortController.signal,
})
if (!response.ok) {
let errorResponse: any
try {
errorResponse = await response.json()
} catch {
throw new ExecutionStreamHttpError(
`Server error (${response.status}): ${response.statusText}`,
response.status
)
}
const error = new ExecutionStreamHttpError(
errorResponse.error || 'Failed to start execution',
response.status
)
if (errorResponse && typeof errorResponse === 'object') {
Object.assign(error, { executionResult: errorResponse })
}
throw error
}
if (!response.body) {
throw new Error('No response body')
}
serverExecutionId = response.headers.get('X-Execution-Id') ?? undefined
if (serverExecutionId) {
onExecutionId?.(serverExecutionId)
}
const reader = response.body.getReader()
await processSSEStream(reader, callbacks, 'Execution')
} catch (error: any) {
if (isClientDisconnectError(error)) {
logger.info('Execution stream disconnected (page unload or abort)')
return
}
if (isRecoverableStreamError(error)) {
logger.warn('Execution stream interrupted; preserving execution for reconnect', {
executionId: serverExecutionId,
error: error.message,
})
throw new SSEStreamInterruptedError(
'Execution stream interrupted before a terminal event was received',
serverExecutionId,
error
)
}
logger.error('Execution stream error:', error)
if (!(error instanceof SSEEventHandlerError)) {
await callbacks.onExecutionError?.({
error: error.message || 'Unknown error',
duration: 0,
})
}
throw error
} finally {
if (sharedAbortControllers.get(streamKey) === abortController) {
sharedAbortControllers.delete(streamKey)
}
}
}, [])
const executeFromBlock = useCallback(async (options: ExecuteFromBlockOptions) => {
const {
workflowId,
startBlockId,
sourceSnapshot,
input,
onExecutionId,
callbacks = {},
} = options
abortWorkflowStreams(workflowId)
const abortController = new AbortController()
const streamKey = executeStreamKey(workflowId)
sharedAbortControllers.set(streamKey, abortController)
let serverExecutionId: string | undefined
try {
// boundary-raw-fetch: run-from-block endpoint returns an SSE stream consumed via response.body.getReader() and processSSEStream; also reads the X-Execution-Id response header
const response = await fetch(`/api/workflows/${workflowId}/execute`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
stream: true,
input,
runFromBlock: { startBlockId, sourceSnapshot },
}),
signal: abortController.signal,
})
if (!response.ok) {
let errorResponse: any
try {
errorResponse = await response.json()
} catch {
throw new ExecutionStreamHttpError(
`Server error (${response.status}): ${response.statusText}`,
response.status
)
}
const error = new ExecutionStreamHttpError(
errorResponse.error || 'Failed to start execution',
response.status
)
if (errorResponse && typeof errorResponse === 'object') {
Object.assign(error, { executionResult: errorResponse })
}
throw error
}
if (!response.body) {
throw new Error('No response body')
}
serverExecutionId = response.headers.get('X-Execution-Id') ?? undefined
if (serverExecutionId) {
onExecutionId?.(serverExecutionId)
}
const reader = response.body.getReader()
await processSSEStream(reader, callbacks, 'Run-from-block')
} catch (error: any) {
if (isClientDisconnectError(error)) {
logger.info('Run-from-block stream disconnected (page unload or abort)')
return
}
if (isRecoverableStreamError(error)) {
logger.warn('Run-from-block stream interrupted; preserving execution for reconnect', {
executionId: serverExecutionId,
error: error.message,
})
throw new SSEStreamInterruptedError(
'Run-from-block stream interrupted before a terminal event was received',
serverExecutionId,
error
)
}
logger.error('Run-from-block execution error:', error)
if (!(error instanceof SSEEventHandlerError)) {
await callbacks.onExecutionError?.({
error: error.message || 'Unknown error',
duration: 0,
})
}
throw error
} finally {
if (sharedAbortControllers.get(streamKey) === abortController) {
sharedAbortControllers.delete(streamKey)
}
}
}, [])
const reconnect = useCallback(async (options: ReconnectStreamOptions) => {
const { workflowId, executionId, fromEventId = 0, callbacks = {} } = options
const abortController = new AbortController()
const streamKey = reconnectStreamKey(workflowId, executionId)
abortStream(streamKey)
sharedAbortControllers.set(streamKey, abortController)
try {
// boundary-raw-fetch: execution reconnect endpoint returns an SSE stream consumed via response.body.getReader() and processSSEStream
const response = await fetch(
`/api/workflows/${workflowId}/executions/${executionId}/stream?from=${fromEventId}`,
{ signal: abortController.signal }
)
if (!response.ok) {
throw new ExecutionStreamHttpError(`Reconnect failed (${response.status})`, response.status)
}
if (!response.body) throw new Error('No response body')
await processSSEStream(response.body.getReader(), callbacks, 'Reconnect')
} catch (error: any) {
if (isClientDisconnectError(error)) return
logger.error('Reconnection stream error:', error)
throw error
} finally {
if (sharedAbortControllers.get(streamKey) === abortController) {
sharedAbortControllers.delete(streamKey)
}
}
}, [])
const cancel = useCallback((workflowId?: string) => {
if (workflowId) {
abortWorkflowStreams(workflowId)
} else {
for (const [, controller] of sharedAbortControllers) {
controller.abort()
}
sharedAbortControllers.clear()
}
}, [])
const cancelReconnect = useCallback((workflowId: string, executionId: string) => {
abortStream(reconnectStreamKey(workflowId, executionId))
}, [])
const cancelExecute = useCallback((workflowId: string) => {
abortStream(executeStreamKey(workflowId))
}, [])
return {
execute,
executeFromBlock,
reconnect,
cancel,
cancelReconnect,
cancelExecute,
}
}