🛜 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

packages/api/src/utils/common.ts

@@ -1,3 +1,6 @@
+import { Providers } from '@librechat/agents';
+import { AuthType } from 'librechat-data-provider';
+
 /**
  * Checks if the given value is truthy by being either the boolean `true` or a string
  * that case-insensitively matches 'true'.
@@ -31,7 +34,7 @@ export function isEnabled(value?: string | boolean | null | undefined): boolean
  * @param value - The value to check.
  * @returns - Returns true if the value is 'user_provided', otherwise false.
  */
-export const isUserProvided = (value?: string): boolean => value === 'user_provided';
+export const isUserProvided = (value?: string): boolean => value === AuthType.USER_PROVIDED;
 
 /**
  * @param values
@@ -46,3 +49,11 @@ export function optionalChainWithEmptyCheck(
   }
   return values[values.length - 1];
 }
+
+/**
+ * Normalize the endpoint name to system-expected value.
+ * @param name
+ */
+export function normalizeEndpointName(name = ''): string {
+  return name.toLowerCase() === Providers.OLLAMA ? Providers.OLLAMA : name;
+}

packages/api/src/utils/email.ts

@@ -0,0 +1,16 @@
+/**
+ * Check if email configuration is set
+ * @returns Returns `true` if either Mailgun or SMTP is properly configured
+ */
+export function checkEmailConfig(): boolean {
+  const hasMailgunConfig =
+    !!process.env.MAILGUN_API_KEY && !!process.env.MAILGUN_DOMAIN && !!process.env.EMAIL_FROM;
+
+  const hasSMTPConfig =
+    (!!process.env.EMAIL_SERVICE || !!process.env.EMAIL_HOST) &&
+    !!process.env.EMAIL_USERNAME &&
+    !!process.env.EMAIL_PASSWORD &&
+    !!process.env.EMAIL_FROM;
+
+  return hasMailgunConfig || hasSMTPConfig;
+}

packages/api/src/utils/index.ts

@@ -1,6 +1,7 @@
 export * from './axios';
 export * from './azure';
 export * from './common';
+export * from './email';
 export * from './env';
 export * from './events';
 export * from './files';

packages/api/src/utils/tempChatRetention.spec.ts

@@ -1,11 +1,11 @@
+import type { AppConfig } from '~/types';
 import {
+  createTempChatExpirationDate,
+  getTempChatRetentionHours,
+  DEFAULT_RETENTION_HOURS,
   MIN_RETENTION_HOURS,
   MAX_RETENTION_HOURS,
-  DEFAULT_RETENTION_HOURS,
-  getTempChatRetentionHours,
-  createTempChatExpirationDate,
 } from './tempChatRetention';
-import type { TCustomConfig } from 'librechat-data-provider';
 
 describe('tempChatRetention', () => {
   const originalEnv = process.env;
@@ -33,43 +33,43 @@ describe('tempChatRetention', () => {
     });
 
     it('should use config value when set', () => {
-      const config: Partial<TCustomConfig> = {
-        interface: {
+      const config: Partial<AppConfig> = {
+        interfaceConfig: {
           temporaryChatRetention: 12,
         },
       };
-      const result = getTempChatRetentionHours(config);
+      const result = getTempChatRetentionHours(config?.interfaceConfig);
       expect(result).toBe(12);
     });
 
     it('should prioritize config over environment variable', () => {
       process.env.TEMP_CHAT_RETENTION_HOURS = '48';
-      const config: Partial<TCustomConfig> = {
-        interface: {
+      const config: Partial<AppConfig> = {
+        interfaceConfig: {
           temporaryChatRetention: 12,
         },
       };
-      const result = getTempChatRetentionHours(config);
+      const result = getTempChatRetentionHours(config?.interfaceConfig);
       expect(result).toBe(12);
     });
 
     it('should enforce minimum retention period', () => {
-      const config: Partial<TCustomConfig> = {
-        interface: {
+      const config: Partial<AppConfig> = {
+        interfaceConfig: {
           temporaryChatRetention: 0,
         },
       };
-      const result = getTempChatRetentionHours(config);
+      const result = getTempChatRetentionHours(config?.interfaceConfig);
       expect(result).toBe(MIN_RETENTION_HOURS);
     });
 
     it('should enforce maximum retention period', () => {
-      const config: Partial<TCustomConfig> = {
-        interface: {
+      const config: Partial<AppConfig> = {
+        interfaceConfig: {
           temporaryChatRetention: 10000,
         },
       };
-      const result = getTempChatRetentionHours(config);
+      const result = getTempChatRetentionHours(config?.interfaceConfig);
       expect(result).toBe(MAX_RETENTION_HOURS);
     });
 
@@ -80,12 +80,12 @@ describe('tempChatRetention', () => {
     });
 
     it('should handle invalid config value', () => {
-      const config: Partial<TCustomConfig> = {
-        interface: {
+      const config: Partial<AppConfig> = {
+        interfaceConfig: {
           temporaryChatRetention: 'invalid' as unknown as number,
         },
       };
-      const result = getTempChatRetentionHours(config);
+      const result = getTempChatRetentionHours(config?.interfaceConfig);
       expect(result).toBe(DEFAULT_RETENTION_HOURS);
     });
   });
@@ -103,13 +103,13 @@ describe('tempChatRetention', () => {
     });
 
     it('should create expiration date with custom retention period', () => {
-      const config: Partial<TCustomConfig> = {
-        interface: {
+      const config: Partial<AppConfig> = {
+        interfaceConfig: {
           temporaryChatRetention: 12,
         },
       };
 
-      const result = createTempChatExpirationDate(config);
+      const result = createTempChatExpirationDate(config?.interfaceConfig);
 
       const expectedDate = new Date();
       expectedDate.setHours(expectedDate.getHours() + 12);

packages/api/src/utils/tempChatRetention.ts

@@ -1,5 +1,5 @@
 import { logger } from '@librechat/data-schemas';
-import type { TCustomConfig } from 'librechat-data-provider';
+import type { AppConfig } from '~/types';
 
 /**
  * Default retention period for temporary chats in hours
@@ -18,10 +18,12 @@ export const MAX_RETENTION_HOURS = 8760;
 
 /**
  * Gets the temporary chat retention period from environment variables or config
- * @param config - The custom configuration object
+ * @param interfaceConfig - The custom configuration object
  * @returns The retention period in hours
  */
-export function getTempChatRetentionHours(config?: Partial<TCustomConfig> | null): number {
+export function getTempChatRetentionHours(
+  interfaceConfig?: AppConfig['interfaceConfig'] | null,
+): number {
   let retentionHours = DEFAULT_RETENTION_HOURS;
 
   // Check environment variable first
@@ -37,8 +39,8 @@ export function getTempChatRetentionHours(config?: Partial<TCustomConfig> | null
   }
 
   // Check config file (takes precedence over environment variable)
-  if (config?.interface?.temporaryChatRetention !== undefined) {
-    const configValue = config.interface.temporaryChatRetention;
+  if (interfaceConfig?.temporaryChatRetention !== undefined) {
+    const configValue = interfaceConfig.temporaryChatRetention;
     if (typeof configValue === 'number' && !isNaN(configValue)) {
       retentionHours = configValue;
     } else {
@@ -66,11 +68,11 @@ export function getTempChatRetentionHours(config?: Partial<TCustomConfig> | null
 
 /**
  * Creates an expiration date for temporary chats
- * @param config - The custom configuration object
+ * @param interfaceConfig - The custom configuration object
  * @returns The expiration date
  */
-export function createTempChatExpirationDate(config?: Partial<TCustomConfig>): Date {
-  const retentionHours = getTempChatRetentionHours(config);
+export function createTempChatExpirationDate(interfaceConfig?: AppConfig['interfaceConfig']): Date {
+  const retentionHours = getTempChatRetentionHours(interfaceConfig);
   const expiredAt = new Date();
   expiredAt.setHours(expiredAt.getHours() + retentionHours);
   return expiredAt;