🛜 refactor: Streamline App Config Usage (#9234)

* 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
This commit is contained in:
Danny Avila 2025-08-26 12:10:18 -04:00 committed by GitHub
parent e1ad235f17
commit 9a210971f5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
210 changed files with 4102 additions and 3465 deletions

View file

@ -2,7 +2,7 @@ import mongoose from 'mongoose';
import { MongoMemoryServer } from 'mongodb-memory-server';
import { logger, balanceSchema } from '@librechat/data-schemas';
import type { NextFunction, Request as ServerRequest, Response as ServerResponse } from 'express';
import type { IBalance, BalanceConfig } from '@librechat/data-schemas';
import type { IBalance } from '@librechat/data-schemas';
import { createSetBalanceConfig } from './balance';
jest.mock('@librechat/data-schemas', () => ({
@ -48,23 +48,22 @@ describe('createSetBalanceConfig', () => {
});
const mockNext: NextFunction = jest.fn();
const defaultBalanceConfig: BalanceConfig = {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
};
describe('Basic Functionality', () => {
test('should create balance record for new user with start balance', async () => {
const userId = new mongoose.Types.ObjectId();
const getBalanceConfig = jest.fn().mockResolvedValue(defaultBalanceConfig);
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -73,7 +72,7 @@ describe('createSetBalanceConfig', () => {
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(getBalanceConfig).toHaveBeenCalled();
expect(getAppConfig).toHaveBeenCalled();
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
@ -88,10 +87,14 @@ describe('createSetBalanceConfig', () => {
test('should skip if balance config is not enabled', async () => {
const userId = new mongoose.Types.ObjectId();
const getBalanceConfig = jest.fn().mockResolvedValue({ enabled: false });
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: false,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -108,13 +111,15 @@ describe('createSetBalanceConfig', () => {
test('should skip if startBalance is null', async () => {
const userId = new mongoose.Types.ObjectId();
const getBalanceConfig = jest.fn().mockResolvedValue({
enabled: true,
startBalance: null,
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: null,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -131,10 +136,19 @@ describe('createSetBalanceConfig', () => {
test('should handle user._id as string', async () => {
const userId = new mongoose.Types.ObjectId().toString();
const getBalanceConfig = jest.fn().mockResolvedValue(defaultBalanceConfig);
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -151,10 +165,19 @@ describe('createSetBalanceConfig', () => {
});
test('should skip if user is not present in request', async () => {
const getBalanceConfig = jest.fn().mockResolvedValue(defaultBalanceConfig);
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -164,7 +187,7 @@ describe('createSetBalanceConfig', () => {
await middleware(req, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
expect(getBalanceConfig).toHaveBeenCalled();
expect(getAppConfig).toHaveBeenCalled();
});
});
@ -183,17 +206,19 @@ describe('createSetBalanceConfig', () => {
// Remove lastRefill to simulate existing user without it
await Balance.updateOne({ _id: doc._id }, { $unset: { lastRefill: 1 } });
const getBalanceConfig = jest.fn().mockResolvedValue({
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -233,17 +258,19 @@ describe('createSetBalanceConfig', () => {
lastRefill: existingLastRefill,
});
const getBalanceConfig = jest.fn().mockResolvedValue({
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -275,17 +302,19 @@ describe('createSetBalanceConfig', () => {
// Remove lastRefill to simulate the edge case
await Balance.updateOne({ _id: doc._id }, { $unset: { lastRefill: 1 } });
const getBalanceConfig = jest.fn().mockResolvedValue({
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -306,14 +335,17 @@ describe('createSetBalanceConfig', () => {
test('should not set lastRefill when auto-refill is disabled', async () => {
const userId = new mongoose.Types.ObjectId();
const getBalanceConfig = jest.fn().mockResolvedValue({
enabled: true,
startBalance: 1000,
autoRefillEnabled: false,
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: false,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -347,17 +379,19 @@ describe('createSetBalanceConfig', () => {
refillAmount: 100,
});
const getBalanceConfig = jest.fn().mockResolvedValue({
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -389,10 +423,19 @@ describe('createSetBalanceConfig', () => {
lastRefill: lastRefillTime,
});
const getBalanceConfig = jest.fn().mockResolvedValue(defaultBalanceConfig);
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -417,13 +460,16 @@ describe('createSetBalanceConfig', () => {
tokenCredits: null,
});
const getBalanceConfig = jest.fn().mockResolvedValue({
enabled: true,
startBalance: 2000,
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 2000,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -440,7 +486,16 @@ describe('createSetBalanceConfig', () => {
describe('Error Handling', () => {
test('should handle database errors gracefully', async () => {
const userId = new mongoose.Types.ObjectId();
const getBalanceConfig = jest.fn().mockResolvedValue(defaultBalanceConfig);
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const dbError = new Error('Database error');
// Mock Balance.findOne to throw an error
@ -451,7 +506,7 @@ describe('createSetBalanceConfig', () => {
}) as unknown as mongoose.Model<IBalance>['findOne']);
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -464,13 +519,13 @@ describe('createSetBalanceConfig', () => {
expect(mockNext).toHaveBeenCalledWith(dbError);
});
test('should handle getBalanceConfig errors', async () => {
test('should handle getAppConfig errors', async () => {
const userId = new mongoose.Types.ObjectId();
const configError = new Error('Config error');
const getBalanceConfig = jest.fn().mockRejectedValue(configError);
const getAppConfig = jest.fn().mockRejectedValue(configError);
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -487,17 +542,20 @@ describe('createSetBalanceConfig', () => {
const userId = new mongoose.Types.ObjectId();
// Missing required auto-refill fields
const getBalanceConfig = jest.fn().mockResolvedValue({
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: null, // Invalid
refillIntervalUnit: 'days',
refillAmount: 500,
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: null, // Invalid
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -519,10 +577,19 @@ describe('createSetBalanceConfig', () => {
describe('Concurrent Updates', () => {
test('should handle concurrent middleware calls for same user', async () => {
const userId = new mongoose.Types.ObjectId();
const getBalanceConfig = jest.fn().mockResolvedValue(defaultBalanceConfig);
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});
@ -554,17 +621,20 @@ describe('createSetBalanceConfig', () => {
async (unit) => {
const userId = new mongoose.Types.ObjectId();
const getBalanceConfig = jest.fn().mockResolvedValue({
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 10,
refillIntervalUnit: unit,
refillAmount: 100,
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 10,
refillIntervalUnit: unit,
refillAmount: 100,
},
});
const middleware = createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
});

View file

@ -2,10 +2,11 @@ import { logger } from '@librechat/data-schemas';
import type { NextFunction, Request as ServerRequest, Response as ServerResponse } from 'express';
import type { IBalance, IUser, BalanceConfig, ObjectId } from '@librechat/data-schemas';
import type { Model } from 'mongoose';
import type { BalanceUpdateFields } from '~/types';
import type { AppConfig, BalanceUpdateFields } from '~/types';
import { getBalanceConfig } from '~/app/config';
export interface BalanceMiddlewareOptions {
getBalanceConfig: () => Promise<BalanceConfig | null>;
getAppConfig: (options?: { role?: string; refresh?: boolean }) => Promise<AppConfig>;
Balance: Model<IBalance>;
}
@ -73,7 +74,7 @@ function buildUpdateFields(
* @returns Express middleware function
*/
export function createSetBalanceConfig({
getBalanceConfig,
getAppConfig,
Balance,
}: BalanceMiddlewareOptions): (
req: ServerRequest,
@ -82,7 +83,9 @@ export function createSetBalanceConfig({
) => Promise<void> {
return async (req: ServerRequest, res: ServerResponse, next: NextFunction): Promise<void> => {
try {
const balanceConfig = await getBalanceConfig();
const user = req.user as IUser & { _id: string | ObjectId };
const appConfig = await getAppConfig({ role: user?.role });
const balanceConfig = getBalanceConfig(appConfig);
if (!balanceConfig?.enabled) {
return next();
}
@ -90,7 +93,6 @@ export function createSetBalanceConfig({
return next();
}
const user = req.user as IUser & { _id: string | ObjectId };
if (!user || !user._id) {
return next();
}