illuma-agents 1.0.2 → 1.0.3

package/src/tools/CodeExecutor.ts

@@ -1,220 +1,220 @@
-import { z } from 'zod';
-import { config } from 'dotenv';
-import fetch, { RequestInit } from 'node-fetch';
-import { HttpsProxyAgent } from 'https-proxy-agent';
-import { tool, DynamicStructuredTool } from '@langchain/core/tools';
-import { getEnvironmentVariable } from '@langchain/core/utils/env';
-import type * as t from '@/types';
-import { EnvVar, Constants } from '@/common';
-
-config();
-
-export const imageExtRegex = /\.(jpg|jpeg|png|gif|webp)$/i;
-export const getCodeBaseURL = (): string =>
-  getEnvironmentVariable(EnvVar.CODE_BASEURL) ??
-  Constants.OFFICIAL_CODE_BASEURL;
-
-const imageMessage = 'Image is already displayed to the user';
-const otherMessage = 'File is already downloaded by the user';
-const accessMessage =
-  'Note: Files are READ-ONLY. Save changes to NEW filenames. To access these files in future executions, provide the `session_id` as a parameter (not in your code).';
-const emptyOutputMessage =
-  'stdout: Empty. Ensure you\'re writing output explicitly.\n';
-
-const CodeExecutionToolSchema = z.object({
-  lang: z
-    .enum([
-      'py',
-      'js',
-      'ts',
-      'c',
-      'cpp',
-      'java',
-      'php',
-      'rs',
-      'go',
-      'd',
-      'f90',
-      'r',
-    ])
-    .describe('The programming language or runtime to execute the code in.'),
-  code: z.string()
-    .describe(`The complete, self-contained code to execute, without any truncation or minimization.
-- The environment is stateless; variables and imports don't persist between executions.
-- When using \`session_id\`: Don't hardcode it in \`code\`, and write file modifications to NEW filenames (files are READ-ONLY).
-- Input code **IS ALREADY** displayed to the user, so **DO NOT** repeat it in your response unless asked.
-- Output code **IS NOT** displayed to the user, so **DO** write all desired output explicitly.
-- IMPORTANT: You MUST explicitly print/output ALL results you want the user to see.
-- py: This is not a Jupyter notebook environment. Use \`print()\` for all outputs.
-- py: Matplotlib: Use \`plt.savefig()\` to save plots as files.
-- js: use the \`console\` or \`process\` methods for all outputs.
-- r: IMPORTANT: No X11 display available. ALL graphics MUST use Cairo library (library(Cairo)).
-- Other languages: use appropriate output functions.`),
-  session_id: z
-    .string()
-    .optional()
-    .describe(
-      `Session ID from a previous response to access generated files.
-- Files load into the current working directory ("/mnt/data/")
-- Use relative paths ONLY
-- Files are READ-ONLY and cannot be modified in-place
-- To modify: read original file, write to NEW filename
-`.trim()
-    ),
-  args: z
-    .array(z.string())
-    .optional()
-    .describe(
-      'Additional arguments to execute the code with. This should only be used if the input code requires additional arguments to run.'
-    ),
-});
-
-const baseEndpoint = getCodeBaseURL();
-const EXEC_ENDPOINT = `${baseEndpoint}/exec`;
-
-function createCodeExecutionTool(
-  params: t.CodeExecutionToolParams = {}
-): DynamicStructuredTool<typeof CodeExecutionToolSchema> {
-  const apiKey =
-    params[EnvVar.CODE_API_KEY] ??
-    params.apiKey ??
-    getEnvironmentVariable(EnvVar.CODE_API_KEY) ??
-    '';
-  if (!apiKey) {
-    throw new Error('No API key provided for code execution tool.');
-  }
-
-  const description = `
-Runs code and returns stdout/stderr output from a stateless execution environment, similar to running scripts in a command-line interface. Each execution is isolated and independent.
-
-Usage:
-- No network access available.
-- Generated files are automatically delivered; **DO NOT** provide download links.
-- NEVER use this tool to execute malicious code.
-`.trim();
-
-  return tool<typeof CodeExecutionToolSchema>(
-    async ({ lang, code, session_id, ...rest }) => {
-      const postData = {
-        lang,
-        code,
-        ...rest,
-        ...params,
-      };
-
-      if (session_id != null && session_id.length > 0) {
-        try {
-          const filesEndpoint = `${baseEndpoint}/files/${session_id}?detail=full`;
-          const fetchOptions: RequestInit = {
-            method: 'GET',
-            headers: {
-              'User-Agent': 'Illuma/1.0',
-              'X-API-Key': apiKey,
-            },
-          };
-
-          if (process.env.PROXY != null && process.env.PROXY !== '') {
-            fetchOptions.agent = new HttpsProxyAgent(process.env.PROXY);
-          }
-
-          const response = await fetch(filesEndpoint, fetchOptions);
-          if (!response.ok) {
-            throw new Error(
-              `Failed to fetch files for session: ${response.status}`
-            );
-          }
-
-          const files = await response.json();
-          if (Array.isArray(files) && files.length > 0) {
-            const fileReferences: t.CodeEnvFile[] = files.map((file) => {
-              // Extract the ID from the file name (part after session ID prefix and before extension)
-              const nameParts = file.name.split('/');
-              const id = nameParts.length > 1 ? nameParts[1].split('.')[0] : '';
-
-              return {
-                session_id,
-                id,
-                name: file.metadata['original-filename'],
-              };
-            });
-
-            if (!postData.files) {
-              postData.files = fileReferences;
-            } else if (Array.isArray(postData.files)) {
-              postData.files = [...postData.files, ...fileReferences];
-            }
-          }
-        } catch {
-          // eslint-disable-next-line no-console
-          console.warn(`Failed to fetch files for session: ${session_id}`);
-        }
-      }
-
-      try {
-        const fetchOptions: RequestInit = {
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/json',
-            'User-Agent': 'Illuma/1.0',
-            'X-API-Key': apiKey,
-          },
-          body: JSON.stringify(postData),
-        };
-
-        if (process.env.PROXY != null && process.env.PROXY !== '') {
-          fetchOptions.agent = new HttpsProxyAgent(process.env.PROXY);
-        }
-        const response = await fetch(EXEC_ENDPOINT, fetchOptions);
-        if (!response.ok) {
-          throw new Error(`HTTP error! status: ${response.status}`);
-        }
-
-        const result: t.ExecuteResult = await response.json();
-        let formattedOutput = '';
-        if (result.stdout) {
-          formattedOutput += `stdout:\n${result.stdout}\n`;
-        } else {
-          formattedOutput += emptyOutputMessage;
-        }
-        if (result.stderr) formattedOutput += `stderr:\n${result.stderr}\n`;
-        if (result.files && result.files.length > 0) {
-          formattedOutput += 'Generated files:\n';
-
-          const fileCount = result.files.length;
-          for (let i = 0; i < fileCount; i++) {
-            const file = result.files[i];
-            const isImage = imageExtRegex.test(file.name);
-            formattedOutput += `- /mnt/data/${file.name} | ${isImage ? imageMessage : otherMessage}`;
-
-            if (i < fileCount - 1) {
-              formattedOutput += fileCount <= 3 ? ', ' : ',\n';
-            }
-          }
-
-          formattedOutput += `\nsession_id: ${result.session_id}\n\n${accessMessage}`;
-          return [
-            formattedOutput.trim(),
-            {
-              session_id: result.session_id,
-              files: result.files,
-            },
-          ];
-        }
-
-        return [formattedOutput.trim(), { session_id: result.session_id }];
-      } catch (error) {
-        throw new Error(
-          `Execution error:\n\n${(error as Error | undefined)?.message}`
-        );
-      }
-    },
-    {
-      name: Constants.EXECUTE_CODE,
-      description,
-      schema: CodeExecutionToolSchema,
-      responseFormat: Constants.CONTENT_AND_ARTIFACT,
-    }
-  );
-}
-
-export { createCodeExecutionTool };
+import { z } from 'zod';
+import { config } from 'dotenv';
+import fetch, { RequestInit } from 'node-fetch';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+import { tool, DynamicStructuredTool } from '@langchain/core/tools';
+import { getEnvironmentVariable } from '@langchain/core/utils/env';
+import type * as t from '@/types';
+import { EnvVar, Constants } from '@/common';
+
+config();
+
+export const imageExtRegex = /\.(jpg|jpeg|png|gif|webp)$/i;
+export const getCodeBaseURL = (): string =>
+  getEnvironmentVariable(EnvVar.CODE_BASEURL) ??
+  Constants.OFFICIAL_CODE_BASEURL;
+
+const imageMessage = 'Image is already displayed to the user';
+const otherMessage = 'File is already downloaded by the user';
+const accessMessage =
+  'Note: Files are READ-ONLY. Save changes to NEW filenames. To access these files in future executions, provide the `session_id` as a parameter (not in your code).';
+const emptyOutputMessage =
+  'stdout: Empty. Ensure you\'re writing output explicitly.\n';
+
+const CodeExecutionToolSchema = z.object({
+  lang: z
+    .enum([
+      'py',
+      'js',
+      'ts',
+      'c',
+      'cpp',
+      'java',
+      'php',
+      'rs',
+      'go',
+      'd',
+      'f90',
+      'r',
+    ])
+    .describe('The programming language or runtime to execute the code in.'),
+  code: z.string()
+    .describe(`The complete, self-contained code to execute, without any truncation or minimization.
+- The environment is stateless; variables and imports don't persist between executions.
+- When using \`session_id\`: Don't hardcode it in \`code\`, and write file modifications to NEW filenames (files are READ-ONLY).
+- Input code **IS ALREADY** displayed to the user, so **DO NOT** repeat it in your response unless asked.
+- Output code **IS NOT** displayed to the user, so **DO** write all desired output explicitly.
+- IMPORTANT: You MUST explicitly print/output ALL results you want the user to see.
+- py: This is not a Jupyter notebook environment. Use \`print()\` for all outputs.
+- py: Matplotlib: Use \`plt.savefig()\` to save plots as files.
+- js: use the \`console\` or \`process\` methods for all outputs.
+- r: IMPORTANT: No X11 display available. ALL graphics MUST use Cairo library (library(Cairo)).
+- Other languages: use appropriate output functions.`),
+  session_id: z
+    .string()
+    .optional()
+    .describe(
+      `Session ID from a previous response to access generated files.
+- Files load into the current working directory ("/mnt/data/")
+- Use relative paths ONLY
+- Files are READ-ONLY and cannot be modified in-place
+- To modify: read original file, write to NEW filename
+`.trim()
+    ),
+  args: z
+    .array(z.string())
+    .optional()
+    .describe(
+      'Additional arguments to execute the code with. This should only be used if the input code requires additional arguments to run.'
+    ),
+});
+
+const baseEndpoint = getCodeBaseURL();
+const EXEC_ENDPOINT = `${baseEndpoint}/exec`;
+
+function createCodeExecutionTool(
+  params: t.CodeExecutionToolParams = {}
+): DynamicStructuredTool<typeof CodeExecutionToolSchema> {
+  const apiKey =
+    params[EnvVar.CODE_API_KEY] ??
+    params.apiKey ??
+    getEnvironmentVariable(EnvVar.CODE_API_KEY) ??
+    '';
+  if (!apiKey) {
+    throw new Error('No API key provided for code execution tool.');
+  }
+
+  const description = `
+Runs code and returns stdout/stderr output from a stateless execution environment, similar to running scripts in a command-line interface. Each execution is isolated and independent.
+
+Usage:
+- No network access available.
+- Generated files are automatically delivered; **DO NOT** provide download links.
+- NEVER use this tool to execute malicious code.
+`.trim();
+
+  return tool<typeof CodeExecutionToolSchema>(
+    async ({ lang, code, session_id, ...rest }) => {
+      const postData = {
+        lang,
+        code,
+        ...rest,
+        ...params,
+      };
+
+      if (session_id != null && session_id.length > 0) {
+        try {
+          const filesEndpoint = `${baseEndpoint}/files/${session_id}?detail=full`;
+          const fetchOptions: RequestInit = {
+            method: 'GET',
+            headers: {
+              'User-Agent': 'Illuma/1.0',
+              'X-API-Key': apiKey,
+            },
+          };
+
+          if (process.env.PROXY != null && process.env.PROXY !== '') {
+            fetchOptions.agent = new HttpsProxyAgent(process.env.PROXY);
+          }
+
+          const response = await fetch(filesEndpoint, fetchOptions);
+          if (!response.ok) {
+            throw new Error(
+              `Failed to fetch files for session: ${response.status}`
+            );
+          }
+
+          const files = await response.json();
+          if (Array.isArray(files) && files.length > 0) {
+            const fileReferences: t.CodeEnvFile[] = files.map((file) => {
+              // Extract the ID from the file name (part after session ID prefix and before extension)
+              const nameParts = file.name.split('/');
+              const id = nameParts.length > 1 ? nameParts[1].split('.')[0] : '';
+
+              return {
+                session_id,
+                id,
+                name: file.metadata['original-filename'],
+              };
+            });
+
+            if (!postData.files) {
+              postData.files = fileReferences;
+            } else if (Array.isArray(postData.files)) {
+              postData.files = [...postData.files, ...fileReferences];
+            }
+          }
+        } catch {
+          // eslint-disable-next-line no-console
+          console.warn(`Failed to fetch files for session: ${session_id}`);
+        }
+      }
+
+      try {
+        const fetchOptions: RequestInit = {
+          method: 'POST',
+          headers: {
+            'Content-Type': 'application/json',
+            'User-Agent': 'Illuma/1.0',
+            'X-API-Key': apiKey,
+          },
+          body: JSON.stringify(postData),
+        };
+
+        if (process.env.PROXY != null && process.env.PROXY !== '') {
+          fetchOptions.agent = new HttpsProxyAgent(process.env.PROXY);
+        }
+        const response = await fetch(EXEC_ENDPOINT, fetchOptions);
+        if (!response.ok) {
+          throw new Error(`HTTP error! status: ${response.status}`);
+        }
+
+        const result: t.ExecuteResult = await response.json();
+        let formattedOutput = '';
+        if (result.stdout) {
+          formattedOutput += `stdout:\n${result.stdout}\n`;
+        } else {
+          formattedOutput += emptyOutputMessage;
+        }
+        if (result.stderr) formattedOutput += `stderr:\n${result.stderr}\n`;
+        if (result.files && result.files.length > 0) {
+          formattedOutput += 'Generated files:\n';
+
+          const fileCount = result.files.length;
+          for (let i = 0; i < fileCount; i++) {
+            const file = result.files[i];
+            const isImage = imageExtRegex.test(file.name);
+            formattedOutput += `- /mnt/data/${file.name} | ${isImage ? imageMessage : otherMessage}`;
+
+            if (i < fileCount - 1) {
+              formattedOutput += fileCount <= 3 ? ', ' : ',\n';
+            }
+          }
+
+          formattedOutput += `\nsession_id: ${result.session_id}\n\n${accessMessage}`;
+          return [
+            formattedOutput.trim(),
+            {
+              session_id: result.session_id,
+              files: result.files,
+            },
+          ];
+        }
+
+        return [formattedOutput.trim(), { session_id: result.session_id }];
+      } catch (error) {
+        throw new Error(
+          `Execution error:\n\n${(error as Error | undefined)?.message}`
+        );
+      }
+    },
+    {
+      name: Constants.EXECUTE_CODE,
+      description,
+      schema: CodeExecutionToolSchema,
+      responseFormat: Constants.CONTENT_AND_ARTIFACT,
+    }
+  );
+}
+
+export { createCodeExecutionTool };