🚧 WIP: Merge Dev Build (#4611)

* refactor: Agent CodeFiles, abortUpload WIP

* feat: code environment file upload

* refactor: useLazyEffect

* refactor:
- Add `watch` from `useFormContext` to check if code execution is enabled
- Disable file upload button if `agent_id` is not selected or code execution is disabled

* WIP: primeCodeFiles; refactor: rename sessionId to session_id for uniformity

* Refactor: Rename session_id to sessionId for uniformity in AuthService.js

* chore: bump @librechat/agents to version 1.7.1

* WIP: prime code files

* refactor: Update code env file upload method to use read stream

* feat: reupload code env file if no longer active

* refactor: isAssistantTool -> isEntityTool + address type issues

* feat: execute code tool hook

* refactor: Rename isPluginAuthenticated to checkPluginAuth in PluginController.js

* refactor: Update PluginController.js to use AuthType constant for comparison

* feat: verify tool authentication (execute_code)

* feat: enter librechat_code_api_key

* refactor: Remove unused imports in BookmarkForm.tsx

* feat: authenticate code tool

* refactor: Update Action.tsx to conditionally render the key and revoke key buttons

* refactor(Code/Action): prevent uncheck-able 'Run Code' capability when key is revoked

* refactor(Code/Action): Update Action.tsx to conditionally render the key and revoke key buttons

* fix: agent file upload edge cases

* chore: bump @librechat/agents

* fix: custom endpoint providerValue icon

* feat: ollama meta modal token values + context

* feat: ollama agents

* refactor: Update token models for Ollama models

* chore: Comment out CodeForm

* refactor: Update token models for Ollama and Meta models

api/server/services/Files/Code/crud.js

@@ -1,19 +1,20 @@
-// downloadStream.js
-
+// Code Files
 const axios = require('axios');
+const FormData = require('form-data');
 const { getCodeBaseURL } = require('@librechat/agents');
 
-const baseURL = getCodeBaseURL();
+const MAX_FILE_SIZE = 25 * 1024 * 1024;
 
 /**
  * Retrieves a download stream for a specified file.
- * @param {string} fileIdentifier - The identifier for the file (e.g., "sessionId/fileId").
+ * @param {string} fileIdentifier - The identifier for the file (e.g., "session_id/fileId").
  * @param {string} apiKey - The API key for authentication.
  * @returns {Promise<AxiosResponse>} A promise that resolves to a readable stream of the file content.
  * @throws {Error} If there's an error during the download process.
  */
 async function getCodeOutputDownloadStream(fileIdentifier, apiKey) {
   try {
+    const baseURL = getCodeBaseURL();
     const response = await axios({
       method: 'get',
       url: `${baseURL}/download/${fileIdentifier}`,
@@ -31,4 +32,45 @@ async function getCodeOutputDownloadStream(fileIdentifier, apiKey) {
   }
 }
 
-module.exports = { getCodeOutputDownloadStream };
+/**
+ * Uploads a file to the Code Environment server.
+ * @param {Object} params - The params object.
+ * @param {ServerRequest} params.req - The request object from Express. It should have a `user` property with an `id`
+ *                       representing the user, and an `app.locals.paths` object with an `uploads` path.
+ * @param {import('fs').ReadStream | import('stream').Readable} params.stream - The read stream for the file.
+ * @param {string} params.filename - The name of the file.
+ * @param {string} params.apiKey - The API key for authentication.
+ * @returns {Promise<string>}
+ * @throws {Error} If there's an error during the upload process.
+ */
+async function uploadCodeEnvFile({ req, stream, filename, apiKey }) {
+  try {
+    const form = new FormData();
+    form.append('file', stream, filename);
+
+    const baseURL = getCodeBaseURL();
+    const response = await axios.post(`${baseURL}/upload`, form, {
+      headers: {
+        ...form.getHeaders(),
+        'Content-Type': 'multipart/form-data',
+        'User-Agent': 'LibreChat/1.0',
+        'User-Id': req.user.id,
+        'X-API-Key': apiKey,
+      },
+      maxContentLength: MAX_FILE_SIZE,
+      maxBodyLength: MAX_FILE_SIZE,
+    });
+
+    /** @type {{ message: string; session_id: string; files: Array<{ fileId: string; filename: string }> }} */
+    const result = response.data;
+    if (result.message !== 'success') {
+      throw new Error(`Error uploading file: ${result.message}`);
+    }
+
+    return `${result.session_id}/${result.files[0].fileId}`;
+  } catch (error) {
+    throw new Error(`Error uploading file: ${error.message}`);
+  }
+}
+
+module.exports = { getCodeOutputDownloadStream, uploadCodeEnvFile };

api/server/services/Files/Code/process.js

@@ -1,11 +1,16 @@
 const path = require('path');
 const { v4 } = require('uuid');
 const axios = require('axios');
-const { getCodeBaseURL, EnvVar } = require('@librechat/agents');
-const { FileContext, imageExtRegex } = require('librechat-data-provider');
+const { getCodeBaseURL } = require('@librechat/agents');
+const {
+  EToolResources,
+  FileContext,
+  imageExtRegex,
+  FileSources,
+} = require('librechat-data-provider');
+const { getStrategyFunctions } = require('~/server/services/Files/strategies');
 const { convertImage } = require('~/server/services/Files/images/convert');
-const { loadAuthValues } = require('~/app/clients/tools/util');
-const { createFile } = require('~/models/File');
+const { createFile, getFiles, updateFile } = require('~/models/File');
 const { logger } = require('~/config');
 
 /**
@@ -13,8 +18,9 @@ const { logger } = require('~/config');
  * @param {ServerRequest} params.req - The Express request object.
  * @param {string} params.id - The file ID.
  * @param {string} params.name - The filename.
+ * @param {string} params.apiKey - The code execution API key.
  * @param {string} params.toolCallId - The tool call ID that generated the file.
- * @param {string} params.sessionId - The code execution session ID.
+ * @param {string} params.session_id - The code execution session ID.
  * @param {string} params.conversationId - The current conversation ID.
  * @param {string} params.messageId - The current message ID.
  * @returns {Promise<MongoFile & { messageId: string, toolCallId: string } | { filename: string; filepath: string; expiresAt: number; conversationId: string; toolCallId: string; messageId: string } | undefined>} The file metadata or undefined if an error occurs.
@@ -23,10 +29,11 @@ const processCodeOutput = async ({
   req,
   id,
   name,
+  apiKey,
   toolCallId,
   conversationId,
   messageId,
-  sessionId,
+  session_id,
 }) => {
   const currentDate = new Date();
   const baseURL = getCodeBaseURL();
@@ -34,7 +41,7 @@ const processCodeOutput = async ({
   if (!fileExt || !imageExtRegex.test(name)) {
     return {
       filename: name,
-      filepath: `/api/files/code/download/${sessionId}/${id}`,
+      filepath: `/api/files/code/download/${session_id}/${id}`,
       /** Note: expires 24 hours after creation */
       expiresAt: currentDate.getTime() + 86400000,
       conversationId,
@@ -45,14 +52,13 @@ const processCodeOutput = async ({
 
   try {
     const formattedDate = currentDate.toISOString();
-    const result = await loadAuthValues({ userId: req.user.id, authFields: [EnvVar.CODE_API_KEY] });
     const response = await axios({
       method: 'get',
-      url: `${baseURL}/download/${sessionId}/${id}`,
+      url: `${baseURL}/download/${session_id}/${id}`,
       responseType: 'arraybuffer',
       headers: {
         'User-Agent': 'LibreChat/1.0',
-        'X-API-Key': result[EnvVar.CODE_API_KEY],
+        'X-API-Key': apiKey,
       },
       timeout: 15000,
     });
@@ -82,6 +88,120 @@ const processCodeOutput = async ({
   }
 };
 
+function checkIfActive(dateString) {
+  const givenDate = new Date(dateString);
+  const currentDate = new Date();
+  const timeDifference = currentDate - givenDate;
+  const hoursPassed = timeDifference / (1000 * 60 * 60);
+  return hoursPassed < 23;
+}
+
+/**
+ * Retrieves the `lastModified` time string for a specified file from Code Execution Server.
+ *
+ * @param {Object} params - The parameters object.
+ * @param {string} params.fileIdentifier - The identifier for the file (e.g., "session_id/fileId").
+ * @param {string} params.apiKey - The API key for authentication.
+ *
+ * @returns {Promise<string|null>}
+ *          A promise that resolves to the `lastModified` time string of the file if successful, or null if there is an
+ *          error in initialization or fetching the info.
+ */
+async function getSessionInfo(fileIdentifier, apiKey) {
+  try {
+    const baseURL = getCodeBaseURL();
+    const session_id = fileIdentifier.split('/')[0];
+    const response = await axios({
+      method: 'get',
+      url: `${baseURL}/files/${session_id}`,
+      params: {
+        detail: 'summary',
+      },
+      headers: {
+        'User-Agent': 'LibreChat/1.0',
+        'X-API-Key': apiKey,
+      },
+      timeout: 5000,
+    });
+
+    return response.data.find((file) => file.name.startsWith(fileIdentifier))?.lastModified;
+  } catch (error) {
+    logger.error(`Error fetching session info: ${error.message}`, error);
+    return null;
+  }
+}
+
+/**
+ *
+ * @param {Object} options
+ * @param {ServerRequest} options.req
+ * @param {Agent['tool_resources']} options.tool_resources
+ * @param {string} apiKey
+ * @returns {Promise<Array<{ id: string; session_id: string; name: string }>>}
+ */
+const primeFiles = async (options, apiKey) => {
+  const { tool_resources } = options;
+  const file_ids = tool_resources?.[EToolResources.execute_code]?.file_ids ?? [];
+  const dbFiles = await getFiles({ file_id: { $in: file_ids } });
+
+  const files = [];
+  const sessions = new Map();
+  for (const file of dbFiles) {
+    if (file.metadata.fileIdentifier) {
+      const [session_id, id] = file.metadata.fileIdentifier.split('/');
+      const pushFile = () => {
+        files.push({
+          id,
+          session_id,
+          name: file.filename,
+        });
+      };
+      if (sessions.has(session_id)) {
+        pushFile();
+        continue;
+      }
+      const reuploadFile = async () => {
+        try {
+          const { getDownloadStream } = getStrategyFunctions(file.source);
+          const { handleFileUpload: uploadCodeEnvFile } = getStrategyFunctions(
+            FileSources.execute_code,
+          );
+          const stream = await getDownloadStream(file.filepath);
+          const fileIdentifier = await uploadCodeEnvFile({
+            req: options.req,
+            stream,
+            filename: file.filename,
+            apiKey,
+          });
+          await updateFile({ file_id: file.file_id, metadata: { fileIdentifier } });
+          sessions.set(session_id, true);
+          pushFile();
+        } catch (error) {
+          logger.error(
+            `Error re-uploading file ${id} in session ${session_id}: ${error.message}`,
+            error,
+          );
+        }
+      };
+      const uploadTime = await getSessionInfo(file.metadata.fileIdentifier, apiKey);
+      if (!uploadTime) {
+        logger.warn(`Failed to get upload time for file ${id} in session ${session_id}`);
+        await reuploadFile();
+        continue;
+      }
+      if (!checkIfActive(uploadTime)) {
+        await reuploadFile();
+        continue;
+      }
+      sessions.set(session_id, true);
+      pushFile();
+    }
+  }
+
+  return files;
+};
+
 module.exports = {
+  primeFiles,
   processCodeOutput,
 };

api/server/services/Files/Firebase/crud.js

@@ -2,7 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const axios = require('axios');
 const fetch = require('node-fetch');
-const { ref, uploadBytes, getDownloadURL, getStream, deleteObject } = require('firebase/storage');
+const { ref, uploadBytes, getDownloadURL, deleteObject } = require('firebase/storage');
 const { getBufferMetadata } = require('~/server/utils');
 const { getFirebaseStorage } = require('./initialize');
 const { logger } = require('~/config');
@@ -155,7 +155,7 @@ function extractFirebaseFilePath(urlString) {
  * Deletes a file from Firebase storage. This function determines the filepath from the
  * Firebase storage URL via regex for deletion. Validated by the user's ID.
  *
- * @param {Express.Request} req - The request object from Express.
+ * @param {ServerRequest} req - The request object from Express.
  * It should contain a `user` object with an `id` property.
  * @param {MongoFile} file - The file object to be deleted.
  *
@@ -195,7 +195,7 @@ const deleteFirebaseFile = async (req, file) => {
  * Uploads a file to Firebase Storage.
  *
  * @param {Object} params - The params object.
- * @param {Express.Request} params.req - The request object from Express. It should have a `user` property with an `id`
+ * @param {ServerRequest} params.req - The request object from Express. It should have a `user` property with an `id`
  *                       representing the user.
  * @param {Express.Multer.File} params.file - The file object, which is part of the request. The file object should
  *                                     have a `path` property that points to the location of the uploaded file.
@@ -225,16 +225,22 @@ async function uploadFileToFirebase({ req, file, file_id }) {
  * Retrieves a readable stream for a file from Firebase storage.
  *
  * @param {string} filepath - The filepath.
- * @returns {ReadableStream} A readable stream of the file.
+ * @returns {Promise<ReadableStream>} A readable stream of the file.
  */
-function getFirebaseFileStream(filepath) {
+async function getFirebaseFileStream(filepath) {
   try {
     const storage = getFirebaseStorage();
     if (!storage) {
       throw new Error('Firebase is not initialized');
     }
-    const fileRef = ref(storage, filepath);
-    return getStream(fileRef);
+
+    const response = await axios({
+      method: 'get',
+      url: filepath,
+      responseType: 'stream',
+    });
+
+    return response.data;
   } catch (error) {
     logger.error('Error getting Firebase file stream:', error);
     throw error;

api/server/services/Files/Local/crud.js

@@ -1,6 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const axios = require('axios');
+const { EModelEndpoint } = require('librechat-data-provider');
 const { getBufferMetadata } = require('~/server/utils');
 const paths = require('~/config/paths');
 const { logger } = require('~/config');
@@ -222,6 +223,10 @@ const deleteLocalFile = async (req, file) => {
 
   const parts = file.filepath.split(path.sep);
   const subfolder = parts[1];
+  if (!subfolder && parts[0] === EModelEndpoint.agents) {
+    logger.warn(`Agent File ${file.file_id} is missing filepath, may have been deleted already`);
+    return;
+  }
   const filepath = path.join(publicPath, file.filepath);
 
   if (!isValidPath(req, publicPath, subfolder, filepath)) {
@@ -235,7 +240,7 @@ const deleteLocalFile = async (req, file) => {
  * Uploads a file to the specified upload directory.
  *
  * @param {Object} params - The params object.
- * @param {Object} params.req - The request object from Express. It should have a `user` property with an `id`
+ * @param {ServerRequest} params.req - The request object from Express. It should have a `user` property with an `id`
  *                       representing the user, and an `app.locals.paths` object with an `uploads` path.
  * @param {Express.Multer.File} params.file - The file object, which is part of the request. The file object should
  *                                     have a `path` property that points to the location of the uploaded file.

api/server/services/Files/OpenAI/crud.js

@@ -7,7 +7,7 @@ const { logger } = require('~/config');
  * Uploads a file that can be used across various OpenAI services.
  *
  * @param {Object} params - The params object.
- * @param {Express.Request} params.req - The request object from Express. It should have a `user` property with an `id`
+ * @param {ServerRequest} params.req - The request object from Express. It should have a `user` property with an `id`
  *                       representing the user, and an `app.locals.paths` object with an `imageOutput` path.
  * @param {Express.Multer.File} params.file - The file uploaded to the server via multer.
  * @param {OpenAIClient} params.openai - The initialized OpenAI client.
@@ -42,7 +42,7 @@ async function uploadOpenAIFile({ req, file, openai }) {
 /**
  * Deletes a file previously uploaded to OpenAI.
  *
- * @param {Express.Request} req - The request object from Express.
+ * @param {ServerRequest} req - The request object from Express.
  * @param {MongoFile} file - The database representation of the uploaded file.
  * @param {OpenAI} openai - The initialized OpenAI client.
  * @returns {Promise<void>}

api/server/services/Files/VectorDB/crud.js

@@ -8,7 +8,7 @@ const { logger } = require('~/config');
  * Deletes a file from the vector database. This function takes a file object, constructs the full path, and
  * verifies the path's validity before deleting the file. If the path is invalid, an error is thrown.
  *
- * @param {Express.Request} req - The request object from Express. It should have an `app.locals.paths` object with
+ * @param {ServerRequest} req - The request object from Express. It should have an `app.locals.paths` object with
  *                       a `publicPath` property.
  * @param {MongoFile} file - The file object to be deleted. It should have a `filepath` property that is
  *                           a string representing the path of the file relative to the publicPath.

api/server/services/Files/process.js

@@ -1,3 +1,4 @@
+const fs = require('fs');
 const path = require('path');
 const mime = require('mime');
 const { v4 } = require('uuid');
@@ -12,14 +13,17 @@ const {
   mergeFileConfig,
   hostImageIdSuffix,
   checkOpenAIStorage,
+  removeNullishValues,
   hostImageNamePrefix,
   isAssistantsEndpoint,
 } = require('librechat-data-provider');
+const { EnvVar } = require('@librechat/agents');
 const { addResourceFileId, deleteResourceFileId } = require('~/server/controllers/assistants/v2');
 const { convertImage, resizeAndConvert } = require('~/server/services/Files/images');
 const { addAgentResourceFile, removeAgentResourceFile } = require('~/models/Agent');
 const { getOpenAIClient } = require('~/server/controllers/assistants/helpers');
 const { createFile, updateFileUsage, deleteFiles } = require('~/models/File');
+const { loadAuthValues } = require('~/app/clients/tools/util');
 const { LB_QueueAsyncCall } = require('~/server/utils/queue');
 const { getStrategyFunctions } = require('./strategies');
 const { determineFileType } = require('~/server/utils');
@@ -89,6 +93,7 @@ function enqueueDeleteOperation({ req, file, deleteFile, promises, resolvedFileI
  * @param {MongoFile[]} params.files - The file objects to delete.
  * @param {Express.Request} params.req - The express request object.
  * @param {DeleteFilesBody} params.req.body - The request body.
+ * @param {string} [params.req.body.agent_id] - The agent ID if file uploaded is associated to an agent.
  * @param {string} [params.req.body.assistant_id] - The assistant ID if file uploaded is associated to an assistant.
  * @param {string} [params.req.body.tool_resource] - The tool resource if assistant file uploaded is associated to a tool resource.
  *
@@ -438,10 +443,25 @@ const processAgentFileUpload = async ({ req, res, file, metadata }) => {
     throw new Error('No agent ID provided for agent file upload');
   }
 
+  let fileInfoMetadata;
+  if (tool_resource === EToolResources.execute_code) {
+    const { handleFileUpload: uploadCodeEnvFile } = getStrategyFunctions(FileSources.execute_code);
+    const result = await loadAuthValues({ userId: req.user.id, authFields: [EnvVar.CODE_API_KEY] });
+    const stream = fs.createReadStream(file.path);
+    const fileIdentifier = await uploadCodeEnvFile({
+      req,
+      stream,
+      filename: file.originalname,
+      apiKey: result[EnvVar.CODE_API_KEY],
+    });
+    fileInfoMetadata = { fileIdentifier };
+  }
+
   const source =
     tool_resource === EToolResources.file_search
       ? FileSources.vectordb
       : req.app.locals.fileStrategy;
+
   const { handleFileUpload } = getStrategyFunctions(source);
   const { file_id, temp_file_id } = metadata;
 
@@ -463,9 +483,9 @@ const processAgentFileUpload = async ({ req, res, file, metadata }) => {
   if (!messageAttachment && tool_resource) {
     await addAgentResourceFile({
       req,
-      agent_id,
       file_id,
-      tool_resource: tool_resource,
+      agent_id,
+      tool_resource,
     });
   }
 
@@ -479,24 +499,24 @@ const processAgentFileUpload = async ({ req, res, file, metadata }) => {
     filepath = result.filepath;
   }
 
-  const result = await createFile(
-    {
-      user: req.user.id,
-      file_id,
-      temp_file_id,
-      bytes,
-      filepath,
-      filename: filename ?? file.originalname,
-      context: messageAttachment ? FileContext.message_attachment : FileContext.agents,
-      model: messageAttachment ? undefined : req.body.model,
-      type: file.mimetype,
-      embedded,
-      source,
-      height,
-      width,
-    },
-    true,
-  );
+  const fileInfo = removeNullishValues({
+    user: req.user.id,
+    file_id,
+    temp_file_id,
+    bytes,
+    filepath,
+    filename: filename ?? file.originalname,
+    context: messageAttachment ? FileContext.message_attachment : FileContext.agents,
+    model: messageAttachment ? undefined : req.body.model,
+    metadata: fileInfoMetadata,
+    type: file.mimetype,
+    embedded,
+    source,
+    height,
+    width,
+  });
+
+  const result = await createFile(fileInfo, true);
   res.status(200).json({ message: 'Agent file uploaded and processed successfully', ...result });
 };
 

api/server/services/Files/strategies.js

@@ -5,11 +5,13 @@ const {
   saveURLToFirebase,
   deleteFirebaseFile,
   saveBufferToFirebase,
+  uploadFileToFirebase,
   uploadImageToFirebase,
   processFirebaseAvatar,
   getFirebaseFileStream,
 } = require('./Firebase');
 const {
+  uploadLocalFile,
   getLocalFileURL,
   saveFileFromURL,
   saveLocalBuffer,
@@ -20,17 +22,15 @@ const {
   getLocalFileStream,
 } = require('./Local');
 const { uploadOpenAIFile, deleteOpenAIFile, getOpenAIFileStream } = require('./OpenAI');
+const { getCodeOutputDownloadStream, uploadCodeEnvFile } = require('./Code');
 const { uploadVectors, deleteVectors } = require('./VectorDB');
-const { getCodeOutputDownloadStream } = require('./Code');
 
 /**
  * Firebase Storage Strategy Functions
  *
  * */
 const firebaseStrategy = () => ({
-  // saveFile:
-  /** @type {typeof uploadVectors | null} */
-  handleFileUpload: null,
+  handleFileUpload: uploadFileToFirebase,
   saveURL: saveURLToFirebase,
   getFileURL: getFirebaseURL,
   deleteFile: deleteFirebaseFile,
@@ -46,8 +46,7 @@ const firebaseStrategy = () => ({
  *
  * */
 const localStrategy = () => ({
-  /** @type {typeof uploadVectors | null} */
-  handleFileUpload: null,
+  handleFileUpload: uploadLocalFile,
   saveURL: saveFileFromURL,
   getFileURL: getLocalFileURL,
   saveBuffer: saveLocalBuffer,
@@ -124,8 +123,7 @@ const codeOutputStrategy = () => ({
   prepareImagePayload: null,
   /** @type {typeof deleteLocalFile | null} */
   deleteFile: null,
-  /** @type {typeof uploadVectors | null} */
-  handleFileUpload: null,
+  handleFileUpload: uploadCodeEnvFile,
   getDownloadStream: getCodeOutputDownloadStream,
 });