Files
simstudioai--sim/apps/sim/lib/copilot/tools/client/run-tool-execution.ts
T
wehub-resource-sync d25d482dc2
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

639 lines
20 KiB
TypeScript

import { createLogger } from '@sim/logger'
import { toError } from '@sim/utils/errors'
import { sleep } from '@sim/utils/helpers'
import { generateId } from '@sim/utils/id'
import { isRecordLike } from '@sim/utils/object'
import {
ASYNC_TOOL_CONFIRMATION_STATUS,
type AsyncCompletionData,
type AsyncConfirmationStatus,
} from '@/lib/copilot/async-runs/lifecycle'
import { COPILOT_CONFIRM_API_PATH } from '@/lib/copilot/constants'
import { MothershipStreamV1ToolOutcome } from '@/lib/copilot/generated/mothership-stream-v1'
import {
RunBlock,
RunFromBlock,
RunWorkflowUntilBlock,
} from '@/lib/copilot/generated/tool-catalog-v1'
import { traceparentHeader } from '@/lib/copilot/tools/client/trace-context'
import { executeWorkflowWithFullLogging } from '@/app/workspace/[workspaceId]/w/[workflowId]/utils/workflow-execution-utils'
import { SSEEventHandlerError, SSEStreamInterruptedError } from '@/hooks/use-execution-stream'
import { useExecutionStore } from '@/stores/execution/store'
import {
clearExecutionPointer,
consolePersistence,
loadExecutionPointer,
saveExecutionPointer,
} from '@/stores/terminal'
import { useWorkflowRegistry } from '@/stores/workflows/registry/store'
const logger = createLogger('CopilotRunToolExecution')
const activeRunToolByWorkflowId = new Map<string, string>()
const activeRunAbortByWorkflowId = new Map<string, AbortController>()
const manuallyStoppedToolCallIds = new Set<string>()
const PENDING_COMPLETION_STORAGE_PREFIX = 'sim:copilot:run-tool-completion:'
interface PendingCompletionReport {
status: AsyncConfirmationStatus
message?: string
data?: AsyncCompletionData
}
class CompletionReportError extends Error {
constructor(message: string) {
super(message)
this.name = 'CompletionReportError'
}
}
function resolveWorkflowInput(params: Record<string, unknown>): unknown {
if (Object.hasOwn(params, 'workflow_input')) {
return params.workflow_input
}
if (Object.hasOwn(params, 'input')) {
return params.input
}
return undefined
}
function resolveTriggerBlockId(params: Record<string, unknown>): string | undefined {
return typeof params.triggerBlockId === 'string' && params.triggerBlockId.length > 0
? params.triggerBlockId
: undefined
}
function pendingCompletionStorageKey(toolCallId: string): string {
return `${PENDING_COMPLETION_STORAGE_PREFIX}${toolCallId}`
}
function savePendingCompletionReport(toolCallId: string, report: PendingCompletionReport): void {
if (typeof window === 'undefined') return
try {
window.sessionStorage.setItem(pendingCompletionStorageKey(toolCallId), JSON.stringify(report))
} catch (error) {
logger.warn('[RunTool] Failed to persist pending completion report', {
toolCallId,
error: toError(error).message,
})
}
}
function loadPendingCompletionReport(toolCallId: string): PendingCompletionReport | null {
if (typeof window === 'undefined') return null
try {
const raw = window.sessionStorage.getItem(pendingCompletionStorageKey(toolCallId))
if (!raw) return null
const parsed = JSON.parse(raw) as PendingCompletionReport
return parsed?.status ? parsed : null
} catch (error) {
logger.warn('[RunTool] Failed to load pending completion report', {
toolCallId,
error: toError(error).message,
})
return null
}
}
function clearPendingCompletionReport(toolCallId: string): void {
if (typeof window === 'undefined') return
try {
window.sessionStorage.removeItem(pendingCompletionStorageKey(toolCallId))
} catch (error) {
logger.warn('[RunTool] Failed to clear pending completion report', {
toolCallId,
error: toError(error).message,
})
}
}
export async function bindRunToolToExecution(
toolCallId: string,
workflowId: string
): Promise<boolean> {
const existingToolCallId = activeRunToolByWorkflowId.get(workflowId)
if (existingToolCallId === toolCallId) {
logger.info('[RunTool] Recovery skipped: run tool is already active in this tab', {
workflowId,
toolCallId,
})
return true
}
if (existingToolCallId && existingToolCallId !== toolCallId) {
logger.warn('[RunTool] Recovery skipped: another run tool is already active', {
workflowId,
toolCallId,
existingToolCallId,
})
return false
}
const pointer = await loadExecutionPointer(workflowId).catch(() => null)
if (!pointer?.executionId) {
logger.info('[RunTool] Recovery skipped: no tab-local execution pointer', {
workflowId,
toolCallId,
})
return false
}
logger.info('[RunTool] Recovery moved to background for existing execution pointer', {
workflowId,
toolCallId,
executionId: pointer.executionId,
})
const pendingCompletion = loadPendingCompletionReport(toolCallId)
if (pendingCompletion) {
try {
await reportCompletion(
toolCallId,
pendingCompletion.status,
pendingCompletion.message,
pendingCompletion.data
)
clearPendingCompletionReport(toolCallId)
} catch (error) {
logger.warn('[RunTool] Failed to report recovered terminal completion', {
workflowId,
toolCallId,
executionId: pointer.executionId,
error: toError(error).message,
})
}
return true
}
try {
await reportCompletion(
toolCallId,
ASYNC_TOOL_CONFIRMATION_STATUS.background,
'Client recovered an existing workflow execution; continuing in background.',
{
workflowId,
executionId: pointer.executionId,
lastEventId: pointer.lastEventId,
}
)
} catch (error) {
logger.warn('[RunTool] Failed to report recovered execution as background', {
workflowId,
toolCallId,
executionId: pointer.executionId,
error: toError(error).message,
})
}
return true
}
/**
* Execute a run tool on the client side using the streaming execute endpoint.
* This gives full interactive feedback: block pulsing, console logs, stop button.
*
* Mirrors staging's RunWorkflowClientTool.handleAccept():
* 1. Execute via executeWorkflowWithFullLogging
* 2. Update client tool state directly (success/error)
* 3. Report completion to server via /api/copilot/confirm (Redis),
* where the server-side handler picks it up and tells Go
*/
export function executeRunToolOnClient(
toolCallId: string,
toolName: string,
params: Record<string, unknown>
): void {
doExecuteRunTool(toolCallId, toolName, params).catch((err) => {
logger.error('[RunTool] Unhandled error in client-side run tool execution', {
toolCallId,
toolName,
error: toError(err).message,
})
})
}
/**
* Synchronously mark the active run tool for a workflow as manually stopped.
* Must be called before issuing the cancellation request so that the
* concurrent doExecuteRunTool catch/success paths see the marker and skip
* their own completion report.
*/
export function markRunToolManuallyStopped(workflowId: string): string | null {
const toolCallId = activeRunToolByWorkflowId.get(workflowId)
if (!toolCallId) return null
manuallyStoppedToolCallIds.add(toolCallId)
return toolCallId
}
export function isRunToolActiveForId(toolCallId: string): boolean {
for (const activeId of activeRunToolByWorkflowId.values()) {
if (activeId === toolCallId) return true
}
return false
}
export function cancelRunToolExecution(workflowId: string): void {
const controller = activeRunAbortByWorkflowId.get(workflowId)
if (!controller) return
controller.abort('user_stop:cancelRunToolExecution')
activeRunAbortByWorkflowId.delete(workflowId)
}
/**
* Report a manual user-initiated stop for an active client-executed run tool.
* This lets Copilot know the run was intentionally cancelled by the user.
* Call markRunToolManuallyStopped first to prevent race conditions.
*/
export async function reportManualRunToolStop(
workflowId: string,
toolCallIdOverride?: string | null
): Promise<void> {
const toolCallId = toolCallIdOverride || activeRunToolByWorkflowId.get(workflowId)
if (!toolCallId) return
if (!manuallyStoppedToolCallIds.has(toolCallId)) {
manuallyStoppedToolCallIds.add(toolCallId)
}
await reportCompletion(
toolCallId,
MothershipStreamV1ToolOutcome.cancelled,
'Workflow execution was stopped manually by the user.',
{
reason: 'user_cancelled',
cancelledByUser: true,
workflowId,
}
)
}
async function doExecuteRunTool(
toolCallId: string,
toolName: string,
params: Record<string, unknown>
): Promise<void> {
const { activeWorkflowId, setActiveWorkflow } = useWorkflowRegistry.getState()
const targetWorkflowId =
typeof params.workflowId === 'string' && params.workflowId.length > 0
? params.workflowId
: activeWorkflowId
if (!targetWorkflowId) {
logger.warn('[RunTool] Execution prevented: no active workflow', { toolCallId, toolName })
await reportCompletion(
toolCallId,
MothershipStreamV1ToolOutcome.error,
'No active workflow found'
)
return
}
const existingToolCallId = activeRunToolByWorkflowId.get(targetWorkflowId)
if (existingToolCallId) {
logger.warn('[RunTool] Execution prevented: another run tool is already active', {
toolCallId,
toolName,
existingToolCallId,
})
await reportCompletion(
toolCallId,
MothershipStreamV1ToolOutcome.error,
'Workflow is already being executed by another tool. Wait for it to complete.'
)
return
}
setActiveWorkflow(targetWorkflowId)
activeRunToolByWorkflowId.set(targetWorkflowId, toolCallId)
const { getWorkflowExecution, setIsExecuting } = useExecutionStore.getState()
const { isExecuting } = getWorkflowExecution(targetWorkflowId)
if (isExecuting) {
logger.warn('[RunTool] Execution prevented: already executing', { toolCallId, toolName })
activeRunToolByWorkflowId.delete(targetWorkflowId)
await reportCompletion(
toolCallId,
MothershipStreamV1ToolOutcome.error,
'Workflow is already executing. Try again later'
)
return
}
// Extract params for all tool types
const workflowInput = resolveWorkflowInput(params)
const triggerBlockId = resolveTriggerBlockId(params)
const useDraftState = params.useDeployedState !== true
const stopAfterBlockId = (() => {
if (toolName === RunWorkflowUntilBlock.id) return params.stopAfterBlockId as string | undefined
if (toolName === RunBlock.id) return params.blockId as string | undefined
return undefined
})()
const runFromBlock = (() => {
if (toolName === RunFromBlock.id && params.startBlockId) {
return {
startBlockId: params.startBlockId as string,
executionId: (params.executionId as string | undefined) || 'latest',
}
}
if (toolName === RunBlock.id && params.blockId) {
return {
startBlockId: params.blockId as string,
executionId: (params.executionId as string | undefined) || 'latest',
}
}
return undefined
})()
const { setCurrentExecutionId } = useExecutionStore.getState()
const abortController = new AbortController()
activeRunAbortByWorkflowId.set(targetWorkflowId, abortController)
consolePersistence.executionStarted()
setIsExecuting(targetWorkflowId, true)
const executionId = generateId()
setCurrentExecutionId(targetWorkflowId, executionId)
saveExecutionPointer({ workflowId: targetWorkflowId, executionId, lastEventId: 0 })
const executionStartTime = new Date().toISOString()
const releaseVisibleExecutionForBackground = () => {
const { setCurrentExecutionId: clearExecId, setActiveBlocks } = useExecutionStore.getState()
if (activeRunToolByWorkflowId.get(targetWorkflowId) === toolCallId) {
clearExecId(targetWorkflowId, null)
consolePersistence.executionEnded()
setIsExecuting(targetWorkflowId, false)
setActiveBlocks(targetWorkflowId, new Set())
}
}
const onPageHide = () => {
if (manuallyStoppedToolCallIds.has(toolCallId)) return
navigator.sendBeacon(
COPILOT_CONFIRM_API_PATH,
new Blob(
[
JSON.stringify({
toolCallId,
status: 'background',
message: 'Client disconnected, execution continuing server-side',
}),
],
{ type: 'application/json' }
)
)
}
if (typeof window !== 'undefined') {
window.addEventListener('pagehide', onPageHide)
}
logger.info('[RunTool] Starting client-side workflow execution', {
toolCallId,
toolName,
executionId,
workflowId: targetWorkflowId,
hasInput: !!workflowInput,
triggerBlockId,
useDraftState,
stopAfterBlockId,
runFromBlock: runFromBlock ? { startBlockId: runFromBlock.startBlockId } : undefined,
})
let leaveExecutionRecoverable = false
try {
const result = await executeWorkflowWithFullLogging({
workflowId: targetWorkflowId,
workflowInput,
executionId,
overrideTriggerType: 'copilot',
triggerBlockId,
useDraftState,
stopAfterBlockId,
runFromBlock,
abortSignal: abortController.signal,
preserveExecutionOnTerminal: true,
})
// Determine success (same logic as staging's RunWorkflowClientTool)
let succeeded = true
let errorMessage: string | undefined
try {
if (result && typeof result === 'object' && 'success' in (result as any)) {
succeeded = Boolean((result as any).success)
if (!succeeded) {
errorMessage = (result as any)?.error || (result as any)?.output?.error
}
} else if (
result &&
typeof result === 'object' &&
'execution' in (result as any) &&
(result as any).execution
) {
succeeded = Boolean((result as any).execution.success)
if (!succeeded) {
errorMessage =
(result as any).execution?.error || (result as any).execution?.output?.error
}
}
} catch {}
if (manuallyStoppedToolCallIds.has(toolCallId)) {
logger.info('[RunTool] Skipping generic completion — already manually stopped', {
toolCallId,
toolName,
})
} else if (succeeded) {
logger.info('[RunTool] Workflow execution succeeded', { toolCallId, toolName })
const pendingCompletion = {
status: MothershipStreamV1ToolOutcome.success,
message: `Workflow execution completed. Started at: ${executionStartTime}`,
data: buildResultData(result),
}
savePendingCompletionReport(toolCallId, pendingCompletion)
await reportCompletion(
toolCallId,
pendingCompletion.status,
pendingCompletion.message,
pendingCompletion.data
)
clearPendingCompletionReport(toolCallId)
} else {
const msg = errorMessage || 'Workflow execution failed'
logger.error('[RunTool] Workflow execution failed', { toolCallId, toolName, error: msg })
const pendingCompletion = {
status: MothershipStreamV1ToolOutcome.error,
message: msg,
data: buildResultData(result),
}
savePendingCompletionReport(toolCallId, pendingCompletion)
await reportCompletion(
toolCallId,
pendingCompletion.status,
pendingCompletion.message,
pendingCompletion.data
)
clearPendingCompletionReport(toolCallId)
}
} catch (err) {
if (manuallyStoppedToolCallIds.has(toolCallId)) {
logger.info('[RunTool] Skipping error completion — already manually stopped', {
toolCallId,
toolName,
})
} else {
const msg = toError(err).message
if (err instanceof SSEEventHandlerError || err instanceof SSEStreamInterruptedError) {
leaveExecutionRecoverable = true
logger.warn(
'[RunTool] Execution stream interrupted; leaving workflow execution in background',
{
toolCallId,
toolName,
executionId: err.executionId,
error: msg,
}
)
releaseVisibleExecutionForBackground()
await reportCompletion(
toolCallId,
ASYNC_TOOL_CONFIRMATION_STATUS.background,
'Client lost local stream processing; workflow execution may still be continuing server-side.'
)
return
}
if (err instanceof CompletionReportError) {
leaveExecutionRecoverable = true
logger.warn('[RunTool] Completion report failed; leaving workflow execution recoverable', {
toolCallId,
toolName,
error: msg,
})
releaseVisibleExecutionForBackground()
return
}
logger.error('[RunTool] Workflow execution threw', { toolCallId, toolName, error: msg })
await reportCompletion(toolCallId, MothershipStreamV1ToolOutcome.error, msg)
}
} finally {
if (typeof window !== 'undefined') {
window.removeEventListener('pagehide', onPageHide)
}
manuallyStoppedToolCallIds.delete(toolCallId)
const activeToolCallId = activeRunToolByWorkflowId.get(targetWorkflowId)
if (activeToolCallId === toolCallId) {
activeRunToolByWorkflowId.delete(targetWorkflowId)
}
const activeAbortController = activeRunAbortByWorkflowId.get(targetWorkflowId)
if (activeAbortController === abortController) {
activeRunAbortByWorkflowId.delete(targetWorkflowId)
}
const { setCurrentExecutionId: clearExecId, setActiveBlocks } = useExecutionStore.getState()
if (!leaveExecutionRecoverable && activeToolCallId === toolCallId) {
clearExecId(targetWorkflowId, null)
clearExecutionPointer(targetWorkflowId)
consolePersistence.executionEnded()
setIsExecuting(targetWorkflowId, false)
setActiveBlocks(targetWorkflowId, new Set())
}
}
}
/**
* Extract a structured result payload from the raw execution result
* for the LLM to see the actual workflow output.
*/
function buildResultData(result: unknown): Record<string, unknown> | undefined {
if (!result || typeof result !== 'object') return undefined
const r = result as Record<string, unknown>
if ('success' in r) {
return {
success: r.success,
output: r.output,
logs: r.logs,
error: r.error,
}
}
if ('execution' in r && r.execution && typeof r.execution === 'object') {
const exec = r.execution as Record<string, unknown>
return {
success: exec.success,
output: exec.output,
logs: exec.logs,
error: exec.error,
}
}
return undefined
}
/**
* Report tool completion to the server via the existing /api/copilot/confirm endpoint.
* This persists the durable async-tool row and wakes the server-side waiter so
* it can continue the paused Copilot run and notify Go.
*/
async function reportCompletion(
toolCallId: string,
status: AsyncConfirmationStatus,
message?: string,
data?: AsyncCompletionData
): Promise<void> {
const basePayload = {
toolCallId,
status,
message: message || (status === 'success' ? 'Tool completed' : 'Tool failed'),
...(data !== undefined ? { data } : {}),
}
const send = async (body: string) =>
fetch(COPILOT_CONFIRM_API_PATH, {
method: 'POST',
headers: { 'Content-Type': 'application/json', ...traceparentHeader() },
body,
})
const body = JSON.stringify(basePayload)
const LARGE_PAYLOAD_THRESHOLD = 10 * 1024 * 1024
const bodySize = new Blob([body]).size
let lastError: Error | null = null
for (let attempt = 1; attempt <= 2; attempt++) {
try {
const res = await send(body)
if (res.ok) return
if (isRecordLike(data) && bodySize > LARGE_PAYLOAD_THRESHOLD) {
const { logs: _logs, ...dataWithoutLogs } = data
logger.warn('[RunTool] reportCompletion failed with large payload, retrying without logs', {
toolCallId,
status: res.status,
bodySize,
})
const retryRes = await send(
JSON.stringify({
toolCallId,
status,
message: message || (status === 'success' ? 'Tool completed' : 'Tool failed'),
data: dataWithoutLogs,
})
)
if (retryRes.ok) return
lastError = new Error(`reportCompletion retry failed with status ${retryRes.status}`)
} else {
lastError = new Error(`reportCompletion failed with status ${res.status}`)
}
} catch (err) {
lastError = toError(err)
}
if (attempt < 2) {
await sleep(250)
}
}
logger.error('[RunTool] reportCompletion failed after retries', {
toolCallId,
error: lastError?.message,
})
throw new CompletionReportError(lastError?.message ?? 'Failed to report tool completion')
}