mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 17:00:15 +01:00
* WIP: app.locals refactoring
WIP: appConfig
fix: update memory configuration retrieval to use getAppConfig based on user role
fix: update comment for AppConfig interface to clarify purpose
🏷️ refactor: Update tests to use getAppConfig for endpoint configurations
ci: Update AppService tests to initialize app config instead of app.locals
ci: Integrate getAppConfig into remaining tests
refactor: Update multer storage destination to use promise-based getAppConfig and improve error handling in tests
refactor: Rename initializeAppConfig to setAppConfig and update related tests
ci: Mock getAppConfig in various tests to provide default configurations
refactor: Update convertMCPToolsToPlugins to use mcpManager for server configuration and adjust related tests
chore: rename `Config/getAppConfig` -> `Config/app`
fix: streamline OpenAI image tools configuration by removing direct appConfig dependency and using function parameters
chore: correct parameter documentation for imageOutputType in ToolService.js
refactor: remove `getCustomConfig` dependency in config route
refactor: update domain validation to use appConfig for allowed domains
refactor: use appConfig registration property
chore: remove app parameter from AppService invocation
refactor: update AppConfig interface to correct registration and turnstile configurations
refactor: remove getCustomConfig dependency and use getAppConfig in PluginController, multer, and MCP services
refactor: replace getCustomConfig with getAppConfig in STTService, TTSService, and related files
refactor: replace getCustomConfig with getAppConfig in Conversation and Message models, update tempChatRetention functions to use AppConfig type
refactor: update getAppConfig calls in Conversation and Message models to include user role for temporary chat expiration
ci: update related tests
refactor: update getAppConfig call in getCustomConfigSpeech to include user role
fix: update appConfig usage to access allowedDomains from actions instead of registration
refactor: enhance AppConfig to include fileStrategies and update related file strategy logic
refactor: update imports to use normalizeEndpointName from @librechat/api and remove redundant definitions
chore: remove deprecated unused RunManager
refactor: get balance config primarily from appConfig
refactor: remove customConfig dependency for appConfig and streamline loadConfigModels logic
refactor: remove getCustomConfig usage and use app config in file citations
refactor: consolidate endpoint loading logic into loadEndpoints function
refactor: update appConfig access to use endpoints structure across various services
refactor: implement custom endpoints configuration and streamline endpoint loading logic
refactor: update getAppConfig call to include user role parameter
refactor: streamline endpoint configuration and enhance appConfig usage across services
refactor: replace getMCPAuthMap with getUserMCPAuthMap and remove unused getCustomConfig file
refactor: add type annotation for loadedEndpoints in loadEndpoints function
refactor: move /services/Files/images/parse to TS API
chore: add missing FILE_CITATIONS permission to IRole interface
refactor: restructure toolkits to TS API
refactor: separate manifest logic into its own module
refactor: consolidate tool loading logic into a new tools module for startup logic
refactor: move interface config logic to TS API
refactor: migrate checkEmailConfig to TypeScript and update imports
refactor: add FunctionTool interface and availableTools to AppConfig
refactor: decouple caching and DB operations from AppService, make part of consolidated `getAppConfig`
WIP: fix tests
* fix: rebase conflicts
* refactor: remove app.locals references
* refactor: replace getBalanceConfig with getAppConfig in various strategies and middleware
* refactor: replace appConfig?.balance with getBalanceConfig in various controllers and clients
* test: add balance configuration to titleConvo method in AgentClient tests
* chore: remove unused `openai-chat-tokens` package
* chore: remove unused imports in initializeMCPs.js
* refactor: update balance configuration to use getAppConfig instead of getBalanceConfig
* refactor: integrate configMiddleware for centralized configuration handling
* refactor: optimize email domain validation by removing unnecessary async calls
* refactor: simplify multer storage configuration by removing async calls
* refactor: reorder imports for better readability in user.js
* refactor: replace getAppConfig calls with req.config for improved performance
* chore: replace getAppConfig calls with req.config in tests for centralized configuration handling
* chore: remove unused override config
* refactor: add configMiddleware to endpoint route and replace getAppConfig with req.config
* chore: remove customConfig parameter from TTSService constructor
* refactor: pass appConfig from request to processFileCitations for improved configuration handling
* refactor: remove configMiddleware from endpoint route and retrieve appConfig directly in getEndpointsConfig if not in `req.config`
* test: add mockAppConfig to processFileCitations tests for improved configuration handling
* fix: pass req.config to hasCustomUserVars and call without await after synchronous refactor
* fix: type safety in useExportConversation
* refactor: retrieve appConfig using getAppConfig in PluginController and remove configMiddleware from plugins route, to avoid always retrieving when plugins are cached
* chore: change `MongoUser` typedef to `IUser`
* fix: Add `user` and `config` fields to ServerRequest and update JSDoc type annotations from Express.Request to ServerRequest
* fix: remove unused setAppConfig mock from Server configuration tests
237 lines
7.7 KiB
JavaScript
237 lines
7.7 KiB
JavaScript
const express = require('express');
|
|
const { nanoid } = require('nanoid');
|
|
const { logger } = require('@librechat/data-schemas');
|
|
const { generateCheckAccess } = require('@librechat/api');
|
|
const {
|
|
Permissions,
|
|
ResourceType,
|
|
PermissionTypes,
|
|
actionDelimiter,
|
|
PermissionBits,
|
|
removeNullishValues,
|
|
} = require('librechat-data-provider');
|
|
const { encryptMetadata, domainParser } = require('~/server/services/ActionService');
|
|
const { findAccessibleResources } = require('~/server/services/PermissionService');
|
|
const { getAgent, updateAgent, getListAgentsByAccess } = require('~/models/Agent');
|
|
const { updateAction, getActions, deleteAction } = require('~/models/Action');
|
|
const { isActionDomainAllowed } = require('~/server/services/domains');
|
|
const { canAccessAgentResource } = require('~/server/middleware');
|
|
const { getRoleByName } = require('~/models/Role');
|
|
|
|
const router = express.Router();
|
|
|
|
const checkAgentCreate = generateCheckAccess({
|
|
permissionType: PermissionTypes.AGENTS,
|
|
permissions: [Permissions.USE, Permissions.CREATE],
|
|
getRoleByName,
|
|
});
|
|
|
|
/**
|
|
* Retrieves all user's actions
|
|
* @route GET /actions/
|
|
* @param {string} req.params.id - Assistant identifier.
|
|
* @returns {Action[]} 200 - success response - application/json
|
|
*/
|
|
router.get('/', async (req, res) => {
|
|
try {
|
|
const userId = req.user.id;
|
|
const editableAgentObjectIds = await findAccessibleResources({
|
|
userId,
|
|
role: req.user.role,
|
|
resourceType: ResourceType.AGENT,
|
|
requiredPermissions: PermissionBits.EDIT,
|
|
});
|
|
|
|
const agentsResponse = await getListAgentsByAccess({
|
|
accessibleIds: editableAgentObjectIds,
|
|
});
|
|
|
|
const editableAgentIds = agentsResponse.data.map((agent) => agent.id);
|
|
const actions =
|
|
editableAgentIds.length > 0 ? await getActions({ agent_id: { $in: editableAgentIds } }) : [];
|
|
|
|
res.json(actions);
|
|
} catch (error) {
|
|
res.status(500).json({ error: error.message });
|
|
}
|
|
});
|
|
|
|
/**
|
|
* Adds or updates actions for a specific agent.
|
|
* @route POST /actions/:agent_id
|
|
* @param {string} req.params.agent_id - The ID of the agent.
|
|
* @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(
|
|
'/:agent_id',
|
|
canAccessAgentResource({
|
|
requiredPermission: PermissionBits.EDIT,
|
|
resourceIdParam: 'agent_id',
|
|
}),
|
|
checkAgentCreate,
|
|
async (req, res) => {
|
|
try {
|
|
const { agent_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 appConfig = req.config;
|
|
const isDomainAllowed = await isActionDomainAllowed(
|
|
metadata.domain,
|
|
appConfig?.actions?.allowedDomains,
|
|
);
|
|
if (!isDomainAllowed) {
|
|
return res.status(400).json({ message: 'Domain not allowed' });
|
|
}
|
|
|
|
let { domain } = metadata;
|
|
domain = await domainParser(domain, true);
|
|
|
|
if (!domain) {
|
|
return res.status(400).json({ message: 'No domain provided' });
|
|
}
|
|
|
|
const action_id = _action_id ?? nanoid();
|
|
const initialPromises = [];
|
|
|
|
// Permissions already validated by middleware - load agent directly
|
|
initialPromises.push(getAgent({ id: agent_id }));
|
|
if (_action_id) {
|
|
initialPromises.push(getActions({ action_id }, true));
|
|
}
|
|
|
|
/** @type {[Agent, [Action|undefined]]} */
|
|
const [agent, actions_result] = await Promise.all(initialPromises);
|
|
if (!agent) {
|
|
return res.status(404).json({ message: 'Agent not found for adding action' });
|
|
}
|
|
|
|
if (actions_result && actions_result.length) {
|
|
const action = actions_result[0];
|
|
metadata = { ...action.metadata, ...metadata };
|
|
}
|
|
|
|
const { actions: _actions = [], author: agent_author } = agent ?? {};
|
|
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 {string[]}} */
|
|
const { tools: _tools = [] } = agent;
|
|
|
|
const tools = _tools
|
|
.filter((tool) => !(tool && (tool.includes(domain) || tool.includes(action_id))))
|
|
.concat(functions.map((tool) => `${tool.function.name}${actionDelimiter}${domain}`));
|
|
|
|
// Force version update since actions are changing
|
|
const updatedAgent = await updateAgent(
|
|
{ id: agent_id },
|
|
{ tools, actions },
|
|
{
|
|
updatingUserId: req.user.id,
|
|
forceVersion: true,
|
|
},
|
|
);
|
|
|
|
// Only update user field for new actions
|
|
const actionUpdateData = { metadata, agent_id };
|
|
if (!actions_result || !actions_result.length) {
|
|
// For new actions, use the agent owner's user ID
|
|
actionUpdateData.user = agent_author || req.user.id;
|
|
}
|
|
|
|
/** @type {[Action]} */
|
|
const updatedAction = await updateAction({ action_id }, actionUpdateData);
|
|
|
|
const sensitiveFields = ['api_key', 'oauth_client_id', 'oauth_client_secret'];
|
|
for (let field of sensitiveFields) {
|
|
if (updatedAction.metadata[field]) {
|
|
delete updatedAction.metadata[field];
|
|
}
|
|
}
|
|
|
|
res.json([updatedAgent, updatedAction]);
|
|
} catch (error) {
|
|
const message = 'Trouble updating the Agent Action';
|
|
logger.error(message, error);
|
|
res.status(500).json({ message });
|
|
}
|
|
},
|
|
);
|
|
|
|
/**
|
|
* Deletes an action for a specific agent.
|
|
* @route DELETE /actions/:agent_id/:action_id
|
|
* @param {string} req.params.agent_id - The ID of the agent.
|
|
* @param {string} req.params.action_id - The ID of the action to delete.
|
|
* @returns {Object} 200 - success response - application/json
|
|
*/
|
|
router.delete(
|
|
'/:agent_id/:action_id',
|
|
canAccessAgentResource({
|
|
requiredPermission: PermissionBits.EDIT,
|
|
resourceIdParam: 'agent_id',
|
|
}),
|
|
checkAgentCreate,
|
|
async (req, res) => {
|
|
try {
|
|
const { agent_id, action_id } = req.params;
|
|
|
|
// Permissions already validated by middleware - load agent directly
|
|
const agent = await getAgent({ id: agent_id });
|
|
if (!agent) {
|
|
return res.status(404).json({ message: 'Agent not found for deleting action' });
|
|
}
|
|
|
|
const { tools = [], actions = [] } = agent;
|
|
|
|
let domain = '';
|
|
const updatedActions = actions.filter((action) => {
|
|
if (action.includes(action_id)) {
|
|
[domain] = action.split(actionDelimiter);
|
|
return false;
|
|
}
|
|
return true;
|
|
});
|
|
|
|
domain = await domainParser(domain, true);
|
|
|
|
if (!domain) {
|
|
return res.status(400).json({ message: 'No domain provided' });
|
|
}
|
|
|
|
const updatedTools = tools.filter((tool) => !(tool && tool.includes(domain)));
|
|
|
|
// Force version update since actions are being removed
|
|
await updateAgent(
|
|
{ id: agent_id },
|
|
{ tools: updatedTools, actions: updatedActions },
|
|
{ updatingUserId: req.user.id, forceVersion: true },
|
|
);
|
|
await deleteAction({ action_id });
|
|
res.status(200).json({ message: 'Action deleted successfully' });
|
|
} catch (error) {
|
|
const message = 'Trouble deleting the Agent Action';
|
|
logger.error(message, error);
|
|
res.status(500).json({ message });
|
|
}
|
|
},
|
|
);
|
|
|
|
module.exports = router;
|