mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 00:40:14 +01:00
* feat: Add granular role-based permissions system with Entra ID integration
- Implement RBAC with viewer/editor/owner roles using bitwise permissions
- Add AccessRole, AclEntry, and Group models for permission management
- Create PermissionService for core permission logic and validation
- Integrate Microsoft Graph API for Entra ID user/group search
- Add middleware for resource access validation with custom ID resolvers
- Implement bulk permission updates with transaction support
- Create permission management UI with people picker and role selection
- Add public sharing capabilities for resources
- Include database migration for existing agent ownership
- Support hybrid local/Entra ID identity management
- Add comprehensive test coverage for all new services
chore: Update @librechat/data-schemas to version 0.0.9 and export common module in index.ts
fix: Update userGroup tests to mock logger correctly and change principalId expectation from null to undefined
* fix(data-schemas): use partial index for group idOnTheSource uniqueness
Replace sparse index with partial filter expression to allow multiple local groups
while maintaining unique constraint for external source IDs. The sparse option
on compound indexes doesn't work as expected when one field is always present.
* fix: imports in migrate-agent-permissions.js
* chore(data-schemas): add comprehensive README for data schemas package
- Introduced a detailed README.md file outlining the structure, architecture patterns, and best practices for the LibreChat Data Schemas package.
- Included guidelines for creating new entities, type definitions, schema files, model factory functions, and database methods.
- Added examples and common patterns to enhance understanding and usage of the package.
* chore: remove unused translation keys from localization file
* ci: fix existing tests based off new permission handling
- Renamed test cases to reflect changes in permission checks being handled at the route level.
- Updated assertions to verify that agents are returned regardless of user permissions due to the new permission system.
- Adjusted mocks in AppService and PermissionService tests to ensure proper functionality without relying on actual implementations.
* ci: add unit tests for access control middleware
- Introduced tests for the `canAccessAgentResource` middleware to validate permission checks for agent resources.
- Implemented tests for various scenarios including user roles, ACL entries, and permission levels.
- Added tests for the `checkAccess` function to ensure proper permission handling based on user roles and permissions.
- Utilized MongoDB in-memory server for isolated test environments.
* refactor: remove unused mocks from GraphApiService tests
* ci: enhance AgentFooter tests with improved mocks and permission handling
- Updated mocks for `useWatch`, `useAuthContext`, `useHasAccess`, and `useResourcePermissions` to streamline test setup.
- Adjusted assertions to reflect changes in UI based on agent ID and user roles.
- Replaced `share-agent` component with `grant-access-dialog` in tests to align with recent UI updates.
- Added tests for handling null agent data and permissions loading scenarios.
* ci: enhance GraphApiService tests with MongoDB in-memory server
- Updated test setup to use MongoDB in-memory server for isolated testing.
- Refactored beforeEach to beforeAll for database connection management.
- Cleared database before each test to ensure a clean state.
- Retained existing mocks while improving test structure for better clarity.
* ci: enhance GraphApiService tests with additional logger mocks
- Added mock implementation for logger methods in GraphApiService tests to improve error and debug logging during test execution.
- Ensured existing mocks remain intact while enhancing test coverage and clarity.
* chore: address ESLint Warnings
* - add cursor-based pagination to getListAgentsByAccess and update handler
- add index on updatedAt and _id in agent schema for improved query performance
* refactor permission service with reuse of model methods from data-schema package
* - Fix ObjectId comparison in getListAgentsHandler using .equals() method instead of strict equality
- Add findPubliclyAccessibleResources function to PermissionService for bulk public resource queries
- Add hasPublicPermission function to PermissionService for individual resource public permission checks
- Update getAgentHandler to use hasPublicPermission for accurate individual agent public status
- Replace instanceProjectId-based global checks with isPublic property from backend in client code
- Add isPublic property to Agent type definition
- Add NODE_TLS_REJECT_UNAUTHORIZED debug setting to VS Code launch config
* feat: add check for People.Read scope in searchContacts
* fix: add roleId parameter to grantPermission and update tests for GraphApiService
* refactor: remove problematic projection pipelines in getResourcePermissions for document db aws compatibility
* feat: enhance agent permissions migration with DocumentDB compatibility and add dry-run script
* feat: add support for including Entra ID group owners as members in permissions management + fix Group members paging
* feat: enforce at least one owner requirement for permission updates and add corresponding localization messages
* refactor: remove German locale (must be added via i18n)
* chore: linting in `api/models/Agent.js` and removed unused variables
* chore: linting, remove unused vars, and remove project-related parameters from `updateAgentHandler`
* chore: address ESLint errors
* chore: revert removal of unused vars for versioning
---------
Co-authored-by: Atef Bellaaj <slalom.bellaaj@external.daimlertruck.com>
761 lines
24 KiB
JavaScript
761 lines
24 KiB
JavaScript
const {
|
|
FileSources,
|
|
EModelEndpoint,
|
|
EImageOutputType,
|
|
AgentCapabilities,
|
|
defaultSocialLogins,
|
|
validateAzureGroups,
|
|
defaultAgentCapabilities,
|
|
deprecatedAzureVariables,
|
|
conflictingAzureVariables,
|
|
} = require('librechat-data-provider');
|
|
|
|
const AppService = require('./AppService');
|
|
|
|
jest.mock('./Config/loadCustomConfig', () => {
|
|
return jest.fn(() =>
|
|
Promise.resolve({
|
|
registration: { socialLogins: ['testLogin'] },
|
|
fileStrategy: 'testStrategy',
|
|
balance: {
|
|
enabled: true,
|
|
},
|
|
}),
|
|
);
|
|
});
|
|
jest.mock('./Files/Firebase/initialize', () => ({
|
|
initializeFirebase: jest.fn(),
|
|
}));
|
|
jest.mock('~/models', () => ({
|
|
initializeRoles: jest.fn(),
|
|
seedDefaultRoles: jest.fn(),
|
|
}));
|
|
jest.mock('~/models/Role', () => ({
|
|
updateAccessPermissions: jest.fn(),
|
|
}));
|
|
jest.mock('./Config', () => ({
|
|
setCachedTools: jest.fn(),
|
|
getCachedTools: jest.fn().mockResolvedValue({
|
|
ExampleTool: {
|
|
type: 'function',
|
|
function: {
|
|
description: 'Example tool function',
|
|
name: 'exampleFunction',
|
|
parameters: {
|
|
type: 'object',
|
|
properties: {
|
|
param1: { type: 'string', description: 'An example parameter' },
|
|
},
|
|
required: ['param1'],
|
|
},
|
|
},
|
|
},
|
|
}),
|
|
}));
|
|
jest.mock('./ToolService', () => ({
|
|
loadAndFormatTools: jest.fn().mockReturnValue({
|
|
ExampleTool: {
|
|
type: 'function',
|
|
function: {
|
|
description: 'Example tool function',
|
|
name: 'exampleFunction',
|
|
parameters: {
|
|
type: 'object',
|
|
properties: {
|
|
param1: { type: 'string', description: 'An example parameter' },
|
|
},
|
|
required: ['param1'],
|
|
},
|
|
},
|
|
},
|
|
}),
|
|
}));
|
|
jest.mock('./start/turnstile', () => ({
|
|
loadTurnstileConfig: jest.fn(() => ({
|
|
siteKey: 'default-site-key',
|
|
options: {},
|
|
})),
|
|
}));
|
|
|
|
const azureGroups = [
|
|
{
|
|
group: 'librechat-westus',
|
|
apiKey: '${WESTUS_API_KEY}',
|
|
instanceName: 'librechat-westus',
|
|
version: '2023-12-01-preview',
|
|
models: {
|
|
'gpt-4-vision-preview': {
|
|
deploymentName: 'gpt-4-vision-preview',
|
|
version: '2024-02-15-preview',
|
|
},
|
|
'gpt-3.5-turbo': {
|
|
deploymentName: 'gpt-35-turbo',
|
|
},
|
|
'gpt-3.5-turbo-1106': {
|
|
deploymentName: 'gpt-35-turbo-1106',
|
|
},
|
|
'gpt-4': {
|
|
deploymentName: 'gpt-4',
|
|
},
|
|
'gpt-4-1106-preview': {
|
|
deploymentName: 'gpt-4-1106-preview',
|
|
},
|
|
},
|
|
},
|
|
{
|
|
group: 'librechat-eastus',
|
|
apiKey: '${EASTUS_API_KEY}',
|
|
instanceName: 'librechat-eastus',
|
|
deploymentName: 'gpt-4-turbo',
|
|
version: '2024-02-15-preview',
|
|
models: {
|
|
'gpt-4-turbo': true,
|
|
},
|
|
},
|
|
];
|
|
|
|
describe('AppService', () => {
|
|
let app;
|
|
const mockedTurnstileConfig = {
|
|
siteKey: 'default-site-key',
|
|
options: {},
|
|
};
|
|
|
|
beforeEach(() => {
|
|
app = { locals: {} };
|
|
process.env.CDN_PROVIDER = undefined;
|
|
});
|
|
|
|
it('should correctly assign process.env and app.locals based on custom config', async () => {
|
|
await AppService(app);
|
|
|
|
expect(process.env.CDN_PROVIDER).toEqual('testStrategy');
|
|
|
|
expect(app.locals).toEqual({
|
|
socialLogins: ['testLogin'],
|
|
fileStrategy: 'testStrategy',
|
|
interfaceConfig: expect.objectContaining({
|
|
endpointsMenu: true,
|
|
modelSelect: true,
|
|
parameters: true,
|
|
sidePanel: true,
|
|
presets: true,
|
|
}),
|
|
mcpConfig: null,
|
|
turnstileConfig: mockedTurnstileConfig,
|
|
modelSpecs: undefined,
|
|
paths: expect.anything(),
|
|
ocr: expect.anything(),
|
|
imageOutputType: expect.any(String),
|
|
fileConfig: undefined,
|
|
secureImageLinks: undefined,
|
|
balance: { enabled: true },
|
|
filteredTools: undefined,
|
|
includedTools: undefined,
|
|
webSearch: {
|
|
cohereApiKey: '${COHERE_API_KEY}',
|
|
firecrawlApiKey: '${FIRECRAWL_API_KEY}',
|
|
firecrawlApiUrl: '${FIRECRAWL_API_URL}',
|
|
jinaApiKey: '${JINA_API_KEY}',
|
|
safeSearch: 1,
|
|
serperApiKey: '${SERPER_API_KEY}',
|
|
},
|
|
memory: undefined,
|
|
agents: {
|
|
disableBuilder: false,
|
|
capabilities: expect.arrayContaining([...defaultAgentCapabilities]),
|
|
},
|
|
});
|
|
});
|
|
|
|
it('should log a warning if the config version is outdated', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
version: '0.9.0', // An outdated version for this test
|
|
registration: { socialLogins: ['testLogin'] },
|
|
fileStrategy: 'testStrategy',
|
|
}),
|
|
);
|
|
|
|
await AppService(app);
|
|
|
|
const { logger } = require('~/config');
|
|
expect(logger.info).toHaveBeenCalledWith(expect.stringContaining('Outdated Config version'));
|
|
});
|
|
|
|
it('should change the `imageOutputType` based on config value', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
version: '0.10.0',
|
|
imageOutputType: EImageOutputType.WEBP,
|
|
}),
|
|
);
|
|
|
|
await AppService(app);
|
|
expect(app.locals.imageOutputType).toEqual(EImageOutputType.WEBP);
|
|
});
|
|
|
|
it('should default to `PNG` `imageOutputType` with no provided type', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
version: '0.10.0',
|
|
}),
|
|
);
|
|
|
|
await AppService(app);
|
|
expect(app.locals.imageOutputType).toEqual(EImageOutputType.PNG);
|
|
});
|
|
|
|
it('should default to `PNG` `imageOutputType` with no provided config', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() => Promise.resolve(undefined));
|
|
|
|
await AppService(app);
|
|
expect(app.locals.imageOutputType).toEqual(EImageOutputType.PNG);
|
|
});
|
|
|
|
it('should initialize Firebase when fileStrategy is firebase', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
fileStrategy: FileSources.firebase,
|
|
}),
|
|
);
|
|
|
|
await AppService(app);
|
|
|
|
const { initializeFirebase } = require('./Files/Firebase/initialize');
|
|
expect(initializeFirebase).toHaveBeenCalled();
|
|
|
|
expect(process.env.CDN_PROVIDER).toEqual(FileSources.firebase);
|
|
});
|
|
|
|
it('should load and format tools accurately with defined structure', async () => {
|
|
const { loadAndFormatTools } = require('./ToolService');
|
|
const { setCachedTools, getCachedTools } = require('./Config');
|
|
|
|
await AppService(app);
|
|
|
|
expect(loadAndFormatTools).toHaveBeenCalledWith({
|
|
adminFilter: undefined,
|
|
adminIncluded: undefined,
|
|
directory: expect.anything(),
|
|
});
|
|
|
|
// Verify setCachedTools was called with the tools
|
|
expect(setCachedTools).toHaveBeenCalledWith(
|
|
{
|
|
ExampleTool: {
|
|
type: 'function',
|
|
function: {
|
|
description: 'Example tool function',
|
|
name: 'exampleFunction',
|
|
parameters: {
|
|
type: 'object',
|
|
properties: {
|
|
param1: { type: 'string', description: 'An example parameter' },
|
|
},
|
|
required: ['param1'],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{ isGlobal: true },
|
|
);
|
|
|
|
// Verify we can retrieve the tools from cache
|
|
const cachedTools = await getCachedTools({ includeGlobal: true });
|
|
expect(cachedTools.ExampleTool).toBeDefined();
|
|
expect(cachedTools.ExampleTool).toEqual({
|
|
type: 'function',
|
|
function: {
|
|
description: 'Example tool function',
|
|
name: 'exampleFunction',
|
|
parameters: {
|
|
type: 'object',
|
|
properties: {
|
|
param1: { type: 'string', description: 'An example parameter' },
|
|
},
|
|
required: ['param1'],
|
|
},
|
|
},
|
|
});
|
|
});
|
|
|
|
it('should correctly configure Assistants endpoint based on custom config', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
endpoints: {
|
|
[EModelEndpoint.assistants]: {
|
|
disableBuilder: true,
|
|
pollIntervalMs: 5000,
|
|
timeoutMs: 30000,
|
|
supportedIds: ['id1', 'id2'],
|
|
privateAssistants: false,
|
|
},
|
|
},
|
|
}),
|
|
);
|
|
|
|
await AppService(app);
|
|
|
|
expect(app.locals).toHaveProperty(EModelEndpoint.assistants);
|
|
expect(app.locals[EModelEndpoint.assistants]).toEqual(
|
|
expect.objectContaining({
|
|
disableBuilder: true,
|
|
pollIntervalMs: 5000,
|
|
timeoutMs: 30000,
|
|
supportedIds: expect.arrayContaining(['id1', 'id2']),
|
|
privateAssistants: false,
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('should correctly configure Agents endpoint based on custom config', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
endpoints: {
|
|
[EModelEndpoint.agents]: {
|
|
disableBuilder: true,
|
|
recursionLimit: 10,
|
|
maxRecursionLimit: 20,
|
|
allowedProviders: ['openai', 'anthropic'],
|
|
capabilities: [AgentCapabilities.tools, AgentCapabilities.actions],
|
|
},
|
|
},
|
|
}),
|
|
);
|
|
|
|
await AppService(app);
|
|
|
|
expect(app.locals).toHaveProperty(EModelEndpoint.agents);
|
|
expect(app.locals[EModelEndpoint.agents]).toEqual(
|
|
expect.objectContaining({
|
|
disableBuilder: true,
|
|
recursionLimit: 10,
|
|
maxRecursionLimit: 20,
|
|
allowedProviders: expect.arrayContaining(['openai', 'anthropic']),
|
|
capabilities: expect.arrayContaining([AgentCapabilities.tools, AgentCapabilities.actions]),
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('should configure Agents endpoint with defaults when no config is provided', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() => Promise.resolve({}));
|
|
|
|
await AppService(app);
|
|
|
|
expect(app.locals).toHaveProperty(EModelEndpoint.agents);
|
|
expect(app.locals[EModelEndpoint.agents]).toEqual(
|
|
expect.objectContaining({
|
|
disableBuilder: false,
|
|
capabilities: expect.arrayContaining([...defaultAgentCapabilities]),
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('should configure Agents endpoint with defaults when endpoints exist but agents is not defined', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
endpoints: {
|
|
[EModelEndpoint.openAI]: {
|
|
titleConvo: true,
|
|
},
|
|
},
|
|
}),
|
|
);
|
|
|
|
await AppService(app);
|
|
|
|
expect(app.locals).toHaveProperty(EModelEndpoint.agents);
|
|
expect(app.locals[EModelEndpoint.agents]).toEqual(
|
|
expect.objectContaining({
|
|
disableBuilder: false,
|
|
capabilities: expect.arrayContaining([...defaultAgentCapabilities]),
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('should correctly configure minimum Azure OpenAI Assistant values', async () => {
|
|
const assistantGroups = [azureGroups[0], { ...azureGroups[1], assistants: true }];
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
endpoints: {
|
|
[EModelEndpoint.azureOpenAI]: {
|
|
groups: assistantGroups,
|
|
assistants: true,
|
|
},
|
|
},
|
|
}),
|
|
);
|
|
|
|
process.env.WESTUS_API_KEY = 'westus-key';
|
|
process.env.EASTUS_API_KEY = 'eastus-key';
|
|
|
|
await AppService(app);
|
|
expect(app.locals).toHaveProperty(EModelEndpoint.azureAssistants);
|
|
expect(app.locals[EModelEndpoint.azureAssistants].capabilities.length).toEqual(3);
|
|
});
|
|
|
|
it('should correctly configure Azure OpenAI endpoint based on custom config', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
endpoints: {
|
|
[EModelEndpoint.azureOpenAI]: {
|
|
groups: azureGroups,
|
|
},
|
|
},
|
|
}),
|
|
);
|
|
|
|
process.env.WESTUS_API_KEY = 'westus-key';
|
|
process.env.EASTUS_API_KEY = 'eastus-key';
|
|
|
|
await AppService(app);
|
|
|
|
expect(app.locals).toHaveProperty(EModelEndpoint.azureOpenAI);
|
|
const azureConfig = app.locals[EModelEndpoint.azureOpenAI];
|
|
expect(azureConfig).toHaveProperty('modelNames');
|
|
expect(azureConfig).toHaveProperty('modelGroupMap');
|
|
expect(azureConfig).toHaveProperty('groupMap');
|
|
|
|
const { modelNames, modelGroupMap, groupMap } = validateAzureGroups(azureGroups);
|
|
expect(azureConfig.modelNames).toEqual(modelNames);
|
|
expect(azureConfig.modelGroupMap).toEqual(modelGroupMap);
|
|
expect(azureConfig.groupMap).toEqual(groupMap);
|
|
});
|
|
|
|
it('should not modify FILE_UPLOAD environment variables without rate limits', async () => {
|
|
// Setup initial environment variables
|
|
process.env.FILE_UPLOAD_IP_MAX = '10';
|
|
process.env.FILE_UPLOAD_IP_WINDOW = '15';
|
|
process.env.FILE_UPLOAD_USER_MAX = '5';
|
|
process.env.FILE_UPLOAD_USER_WINDOW = '20';
|
|
|
|
const initialEnv = { ...process.env };
|
|
|
|
await AppService(app);
|
|
|
|
// Expect environment variables to remain unchanged
|
|
expect(process.env.FILE_UPLOAD_IP_MAX).toEqual(initialEnv.FILE_UPLOAD_IP_MAX);
|
|
expect(process.env.FILE_UPLOAD_IP_WINDOW).toEqual(initialEnv.FILE_UPLOAD_IP_WINDOW);
|
|
expect(process.env.FILE_UPLOAD_USER_MAX).toEqual(initialEnv.FILE_UPLOAD_USER_MAX);
|
|
expect(process.env.FILE_UPLOAD_USER_WINDOW).toEqual(initialEnv.FILE_UPLOAD_USER_WINDOW);
|
|
});
|
|
|
|
it('should correctly set FILE_UPLOAD environment variables based on rate limits', async () => {
|
|
// Define and mock a custom configuration with rate limits
|
|
const rateLimitsConfig = {
|
|
rateLimits: {
|
|
fileUploads: {
|
|
ipMax: '100',
|
|
ipWindowInMinutes: '60',
|
|
userMax: '50',
|
|
userWindowInMinutes: '30',
|
|
},
|
|
},
|
|
};
|
|
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve(rateLimitsConfig),
|
|
);
|
|
|
|
await AppService(app);
|
|
|
|
// Verify that process.env has been updated according to the rate limits config
|
|
expect(process.env.FILE_UPLOAD_IP_MAX).toEqual('100');
|
|
expect(process.env.FILE_UPLOAD_IP_WINDOW).toEqual('60');
|
|
expect(process.env.FILE_UPLOAD_USER_MAX).toEqual('50');
|
|
expect(process.env.FILE_UPLOAD_USER_WINDOW).toEqual('30');
|
|
});
|
|
|
|
it('should fallback to default FILE_UPLOAD environment variables when rate limits are unspecified', async () => {
|
|
// Setup initial environment variables to non-default values
|
|
process.env.FILE_UPLOAD_IP_MAX = 'initialMax';
|
|
process.env.FILE_UPLOAD_IP_WINDOW = 'initialWindow';
|
|
process.env.FILE_UPLOAD_USER_MAX = 'initialUserMax';
|
|
process.env.FILE_UPLOAD_USER_WINDOW = 'initialUserWindow';
|
|
|
|
await AppService(app);
|
|
|
|
// Verify that process.env falls back to the initial values
|
|
expect(process.env.FILE_UPLOAD_IP_MAX).toEqual('initialMax');
|
|
expect(process.env.FILE_UPLOAD_IP_WINDOW).toEqual('initialWindow');
|
|
expect(process.env.FILE_UPLOAD_USER_MAX).toEqual('initialUserMax');
|
|
expect(process.env.FILE_UPLOAD_USER_WINDOW).toEqual('initialUserWindow');
|
|
});
|
|
|
|
it('should not modify IMPORT environment variables without rate limits', async () => {
|
|
// Setup initial environment variables
|
|
process.env.IMPORT_IP_MAX = '10';
|
|
process.env.IMPORT_IP_WINDOW = '15';
|
|
process.env.IMPORT_USER_MAX = '5';
|
|
process.env.IMPORT_USER_WINDOW = '20';
|
|
|
|
const initialEnv = { ...process.env };
|
|
|
|
await AppService(app);
|
|
|
|
// Expect environment variables to remain unchanged
|
|
expect(process.env.IMPORT_IP_MAX).toEqual(initialEnv.IMPORT_IP_MAX);
|
|
expect(process.env.IMPORT_IP_WINDOW).toEqual(initialEnv.IMPORT_IP_WINDOW);
|
|
expect(process.env.IMPORT_USER_MAX).toEqual(initialEnv.IMPORT_USER_MAX);
|
|
expect(process.env.IMPORT_USER_WINDOW).toEqual(initialEnv.IMPORT_USER_WINDOW);
|
|
});
|
|
|
|
it('should correctly set IMPORT environment variables based on rate limits', async () => {
|
|
// Define and mock a custom configuration with rate limits
|
|
const importLimitsConfig = {
|
|
rateLimits: {
|
|
conversationsImport: {
|
|
ipMax: '150',
|
|
ipWindowInMinutes: '60',
|
|
userMax: '50',
|
|
userWindowInMinutes: '30',
|
|
},
|
|
},
|
|
};
|
|
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve(importLimitsConfig),
|
|
);
|
|
|
|
await AppService(app);
|
|
|
|
// Verify that process.env has been updated according to the rate limits config
|
|
expect(process.env.IMPORT_IP_MAX).toEqual('150');
|
|
expect(process.env.IMPORT_IP_WINDOW).toEqual('60');
|
|
expect(process.env.IMPORT_USER_MAX).toEqual('50');
|
|
expect(process.env.IMPORT_USER_WINDOW).toEqual('30');
|
|
});
|
|
|
|
it('should fallback to default IMPORT environment variables when rate limits are unspecified', async () => {
|
|
// Setup initial environment variables to non-default values
|
|
process.env.IMPORT_IP_MAX = 'initialMax';
|
|
process.env.IMPORT_IP_WINDOW = 'initialWindow';
|
|
process.env.IMPORT_USER_MAX = 'initialUserMax';
|
|
process.env.IMPORT_USER_WINDOW = 'initialUserWindow';
|
|
|
|
await AppService(app);
|
|
|
|
// Verify that process.env falls back to the initial values
|
|
expect(process.env.IMPORT_IP_MAX).toEqual('initialMax');
|
|
expect(process.env.IMPORT_IP_WINDOW).toEqual('initialWindow');
|
|
expect(process.env.IMPORT_USER_MAX).toEqual('initialUserMax');
|
|
expect(process.env.IMPORT_USER_WINDOW).toEqual('initialUserWindow');
|
|
});
|
|
});
|
|
|
|
describe('AppService updating app.locals and issuing warnings', () => {
|
|
let app;
|
|
let initialEnv;
|
|
|
|
beforeEach(() => {
|
|
// Store initial environment variables to restore them after each test
|
|
initialEnv = { ...process.env };
|
|
|
|
app = { locals: {} };
|
|
process.env.CDN_PROVIDER = undefined;
|
|
});
|
|
|
|
afterEach(() => {
|
|
// Restore initial environment variables
|
|
process.env = { ...initialEnv };
|
|
});
|
|
|
|
it('should update app.locals with default values if loadCustomConfig returns undefined', async () => {
|
|
// Mock loadCustomConfig to return undefined
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() => Promise.resolve(undefined));
|
|
|
|
await AppService(app);
|
|
|
|
expect(app.locals).toBeDefined();
|
|
expect(app.locals.paths).toBeDefined();
|
|
expect(app.locals.fileStrategy).toEqual(FileSources.local);
|
|
expect(app.locals.socialLogins).toEqual(defaultSocialLogins);
|
|
expect(app.locals.balance).toEqual(
|
|
expect.objectContaining({
|
|
enabled: false,
|
|
startBalance: undefined,
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('should update app.locals with values from loadCustomConfig', async () => {
|
|
// Mock loadCustomConfig to return a specific config object with a complete balance config
|
|
const customConfig = {
|
|
fileStrategy: 'firebase',
|
|
registration: { socialLogins: ['testLogin'] },
|
|
balance: {
|
|
enabled: false,
|
|
startBalance: 5000,
|
|
autoRefillEnabled: true,
|
|
refillIntervalValue: 15,
|
|
refillIntervalUnit: 'hours',
|
|
refillAmount: 5000,
|
|
},
|
|
};
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve(customConfig),
|
|
);
|
|
|
|
await AppService(app);
|
|
|
|
expect(app.locals).toBeDefined();
|
|
expect(app.locals.paths).toBeDefined();
|
|
expect(app.locals.fileStrategy).toEqual(customConfig.fileStrategy);
|
|
expect(app.locals.socialLogins).toEqual(customConfig.registration.socialLogins);
|
|
expect(app.locals.balance).toEqual(customConfig.balance);
|
|
});
|
|
|
|
it('should apply the assistants endpoint configuration correctly to app.locals', async () => {
|
|
const mockConfig = {
|
|
endpoints: {
|
|
assistants: {
|
|
disableBuilder: true,
|
|
pollIntervalMs: 5000,
|
|
timeoutMs: 30000,
|
|
supportedIds: ['id1', 'id2'],
|
|
},
|
|
},
|
|
};
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() => Promise.resolve(mockConfig));
|
|
|
|
const app = { locals: {} };
|
|
await AppService(app);
|
|
|
|
expect(app.locals).toHaveProperty('assistants');
|
|
const { assistants } = app.locals;
|
|
expect(assistants.disableBuilder).toBe(true);
|
|
expect(assistants.pollIntervalMs).toBe(5000);
|
|
expect(assistants.timeoutMs).toBe(30000);
|
|
expect(assistants.supportedIds).toEqual(['id1', 'id2']);
|
|
expect(assistants.excludedIds).toBeUndefined();
|
|
});
|
|
|
|
it('should log a warning when both supportedIds and excludedIds are provided', async () => {
|
|
const mockConfig = {
|
|
endpoints: {
|
|
assistants: {
|
|
disableBuilder: false,
|
|
pollIntervalMs: 3000,
|
|
timeoutMs: 20000,
|
|
supportedIds: ['id1', 'id2'],
|
|
excludedIds: ['id3'],
|
|
},
|
|
},
|
|
};
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() => Promise.resolve(mockConfig));
|
|
|
|
const app = { locals: {} };
|
|
await require('./AppService')(app);
|
|
|
|
const { logger } = require('~/config');
|
|
expect(logger.warn).toHaveBeenCalledWith(
|
|
expect.stringContaining(
|
|
"The 'assistants' endpoint has both 'supportedIds' and 'excludedIds' defined.",
|
|
),
|
|
);
|
|
});
|
|
|
|
it('should log a warning when privateAssistants and supportedIds or excludedIds are provided', async () => {
|
|
const mockConfig = {
|
|
endpoints: {
|
|
assistants: {
|
|
privateAssistants: true,
|
|
supportedIds: ['id1'],
|
|
},
|
|
},
|
|
};
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() => Promise.resolve(mockConfig));
|
|
|
|
const app = { locals: {} };
|
|
await require('./AppService')(app);
|
|
|
|
const { logger } = require('~/config');
|
|
expect(logger.warn).toHaveBeenCalledWith(
|
|
expect.stringContaining(
|
|
"The 'assistants' endpoint has both 'privateAssistants' and 'supportedIds' or 'excludedIds' defined.",
|
|
),
|
|
);
|
|
});
|
|
|
|
it('should issue expected warnings when loading Azure Groups with deprecated Environment Variables', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
endpoints: {
|
|
[EModelEndpoint.azureOpenAI]: {
|
|
groups: azureGroups,
|
|
},
|
|
},
|
|
}),
|
|
);
|
|
|
|
deprecatedAzureVariables.forEach((varInfo) => {
|
|
process.env[varInfo.key] = 'test';
|
|
});
|
|
|
|
const app = { locals: {} };
|
|
await require('./AppService')(app);
|
|
|
|
const { logger } = require('~/config');
|
|
deprecatedAzureVariables.forEach(({ key, description }) => {
|
|
expect(logger.warn).toHaveBeenCalledWith(
|
|
`The \`${key}\` environment variable (related to ${description}) should not be used in combination with the \`azureOpenAI\` endpoint configuration, as you will experience conflicts and errors.`,
|
|
);
|
|
});
|
|
});
|
|
|
|
it('should issue expected warnings when loading conflicting Azure Envrionment Variables', async () => {
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
endpoints: {
|
|
[EModelEndpoint.azureOpenAI]: {
|
|
groups: azureGroups,
|
|
},
|
|
},
|
|
}),
|
|
);
|
|
|
|
conflictingAzureVariables.forEach((varInfo) => {
|
|
process.env[varInfo.key] = 'test';
|
|
});
|
|
|
|
const app = { locals: {} };
|
|
await require('./AppService')(app);
|
|
|
|
const { logger } = require('~/config');
|
|
conflictingAzureVariables.forEach(({ key }) => {
|
|
expect(logger.warn).toHaveBeenCalledWith(
|
|
`The \`${key}\` environment variable should not be used in combination with the \`azureOpenAI\` endpoint configuration, as you may experience with the defined placeholders for mapping to the current model grouping using the same name.`,
|
|
);
|
|
});
|
|
});
|
|
|
|
it('should not parse environment variable references in OCR config', async () => {
|
|
// Mock custom configuration with env variable references in OCR config
|
|
const mockConfig = {
|
|
ocr: {
|
|
apiKey: '${OCR_API_KEY_CUSTOM_VAR_NAME}',
|
|
baseURL: '${OCR_BASEURL_CUSTOM_VAR_NAME}',
|
|
strategy: 'mistral_ocr',
|
|
mistralModel: 'mistral-medium',
|
|
},
|
|
};
|
|
|
|
require('./Config/loadCustomConfig').mockImplementationOnce(() => Promise.resolve(mockConfig));
|
|
|
|
// Set actual environment variables with different values
|
|
process.env.OCR_API_KEY_CUSTOM_VAR_NAME = 'actual-api-key';
|
|
process.env.OCR_BASEURL_CUSTOM_VAR_NAME = 'https://actual-ocr-url.com';
|
|
|
|
// Initialize app
|
|
const app = { locals: {} };
|
|
await AppService(app);
|
|
|
|
// Verify that the raw string references were preserved and not interpolated
|
|
expect(app.locals.ocr).toBeDefined();
|
|
expect(app.locals.ocr.apiKey).toEqual('${OCR_API_KEY_CUSTOM_VAR_NAME}');
|
|
expect(app.locals.ocr.baseURL).toEqual('${OCR_BASEURL_CUSTOM_VAR_NAME}');
|
|
expect(app.locals.ocr.strategy).toEqual('mistral_ocr');
|
|
expect(app.locals.ocr.mistralModel).toEqual('mistral-medium');
|
|
});
|
|
});
|