Repository navigation
Expand file tree
/
Copy pathexecute.ts
More file actions
280 lines (268 loc) · 10.9 KB
/
Copy pathexecute.ts
File metadata and controls
280 lines (268 loc) · 10.9 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
import type { FunctionExecuteBody } from '@/lib/api/contracts'
import {
normalizeRecord,
normalizeRecordMap,
normalizeStringRecord,
normalizeWorkflowVariables,
} from '@/lib/core/utils/records'
import { isUserFileWithMetadata } from '@/lib/core/utils/user-file'
import { DEFAULT_EXECUTION_TIMEOUT_MS } from '@/lib/execution/constants'
import { DEFAULT_CODE_LANGUAGE } from '@/lib/execution/languages'
import { PRIVATE_SECRET_PROVENANCE_FIELD } from '@/lib/execution/private-tool-metadata'
import { SANDBOX_INPUT_DIR, SANDBOX_OUTPUT_DIR } from '@/lib/execution/remote-sandbox/sandbox-paths'
import type { UserFile } from '@/executor/types'
import type { CodeExecutionInput, CodeExecutionOutput } from '@/tools/function/types'
import type { InternalToolConfig } from '@/tools/types'
/**
* Normalizes the mounted-file param, which advanced-mode template resolution
* delivers as a JSON string rather than an array.
*
* Deliberately not `normalizeFileInput` from `@/blocks/utils`: that module
* reaches the providers store and Sim's icon set, so importing it here would
* drag React and zustand into the tool registry's module graph.
*/
function normalizeSandboxInputFiles(value: unknown): FunctionExecuteBody['files'] {
if (!value) return undefined
let parsed = value
if (typeof parsed === 'string') {
try {
parsed = JSON.parse(parsed)
} catch {
return undefined
}
}
const files = Array.isArray(parsed) ? parsed : [parsed]
const userFiles = files.filter((file): file is UserFile => isUserFileWithMetadata(file))
if (userFiles.length === 0) return undefined
// Copied onto fresh objects because the boundary schema is `.passthrough()`:
// its inferred type carries an index signature, which a declared interface
// like UserFile cannot satisfy directly.
return userFiles.map((file) => ({ ...file }))
}
/** Builds the canonical Function protocol body for both HTTP compatibility and in-process calls. */
export function buildFunctionExecuteBody(params: CodeExecutionInput): FunctionExecuteBody {
const codeContent = Array.isArray(params.code)
? params.code.map((entry: { content: string }) => entry.content).join('\n')
: params.code
return {
code: codeContent,
sourceCode: params.sourceCode,
language: params.language || DEFAULT_CODE_LANGUAGE,
timeout: params.timeout || DEFAULT_EXECUTION_TIMEOUT_MS,
title: params.title,
outputPath: params.outputPath,
outputFormat: params.outputFormat,
outputTable: params.outputTable,
outputSandboxPath: params.outputSandboxPath,
outputMimeType: params.outputMimeType,
sandboxId: params.sandboxId,
secretScope: params.secretScope,
mountedSecrets: params.mountedSecrets,
unredactedSecretNames: params.unredactedSecretNames,
overwriteFileId: params.overwriteFileId,
inputs: params.inputs,
outputs: params.outputs,
files: normalizeSandboxInputFiles(params.files),
envVars: normalizeStringRecord(params.envVars),
workflowVariables: normalizeWorkflowVariables(params.workflowVariables),
blockData: normalizeRecord(params.blockData),
blockNameMapping: normalizeStringRecord(params.blockNameMapping),
blockOutputSchemas: normalizeRecordMap(params.blockOutputSchemas),
contextVariables: normalizeRecord(params.contextVariables),
workflowId: params._context?.workflowId,
executionId: params._context?.executionId,
largeValueExecutionIds: params._context?.largeValueExecutionIds,
largeValueKeys: params._context?.largeValueKeys,
fileKeys: params._context?.fileKeys,
allowLargeValueWorkflowScope: params._context?.allowLargeValueWorkflowScope,
userId: params._context?.userId,
workspaceId: params._context?.workspaceId,
isCustomTool: params.isCustomTool || false,
...(params[PRIVATE_SECRET_PROVENANCE_FIELD]
? { [PRIVATE_SECRET_PROVENANCE_FIELD]: params[PRIVATE_SECRET_PROVENANCE_FIELD] }
: {}),
...(params._sandboxFiles ? { _sandboxFiles: params._sandboxFiles } : {}),
}
}
export const functionExecuteTool: InternalToolConfig<CodeExecutionInput, CodeExecutionOutput> = {
id: 'function_execute',
name: 'Function Execute',
description: `Execute JavaScript, Python, or shell scripts in a secure sandbox. For JS: fetch() is available, code runs in an async IIFE wrapper. Shell includes general utilities such as jq, curl, git, and rg. Use outputPath/outputTable to persist returned data, or outputSandboxPath + outputPath to export a file created inside the sandbox into the workspace. Naming outputSandboxPath exports only those paths — the /tmp/sim/outputs directory is not harvested in the same call, so use one or the other.
To read a file, pass its id in \`files\`: each one is mounted read-only under ${SANDBOX_INPUT_DIR}. List that directory to find them rather than guessing a path — names are sanitized and de-duplicated, so they do not always match the original.
To return a file, write it to ${SANDBOX_OUTPUT_DIR}. Everything there comes back in this tool's \`files\` output as a platform file object, which another tool that takes a file accepts directly — no upload step in between.`,
version: '1.0.0',
params: {
code: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description:
'Source code in the selected language. JavaScript runs as an async function body and returns a result with return. Python runs as a module and returns an optional result through __sim_result__; legacy snippets with a top-level return remain supported. Shell runs as Bash and can emit a typed result with __SIM_RESULT__=<json>.',
},
language: {
type: 'string',
required: false,
visibility: 'user-only',
description: 'Language to execute (javascript, python, or shell)',
default: DEFAULT_CODE_LANGUAGE,
},
timeout: {
type: 'number',
required: false,
visibility: 'hidden',
description: 'Execution timeout in milliseconds',
default: DEFAULT_EXECUTION_TIMEOUT_MS,
},
title: {
type: 'string',
required: false,
visibility: 'hidden',
description: 'Short user-visible label for this execution.',
},
outputPath: {
type: 'string',
required: false,
visibility: 'hidden',
description:
'Write the tool result back to a workspace file, e.g. "files/result.json" or "files/report.csv". Use for text/JSON/CSV/markdown/html outputs.',
},
outputFormat: {
type: 'string',
required: false,
visibility: 'hidden',
description: 'Optional format override for outputPath (json, csv, txt, md, html).',
},
outputTable: {
type: 'string',
required: false,
visibility: 'hidden',
description:
'Overwrite a workspace table with the code result. The code must return an array of objects.',
},
outputSandboxPath: {
type: 'string',
required: false,
visibility: 'hidden',
description:
'Export a file created inside the sandbox to the workspace. Provide the sandbox file path here and also set outputPath to the workspace destination.',
},
outputMimeType: {
type: 'string',
required: false,
visibility: 'hidden',
description:
'MIME type for the exported file. Required for binary files (e.g. "image/png", "application/pdf"). If omitted, inferred from outputPath extension for text formats.',
},
overwriteFileId: {
type: 'string',
required: false,
visibility: 'hidden',
description:
'Overwrite this existing workspace file ID instead of creating a duplicate output file.',
},
files: {
type: 'file[]',
required: false,
visibility: 'user-or-llm',
description: `Files to mount read-only into the sandbox under ${SANDBOX_INPUT_DIR}. Pass file ids from earlier tool results (or canonical workspace file ids); the runtime resolves them into full file objects before the code runs.`,
},
sandboxId: {
type: 'string',
required: false,
visibility: 'user-only',
description: 'Workspace sandbox providing importable packages and CLI tools',
},
secretScope: {
type: 'string',
required: false,
visibility: 'user-only',
description: 'Whether this code can read all workspace secrets or only selected ones',
},
mountedSecrets: {
type: 'json',
required: false,
visibility: 'user-only',
description: 'Secret names this code can read when secretScope is "selected"',
},
envVars: {
type: 'object',
required: false,
visibility: 'hidden',
description: 'Environment variables to make available during execution',
default: {},
},
blockData: {
type: 'object',
required: false,
visibility: 'hidden',
description: 'Block output data for variable resolution',
default: {},
},
blockNameMapping: {
type: 'object',
required: false,
visibility: 'hidden',
description: 'Mapping of block names to block IDs',
default: {},
},
blockOutputSchemas: {
type: 'object',
required: false,
visibility: 'hidden',
description: 'Mapping of block IDs to their output schemas for validation',
default: {},
},
workflowVariables: {
type: 'object',
required: false,
visibility: 'hidden',
description: 'Workflow variables for <variable.name> resolution',
default: {},
},
},
operation: {
input: buildFunctionExecuteBody,
},
transformResponse: async (response: Response): Promise<CodeExecutionOutput> => {
const result = await response.json()
if (!result.success) {
return {
success: false,
output: {
result: null,
stdout: result.output?.stdout || '',
// Always an array, never undefined: a declared `file[]` output that is
// missing warns on every call, and this branch runs for every failure.
files: result.output?.files ?? [],
...(result.output?.cost ? { cost: result.output.cost } : {}),
},
error: result.error,
retryable: result.retryable,
resources: result.resources,
largeValueKeys: result.largeValueKeys,
fileKeys: result.fileKeys,
}
}
return {
success: true,
output: {
result: result.output.result,
stdout: result.output.stdout,
files: result.output.files ?? [],
...(result.output.cost ? { cost: result.output.cost } : {}),
},
resources: result.resources,
largeValueKeys: result.largeValueKeys,
fileKeys: result.fileKeys,
retryable: result.retryable,
}
},
outputs: {
result: { type: 'json', description: 'The structured result emitted by the executed code' },
stdout: { type: 'string', description: 'The standard output of the code execution' },
files: {
type: 'file[]',
description: `Files the code wrote to ${SANDBOX_OUTPUT_DIR}, persisted as platform file objects`,
},
},
}