mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-16 16:30: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
134 lines
4.3 KiB
JavaScript
134 lines
4.3 KiB
JavaScript
// const OpenAI = require('openai');
|
|
const { ProxyAgent } = require('undici');
|
|
const { ErrorTypes, EModelEndpoint } = require('librechat-data-provider');
|
|
const { getUserKey, getUserKeyExpiry, getUserKeyValues } = require('~/server/services/UserService');
|
|
const initializeClient = require('./initialize');
|
|
// const { OpenAIClient } = require('~/app');
|
|
|
|
jest.mock('~/server/services/UserService', () => ({
|
|
getUserKey: jest.fn(),
|
|
getUserKeyExpiry: jest.fn(),
|
|
getUserKeyValues: jest.fn(),
|
|
checkUserKeyExpiry: jest.requireActual('~/server/services/UserService').checkUserKeyExpiry,
|
|
}));
|
|
|
|
// Config is now passed via req.config, not getAppConfig
|
|
|
|
const today = new Date();
|
|
const tenDaysFromToday = new Date(today.setDate(today.getDate() + 10));
|
|
const isoString = tenDaysFromToday.toISOString();
|
|
|
|
describe('initializeClient', () => {
|
|
// Set up environment variables
|
|
const originalEnvironment = process.env;
|
|
const app = {
|
|
locals: {},
|
|
};
|
|
|
|
beforeEach(() => {
|
|
jest.resetModules(); // Clears the cache
|
|
process.env = { ...originalEnvironment }; // Make a copy
|
|
});
|
|
|
|
afterAll(() => {
|
|
process.env = originalEnvironment; // Restore original env vars
|
|
});
|
|
|
|
test('initializes OpenAI client with default API key and URL', async () => {
|
|
process.env.AZURE_ASSISTANTS_API_KEY = 'default-api-key';
|
|
process.env.AZURE_ASSISTANTS_BASE_URL = 'https://default.api.url';
|
|
|
|
// Assuming 'isUserProvided' to return false for this test case
|
|
jest.mock('~/server/utils', () => ({
|
|
isUserProvided: jest.fn().mockReturnValueOnce(false),
|
|
}));
|
|
|
|
const req = {
|
|
user: { id: 'user123' },
|
|
app,
|
|
config: { endpoints: { [EModelEndpoint.azureOpenAI]: {} } },
|
|
};
|
|
const res = {};
|
|
|
|
const { openai, openAIApiKey } = await initializeClient({ req, res });
|
|
expect(openai.apiKey).toBe('default-api-key');
|
|
expect(openAIApiKey).toBe('default-api-key');
|
|
expect(openai.baseURL).toBe('https://default.api.url');
|
|
});
|
|
|
|
test('initializes OpenAI client with user-provided API key and URL', async () => {
|
|
process.env.AZURE_ASSISTANTS_API_KEY = 'user_provided';
|
|
process.env.AZURE_ASSISTANTS_BASE_URL = 'user_provided';
|
|
|
|
getUserKeyValues.mockResolvedValue({ apiKey: 'user-api-key', baseURL: 'https://user.api.url' });
|
|
getUserKeyExpiry.mockResolvedValue(isoString);
|
|
|
|
const req = {
|
|
user: { id: 'user123' },
|
|
app,
|
|
config: { endpoints: { [EModelEndpoint.azureOpenAI]: {} } },
|
|
};
|
|
const res = {};
|
|
|
|
const { openai, openAIApiKey } = await initializeClient({ req, res });
|
|
expect(openAIApiKey).toBe('user-api-key');
|
|
expect(openai.apiKey).toBe('user-api-key');
|
|
expect(openai.baseURL).toBe('https://user.api.url');
|
|
});
|
|
|
|
test('throws error for invalid JSON in user-provided values', async () => {
|
|
process.env.AZURE_ASSISTANTS_API_KEY = 'user_provided';
|
|
getUserKey.mockResolvedValue('invalid-json');
|
|
getUserKeyExpiry.mockResolvedValue(isoString);
|
|
getUserKeyValues.mockImplementation(() => {
|
|
let userValues = getUserKey();
|
|
try {
|
|
userValues = JSON.parse(userValues);
|
|
} catch {
|
|
throw new Error(
|
|
JSON.stringify({
|
|
type: ErrorTypes.INVALID_USER_KEY,
|
|
}),
|
|
);
|
|
}
|
|
return userValues;
|
|
});
|
|
|
|
const req = {
|
|
user: { id: 'user123' },
|
|
config: { endpoints: { [EModelEndpoint.azureOpenAI]: {} } },
|
|
};
|
|
const res = {};
|
|
|
|
await expect(initializeClient({ req, res })).rejects.toThrow(/invalid_user_key/);
|
|
});
|
|
|
|
test('throws error if API key is not provided', async () => {
|
|
delete process.env.AZURE_ASSISTANTS_API_KEY; // Simulate missing API key
|
|
|
|
const req = {
|
|
user: { id: 'user123' },
|
|
app,
|
|
config: { endpoints: { [EModelEndpoint.azureOpenAI]: {} } },
|
|
};
|
|
const res = {};
|
|
|
|
await expect(initializeClient({ req, res })).rejects.toThrow(/Assistants API key not/);
|
|
});
|
|
|
|
test('initializes OpenAI client with proxy configuration', async () => {
|
|
process.env.AZURE_ASSISTANTS_API_KEY = 'test-key';
|
|
process.env.PROXY = 'http://proxy.server';
|
|
|
|
const req = {
|
|
user: { id: 'user123' },
|
|
app,
|
|
config: { endpoints: { [EModelEndpoint.azureOpenAI]: {} } },
|
|
};
|
|
const res = {};
|
|
|
|
const { openai } = await initializeClient({ req, res });
|
|
expect(openai.fetchOptions).toBeDefined();
|
|
expect(openai.fetchOptions.dispatcher).toBeInstanceOf(ProxyAgent);
|
|
});
|
|
});
|