mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-21 02:40:14 +01:00
* ✨feat: OAuth for Actions * WIP: PoC flow state manager * refactor: Add identifier field to token model from action schema * chore: fix potential file type issues * ci: fix type issue with action metadata auth * fix: ensure FlowManagerOptions has a default ttl value * WIP: OAUTH actions * WIP: first pass OAuth Action * fix: standardize identifier usage in OAuth flow handling * fix: update token retrieval to include userId in query and use correct identifier * refacotr: update token retrieval to use userId for OAuth token query * feat: Tool Call Auth styling * fix: streamline token creation and add type field to token schema * refactor: cleanup OAuth flow by encrypting client credentials and ensuring oauth operations only run under condition * refactor: use encrypted credentials in OAuth callback * fix: update Token collection indexes to use expiresAt TTL index and not createdAt legacy index * refactor: enhance Token index cleanup by improving logging and removing redundant index creation logic * refactor: remove unused OAuth login route and related logic for improved clarity * refactor: replace fetch with axios for OAuth token exchange and improve error handling * refactor: better UX after authentication before oauth tool execution * refactor: implement cleanup handlers for FlowStateManager intervals to enhance resource management * refactor: encrypt OAuth tokens before storing and decrypt upon retrieval for enhanced security * refactor: enhance authentication success page with improved styling and countdown feature * refactor: add response_type parameter to OAuth redirect URI for improved compatibility * chore: update translation.json new localizations * chore: remove unused OGDialog import from OGDialogTemplate component * refactor: Actions Auth using new Dialog styling, use same component with Agents/Assistants * refactor: update removeNullishValues function to support removal of empty strings and adjust transform usage in schemas * chore: bump version of librechat-data-provider to 0.7.6991 * refactor: integrate removeNullishValues function to clean metadata before encryption in agent and assistant routes * refactor: update OAuth input fields to use 'password' type for better security * refactor: update localization placeholders for sign-in message to use double curly braces * refactor: add access_type parameter for offline access in createActionTool function * refactor: implement handleOAuthToken function for token management and encryption * feat: refresh token support * refactor: add default expiration for access token and error handling for missing token * feat: localizations for ActionAuth * refactor: set refresh token expiration to null to not expire if expiry never given * fix: prevent crash fromerror within async handleAbortError in AskController, EditController, and AgentController * feat: Action Callback URL * 🌍 i18n: Update translation.json with latest translations * refactor: handle errors in flow state checking to prevent unhandled promise rejections * fix: improve flow state concurrency to prevent multiple token creation calls * refactor: RequestExecutor to use separate axios instance * refactor: improve concurrency flows by keeping completed state until TTL expiry * refactor: increase TTL for flow state management and adjust monitoring interval * ci: mock axios instance creation in actions spec * feat: add Babel and Jest configuration files; implement FlowStateManager tests with concurrency handling * chore: add disableOAuth prop to ActionsAuth (not implemented for Assistants yet) --------- Co-authored-by: Danny Avila <danny@librechat.ai> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
205 lines
7.2 KiB
JavaScript
205 lines
7.2 KiB
JavaScript
const express = require('express');
|
|
const { nanoid } = require('nanoid');
|
|
const { actionDelimiter, EModelEndpoint, removeNullishValues } = require('librechat-data-provider');
|
|
const { encryptMetadata, domainParser } = require('~/server/services/ActionService');
|
|
const { getOpenAIClient } = require('~/server/controllers/assistants/helpers');
|
|
const { updateAction, getActions, deleteAction } = require('~/models/Action');
|
|
const { updateAssistantDoc, getAssistant } = require('~/models/Assistant');
|
|
const { isActionDomainAllowed } = require('~/server/services/domains');
|
|
const { logger } = require('~/config');
|
|
|
|
const router = express.Router();
|
|
|
|
/**
|
|
* Adds or updates actions for a specific assistant.
|
|
* @route POST /actions/:assistant_id
|
|
* @param {string} req.params.assistant_id - The ID of the assistant.
|
|
* @param {FunctionTool[]} req.body.functions - The functions to be added or updated.
|
|
* @param {string} [req.body.action_id] - Optional ID for the action.
|
|
* @param {ActionMetadata} req.body.metadata - Metadata for the action.
|
|
* @returns {Object} 200 - success response - application/json
|
|
*/
|
|
router.post('/:assistant_id', async (req, res) => {
|
|
try {
|
|
const { assistant_id } = req.params;
|
|
|
|
/** @type {{ functions: FunctionTool[], action_id: string, metadata: ActionMetadata }} */
|
|
const { functions, action_id: _action_id, metadata: _metadata } = req.body;
|
|
if (!functions.length) {
|
|
return res.status(400).json({ message: 'No functions provided' });
|
|
}
|
|
|
|
let metadata = await encryptMetadata(removeNullishValues(_metadata, true));
|
|
const isDomainAllowed = await isActionDomainAllowed(metadata.domain);
|
|
if (!isDomainAllowed) {
|
|
return res.status(400).json({ message: 'Domain not allowed' });
|
|
}
|
|
|
|
let { domain } = metadata;
|
|
domain = await domainParser(req, domain, true);
|
|
|
|
if (!domain) {
|
|
return res.status(400).json({ message: 'No domain provided' });
|
|
}
|
|
|
|
const action_id = _action_id ?? nanoid();
|
|
const initialPromises = [];
|
|
|
|
const { openai } = await getOpenAIClient({ req, res });
|
|
|
|
initialPromises.push(getAssistant({ assistant_id }));
|
|
initialPromises.push(openai.beta.assistants.retrieve(assistant_id));
|
|
!!_action_id && initialPromises.push(getActions({ action_id }, true));
|
|
|
|
/** @type {[AssistantDocument, Assistant, [Action|undefined]]} */
|
|
const [assistant_data, assistant, actions_result] = await Promise.all(initialPromises);
|
|
|
|
if (actions_result && actions_result.length) {
|
|
const action = actions_result[0];
|
|
metadata = { ...action.metadata, ...metadata };
|
|
}
|
|
|
|
if (!assistant) {
|
|
return res.status(404).json({ message: 'Assistant not found' });
|
|
}
|
|
|
|
const { actions: _actions = [], user: assistant_user } = assistant_data ?? {};
|
|
const actions = [];
|
|
for (const action of _actions) {
|
|
const [_action_domain, current_action_id] = action.split(actionDelimiter);
|
|
if (current_action_id === action_id) {
|
|
continue;
|
|
}
|
|
|
|
actions.push(action);
|
|
}
|
|
|
|
actions.push(`${domain}${actionDelimiter}${action_id}`);
|
|
|
|
/** @type {{ tools: FunctionTool[] | { type: 'code_interpreter'|'retrieval'}[]}} */
|
|
const { tools: _tools = [] } = assistant;
|
|
|
|
const tools = _tools
|
|
.filter(
|
|
(tool) =>
|
|
!(
|
|
tool.function &&
|
|
(tool.function.name.includes(domain) || tool.function.name.includes(action_id))
|
|
),
|
|
)
|
|
.concat(
|
|
functions.map((tool) => ({
|
|
...tool,
|
|
function: {
|
|
...tool.function,
|
|
name: `${tool.function.name}${actionDelimiter}${domain}`,
|
|
},
|
|
})),
|
|
);
|
|
|
|
let updatedAssistant = await openai.beta.assistants.update(assistant_id, { tools });
|
|
const promises = [];
|
|
|
|
// Only update user field for new assistant documents
|
|
const assistantUpdateData = { actions };
|
|
if (!assistant_data) {
|
|
assistantUpdateData.user = req.user.id;
|
|
}
|
|
promises.push(updateAssistantDoc({ assistant_id }, assistantUpdateData));
|
|
|
|
// Only update user field for new actions
|
|
const actionUpdateData = { metadata, assistant_id };
|
|
if (!actions_result || !actions_result.length) {
|
|
// For new actions, use the assistant owner's user ID
|
|
actionUpdateData.user = assistant_user || req.user.id;
|
|
}
|
|
promises.push(updateAction({ action_id }, actionUpdateData));
|
|
|
|
/** @type {[AssistantDocument, Action]} */
|
|
let [assistantDocument, updatedAction] = await Promise.all(promises);
|
|
const sensitiveFields = ['api_key', 'oauth_client_id', 'oauth_client_secret'];
|
|
for (let field of sensitiveFields) {
|
|
if (updatedAction.metadata[field]) {
|
|
delete updatedAction.metadata[field];
|
|
}
|
|
}
|
|
|
|
/* Map Azure OpenAI model to the assistant as defined by config */
|
|
if (req.app.locals[EModelEndpoint.azureOpenAI]?.assistants) {
|
|
updatedAssistant = {
|
|
...updatedAssistant,
|
|
model: req.body.model,
|
|
};
|
|
}
|
|
|
|
res.json([assistantDocument, updatedAssistant, updatedAction]);
|
|
} catch (error) {
|
|
const message = 'Trouble updating the Assistant Action';
|
|
logger.error(message, error);
|
|
res.status(500).json({ message });
|
|
}
|
|
});
|
|
|
|
/**
|
|
* Deletes an action for a specific assistant.
|
|
* @route DELETE /actions/:assistant_id/:action_id
|
|
* @param {string} req.params.assistant_id - The ID of the assistant.
|
|
* @param {string} req.params.action_id - The ID of the action to delete.
|
|
* @returns {Object} 200 - success response - application/json
|
|
*/
|
|
router.delete('/:assistant_id/:action_id/:model', async (req, res) => {
|
|
try {
|
|
const { assistant_id, action_id, model } = req.params;
|
|
req.body.model = model;
|
|
const { openai } = await getOpenAIClient({ req, res });
|
|
|
|
const initialPromises = [];
|
|
initialPromises.push(getAssistant({ assistant_id }));
|
|
initialPromises.push(openai.beta.assistants.retrieve(assistant_id));
|
|
|
|
/** @type {[AssistantDocument, Assistant]} */
|
|
const [assistant_data, assistant] = await Promise.all(initialPromises);
|
|
|
|
const { actions = [] } = assistant_data ?? {};
|
|
const { tools = [] } = assistant ?? {};
|
|
|
|
let domain = '';
|
|
const updatedActions = actions.filter((action) => {
|
|
if (action.includes(action_id)) {
|
|
[domain] = action.split(actionDelimiter);
|
|
return false;
|
|
}
|
|
return true;
|
|
});
|
|
|
|
domain = await domainParser(req, domain, true);
|
|
|
|
if (!domain) {
|
|
return res.status(400).json({ message: 'No domain provided' });
|
|
}
|
|
|
|
const updatedTools = tools.filter(
|
|
(tool) => !(tool.function && tool.function.name.includes(domain)),
|
|
);
|
|
|
|
await openai.beta.assistants.update(assistant_id, { tools: updatedTools });
|
|
|
|
const promises = [];
|
|
// Only update user field if assistant document doesn't exist
|
|
const assistantUpdateData = { actions: updatedActions };
|
|
if (!assistant_data) {
|
|
assistantUpdateData.user = req.user.id;
|
|
}
|
|
promises.push(updateAssistantDoc({ assistant_id }, assistantUpdateData));
|
|
promises.push(deleteAction({ action_id }));
|
|
|
|
await Promise.all(promises);
|
|
res.status(200).json({ message: 'Action deleted successfully' });
|
|
} catch (error) {
|
|
const message = 'Trouble deleting the Assistant Action';
|
|
logger.error(message, error);
|
|
res.status(500).json({ message });
|
|
}
|
|
});
|
|
|
|
module.exports = router;
|