mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-09-09 08:02:04 +00:00
* fix: report complete agents api usage * fix: preserve invoked usage context * test: cover absent usage context * fix: type responses usage finalization * fix: preserve reasoning usage aliases * fix: declare reasoning usage alias
1482 lines
54 KiB
JavaScript
1482 lines
54 KiB
JavaScript
/**
|
|
* Unit tests for OpenAI-compatible API controller
|
|
* Tests that recordCollectedUsage is called correctly for token spending
|
|
*/
|
|
|
|
const { ErrorTypes, ResourceType } = require('librechat-data-provider');
|
|
|
|
const mockProcessStream = jest.fn().mockResolvedValue(undefined);
|
|
const mockSpendTokens = jest.fn().mockResolvedValue({});
|
|
const mockSpendStructuredTokens = jest.fn().mockResolvedValue({});
|
|
const mockRecordCollectedUsage = jest
|
|
.fn()
|
|
.mockResolvedValue({ input_tokens: 100, output_tokens: 50 });
|
|
const mockGetBalanceConfig = jest.fn().mockReturnValue({ enabled: true });
|
|
const mockGetTransactionsConfig = jest.fn().mockReturnValue({ enabled: true });
|
|
const mockResolveMemoryAvailability = jest.fn().mockResolvedValue(true);
|
|
const mockBuildAgentScopedContext = jest.fn().mockResolvedValue(new Map());
|
|
const mockBuildAgentContextAttachmentsByAgentId = jest.fn().mockReturnValue(new Map());
|
|
const mockBuildInlineMemoryContext = jest.fn().mockResolvedValue('');
|
|
const mockApplyContextToAgent = jest.fn().mockResolvedValue(undefined);
|
|
const mockCompletionUsage = {
|
|
prompt_tokens: 125,
|
|
completion_tokens: 50,
|
|
total_tokens: 175,
|
|
primary: { prompt_tokens: 100, completion_tokens: 40, total_tokens: 140 },
|
|
subagent: { prompt_tokens: 25, completion_tokens: 10, total_tokens: 35 },
|
|
};
|
|
const mockBuildCompletionUsage = jest.fn().mockReturnValue(mockCompletionUsage);
|
|
const mockInitialSessions = new Map([['execute_code', { session_id: 'seeded' }]]);
|
|
const mockGetSafeErrorMetadata = jest.fn((error) => {
|
|
const status = error?.status ?? error?.statusCode ?? error?.response?.status;
|
|
return {
|
|
type: error instanceof Error ? 'Error' : 'UnknownError',
|
|
...(Number.isInteger(status) && status >= 100 && status <= 599 && { status }),
|
|
};
|
|
});
|
|
const mockHasActivePiiPatterns = (config) =>
|
|
config != null &&
|
|
(config.starterPatterns == null ||
|
|
config.starterPatterns.length > 0 ||
|
|
(config.customPatterns?.length ?? 0) > 0);
|
|
const mockHasModelBoundContentProtection = (filters, legacyPii) => {
|
|
const sourcePolicies = [
|
|
legacyPii,
|
|
filters?.messages?.pii,
|
|
filters?.agentInstructions?.pii,
|
|
filters?.conversationStarters?.pii,
|
|
filters?.skills?.pii,
|
|
filters?.memories?.pii,
|
|
filters?.files?.pii,
|
|
filters?.toolArguments?.pii,
|
|
filters?.modelParameters?.pii,
|
|
filters?.actionMetadata?.pii,
|
|
];
|
|
if (sourcePolicies.some(mockHasActivePiiPatterns)) {
|
|
return true;
|
|
}
|
|
const filePolicy = filters?.files?.pii;
|
|
return (
|
|
filePolicy?.uninspectable === 'block' &&
|
|
(filePolicy.fields == null ||
|
|
filePolicy.fields.some((field) =>
|
|
['content', 'extracted_text', 'transcript'].includes(field),
|
|
))
|
|
);
|
|
};
|
|
class MockAgentRunEnvelopeError extends TypeError {
|
|
constructor(message) {
|
|
super(message);
|
|
this.name = 'AgentRunEnvelopeError';
|
|
}
|
|
}
|
|
const mockCreateAgentRunEnvelope = jest.fn(
|
|
({ protocol, requestId, receivedAt, principal, payload }) => ({
|
|
version: 1,
|
|
protocol,
|
|
requestId,
|
|
receivedAt,
|
|
principal: {
|
|
userId: principal.id,
|
|
...(principal.role != null && { role: principal.role }),
|
|
...(principal.tenantId != null && { tenantId: principal.tenantId }),
|
|
},
|
|
payload: JSON.parse(JSON.stringify(payload)),
|
|
}),
|
|
);
|
|
const mockBuildSkillPrimedIdsByName = jest.fn((manualSkillPrimes, alwaysApplySkillPrimes) => {
|
|
const primed = {};
|
|
for (const skill of alwaysApplySkillPrimes ?? []) {
|
|
primed[skill.name] = skill._id.toString();
|
|
}
|
|
for (const skill of manualSkillPrimes ?? []) {
|
|
primed[skill.name] = skill._id.toString();
|
|
}
|
|
return Object.keys(primed).length > 0 ? primed : undefined;
|
|
});
|
|
const mockEnrichWithSkillConfigurable = jest.fn((result) => result);
|
|
const mockBuildAgentToolContext = jest.fn(({ agent, config }) => ({
|
|
agent,
|
|
endpointTokenConfig: config.endpointTokenConfig,
|
|
toolRegistry: config.toolRegistry,
|
|
userMCPAuthMap: config.userMCPAuthMap,
|
|
tool_resources: config.tool_resources,
|
|
actionsEnabled: config.actionsEnabled,
|
|
accessibleSkillIds: config.accessibleSkillIds,
|
|
activeSkillNames: config.activeSkillNames,
|
|
codeEnvAvailable: config.codeEnvAvailable,
|
|
skillAuthoringAvailable: config.skillAuthoringAvailable,
|
|
fileAuthoringToolNames: config.fileAuthoringToolNames,
|
|
skillPrimedIdsByName:
|
|
mockBuildSkillPrimedIdsByName(config.manualSkillPrimes, config.alwaysApplySkillPrimes) ?? {},
|
|
}));
|
|
const mockEnrichLoadedToolsWithAgentContext = jest.fn(({ result, req, ctx }) =>
|
|
mockEnrichWithSkillConfigurable({
|
|
result,
|
|
context: {
|
|
req,
|
|
accessibleSkillIds: ctx.accessibleSkillIds,
|
|
codeEnvAvailable: ctx.codeEnvAvailable === true,
|
|
skillPrimedIdsByName: ctx.skillPrimedIdsByName,
|
|
activeSkillNames: ctx.activeSkillNames,
|
|
skillAuthoringAvailable: ctx.skillAuthoringAvailable === true,
|
|
fileAuthoringToolNames: ctx.fileAuthoringToolNames,
|
|
},
|
|
}),
|
|
);
|
|
const mockCanAuthorSkillFiles = jest.fn(
|
|
({ scopedEditableSkillIds = [], skillCreateAllowed }) =>
|
|
scopedEditableSkillIds.length > 0 || skillCreateAllowed === true,
|
|
);
|
|
const mockGetSkillToolDeps = jest.fn(() => ({}));
|
|
|
|
jest.mock('nanoid', () => ({
|
|
nanoid: jest.fn(() => 'mock-nanoid-123'),
|
|
}));
|
|
|
|
jest.mock('@librechat/data-schemas', () => ({
|
|
logger: {
|
|
debug: jest.fn(),
|
|
error: jest.fn(),
|
|
warn: jest.fn(),
|
|
},
|
|
}));
|
|
|
|
jest.mock('@librechat/agents', () => ({
|
|
Callback: { TOOL_ERROR: 'TOOL_ERROR' },
|
|
ToolEndHandler: jest.fn(),
|
|
formatAgentMessages: jest.fn().mockReturnValue({
|
|
messages: [],
|
|
indexTokenCountMap: {},
|
|
}),
|
|
}));
|
|
|
|
jest.mock('@librechat/api', () => ({
|
|
collectReachableAgents: (roots) => {
|
|
const agents = [];
|
|
const pending = [...roots];
|
|
const visited = new Set();
|
|
for (let index = 0; index < pending.length; index++) {
|
|
const agent = pending[index];
|
|
if (!agent || visited.has(agent)) {
|
|
continue;
|
|
}
|
|
visited.add(agent);
|
|
agents.push(agent);
|
|
pending.push(...(agent.subagentAgentConfigs ?? []));
|
|
}
|
|
return agents;
|
|
},
|
|
/** Pass-through: the controller strips UI-only activity-label parts
|
|
* before SDK formatting; the mock must expose it like any other used
|
|
* export or the call throws before the assertions run. */
|
|
stripActivityLabelParts: jest.fn((payload) => payload),
|
|
writeSSE: jest.fn(),
|
|
createRun: jest.fn().mockResolvedValue({
|
|
processStream: mockProcessStream,
|
|
}),
|
|
applyContextToAgent: (...args) => mockApplyContextToAgent(...args),
|
|
buildAgentScopedContext: (...args) => mockBuildAgentScopedContext(...args),
|
|
buildInlineMemoryContext: (...args) => mockBuildInlineMemoryContext(...args),
|
|
buildAgentContextAttachmentsByAgentId: (...args) =>
|
|
mockBuildAgentContextAttachmentsByAgentId(...args),
|
|
createChunk: jest.fn().mockReturnValue({}),
|
|
buildToolSet: jest.fn().mockReturnValue(new Set()),
|
|
buildInitialToolSessions: jest.fn().mockReturnValue(mockInitialSessions),
|
|
AgentRunEnvelopeError: MockAgentRunEnvelopeError,
|
|
createAgentRunEnvelope: (...args) => mockCreateAgentRunEnvelope(...args),
|
|
createMCPRuntimeRequestBody: ({ messageId, conversationId, parentMessageId }) => ({
|
|
messageId,
|
|
conversationId,
|
|
...(parentMessageId !== undefined && {
|
|
parentMessageId: parentMessageId ?? '00000000-0000-0000-0000-000000000000',
|
|
}),
|
|
}),
|
|
scopeSkillIds: jest.fn().mockImplementation((ids) => ids),
|
|
resolveAgentScopedSkillIds: jest
|
|
.fn()
|
|
.mockImplementation(({ accessibleSkillIds }) => accessibleSkillIds),
|
|
loadSkillStates: jest.fn().mockResolvedValue({ skillStates: {}, defaultActiveOnShare: false }),
|
|
sendFinalChunk: jest.fn(),
|
|
buildCompletionUsage: mockBuildCompletionUsage,
|
|
createSafeUser: jest.fn().mockReturnValue({ id: 'user-123' }),
|
|
validateRequest: jest
|
|
.fn()
|
|
.mockReturnValue({ request: { model: 'agent-123', messages: [], stream: false } }),
|
|
initializeAgent: jest.fn().mockResolvedValue({
|
|
id: 'agent-123',
|
|
model: 'gpt-4',
|
|
model_parameters: {},
|
|
toolRegistry: {},
|
|
edges: [],
|
|
}),
|
|
getBalanceConfig: mockGetBalanceConfig,
|
|
createErrorResponse: jest.fn(),
|
|
getTransactionsConfig: mockGetTransactionsConfig,
|
|
recordCollectedUsage: mockRecordCollectedUsage,
|
|
createSubagentUsageSink: jest.fn().mockReturnValue(jest.fn()),
|
|
resolveAgentTokenConfig: jest.fn(({ agentId, byAgentId, fallback }) =>
|
|
agentId != null && byAgentId?.has(agentId) ? byAgentId.get(agentId) : fallback,
|
|
),
|
|
extractManualSkills: jest.fn().mockReturnValue(undefined),
|
|
injectSkillPrimes: jest.fn().mockReturnValue({
|
|
initialMessages: [],
|
|
indexTokenCountMap: {},
|
|
inserted: 0,
|
|
insertIdx: -1,
|
|
alwaysApplyDropped: 0,
|
|
alwaysApplyDedupedFromManual: 0,
|
|
}),
|
|
buildNonStreamingResponse: jest.fn().mockReturnValue({ id: 'resp-123' }),
|
|
createOpenAIStreamTracker: jest.fn().mockReturnValue({
|
|
addText: jest.fn(),
|
|
addReasoning: jest.fn(),
|
|
toolCalls: new Map(),
|
|
usage: { promptTokens: 0, completionTokens: 0, reasoningTokens: 0 },
|
|
}),
|
|
createOpenAIContentAggregator: jest.fn().mockReturnValue({
|
|
addText: jest.fn(),
|
|
addReasoning: jest.fn(),
|
|
getText: jest.fn().mockReturnValue(''),
|
|
getReasoning: jest.fn().mockReturnValue(''),
|
|
toolCalls: new Map(),
|
|
usage: { promptTokens: 100, completionTokens: 50, reasoningTokens: 0 },
|
|
}),
|
|
resolveRecursionLimit: jest.fn().mockReturnValue(50),
|
|
createToolExecuteHandler: jest.fn().mockReturnValue({ handle: jest.fn() }),
|
|
isChatCompletionValidationFailure: jest.fn().mockReturnValue(false),
|
|
inspectContent: jest.fn().mockReturnValue(null),
|
|
extractMessageContent: jest.fn().mockReturnValue([]),
|
|
extractModelParameterContent: jest.fn().mockReturnValue([]),
|
|
extractSkillContent: jest.fn().mockReturnValue([]),
|
|
getBlockedOpaqueFileField: jest.fn().mockReturnValue(null),
|
|
getContentTraversalFragments: jest.fn().mockReturnValue([]),
|
|
isContentTraversalProtected: jest.fn().mockReturnValue(true),
|
|
isContentTraversalLimitError: jest.fn((error) => error?.code === 'content_filter_uninspectable'),
|
|
assertModelBoundContent: jest.fn(),
|
|
hasModelBoundContentProtection: mockHasModelBoundContentProtection,
|
|
isContentFilterError: jest.fn((error) => error?.code === 'content_filter_block'),
|
|
getSafeErrorMetadata: mockGetSafeErrorMetadata,
|
|
contentFilterBlockResponse: jest.fn().mockReturnValue({
|
|
error: 'content_filter_block',
|
|
message: 'Submitted content was blocked.',
|
|
}),
|
|
contentFilterUninspectableResponse: jest.fn().mockReturnValue({
|
|
error: 'content_filter_uninspectable',
|
|
message: 'Submitted file content could not be inspected before processing.',
|
|
source: 'file',
|
|
field: 'content',
|
|
}),
|
|
discoverConnectedAgents: jest.fn().mockResolvedValue({
|
|
agentConfigs: new Map(),
|
|
edges: [],
|
|
skippedAgentIds: new Set(),
|
|
userMCPAuthMap: undefined,
|
|
}),
|
|
resolveSubagentGraphs: jest.fn().mockResolvedValue(undefined),
|
|
}));
|
|
|
|
jest.mock('~/server/controllers/ModelController', () => ({
|
|
getModelsConfig: jest.fn().mockResolvedValue({}),
|
|
}));
|
|
|
|
jest.mock('~/server/services/MCP', () => ({
|
|
resolveConfigServers: jest.fn().mockResolvedValue({}),
|
|
}));
|
|
|
|
jest.mock('~/config', () => ({
|
|
getMCPManager: jest.fn().mockReturnValue({}),
|
|
}));
|
|
|
|
jest.mock('~/server/services/Files/permissions', () => ({
|
|
filterFilesByAgentAccess: jest.fn(),
|
|
}));
|
|
|
|
jest.mock('~/server/services/Endpoints/agents/skillDeps', () => ({
|
|
getSkillToolDeps: mockGetSkillToolDeps,
|
|
getSkillDbMethods: jest.fn(() => ({})),
|
|
canAuthorSkillFiles: mockCanAuthorSkillFiles,
|
|
withDeploymentSkillIds: jest.fn((ids = []) => ids),
|
|
enrichWithSkillConfigurable: mockEnrichWithSkillConfigurable,
|
|
buildSkillPrimedIdsByName: mockBuildSkillPrimedIdsByName,
|
|
buildAgentToolContext: mockBuildAgentToolContext,
|
|
resolveMemoryAvailability: mockResolveMemoryAvailability,
|
|
enrichLoadedToolsWithAgentContext: mockEnrichLoadedToolsWithAgentContext,
|
|
}));
|
|
|
|
jest.mock('~/cache', () => ({
|
|
logViolation: jest.fn(),
|
|
}));
|
|
|
|
jest.mock('~/server/services/ToolService', () => ({
|
|
loadAgentTools: jest.fn().mockResolvedValue([]),
|
|
loadToolsForExecution: jest.fn().mockResolvedValue([]),
|
|
isFatalAgentInitializationError: (error) =>
|
|
['AGENT_EXPECTED_MCP_TOOLS_UNAVAILABLE', 'resource_recovery_required'].includes(error?.code),
|
|
}));
|
|
|
|
const mockGetMultiplier = jest.fn().mockReturnValue(1);
|
|
const mockGetCacheMultiplier = jest.fn().mockReturnValue(null);
|
|
|
|
jest.mock('~/server/controllers/agents/callbacks', () => ({
|
|
createToolEndCallback: jest.fn().mockReturnValue(jest.fn()),
|
|
buildSummarizationHandlers: jest.fn().mockReturnValue({}),
|
|
contextualizeModelUsage: jest.fn().mockImplementation((usage) => usage),
|
|
agentLogHandlerObj: { handle: jest.fn() },
|
|
}));
|
|
|
|
jest.mock('~/server/services/PermissionService', () => ({
|
|
findAccessibleResources: jest.fn().mockResolvedValue([]),
|
|
checkPermission: jest.fn().mockResolvedValue(true),
|
|
}));
|
|
|
|
jest.mock('~/server/services/Files/strategies', () => ({
|
|
getStrategyFunctions: jest.fn().mockReturnValue({}),
|
|
}));
|
|
|
|
jest.mock('~/server/services/Files/Code/crud', () => ({
|
|
batchUploadCodeEnvFiles: jest.fn().mockResolvedValue({ session_id: '', files: [] }),
|
|
}));
|
|
|
|
jest.mock('~/server/services/Files/Code/process', () => ({
|
|
getSessionInfo: jest.fn().mockResolvedValue(null),
|
|
checkIfActive: jest.fn().mockReturnValue(false),
|
|
}));
|
|
|
|
const mockUpdateBalance = jest.fn().mockResolvedValue({});
|
|
const mockBulkInsertTransactions = jest.fn().mockResolvedValue(undefined);
|
|
|
|
jest.mock('~/models', () => ({
|
|
getAgent: jest.fn().mockResolvedValue({ id: 'agent-123', name: 'Test Agent' }),
|
|
getFiles: jest.fn(),
|
|
getUserKey: jest.fn(),
|
|
getMessages: jest.fn(),
|
|
updateFilesUsage: jest.fn(),
|
|
getUserKeyValues: jest.fn(),
|
|
getUserCodeFiles: jest.fn(),
|
|
getToolFilesByIds: jest.fn(),
|
|
getCodeGeneratedFiles: jest.fn(),
|
|
updateBalance: mockUpdateBalance,
|
|
bulkInsertTransactions: mockBulkInsertTransactions,
|
|
spendTokens: mockSpendTokens,
|
|
spendStructuredTokens: mockSpendStructuredTokens,
|
|
getMultiplier: mockGetMultiplier,
|
|
getCacheMultiplier: mockGetCacheMultiplier,
|
|
getConvoFiles: jest.fn().mockResolvedValue([]),
|
|
getFormattedMemories: jest.fn().mockResolvedValue({ withKeys: '', withoutKeys: '' }),
|
|
getConvo: jest.fn().mockResolvedValue(null),
|
|
}));
|
|
|
|
describe('OpenAIChatCompletionController', () => {
|
|
let OpenAIChatCompletionController;
|
|
let req, res;
|
|
|
|
beforeEach(() => {
|
|
jest.clearAllMocks();
|
|
|
|
const controller = require('../openai');
|
|
OpenAIChatCompletionController = controller.OpenAIChatCompletionController;
|
|
|
|
req = {
|
|
body: {
|
|
model: 'agent-123',
|
|
messages: [{ role: 'user', content: 'Hello' }],
|
|
stream: false,
|
|
},
|
|
user: { id: 'user-123' },
|
|
config: {
|
|
endpoints: {
|
|
agents: { allowedProviders: ['openAI'] },
|
|
},
|
|
},
|
|
on: jest.fn(),
|
|
};
|
|
|
|
res = {
|
|
status: jest.fn().mockReturnThis(),
|
|
json: jest.fn(),
|
|
setHeader: jest.fn(),
|
|
flushHeaders: jest.fn(),
|
|
end: jest.fn(),
|
|
write: jest.fn(),
|
|
};
|
|
});
|
|
|
|
it('resolves saved graph subagents for remote chat-completion runs', async () => {
|
|
const {
|
|
initializeAgent,
|
|
resolveSubagentGraphs,
|
|
createSubagentUsageSink,
|
|
} = require('@librechat/api');
|
|
const primaryConfig = {
|
|
id: 'agent-123',
|
|
model: 'gpt-4',
|
|
endpointTokenConfig: { 'gpt-4': { prompt: 1 } },
|
|
model_parameters: {},
|
|
toolRegistry: {},
|
|
edges: [],
|
|
subagents: {
|
|
enabled: true,
|
|
graphs: [{ type: 'team', agent_ids: ['agent-123'], edges: [] }],
|
|
},
|
|
};
|
|
initializeAgent.mockResolvedValueOnce(primaryConfig);
|
|
const memberTokenConfig = { 'custom-model': { prompt: 7 } };
|
|
const memberConfig = {
|
|
id: 'agent-graph-member',
|
|
endpointTokenConfig: memberTokenConfig,
|
|
agentContextAttachments: [{ file_id: 'member-file' }],
|
|
};
|
|
resolveSubagentGraphs.mockImplementationOnce(async ({ rootConfigs }, deps) => {
|
|
rootConfigs[0].subagentGraphConfigs = [
|
|
{ definition: { type: 'team' }, memberConfigs: [memberConfig] },
|
|
];
|
|
deps.onAgentInitialized('agent-graph-member', { id: 'agent-graph-member' }, memberConfig);
|
|
});
|
|
req.config.endpoints.agents.capabilities = ['subagents'];
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(resolveSubagentGraphs).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
primaryConfig,
|
|
rootConfigs: [primaryConfig],
|
|
resourceType: ResourceType.REMOTE_AGENT,
|
|
memoryAvailable: true,
|
|
}),
|
|
expect.objectContaining({ getAgent: expect.any(Function) }),
|
|
);
|
|
const usageParams = mockRecordCollectedUsage.mock.calls[0][1];
|
|
expect(usageParams.endpointTokenConfig).toBe(primaryConfig.endpointTokenConfig);
|
|
expect(usageParams.resolveEndpointTokenConfig({ agentId: 'agent-graph-member' })).toBe(
|
|
memberTokenConfig,
|
|
);
|
|
expect(mockResolveMemoryAvailability).toHaveBeenCalledWith(
|
|
expect.objectContaining({ enabledCapabilities: expect.any(Set), user: req.user }),
|
|
);
|
|
expect(mockBuildAgentContextAttachmentsByAgentId).toHaveBeenCalledWith([
|
|
primaryConfig,
|
|
memberConfig,
|
|
]);
|
|
expect(mockBuildAgentScopedContext).toHaveBeenCalledWith(
|
|
expect.objectContaining({ agentIds: ['agent-123', 'agent-graph-member'] }),
|
|
);
|
|
expect(mockApplyContextToAgent).toHaveBeenCalledWith(
|
|
expect.objectContaining({ agent: memberConfig, agentId: 'agent-graph-member' }),
|
|
);
|
|
expect(mockBuildInlineMemoryContext).toHaveBeenCalledWith(
|
|
expect.objectContaining({ agent: memberConfig, memoryAvailable: true }),
|
|
);
|
|
const { createRun } = require('@librechat/api');
|
|
expect(createRun).toHaveBeenCalledWith(
|
|
expect.objectContaining({ initialSessions: mockInitialSessions }),
|
|
);
|
|
expect(createSubagentUsageSink).toHaveBeenCalledWith(expect.any(Array));
|
|
});
|
|
|
|
it('uses collected usage for the non-streaming response', async () => {
|
|
const { buildNonStreamingResponse } = require('@librechat/api');
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
const collectedUsage = mockRecordCollectedUsage.mock.calls.at(-1)[1].collectedUsage;
|
|
expect(mockBuildCompletionUsage).toHaveBeenCalledWith(collectedUsage);
|
|
expect(buildNonStreamingResponse).toHaveBeenCalledWith(
|
|
expect.anything(),
|
|
expect.anything(),
|
|
expect.anything(),
|
|
expect.anything(),
|
|
mockCompletionUsage,
|
|
);
|
|
});
|
|
|
|
it('uses collected usage in the final streaming chunk', async () => {
|
|
const { validateRequest, sendFinalChunk } = require('@librechat/api');
|
|
validateRequest.mockReturnValueOnce({
|
|
request: { model: 'agent-123', messages: [], stream: true },
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(sendFinalChunk).toHaveBeenCalledWith(expect.anything(), 'stop', mockCompletionUsage);
|
|
});
|
|
|
|
describe('content filtering', () => {
|
|
it('blocks opaque inline media before text inspection or agent loading', async () => {
|
|
const api = require('@librechat/api');
|
|
const db = require('~/models');
|
|
const messages = [
|
|
{
|
|
role: 'user',
|
|
content: [
|
|
{
|
|
type: 'image_url',
|
|
image_url: { url: 'data:image/png;base64,do-not-echo' },
|
|
},
|
|
],
|
|
},
|
|
];
|
|
api.validateRequest.mockReturnValueOnce({
|
|
request: { model: 'agent-123', messages, stream: false },
|
|
});
|
|
api.getBlockedOpaqueFileField.mockReturnValueOnce('content');
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(api.getBlockedOpaqueFileField).toHaveBeenCalledWith(req.config.filters, messages);
|
|
expect(api.extractMessageContent).not.toHaveBeenCalled();
|
|
expect(db.getAgent).not.toHaveBeenCalled();
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(
|
|
'Submitted file content could not be inspected before processing.',
|
|
'invalid_request_error',
|
|
'content_filter_uninspectable',
|
|
);
|
|
expect(JSON.stringify(api.createErrorResponse.mock.calls)).not.toContain('do-not-echo');
|
|
});
|
|
|
|
it('returns a raw-free error when nested message inspection exhausts its budget', async () => {
|
|
const api = require('@librechat/api');
|
|
const db = require('~/models');
|
|
req.config.filters = { messages: { pii: { starterPatterns: [] } } };
|
|
api.extractMessageContent.mockImplementationOnce(() => {
|
|
throw {
|
|
code: 'content_filter_uninspectable',
|
|
statusCode: 400,
|
|
body: {
|
|
error: 'content_filter_uninspectable',
|
|
message: 'Submitted content could not be completely inspected before processing.',
|
|
source: 'message',
|
|
field: 'content_part',
|
|
},
|
|
};
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(db.getAgent).not.toHaveBeenCalled();
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(
|
|
'Submitted content could not be completely inspected before processing.',
|
|
'invalid_request_error',
|
|
'content_filter_uninspectable',
|
|
);
|
|
});
|
|
|
|
it('preserves field granularity when the exhausted nested field is not selected', async () => {
|
|
const api = require('@librechat/api');
|
|
const db = require('~/models');
|
|
req.config.filters = {
|
|
messages: { pii: { fields: ['text'], starterPatterns: [] } },
|
|
};
|
|
api.extractMessageContent.mockImplementationOnce(() => {
|
|
throw {
|
|
code: 'content_filter_uninspectable',
|
|
statusCode: 400,
|
|
body: {
|
|
error: 'content_filter_uninspectable',
|
|
message: 'Submitted content could not be completely inspected before processing.',
|
|
source: 'message',
|
|
field: 'content_part',
|
|
},
|
|
};
|
|
});
|
|
api.isContentTraversalProtected.mockReturnValueOnce(false);
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(db.getAgent).toHaveBeenCalled();
|
|
expect(api.createErrorResponse).not.toHaveBeenCalledWith(
|
|
expect.anything(),
|
|
'invalid_request_error',
|
|
'content_filter_uninspectable',
|
|
);
|
|
});
|
|
|
|
it('continues when exhausted model parameters are outside the active policy', async () => {
|
|
const api = require('@librechat/api');
|
|
const db = require('~/models');
|
|
api.extractModelParameterContent.mockImplementationOnce(() => {
|
|
throw {
|
|
code: 'content_filter_uninspectable',
|
|
statusCode: 400,
|
|
body: {
|
|
error: 'content_filter_uninspectable',
|
|
message: 'Submitted content could not be completely inspected before processing.',
|
|
source: 'model_parameter',
|
|
field: 'request_fields',
|
|
},
|
|
};
|
|
});
|
|
api.isContentTraversalProtected.mockReturnValueOnce(false);
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(db.getAgent).toHaveBeenCalled();
|
|
expect(api.createErrorResponse).not.toHaveBeenCalledWith(
|
|
expect.anything(),
|
|
'invalid_request_error',
|
|
'content_filter_uninspectable',
|
|
);
|
|
});
|
|
|
|
it('blocks submitted messages and model parameters before loading the agent', async () => {
|
|
const api = require('@librechat/api');
|
|
const db = require('~/models');
|
|
api.validateRequest.mockReturnValueOnce({
|
|
request: {
|
|
model: 'agent-123',
|
|
messages: [],
|
|
stream: false,
|
|
stop: ['submitted stop sequence'],
|
|
},
|
|
});
|
|
api.inspectContent.mockReturnValueOnce({
|
|
detectorId: 'pii-pattern',
|
|
ruleId: 'sk_prefix',
|
|
label: 'sk- prefix token',
|
|
source: 'model_parameter',
|
|
field: 'stop',
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(api.extractMessageContent).toHaveBeenCalled();
|
|
expect(api.extractModelParameterContent).toHaveBeenCalledWith(
|
|
expect.objectContaining({ stop: ['submitted stop sequence'] }),
|
|
);
|
|
expect(db.getAgent).not.toHaveBeenCalled();
|
|
expect(res.status).toHaveBeenCalledWith(400);
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(
|
|
'Submitted content was blocked.',
|
|
'invalid_request_error',
|
|
'content_filter_block',
|
|
);
|
|
});
|
|
|
|
it('blocks manually selected skill names before resolving the skill', async () => {
|
|
const api = require('@librechat/api');
|
|
const db = require('~/models');
|
|
req.body.manualSkills = ['PRIVATE-SKILL'];
|
|
api.extractManualSkills.mockReturnValueOnce(['PRIVATE-SKILL']);
|
|
api.inspectContent.mockReturnValueOnce({
|
|
detectorId: 'pii-pattern',
|
|
ruleId: 'private',
|
|
label: 'private value',
|
|
source: 'skill',
|
|
field: 'name',
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(api.extractSkillContent).toHaveBeenCalledWith({ name: 'PRIVATE-SKILL' });
|
|
expect(db.getAgent).not.toHaveBeenCalled();
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(
|
|
'Submitted content was blocked.',
|
|
'invalid_request_error',
|
|
'content_filter_block',
|
|
);
|
|
});
|
|
|
|
it('rejects filtered model-bound context before starting a streaming response', async () => {
|
|
const api = require('@librechat/api');
|
|
api.validateRequest.mockReturnValueOnce({
|
|
request: {
|
|
model: 'agent-123',
|
|
messages: [],
|
|
stream: true,
|
|
},
|
|
});
|
|
api.assertModelBoundContent.mockImplementationOnce(() => {
|
|
throw Object.assign(new Error('Submitted content contains a private value.'), {
|
|
code: 'content_filter_block',
|
|
statusCode: 400,
|
|
body: {
|
|
error: 'content_filter_block',
|
|
message: 'Submitted content contains a private value. Remove it and try again.',
|
|
source: 'agent_instruction',
|
|
field: 'instructions',
|
|
},
|
|
});
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(res.status).toHaveBeenCalledWith(400);
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(
|
|
'Submitted content contains a private value. Remove it and try again.',
|
|
'invalid_request_error',
|
|
'content_filter_block',
|
|
);
|
|
expect(res.setHeader).not.toHaveBeenCalled();
|
|
expect(res.flushHeaders).not.toHaveBeenCalled();
|
|
expect(api.writeSSE).not.toHaveBeenCalled();
|
|
expect(api.createRun).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('preflights file-derived content from every reachable agent under a files-only policy', async () => {
|
|
const api = require('@librechat/api');
|
|
const primaryRequestFile = { filename: 'primary-request.txt', content: 'primary request' };
|
|
const primaryContextFile = { filename: 'primary-context.txt', content: 'primary context' };
|
|
const handoffRequestFile = { filename: 'handoff-request.txt', content: 'handoff request' };
|
|
const handoffContextFile = {
|
|
filename: 'handoff-context.txt',
|
|
content: 'sk-handoff-context',
|
|
};
|
|
const nestedRequestFile = { filename: 'nested-request.txt', content: 'nested request' };
|
|
const nestedPureSubagent = {
|
|
id: 'agent-nested-pure',
|
|
model: 'gpt-4',
|
|
model_parameters: {},
|
|
requestAttachments: [nestedRequestFile],
|
|
dynamicToolContextMap: { nested_lookup: 'nested dynamic context' },
|
|
};
|
|
const pureSubagent = {
|
|
id: 'agent-pure',
|
|
model: 'gpt-4',
|
|
model_parameters: {},
|
|
subagentAgentConfigs: [nestedPureSubagent],
|
|
};
|
|
const blockedError = Object.assign(new Error('Submitted file content was blocked.'), {
|
|
code: 'content_filter_block',
|
|
statusCode: 400,
|
|
body: {
|
|
error: 'content_filter_block',
|
|
message: 'Submitted file content was blocked.',
|
|
source: 'file',
|
|
field: 'content',
|
|
},
|
|
});
|
|
req.config.filters = {
|
|
files: { pii: { fields: ['content'], starterPatterns: ['sk-'] } },
|
|
};
|
|
api.validateRequest.mockReturnValueOnce({
|
|
request: { model: 'agent-123', messages: [], stream: true },
|
|
});
|
|
api.initializeAgent.mockResolvedValueOnce({
|
|
id: 'agent-123',
|
|
model: 'gpt-4',
|
|
model_parameters: {},
|
|
toolRegistry: {},
|
|
edges: [{ source: 'agent-123', target: 'agent-handoff' }],
|
|
requestAttachments: [primaryRequestFile],
|
|
agentContextAttachments: [primaryContextFile],
|
|
dynamicToolContextMap: { execute_code: 'primary dynamic context' },
|
|
subagentAgentConfigs: [pureSubagent],
|
|
});
|
|
api.discoverConnectedAgents.mockResolvedValueOnce({
|
|
agentConfigs: new Map([
|
|
[
|
|
'agent-handoff',
|
|
{
|
|
id: 'agent-handoff',
|
|
model: 'gpt-4',
|
|
model_parameters: {},
|
|
requestAttachments: [handoffRequestFile],
|
|
agentContextAttachments: [handoffContextFile],
|
|
dynamicToolContextMap: { file_search: 'handoff dynamic context' },
|
|
},
|
|
],
|
|
]),
|
|
edges: [],
|
|
skippedAgentIds: new Set(),
|
|
userMCPAuthMap: undefined,
|
|
});
|
|
api.assertModelBoundContent.mockImplementationOnce(({ filters, agents, files }) => {
|
|
expect(filters).toEqual(req.config.filters);
|
|
expect(agents.map(({ id }) => id)).toEqual([
|
|
'agent-123',
|
|
'agent-handoff',
|
|
'agent-pure',
|
|
'agent-nested-pure',
|
|
]);
|
|
expect(files).toEqual([
|
|
primaryRequestFile,
|
|
primaryContextFile,
|
|
{ content: 'primary dynamic context' },
|
|
handoffRequestFile,
|
|
handoffContextFile,
|
|
{ content: 'handoff dynamic context' },
|
|
nestedRequestFile,
|
|
{ content: 'nested dynamic context' },
|
|
]);
|
|
throw blockedError;
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(api.createRun).not.toHaveBeenCalled();
|
|
expect(res.setHeader).not.toHaveBeenCalled();
|
|
expect(res.flushHeaders).not.toHaveBeenCalled();
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(
|
|
blockedError.body.message,
|
|
'invalid_request_error',
|
|
'content_filter_block',
|
|
);
|
|
});
|
|
|
|
it('preflights the exact synthesized dynamic tool context as file content', async () => {
|
|
const api = require('@librechat/api');
|
|
const blockedError = Object.assign(new Error('Submitted file content was blocked.'), {
|
|
code: 'content_filter_block',
|
|
statusCode: 400,
|
|
body: {
|
|
error: 'content_filter_block',
|
|
message: 'Submitted file content was blocked.',
|
|
source: 'file',
|
|
field: 'content',
|
|
},
|
|
});
|
|
req.config.filters = {
|
|
files: { pii: { fields: ['content'], starterPatterns: ['sk-'] } },
|
|
};
|
|
api.validateRequest.mockReturnValueOnce({
|
|
request: { model: 'agent-123', messages: [], stream: true },
|
|
});
|
|
api.initializeAgent.mockResolvedValueOnce({
|
|
id: 'agent-123',
|
|
model: 'gpt-4',
|
|
model_parameters: {},
|
|
toolRegistry: {},
|
|
edges: [],
|
|
dynamicToolContextMap: {
|
|
execute_code: ' safe context',
|
|
ignored_empty: '',
|
|
file_search: 'sk-dynamic-file-context ',
|
|
ignored_non_string: 42,
|
|
},
|
|
});
|
|
api.assertModelBoundContent.mockImplementationOnce(({ filters, files }) => {
|
|
expect(filters).toEqual(req.config.filters);
|
|
expect(files).toEqual([{ content: 'safe context\nsk-dynamic-file-context' }]);
|
|
throw blockedError;
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(api.createRun).not.toHaveBeenCalled();
|
|
expect(res.setHeader).not.toHaveBeenCalled();
|
|
expect(res.flushHeaders).not.toHaveBeenCalled();
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(
|
|
blockedError.body.message,
|
|
'invalid_request_error',
|
|
'content_filter_block',
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('safe error logging', () => {
|
|
it('logs bounded metadata and returns a raw-free provider error', async () => {
|
|
const api = require('@librechat/api');
|
|
const { logger } = require('@librechat/data-schemas');
|
|
const rawValue = 'PRIVATE-OPENAI-PROVIDER-PAYLOAD';
|
|
const providerError = Object.assign(new Error(`Provider echoed ${rawValue}`), {
|
|
code: 'ERR_REMOTE',
|
|
response: {
|
|
status: 502,
|
|
headers: { authorization: rawValue },
|
|
data: { prompt: rawValue },
|
|
},
|
|
});
|
|
req.config.filters = { messages: { pii: {} } };
|
|
mockProcessStream.mockRejectedValueOnce(providerError);
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(mockGetSafeErrorMetadata).toHaveBeenCalledWith(providerError);
|
|
const errorLog = logger.error.mock.calls.find(
|
|
([message]) => message === '[OpenAI API] Error:',
|
|
);
|
|
expect(errorLog).toEqual(['[OpenAI API] Error:', { type: 'Error', status: 502 }]);
|
|
expect(JSON.stringify(errorLog)).not.toContain(rawValue);
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(
|
|
'An error occurred while processing the request',
|
|
'server_error',
|
|
null,
|
|
);
|
|
expect(JSON.stringify(api.createErrorResponse.mock.calls)).not.toContain(rawValue);
|
|
expect(res.status).toHaveBeenCalledWith(500);
|
|
});
|
|
|
|
it('streams a raw-free provider error after headers are sent', async () => {
|
|
const api = require('@librechat/api');
|
|
const rawValue = 'PRIVATE-OPENAI-STREAM-PAYLOAD';
|
|
api.validateRequest.mockReturnValueOnce({
|
|
request: {
|
|
model: 'agent-123',
|
|
messages: [{ role: 'user', content: 'Hello' }],
|
|
stream: true,
|
|
},
|
|
});
|
|
req.config.filters = { messages: { pii: {} } };
|
|
res.flushHeaders.mockImplementationOnce(() => {
|
|
res.headersSent = true;
|
|
});
|
|
mockProcessStream.mockRejectedValueOnce(new Error(`Provider echoed ${rawValue}`));
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(api.createChunk).toHaveBeenCalledWith(
|
|
expect.any(Object),
|
|
{ content: '\n\nError: An error occurred while processing the request' },
|
|
'stop',
|
|
);
|
|
expect(JSON.stringify(api.createChunk.mock.calls)).not.toContain(rawValue);
|
|
expect(JSON.stringify(api.writeSSE.mock.calls)).not.toContain(rawValue);
|
|
});
|
|
|
|
it('preserves the legacy provider error when protection is inactive', async () => {
|
|
const api = require('@librechat/api');
|
|
const rawValue = 'LEGACY-OPENAI-PROVIDER-ERROR';
|
|
mockProcessStream.mockRejectedValueOnce(
|
|
Object.assign(new Error(rawValue), { code: 'ERR_LEGACY_REMOTE' }),
|
|
);
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(
|
|
rawValue,
|
|
'server_error',
|
|
'ERR_LEGACY_REMOTE',
|
|
);
|
|
});
|
|
|
|
it.each([
|
|
['a management-only prompt', { prompts: { pii: {} } }],
|
|
['an inert message', { messages: { pii: { starterPatterns: [] } } }],
|
|
])('preserves the legacy provider error for %s policy', async (_policy, filters) => {
|
|
const api = require('@librechat/api');
|
|
const rawValue = 'LEGACY-OPENAI-CONFIGURED-PROVIDER-ERROR';
|
|
req.config.filters = filters;
|
|
mockProcessStream.mockRejectedValueOnce(new Error(rawValue));
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(api.createErrorResponse).toHaveBeenCalledWith(rawValue, 'server_error', null);
|
|
});
|
|
|
|
it('preserves the legacy streamed provider error when protection is inactive', async () => {
|
|
const api = require('@librechat/api');
|
|
const rawValue = 'LEGACY-OPENAI-STREAM-ERROR';
|
|
api.validateRequest.mockReturnValueOnce({
|
|
request: {
|
|
model: 'agent-123',
|
|
messages: [{ role: 'user', content: 'Hello' }],
|
|
stream: true,
|
|
},
|
|
});
|
|
res.flushHeaders.mockImplementationOnce(() => {
|
|
res.headersSent = true;
|
|
});
|
|
mockProcessStream.mockRejectedValueOnce(new Error(rawValue));
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(api.createChunk).toHaveBeenCalledWith(
|
|
expect.any(Object),
|
|
{ content: `\n\nError: ${rawValue}` },
|
|
'stop',
|
|
);
|
|
});
|
|
|
|
it('logs bounded metadata for tool callback failures', async () => {
|
|
const { logger } = require('@librechat/data-schemas');
|
|
const rawValue = 'PRIVATE-OPENAI-TOOL-PAYLOAD';
|
|
const toolError = Object.assign(new Error(`Tool echoed ${rawValue}`), {
|
|
code: 'ERR_TOOL',
|
|
response: { status: 422, data: { output: rawValue } },
|
|
});
|
|
mockProcessStream.mockImplementationOnce(async (_input, _config, options) => {
|
|
options.callbacks.TOOL_ERROR({}, toolError, 'execute_code');
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(mockGetSafeErrorMetadata).toHaveBeenCalledWith(toolError);
|
|
const errorLog = logger.error.mock.calls.find(([message]) =>
|
|
message.includes('Tool Error "execute_code"'),
|
|
);
|
|
expect(errorLog).toEqual([
|
|
'[OpenAI API] Tool Error "execute_code"',
|
|
{ type: 'Error', status: 422 },
|
|
]);
|
|
expect(JSON.stringify(errorLog)).not.toContain(rawValue);
|
|
});
|
|
});
|
|
|
|
describe('conversation ownership validation', () => {
|
|
it('should skip ownership check when conversation_id is not provided', async () => {
|
|
const { getConvo } = require('~/models');
|
|
await OpenAIChatCompletionController(req, res);
|
|
expect(getConvo).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should return 400 when conversation_id is not a string', async () => {
|
|
const { validateRequest } = require('@librechat/api');
|
|
validateRequest.mockReturnValueOnce({
|
|
request: { model: 'agent-123', messages: [], stream: false, conversation_id: { $gt: '' } },
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
expect(res.status).toHaveBeenCalledWith(400);
|
|
});
|
|
|
|
it('should return 404 when conversation is not owned by user', async () => {
|
|
const { validateRequest } = require('@librechat/api');
|
|
const { getConvo } = require('~/models');
|
|
validateRequest.mockReturnValueOnce({
|
|
request: {
|
|
model: 'agent-123',
|
|
messages: [],
|
|
stream: false,
|
|
conversation_id: 'convo-abc',
|
|
},
|
|
});
|
|
getConvo.mockResolvedValueOnce(null);
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
expect(getConvo).toHaveBeenCalledWith('user-123', 'convo-abc');
|
|
expect(res.status).toHaveBeenCalledWith(404);
|
|
});
|
|
|
|
it('should proceed when conversation is owned by user', async () => {
|
|
const { validateRequest } = require('@librechat/api');
|
|
const { getConvo } = require('~/models');
|
|
validateRequest.mockReturnValueOnce({
|
|
request: {
|
|
model: 'agent-123',
|
|
messages: [],
|
|
stream: false,
|
|
conversation_id: 'convo-abc',
|
|
},
|
|
});
|
|
getConvo.mockResolvedValueOnce({ conversationId: 'convo-abc', user: 'user-123' });
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
expect(getConvo).toHaveBeenCalledWith('user-123', 'convo-abc');
|
|
expect(res.status).not.toHaveBeenCalledWith(404);
|
|
});
|
|
|
|
it('should return 500 when getConvo throws a DB error', async () => {
|
|
const { validateRequest } = require('@librechat/api');
|
|
const { getConvo } = require('~/models');
|
|
validateRequest.mockReturnValueOnce({
|
|
request: {
|
|
model: 'agent-123',
|
|
messages: [],
|
|
stream: false,
|
|
conversation_id: 'convo-abc',
|
|
},
|
|
});
|
|
getConvo.mockRejectedValueOnce(new Error('DB connection failed'));
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
expect(res.status).toHaveBeenCalledWith(500);
|
|
});
|
|
});
|
|
|
|
describe('remote-agent file authorization', () => {
|
|
it('threads the remote-agent permission boundary through initialization and tool loading', async () => {
|
|
const { initializeAgent, createToolExecuteHandler } = require('@librechat/api');
|
|
const { loadAgentTools, loadToolsForExecution } = require('~/server/services/ToolService');
|
|
const { filterFilesByAgentAccess } = require('~/server/services/Files/permissions');
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
const [initializeParams, dbMethods] = initializeAgent.mock.calls.at(-1);
|
|
const filterParams = {
|
|
files: [{ file_id: 'owner-file', user: 'agent-owner' }],
|
|
userId: 'user-123',
|
|
role: 'USER',
|
|
agentId: 'agent-123',
|
|
};
|
|
await dbMethods.filterFilesByAgentAccess(filterParams);
|
|
expect(filterFilesByAgentAccess).toHaveBeenLastCalledWith({
|
|
...filterParams,
|
|
resourceType: ResourceType.REMOTE_AGENT,
|
|
});
|
|
|
|
await initializeParams.loadTools({
|
|
agentId: 'agent-123',
|
|
tools: ['file_search'],
|
|
provider: 'openAI',
|
|
model: 'gpt-4',
|
|
tool_resources: { file_search: { file_ids: ['owner-file'] } },
|
|
});
|
|
expect(loadAgentTools).toHaveBeenLastCalledWith(
|
|
expect.objectContaining({ agentResourceType: ResourceType.REMOTE_AGENT }),
|
|
);
|
|
|
|
const toolExecuteOptions = createToolExecuteHandler.mock.calls.at(-1)[0];
|
|
await toolExecuteOptions.loadTools(['file_search'], 'agent-123');
|
|
expect(loadToolsForExecution).toHaveBeenLastCalledWith(
|
|
expect.objectContaining({
|
|
agentResourceType: ResourceType.REMOTE_AGENT,
|
|
requestBody: initializeParams.requestBody,
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('returns 503 when an agent expects MCP tools but resolves none', async () => {
|
|
const { initializeAgent } = require('@librechat/api');
|
|
const { loadAgentTools } = require('~/server/services/ToolService');
|
|
const toolError = Object.assign(new Error('Expected MCP tools are unavailable'), {
|
|
code: 'AGENT_EXPECTED_MCP_TOOLS_UNAVAILABLE',
|
|
status: 503,
|
|
statusCode: 503,
|
|
});
|
|
loadAgentTools.mockRejectedValueOnce(toolError);
|
|
initializeAgent.mockImplementationOnce(async ({ req, res, loadTools, agent }) => {
|
|
await loadTools({
|
|
req,
|
|
res,
|
|
tools: ['run_query_mcp_warehouse'],
|
|
model: agent.model,
|
|
agentId: agent.id,
|
|
provider: agent.provider,
|
|
});
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(res.status).toHaveBeenCalledWith(503);
|
|
});
|
|
|
|
it('returns the resource recovery status and code before model invocation', async () => {
|
|
const { createErrorResponse, initializeAgent } = require('@librechat/api');
|
|
const { loadAgentTools } = require('~/server/services/ToolService');
|
|
const toolError = Object.assign(new Error('resource recovery required'), {
|
|
code: ErrorTypes.RESOURCE_RECOVERY_REQUIRED,
|
|
status: 409,
|
|
statusCode: 409,
|
|
});
|
|
loadAgentTools.mockRejectedValueOnce(toolError);
|
|
initializeAgent.mockImplementationOnce(async ({ req, res, loadTools, agent }) => {
|
|
await loadTools({
|
|
req,
|
|
res,
|
|
tools: ['execute_code'],
|
|
model: agent.model,
|
|
agentId: agent.id,
|
|
provider: agent.provider,
|
|
});
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(res.status).toHaveBeenCalledWith(409);
|
|
expect(createErrorResponse).toHaveBeenCalledWith(
|
|
'resource recovery required',
|
|
'invalid_request_error',
|
|
ErrorTypes.RESOURCE_RECOVERY_REQUIRED,
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('execution envelope', () => {
|
|
it('creates the portable run input before agent initialization', async () => {
|
|
req.user = {
|
|
id: 'user-123',
|
|
role: 'USER',
|
|
tenantId: 'tenant-123',
|
|
federatedTokens: { access_token: 'secret' },
|
|
};
|
|
const requestBody = {
|
|
...req.body,
|
|
ephemeralAgent: { skills: true },
|
|
manualSkills: ['review-code'],
|
|
timezone: 'America/New_York',
|
|
};
|
|
req.body = requestBody;
|
|
const { validateRequest, initializeAgent } = require('@librechat/api');
|
|
validateRequest.mockReturnValueOnce({ request: requestBody });
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(mockCreateAgentRunEnvelope).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
protocol: 'chat.completions',
|
|
principal: req.user,
|
|
payload: requestBody,
|
|
requestId: expect.any(String),
|
|
receivedAt: expect.any(Number),
|
|
}),
|
|
);
|
|
expect(mockCreateAgentRunEnvelope.mock.invocationCallOrder[0]).toBeLessThan(
|
|
initializeAgent.mock.invocationCallOrder[0],
|
|
);
|
|
expect(req.body).not.toBe(requestBody);
|
|
expect(req.body).toEqual(requestBody);
|
|
expect(JSON.stringify(mockCreateAgentRunEnvelope.mock.results[0].value)).not.toContain(
|
|
'secret',
|
|
);
|
|
});
|
|
|
|
it('returns a protocol 400 when the envelope rejects a non-JSON payload', async () => {
|
|
const message = 'payload.max_tokens must contain only finite numbers';
|
|
const { createErrorResponse, initializeAgent } = require('@librechat/api');
|
|
mockCreateAgentRunEnvelope.mockImplementationOnce(() => {
|
|
throw new MockAgentRunEnvelopeError(message);
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(res.status).toHaveBeenCalledWith(400);
|
|
expect(createErrorResponse).toHaveBeenCalledWith(message, 'invalid_request_error', null);
|
|
expect(initializeAgent).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe('token usage recording', () => {
|
|
it('should call recordCollectedUsage after successful non-streaming completion', async () => {
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(mockRecordCollectedUsage).toHaveBeenCalledTimes(1);
|
|
expect(mockRecordCollectedUsage).toHaveBeenCalledWith(
|
|
{
|
|
spendTokens: mockSpendTokens,
|
|
spendStructuredTokens: mockSpendStructuredTokens,
|
|
pricing: { getMultiplier: mockGetMultiplier, getCacheMultiplier: mockGetCacheMultiplier },
|
|
bulkWriteOps: {
|
|
insertMany: mockBulkInsertTransactions,
|
|
updateBalance: mockUpdateBalance,
|
|
},
|
|
},
|
|
expect.objectContaining({
|
|
user: 'user-123',
|
|
conversationId: expect.any(String),
|
|
collectedUsage: expect.any(Array),
|
|
context: 'message',
|
|
balance: { enabled: true },
|
|
transactions: { enabled: true },
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('should pass balance and transactions config to recordCollectedUsage', async () => {
|
|
mockGetBalanceConfig.mockReturnValue({ enabled: true, startBalance: 1000 });
|
|
mockGetTransactionsConfig.mockReturnValue({ enabled: true, rateLimit: 100 });
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(mockRecordCollectedUsage).toHaveBeenCalledWith(
|
|
expect.any(Object),
|
|
expect.objectContaining({
|
|
balance: { enabled: true, startBalance: 1000 },
|
|
transactions: { enabled: true, rateLimit: 100 },
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('should pass spendTokens, spendStructuredTokens, pricing, and bulkWriteOps as dependencies', async () => {
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
const [deps] = mockRecordCollectedUsage.mock.calls[0];
|
|
expect(deps).toHaveProperty('spendTokens', mockSpendTokens);
|
|
expect(deps).toHaveProperty('spendStructuredTokens', mockSpendStructuredTokens);
|
|
expect(deps).toHaveProperty('pricing');
|
|
expect(deps.pricing).toHaveProperty('getMultiplier', mockGetMultiplier);
|
|
expect(deps.pricing).toHaveProperty('getCacheMultiplier', mockGetCacheMultiplier);
|
|
expect(deps).toHaveProperty('bulkWriteOps');
|
|
expect(deps.bulkWriteOps).toHaveProperty('insertMany', mockBulkInsertTransactions);
|
|
expect(deps.bulkWriteOps).toHaveProperty('updateBalance', mockUpdateBalance);
|
|
});
|
|
|
|
it('should include model from primaryConfig in recordCollectedUsage params', async () => {
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(mockRecordCollectedUsage).toHaveBeenCalledWith(
|
|
expect.any(Object),
|
|
expect.objectContaining({
|
|
model: 'gpt-4',
|
|
}),
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('recursionLimit resolution', () => {
|
|
it('threads the OpenAI parent message id through both MCP execution bodies', async () => {
|
|
const { validateRequest, createRun, initializeAgent } = require('@librechat/api');
|
|
const { getConvo } = require('~/models');
|
|
validateRequest.mockReturnValueOnce({
|
|
request: {
|
|
model: 'agent-123',
|
|
messages: [],
|
|
stream: false,
|
|
conversation_id: 'conversation-123',
|
|
parent_message_id: 'parent-123',
|
|
},
|
|
});
|
|
getConvo.mockResolvedValueOnce({ conversationId: 'conversation-123', user: 'user-123' });
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(initializeAgent).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
requestBody: {
|
|
messageId: 'chatcmpl-mock-nanoid-123',
|
|
conversationId: 'conversation-123',
|
|
parentMessageId: 'parent-123',
|
|
},
|
|
}),
|
|
expect.anything(),
|
|
);
|
|
expect(createRun).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
requestBody: {
|
|
messageId: 'chatcmpl-mock-nanoid-123',
|
|
conversationId: 'conversation-123',
|
|
parentMessageId: 'parent-123',
|
|
},
|
|
}),
|
|
);
|
|
expect(mockProcessStream).toHaveBeenCalledWith(
|
|
expect.anything(),
|
|
expect.objectContaining({
|
|
configurable: expect.objectContaining({
|
|
requestBody: {
|
|
messageId: 'chatcmpl-mock-nanoid-123',
|
|
conversationId: 'conversation-123',
|
|
parentMessageId: 'parent-123',
|
|
},
|
|
}),
|
|
}),
|
|
expect.anything(),
|
|
);
|
|
});
|
|
|
|
it('does not synthesize an MCP parent for a continuation that omits it', async () => {
|
|
const { validateRequest, initializeAgent } = require('@librechat/api');
|
|
const { getConvo } = require('~/models');
|
|
validateRequest.mockReturnValueOnce({
|
|
request: {
|
|
model: 'agent-123',
|
|
messages: [],
|
|
stream: false,
|
|
conversation_id: 'conversation-123',
|
|
},
|
|
});
|
|
getConvo.mockResolvedValueOnce({ conversationId: 'conversation-123', user: 'user-123' });
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
const requestBody = initializeAgent.mock.calls.at(-1)[0].requestBody;
|
|
expect(requestBody).toEqual({
|
|
messageId: 'chatcmpl-mock-nanoid-123',
|
|
conversationId: 'conversation-123',
|
|
});
|
|
expect(requestBody).not.toHaveProperty('parentMessageId');
|
|
});
|
|
|
|
it('should pass resolveRecursionLimit result to processStream config', async () => {
|
|
const { resolveRecursionLimit } = require('@librechat/api');
|
|
resolveRecursionLimit.mockReturnValueOnce(75);
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(mockProcessStream).toHaveBeenCalledWith(
|
|
expect.anything(),
|
|
expect.objectContaining({ recursionLimit: 75 }),
|
|
expect.anything(),
|
|
);
|
|
});
|
|
|
|
it('should call resolveRecursionLimit with agentsEConfig and agent', async () => {
|
|
const { resolveRecursionLimit } = require('@librechat/api');
|
|
const { getAgent } = require('~/models');
|
|
const mockAgent = { id: 'agent-123', name: 'Test', recursion_limit: 200 };
|
|
getAgent.mockResolvedValueOnce(mockAgent);
|
|
|
|
req.config = {
|
|
endpoints: {
|
|
agents: { recursionLimit: 100, maxRecursionLimit: 150, allowedProviders: [] },
|
|
},
|
|
};
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
expect(resolveRecursionLimit).toHaveBeenCalledWith(req.config.endpoints.agents, mockAgent);
|
|
});
|
|
});
|
|
|
|
describe('sub-agent skill priming', () => {
|
|
it('passes the sub-agent primed skill IDs into tool execution', async () => {
|
|
const {
|
|
initializeAgent,
|
|
discoverConnectedAgents,
|
|
createToolExecuteHandler,
|
|
} = require('@librechat/api');
|
|
const { loadToolsForExecution } = require('~/server/services/ToolService');
|
|
const subAgent = { id: 'agent-sub', name: 'Sub Agent' };
|
|
const subConfig = {
|
|
id: 'agent-sub',
|
|
model: 'gpt-4',
|
|
model_parameters: {},
|
|
toolRegistry: new Map(),
|
|
userMCPAuthMap: { sub: { token: 'sub-token' } },
|
|
tool_resources: { code_interpreter: { file_ids: ['sub-file'] } },
|
|
actionsEnabled: true,
|
|
accessibleSkillIds: ['sub-skill-id'],
|
|
activeSkillNames: ['sub-hidden-skill'],
|
|
codeEnvAvailable: true,
|
|
skillAuthoringAvailable: true,
|
|
fileAuthoringToolNames: ['create_file', 'edit_file'],
|
|
manualSkillPrimes: [{ name: 'sub-hidden-skill', _id: { toString: () => 'sub-manual-id' } }],
|
|
alwaysApplySkillPrimes: [
|
|
{ name: 'sub-always-skill', _id: { toString: () => 'sub-always-id' } },
|
|
],
|
|
};
|
|
|
|
initializeAgent.mockResolvedValueOnce({
|
|
id: 'agent-123',
|
|
model: 'gpt-4',
|
|
model_parameters: {},
|
|
toolRegistry: new Map(),
|
|
edges: [{ source: 'agent-123', target: 'agent-sub' }],
|
|
accessibleSkillIds: ['primary-skill-id'],
|
|
activeSkillNames: ['primary-skill'],
|
|
codeEnvAvailable: false,
|
|
skillAuthoringAvailable: false,
|
|
fileAuthoringToolNames: [],
|
|
manualSkillPrimes: [{ name: 'primary-skill', _id: { toString: () => 'primary-skill-id' } }],
|
|
});
|
|
discoverConnectedAgents.mockImplementationOnce(async (_params, deps) => {
|
|
deps.onAgentInitialized('agent-sub', subAgent, subConfig);
|
|
return {
|
|
agentConfigs: new Map([['agent-sub', subConfig]]),
|
|
edges: [],
|
|
skippedAgentIds: new Set(),
|
|
userMCPAuthMap: undefined,
|
|
};
|
|
});
|
|
|
|
await OpenAIChatCompletionController(req, res);
|
|
|
|
const toolExecuteOptions = createToolExecuteHandler.mock.calls.at(-1)[0];
|
|
await toolExecuteOptions.loadTools(['read_file'], 'agent-sub');
|
|
|
|
expect(loadToolsForExecution).toHaveBeenLastCalledWith(
|
|
expect.objectContaining({
|
|
agent: subAgent,
|
|
toolRegistry: subConfig.toolRegistry,
|
|
userMCPAuthMap: subConfig.userMCPAuthMap,
|
|
tool_resources: subConfig.tool_resources,
|
|
actionsEnabled: true,
|
|
}),
|
|
);
|
|
expect(mockEnrichWithSkillConfigurable).toHaveBeenLastCalledWith({
|
|
result: expect.anything(),
|
|
context: {
|
|
req,
|
|
accessibleSkillIds: ['sub-skill-id'],
|
|
codeEnvAvailable: true,
|
|
skillPrimedIdsByName: {
|
|
'sub-always-skill': 'sub-always-id',
|
|
'sub-hidden-skill': 'sub-manual-id',
|
|
},
|
|
activeSkillNames: ['sub-hidden-skill'],
|
|
skillAuthoringAvailable: true,
|
|
fileAuthoringToolNames: ['create_file', 'edit_file'],
|
|
},
|
|
});
|
|
});
|
|
});
|
|
});
|