[pull] main from LibreChat-AI:main

api/server/controllers/agents/__tests__/openai.spec.js

@@ -576,7 +576,7 @@ describe('OpenAIChatCompletionController', () => {
   );
 
   it.each([true, false])(
-    'publishes only the accepted client call after a model claim (stream=%s)',
+    'publishes accepted client calls after text and a model claim (stream=%s)',
     async (streaming) => {
       const api = require('@librechat/api');
       const actual = jest.requireActual('@librechat/api');
@@ -608,6 +608,9 @@ describe('OpenAIChatCompletionController', () => {
           agentId: 'agent-123',
           messageId: 'claimed-message',
         });
+        await handlers.on_message_delta.handle('on_message_delta', {
+          delta: { content: [{ type: 'text', text: 'Checking the weather.' }] },
+        });
         await handlers.on_model_response.handle('on_model_response', {
           type: 'model_response',
           id: 'accepted-client',
@@ -627,6 +630,9 @@ describe('OpenAIChatCompletionController', () => {
             .map(([frame]) => frame)
             .filter((frame) => frame !== 'data: [DONE]\n\n')
             .map((frame) => JSON.parse(frame.slice(6)));
+          expect(
+            frames.some((frame) => frame.choices[0].delta.content === 'Checking the weather.'),
+          ).toBe(true);
           const calls = frames.flatMap((frame) => frame.choices[0].delta.tool_calls ?? []);
           expect(calls).toEqual([
             { index: 0, id: 'a', type: 'function', function: { name: 'get_time', arguments: '' } },
@@ -642,6 +648,7 @@ describe('OpenAIChatCompletionController', () => {
           expect(frames.at(-1).choices[0].finish_reason).toBe('tool_calls');
         } else {
           const choice = res.json.mock.calls[0][0].choices[0];
+          expect(choice.message.content).toBe('Checking the weather.');
           expect(choice.message.tool_calls).toEqual([
             {
               id: 'a',
@@ -909,6 +916,7 @@ describe('OpenAIChatCompletionController', () => {
       expect.anything(),
       expect.anything(),
       mockCompletionUsage,
+      true,
     );
   });
 
@@ -920,7 +928,12 @@ describe('OpenAIChatCompletionController', () => {
 
     await OpenAIChatCompletionController(req, res);
 
-    expect(sendFinalChunk).toHaveBeenCalledWith(expect.anything(), 'stop', mockCompletionUsage);
+    expect(sendFinalChunk).toHaveBeenCalledWith(
+      expect.anything(),
+      'stop',
+      mockCompletionUsage,
+      true,
+    );
   });
 
   describe('content filtering', () => {

api/server/controllers/agents/openai.js

@@ -1180,7 +1180,7 @@ const executeOpenAIChatCompletion = async (envelope, { req, res }) => {
       // Finalize response
       const duration = Date.now() - requestStartTime;
       if (isStreaming) {
-        sendFinalChunk(handlerConfig, 'stop', usage);
+        sendFinalChunk(handlerConfig, 'stop', usage, true);
         res.end();
         logger.debug(`[OpenAI API] Response ${responseId} completed in ${duration}ms (streaming)`);
 
@@ -1216,6 +1216,7 @@ const executeOpenAIChatCompletion = async (envelope, { req, res }) => {
           aggregator.getReasoning(),
           aggregator.toolCalls,
           usage,
+          true,
         );
         res.json(response);
         logger.debug(

api/server/services/Config/app.js

@@ -33,9 +33,9 @@ async function invalidateCodeEnvironmentConfigCache(tenantId) {
   await getCodeEnvironmentRegistry().invalidateAccessibleConfigurations(tenantId);
 }
 
-const loadBaseConfig = async () => {
+const loadBaseConfig = async (mode) => {
   /** @type {TCustomConfig} */
-  const config = (await loadCustomConfig()) ?? {};
+  const config = (await loadCustomConfig(true, { mode })) ?? {};
   /** @type {Record<string, FunctionTool>} */
   const systemTools = loadAndFormatTools({
     adminFilter: config.filteredTools,

api/server/services/Config/loadCustomConfig.js

@@ -1,237 +1,11 @@
 const path = require('path');
-const axios = require('axios');
-const yaml = require('js-yaml');
-const keyBy = require('lodash/keyBy');
-const { loadYaml, redactConfigSecretMaps } = require('@librechat/api');
-const { Providers } = require('@librechat/agents');
-const { logger } = require('@librechat/data-schemas');
-const {
-  configSchema,
-  paramSettings,
-  EModelEndpoint,
-  EImageOutputType,
-  setMaxSubagents,
-  agentParamSettings,
-  validateSettingDefinitions,
-} = require('librechat-data-provider');
+const { loadYaml, redactConfigSecretMaps, createCustomConfigLoader } = require('@librechat/api');
 
 const projectRoot = path.resolve(__dirname, '..', '..', '..', '..');
 const defaultConfigPath = path.resolve(projectRoot, 'librechat.yaml');
 
-let i = 0;
-
-const OPENROUTER_PROMPT_CACHE_DEFAULT = {
-  key: 'promptCache',
-  default: true,
-};
-
-function includesOpenRouter(value) {
-  return typeof value === 'string' && value.toLowerCase().includes(Providers.OPENROUTER);
-}
-
-function isOpenRouterEndpoint(endpoint) {
-  return includesOpenRouter(endpoint.name) || includesOpenRouter(endpoint.baseURL);
-}
-
-function shouldPreserveCustomParams(customParams) {
-  const defaultEndpoint = customParams?.defaultParamsEndpoint;
-  return (
-    defaultEndpoint && defaultEndpoint !== 'custom' && defaultEndpoint !== Providers.OPENROUTER
-  );
-}
-
-function addOpenRouterDefaults(endpoint) {
-  if (!isOpenRouterEndpoint(endpoint)) {
-    return;
-  }
-
-  if (shouldPreserveCustomParams(endpoint.customParams)) {
-    return;
-  }
-
-  const customParams = endpoint.customParams ?? {};
-  const paramDefinitions = customParams.paramDefinitions ?? [];
-  const hasPromptCache = paramDefinitions.some((param) => param.key === 'promptCache');
-
-  endpoint.customParams = {
-    ...customParams,
-    defaultParamsEndpoint: Providers.OPENROUTER,
-    paramDefinitions: hasPromptCache
-      ? paramDefinitions
-      : [...paramDefinitions, OPENROUTER_PROMPT_CACHE_DEFAULT],
-  };
-}
-
-/**
- * Load custom configuration files and caches the object if the `cache` field at root is true.
- * Validation via parsing the config file with the config schema.
- * @function loadCustomConfig
- * @returns {Promise<TCustomConfig | null>} A promise that resolves to null or the custom config object.
- * */
-async function loadCustomConfig(printConfig = true) {
-  // Use CONFIG_PATH if set, otherwise fallback to defaultConfigPath
-  const configPath = process.env.CONFIG_PATH || defaultConfigPath;
-
-  let customConfig;
-
-  if (/^https?:\/\//.test(configPath)) {
-    try {
-      const response = await axios.get(configPath);
-      customConfig = response.data;
-    } catch (error) {
-      i === 0 && logger.error(`Failed to fetch the remote config file from ${configPath}`, error);
-      i === 0 && i++;
-      return null;
-    }
-  } else {
-    customConfig = loadYaml(configPath);
-    if (!customConfig) {
-      i === 0 &&
-        logger.info(
-          'Custom config file missing or YAML format invalid.\n\nCheck out the latest config file guide for configurable options and features.\nhttps://www.librechat.ai/docs/configuration/librechat_yaml\n\n',
-        );
-      i === 0 && i++;
-      return null;
-    }
-
-    if (customConfig.reason || customConfig.stack) {
-      i === 0 && logger.error('Config file YAML format is invalid:', customConfig);
-      i === 0 && i++;
-      return null;
-    }
-  }
-
-  if (typeof customConfig === 'string') {
-    try {
-      customConfig = yaml.load(customConfig);
-    } catch (parseError) {
-      i === 0 && logger.info(`Failed to parse the YAML config from ${configPath}`, parseError);
-      i === 0 && i++;
-      return null;
-    }
-  }
-
-  // Applied before parsing so specs validated in the same pass (whose subagent
-  // presets share the cap) check against the configured limit. Invalid values
-  // are ignored here and rejected by the schema parse below.
-  setMaxSubagents(customConfig?.endpoints?.[EModelEndpoint.agents]?.maxSubagents);
-
-  const result = configSchema.strict().safeParse(customConfig);
-  if (result?.error?.errors?.some((err) => err?.path && err.path?.includes('imageOutputType'))) {
-    throw new Error(
-      `
-Please specify a correct \`imageOutputType\` value (case-sensitive).
-
-      The available options are:
-      - ${EImageOutputType.JPEG}
-      - ${EImageOutputType.PNG}
-      - ${EImageOutputType.WEBP}
-
-      Refer to the latest config file guide for more information:
-      https://www.librechat.ai/docs/configuration/librechat_yaml`,
-    );
-  }
-  if (!result.success) {
-    let errorMessage = `Invalid custom config file at ${configPath}:
-${JSON.stringify(result.error, null, 2)}`;
-
-    logger.error(errorMessage);
-    const speechError = result.error.errors.find(
-      (err) =>
-        err.code === 'unrecognized_keys' &&
-        (err.message?.includes('stt') || err.message?.includes('tts')),
-    );
-
-    if (speechError) {
-      logger.warn(`
-The Speech-to-text and Text-to-speech configuration format has recently changed.
-If you're getting this error, please refer to the latest documentation:
-
-https://www.librechat.ai/docs/configuration/stt_tts`);
-    }
-
-    if (process.env.CONFIG_BYPASS_VALIDATION === 'true') {
-      logger.warn(
-        'CONFIG_BYPASS_VALIDATION is enabled. Continuing with default configuration despite validation errors.',
-      );
-      return null;
-    }
-
-    logger.error(
-      'Exiting due to invalid configuration. Set CONFIG_BYPASS_VALIDATION=true to bypass this check.',
-    );
-    process.exit(1);
-  } else {
-    if (printConfig) {
-      // Masks map-valued secrets (e.g. `langfuse.headers`) so literal gateway
-      // credentials are not copied into application logs on every startup.
-      const loggableConfig = redactConfigSecretMaps(customConfig);
-      logger.info('Custom config file loaded:');
-      logger.info(JSON.stringify(loggableConfig, null, 2));
-      logger.debug('Custom config:', loggableConfig);
-    }
-  }
-
-  (customConfig.endpoints?.custom ?? []).forEach(addOpenRouterDefaults);
-
-  (customConfig.endpoints?.custom ?? [])
-    .filter((endpoint) => endpoint.customParams)
-    .forEach((endpoint) => parseCustomParams(endpoint.name, endpoint.customParams));
-
-  if (result.data.modelSpecs) {
-    customConfig.modelSpecs = result.data.modelSpecs;
-  }
-
-  return customConfig;
-}
-
-// Validate and fill out missing values for custom parameters
-function parseCustomParams(endpointName, customParams) {
-  const paramEndpoint = customParams.defaultParamsEndpoint ?? 'custom';
-  customParams.defaultParamsEndpoint = paramEndpoint;
-  customParams.paramDefinitions = customParams.paramDefinitions || [];
-
-  // Checks if `defaultParamsEndpoint` is a key in `paramSettings`.
-  const validEndpoints = new Set([
-    ...Object.keys(paramSettings),
-    ...Object.keys(agentParamSettings),
-  ]);
-  if (!validEndpoints.has(paramEndpoint)) {
-    throw new Error(
-      `defaultParamsEndpoint of "${endpointName}" endpoint is invalid. ` +
-        `Valid options are ${Array.from(validEndpoints).join(', ')}`,
-    );
-  }
-
-  // creates default param maps
-  const regularParams = paramSettings[paramEndpoint] ?? [];
-  const agentParams = agentParamSettings[paramEndpoint] ?? [];
-  const defaultParams = regularParams.concat(agentParams);
-  const defaultParamsMap = keyBy(defaultParams, 'key');
-
-  // TODO: Remove this check once we support new parameters not part of default parameters.
-  // Checks if every key in `paramDefinitions` is valid.
-  const validKeys = new Set(Object.keys(defaultParamsMap));
-  const paramKeys = customParams.paramDefinitions.map((param) => param.key);
-  if (paramKeys.some((key) => !validKeys.has(key))) {
-    throw new Error(
-      `paramDefinitions of "${endpointName}" endpoint contains invalid key(s). ` +
-        `Valid parameter keys are ${Array.from(validKeys).join(', ')}`,
-    );
-  }
-
-  // Fill out missing values for custom param definitions
-  customParams.paramDefinitions = customParams.paramDefinitions.map((param) => {
-    return { ...defaultParamsMap[param.key], ...param, optionType: 'custom' };
-  });
-
-  try {
-    validateSettingDefinitions(customParams.paramDefinitions);
-  } catch (e) {
-    throw new Error(
-      `Custom parameter definitions for "${endpointName}" endpoint is malformed: ${e.message}`,
-    );
-  }
-}
-
-module.exports = loadCustomConfig;
+module.exports = createCustomConfigLoader({
+  loadLocal: loadYaml,
+  defaultConfigPath,
+  redactConfig: redactConfigSecretMaps,
+});