@librechat/agents 3.0.74 → 3.0.76

package/src/scripts/code_exec_session.ts

@@ -0,0 +1,282 @@
+// src/scripts/code_exec_session.ts
+/**
+ * Test script for automatic session tracking in code execution tools.
+ *
+ * This tests the automatic session_id injection feature where:
+ * 1. First code execution generates files and returns a session_id
+ * 2. Session context is stored in Graph.sessions
+ * 3. Subsequent code executions automatically have access to previous files
+ *    without the LLM needing to explicitly pass session_id
+ *
+ * Run with: npm run code_exec_session
+ */
+import { config } from 'dotenv';
+config();
+import { HumanMessage, BaseMessage } from '@langchain/core/messages';
+import type { RunnableConfig } from '@langchain/core/runnables';
+import type * as t from '@/types';
+import { ChatModelStreamHandler, createContentAggregator } from '@/stream';
+import {
+  ToolEndHandler,
+  ModelEndHandler,
+  createMetadataAggregator,
+} from '@/events';
+import { getLLMConfig } from '@/utils/llmConfig';
+import { getArgs } from '@/scripts/args';
+import { Constants, GraphEvents } from '@/common';
+import { Run } from '@/run';
+import { createCodeExecutionTool } from '@/tools/CodeExecutor';
+
+const conversationHistory: BaseMessage[] = [];
+
+/**
+ * Prints a formatted section header for test output
+ */
+function printSection(title: string): void {
+  console.log('\n' + '='.repeat(60));
+  console.log(` ${title}`);
+  console.log('='.repeat(60) + '\n');
+}
+
+/**
+ * Prints session context from the graph for debugging
+ */
+function printSessionContext(run: Run<t.IState>): void {
+  const graph = run.Graph;
+  if (!graph) {
+    console.log('[Session] No graph available');
+    return;
+  }
+
+  const session = graph.sessions.get(Constants.EXECUTE_CODE) as
+    | t.CodeSessionContext
+    | undefined;
+
+  if (!session) {
+    console.log('[Session] No session context stored yet');
+    return;
+  }
+
+  console.log('[Session] Current session context:');
+  console.log(`  - session_id: ${session.session_id}`);
+  console.log(`  - files: ${JSON.stringify(session.files, null, 2)}`);
+  console.log(
+    `  - lastUpdated: ${new Date(session.lastUpdated).toISOString()}`
+  );
+}
+
+async function testAutomaticSessionTracking(): Promise<void> {
+  const { userName, location, provider, currentDate } = await getArgs();
+  const { contentParts, aggregateContent } = createContentAggregator();
+
+  const customHandlers = {
+    [GraphEvents.TOOL_END]: new ToolEndHandler(),
+    [GraphEvents.CHAT_MODEL_END]: new ModelEndHandler(),
+    [GraphEvents.CHAT_MODEL_STREAM]: new ChatModelStreamHandler(),
+    [GraphEvents.ON_RUN_STEP_COMPLETED]: {
+      handle: (
+        event: GraphEvents.ON_RUN_STEP_COMPLETED,
+        data: t.StreamEventData
+      ): void => {
+        console.log('====== ON_RUN_STEP_COMPLETED ======');
+        console.dir(data, { depth: null });
+        aggregateContent({
+          event,
+          data: data as unknown as { result: t.ToolEndEvent },
+        });
+      },
+    },
+    [GraphEvents.ON_RUN_STEP]: {
+      handle: (
+        event: GraphEvents.ON_RUN_STEP,
+        data: t.StreamEventData
+      ): void => {
+        console.log('====== ON_RUN_STEP ======');
+        console.dir(data, { depth: null });
+        aggregateContent({ event, data: data as t.RunStep });
+      },
+    },
+    [GraphEvents.ON_RUN_STEP_DELTA]: {
+      handle: (
+        event: GraphEvents.ON_RUN_STEP_DELTA,
+        data: t.StreamEventData
+      ): void => {
+        aggregateContent({ event, data: data as t.RunStepDeltaEvent });
+      },
+    },
+    [GraphEvents.ON_MESSAGE_DELTA]: {
+      handle: (
+        event: GraphEvents.ON_MESSAGE_DELTA,
+        data: t.StreamEventData
+      ): void => {
+        aggregateContent({ event, data: data as t.MessageDeltaEvent });
+      },
+    },
+    [GraphEvents.TOOL_START]: {
+      handle: (
+        _event: string,
+        data: t.StreamEventData,
+        _metadata?: Record<string, unknown>
+      ): void => {
+        console.log('====== TOOL_START ======');
+        console.dir(data, { depth: null });
+      },
+    },
+  };
+
+  const llmConfig = getLLMConfig(provider);
+
+  const run = await Run.create<t.IState>({
+    runId: 'session-tracking-test-1',
+    graphConfig: {
+      type: 'standard',
+      llmConfig,
+      tools: [createCodeExecutionTool()],
+      instructions: `You are an AI assistant testing automatic file persistence.
+When writing Python code:
+- Use print() for all outputs
+- Files from previous executions are automatically available in /mnt/data/
+- Files are READ-ONLY; write modifications to NEW filenames
+- IMPORTANT: Do NOT include session_id in your tool calls - it's handled automatically.`,
+      additional_instructions: `User: ${userName}, Location: ${location}, Date: ${currentDate}.`,
+    },
+    returnContent: true,
+    customHandlers,
+  });
+
+  const streamConfig: Partial<RunnableConfig> & {
+    version: 'v1' | 'v2';
+    run_id?: string;
+    streamMode: string;
+  } = {
+    configurable: {
+      provider,
+      thread_id: 'session-tracking-test',
+    },
+    streamMode: 'values',
+    version: 'v2' as const,
+  };
+
+  // =========================================================================
+  // Test 1: Create initial file (establishes session)
+  // =========================================================================
+  printSection('Test 1: Create Initial File');
+  console.log(
+    'This test creates a file, which should establish a session context.\n'
+  );
+
+  const userMessage1 = `
+Create a Python file that writes a simple JSON config file named "app_config.json" with the following content:
+{
+  "app_name": "TestApp",
+  "version": "1.0.0",
+  "debug": true
+}
+
+After writing, print the contents to confirm it was created correctly.
+`;
+
+  conversationHistory.push(new HumanMessage(userMessage1));
+  await run.processStream({ messages: conversationHistory }, streamConfig);
+
+  const finalMessages1 = run.getRunMessages();
+  if (finalMessages1) {
+    conversationHistory.push(...finalMessages1);
+  }
+
+  printSection('Session Context After Test 1');
+  printSessionContext(run);
+
+  // =========================================================================
+  // Test 2: Access previously created file (uses automatic session injection)
+  // =========================================================================
+  printSection('Test 2: Access Previous File (Automatic Session)');
+  console.log('This test reads the file created in Test 1.');
+  console.log(
+    'The LLM does NOT need to provide session_id - it should be injected automatically.\n'
+  );
+
+  const userMessage2 = `
+Now read the app_config.json file that was just created and:
+1. Print its contents
+2. Confirm the version is "1.0.0"
+
+Note: You should be able to access this file from the previous execution automatically.
+`;
+
+  conversationHistory.push(new HumanMessage(userMessage2));
+  await run.processStream({ messages: conversationHistory }, streamConfig);
+
+  const finalMessages2 = run.getRunMessages();
+  if (finalMessages2) {
+    conversationHistory.push(...finalMessages2);
+  }
+
+  printSection('Session Context After Test 2');
+  printSessionContext(run);
+
+  // =========================================================================
+  // Test 3: Modify file (write to new filename)
+  // =========================================================================
+  printSection('Test 3: Modify File (Write to New Filename)');
+  console.log(
+    'This test modifies the config by reading the old file and writing a new one.\n'
+  );
+
+  const userMessage3 = `
+Read app_config.json, update the version to "2.0.0" and debug to false, 
+then save it as "app_config_v2.json". Print both the old and new contents.
+`;
+
+  conversationHistory.push(new HumanMessage(userMessage3));
+  await run.processStream({ messages: conversationHistory }, streamConfig);
+
+  const finalMessages3 = run.getRunMessages();
+  if (finalMessages3) {
+    conversationHistory.push(...finalMessages3);
+  }
+
+  printSection('Session Context After Test 3');
+  printSessionContext(run);
+
+  // =========================================================================
+  // Summary
+  // =========================================================================
+  printSection('Test Summary');
+  console.log('The automatic session tracking feature should have:');
+  console.log('1. Stored the session_id after the first code execution');
+  console.log('2. Automatically injected it into subsequent executions');
+  console.log('3. Accumulated file references across all executions');
+  console.log('\nCheck the session context output above to verify.\n');
+
+  // Generate title
+  const { handleLLMEnd, collected } = createMetadataAggregator();
+  const titleResult = await run.generateTitle({
+    provider,
+    inputText: 'Testing automatic session tracking for code execution',
+    contentParts,
+    chainOptions: {
+      callbacks: [{ handleLLMEnd }],
+    },
+  });
+  console.log('Generated Title:', titleResult);
+  console.log('Collected metadata:', collected);
+}
+
+process.on('unhandledRejection', (reason, promise) => {
+  console.error('Unhandled Rejection at:', promise, 'reason:', reason);
+  console.log('Conversation history:');
+  console.dir(conversationHistory, { depth: null });
+  process.exit(1);
+});
+
+process.on('uncaughtException', (err) => {
+  console.error('Uncaught Exception:', err);
+});
+
+testAutomaticSessionTracking().catch((err) => {
+  console.error(err);
+  console.log('Conversation history:');
+  console.dir(conversationHistory, { depth: null });
+  process.exit(1);
+});

package/src/scripts/test_code_api.ts

@@ -0,0 +1,361 @@
+// src/scripts/test_code_api.ts
+/**
+ * Direct test of the Code API to verify session file persistence.
+ * This bypasses the LLM and tests the API directly.
+ *
+ * Run with: npx ts-node -r dotenv/config src/scripts/test_code_api.ts
+ */
+import { config } from 'dotenv';
+config();
+
+import fetch, { RequestInit } from 'node-fetch';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+
+const API_KEY = process.env.LIBRECHAT_CODE_API_KEY ?? '';
+const BASE_URL =
+  process.env.LIBRECHAT_CODE_BASEURL ?? 'https://api.librechat.ai/v1';
+const PROXY = process.env.PROXY;
+
+if (!API_KEY) {
+  console.error('LIBRECHAT_CODE_API_KEY not set');
+  process.exit(1);
+}
+
+interface FileRef {
+  id: string;
+  name: string;
+  session_id?: string;
+  /** Lineage tracking - present if file was modified from previous session */
+  modified_from?: {
+    id: string;
+    session_id: string;
+  };
+}
+
+interface ExecResult {
+  session_id: string;
+  stdout: string;
+  stderr: string;
+  files?: FileRef[];
+}
+
+interface FileInfo {
+  name: string;
+  metadata: Record<string, string>;
+}
+
+async function makeRequest(
+  endpoint: string,
+  body?: Record<string, unknown>
+): Promise<unknown> {
+  const fetchOptions: RequestInit = {
+    method: body ? 'POST' : 'GET',
+    headers: {
+      'Content-Type': 'application/json',
+      'User-Agent': 'LibreChat/1.0',
+      'X-API-Key': API_KEY,
+    },
+  };
+
+  if (body) {
+    fetchOptions.body = JSON.stringify(body);
+  }
+
+  if (PROXY) {
+    fetchOptions.agent = new HttpsProxyAgent(PROXY);
+  }
+
+  console.log(`\n>>> ${body ? 'POST' : 'GET'} ${endpoint}`);
+  if (body) {
+    console.log('Body:', JSON.stringify(body, null, 2));
+  }
+
+  const response = await fetch(endpoint, fetchOptions);
+  const result = await response.json();
+
+  console.log(`<<< Response (${response.status}):`);
+  console.log(JSON.stringify(result, null, 2));
+
+  if (!response.ok) {
+    throw new Error(`HTTP ${response.status}: ${JSON.stringify(result)}`);
+  }
+
+  return result;
+}
+
+async function testCodeAPI(): Promise<void> {
+  console.log('='.repeat(60));
+  console.log('TEST 1: Create a file');
+  console.log('='.repeat(60));
+
+  const createCode = `
+import json
+
+config = {
+    "app_name": "TestApp",
+    "version": "1.0.0",
+    "debug": True
+}
+
+with open("/mnt/data/test_config.json", "w") as f:
+    json.dump(config, f, indent=2)
+
+with open("/mnt/data/test_config.json", "r") as f:
+    print(f.read())
+`;
+
+  const result1 = (await makeRequest(`${BASE_URL}/exec`, {
+    lang: 'py',
+    code: createCode,
+  })) as ExecResult;
+
+  const sessionId = result1.session_id;
+  const files = result1.files ?? [];
+
+  console.log('\n--- Result Summary ---');
+  console.log('session_id:', sessionId);
+  console.log('files:', files);
+  console.log('stdout:', result1.stdout);
+  console.log('stderr:', result1.stderr);
+
+  if (!sessionId || files.length === 0) {
+    console.error('\n❌ No session_id or files returned!');
+    return;
+  }
+
+  // Check if files now include session_id (new API feature)
+  const hasSessionIdInFiles = files.some((f) => f.session_id != null);
+  console.log('\n✅ Files include session_id:', hasSessionIdInFiles);
+
+  console.log('\n' + '='.repeat(60));
+  console.log(
+    'TEST 2: Fetch files IMMEDIATELY (no delay - testing race condition fix)'
+  );
+  console.log('='.repeat(60));
+
+  const filesResult = (await makeRequest(
+    `${BASE_URL}/files/${sessionId}?detail=full`
+  )) as FileInfo[];
+
+  console.log('\n--- Files in session (detail=full) ---');
+  for (const file of filesResult) {
+    console.log('File:', file.name);
+    console.log('  metadata:', file.metadata);
+  }
+
+  if (filesResult.length === 0) {
+    console.log(
+      '\n⚠️  Files endpoint returned empty - race condition may still exist'
+    );
+  } else {
+    console.log('\n✅ Files available immediately!');
+  }
+
+  // Test new normalized detail level
+  console.log('\n' + '='.repeat(60));
+  console.log('TEST 2b: Fetch files with detail=normalized');
+  console.log('='.repeat(60));
+
+  const normalizedResult = (await makeRequest(
+    `${BASE_URL}/files/${sessionId}?detail=normalized`
+  )) as FileRef[];
+
+  console.log('\n--- Files in session (detail=normalized) ---');
+  console.log(JSON.stringify(normalizedResult, null, 2));
+
+  console.log('\n' + '='.repeat(60));
+  console.log(
+    'TEST 3: Read file IMMEDIATELY using files from original response'
+  );
+  console.log('='.repeat(60));
+
+  // Use files directly - if API returns session_id, use that; otherwise add it
+  const fileReferences: FileRef[] = files.map((file) => ({
+    session_id: file.session_id ?? sessionId,
+    id: file.id,
+    name: file.name,
+  }));
+
+  console.log(
+    '\nFile references we will send:',
+    JSON.stringify(fileReferences, null, 2)
+  );
+
+  const readCode = `
+import json
+
+with open("/mnt/data/test_config.json", "r") as f:
+    config = json.load(f)
+    print("Read config:")
+    print(json.dumps(config, indent=2))
+    print("Version:", config.get("version"))
+`;
+
+  const result2 = (await makeRequest(`${BASE_URL}/exec`, {
+    lang: 'py',
+    code: readCode,
+    files: fileReferences,
+  })) as ExecResult;
+
+  console.log('\n--- Result Summary ---');
+  console.log('stdout:', result2.stdout);
+  console.log('stderr:', result2.stderr);
+
+  if (result2.stderr && result2.stderr.includes('FileNotFoundError')) {
+    console.log(
+      '\n❌ File not found! The file reference format might be wrong.'
+    );
+
+    // Try alternative format - just session_id
+    console.log('\n' + '='.repeat(60));
+    console.log('TEST 4: Try with just session_id in request');
+    console.log('='.repeat(60));
+
+    const result3 = (await makeRequest(`${BASE_URL}/exec`, {
+      lang: 'py',
+      code: readCode,
+      session_id: sessionId,
+    })) as ExecResult;
+
+    console.log('\n--- Result Summary ---');
+    console.log('stdout:', result3.stdout);
+    console.log('stderr:', result3.stderr);
+  } else {
+    console.log('\n✅ File read successfully!');
+  }
+
+  // ============================================================
+  // TEST 4: MODIFY the file (same filename) - tests editable files
+  // ============================================================
+  console.log('\n' + '='.repeat(60));
+  console.log('TEST 4: MODIFY file in-place (testing editable files feature)');
+  console.log('='.repeat(60));
+
+  const modifyCode = `
+import json
+
+# Read the existing file
+with open("/mnt/data/test_config.json", "r") as f:
+    config = json.load(f)
+
+print("Original config:")
+print(json.dumps(config, indent=2))
+
+# Modify the config
+config["version"] = "2.0.0"
+config["modified"] = True
+
+# Write BACK to the SAME filename (should work now!)
+with open("/mnt/data/test_config.json", "w") as f:
+    json.dump(config, f, indent=2)
+
+# Verify the write
+with open("/mnt/data/test_config.json", "r") as f:
+    updated = json.load(f)
+
+print("\\nUpdated config:")
+print(json.dumps(updated, indent=2))
+`;
+
+  const result3 = (await makeRequest(`${BASE_URL}/exec`, {
+    lang: 'py',
+    code: modifyCode,
+    files: fileReferences,
+  })) as ExecResult;
+
+  console.log('\n--- Result Summary ---');
+  console.log('stdout:', result3.stdout);
+  console.log('stderr:', result3.stderr);
+  console.log('files:', JSON.stringify(result3.files, null, 2));
+
+  if (result3.stderr && result3.stderr.includes('Permission denied')) {
+    console.log('\n❌ Permission denied - files are still read-only!');
+  } else if (result3.stderr && result3.stderr.includes('Error')) {
+    console.log('\n❌ Error modifying file:', result3.stderr);
+  } else {
+    console.log('\n✅ File modified successfully!');
+
+    // Check for modified_from lineage
+    const modifiedFile = result3.files?.find(
+      (f) => f.name === 'test_config.json'
+    );
+    if (modifiedFile) {
+      console.log('\n--- Modified File Details ---');
+      console.log('  id:', modifiedFile.id);
+      console.log('  name:', modifiedFile.name);
+      console.log('  session_id:', modifiedFile.session_id);
+      if (modifiedFile.modified_from) {
+        console.log(
+          '  modified_from:',
+          JSON.stringify(modifiedFile.modified_from)
+        );
+        console.log(
+          '\n✅ Lineage tracking working! File shows it was modified from previous session.'
+        );
+      } else {
+        console.log(
+          '\n⚠️  No modified_from field - lineage tracking not present'
+        );
+      }
+    } else {
+      console.log('\n⚠️  Modified file not found in response files array');
+    }
+  }
+
+  // ============================================================
+  // TEST 5: Verify modification persists in next execution
+  // ============================================================
+  console.log('\n' + '='.repeat(60));
+  console.log(
+    'TEST 5: Verify modified file can be read in subsequent execution'
+  );
+  console.log('='.repeat(60));
+
+  // Use the new file references from the modify response
+  const newFileRefs: FileRef[] = (result3.files ?? []).map((file) => ({
+    session_id: file.session_id ?? result3.session_id,
+    id: file.id,
+    name: file.name,
+  }));
+
+  if (newFileRefs.length === 0) {
+    console.log(
+      '\n⚠️  No files returned from modification, skipping verification'
+    );
+  } else {
+    console.log(
+      '\nUsing new file references:',
+      JSON.stringify(newFileRefs, null, 2)
+    );
+
+    const verifyCode = `
+import json
+
+with open("/mnt/data/test_config.json", "r") as f:
+    config = json.load(f)
+
+print("Verified config:")
+print(json.dumps(config, indent=2))
+
+if config.get("version") == "2.0.0" and config.get("modified") == True:
+    print("\\n✅ Modification persisted correctly!")
+else:
+    print("\\n❌ Modification did NOT persist!")
+`;
+
+    const result4 = (await makeRequest(`${BASE_URL}/exec`, {
+      lang: 'py',
+      code: verifyCode,
+      files: newFileRefs,
+    })) as ExecResult;
+
+    console.log('\n--- Result Summary ---');
+    console.log('stdout:', result4.stdout);
+    console.log('stderr:', result4.stderr);
+  }
+}
+
+testCodeAPI().catch((err) => {
+  console.error('Error:', err);
+  process.exit(1);
+});