🅰️ feat: Azure Config to Allow Different Deployments per Model (#1863)

* wip: first pass for azure endpoint schema

* refactor: azure config to return groupMap and modelConfigMap

* wip: naming and schema changes

* refactor(errorsToString): move to data-provider

* feat: rename to azureGroups, add additional tests, tests all expected outcomes, return errors

* feat(AppService): load Azure groups

* refactor(azure): use imported types, write `mapModelToAzureConfig`

* refactor: move `extractEnvVariable` to data-provider

* refactor(validateAzureGroups): throw on duplicate groups or models; feat(mapModelToAzureConfig): throw if env vars not present, add tests

* refactor(AppService): ensure each model is properly configured on startup

* refactor: deprecate azureOpenAI environment variables in favor of librechat.yaml config

* feat: use helper functions to handle and order enabled/default endpoints; initialize azureOpenAI from config file

* refactor: redefine types as well as load azureOpenAI models from config file

* chore(ci): fix test description naming

* feat(azureOpenAI): use validated model grouping for request authentication

* chore: bump data-provider following rebase

* chore: bump config file version noting significant changes

* feat: add title options and switch azure configs for titling and vision requests

* feat: enable azure plugins from config file

* fix(ci): pass tests

* chore(.env.example): mark `PLUGINS_USE_AZURE` as deprecated

* fix(fetchModels): early return if apiKey not passed

* chore: fix azure config typing

* refactor(mapModelToAzureConfig): return baseURL and headers as well as azureOptions

* feat(createLLM): use `azureOpenAIBasePath`

* feat(parsers): resolveHeaders

* refactor(extractBaseURL): handle invalid input

* feat(OpenAIClient): handle headers and baseURL for azureConfig

* fix(ci): pass `OpenAIClient` tests

* chore: extract env var for azureOpenAI group config, baseURL

* docs: azureOpenAI config setup docs

* feat: safe check of potential conflicting env vars that map to unique placeholders

* fix: reset apiKey when model switches from originally requested model (vision or title)

* chore: linting

* docs: CONFIG_PATH notes in custom_config.md

api/server/services/AppService.spec.js

@@ -1,4 +1,11 @@
-const { FileSources, defaultSocialLogins } = require('librechat-data-provider');
+const {
+  FileSources,
+  EModelEndpoint,
+  defaultSocialLogins,
+  validateAzureGroups,
+  deprecatedAzureVariables,
+  conflictingAzureVariables,
+} = require('librechat-data-provider');
 
 const AppService = require('./AppService');
 
@@ -32,6 +39,43 @@ jest.mock('./ToolService', () => ({
   }),
 }));
 
+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;
 
@@ -122,11 +166,11 @@ describe('AppService', () => {
     });
   });
 
-  it('should correctly configure endpoints based on custom config', async () => {
+  it('should correctly configure Assistants endpoint based on custom config', async () => {
     require('./Config/loadCustomConfig').mockImplementationOnce(() =>
       Promise.resolve({
         endpoints: {
-          assistants: {
+          [EModelEndpoint.assistants]: {
             disableBuilder: true,
             pollIntervalMs: 5000,
             timeoutMs: 30000,
@@ -138,8 +182,8 @@ describe('AppService', () => {
 
     await AppService(app);
 
-    expect(app.locals).toHaveProperty('assistants');
-    expect(app.locals.assistants).toEqual(
+    expect(app.locals).toHaveProperty(EModelEndpoint.assistants);
+    expect(app.locals[EModelEndpoint.assistants]).toEqual(
       expect.objectContaining({
         disableBuilder: true,
         pollIntervalMs: 5000,
@@ -149,6 +193,34 @@ describe('AppService', () => {
     );
   });
 
+  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';
@@ -213,7 +285,7 @@ describe('AppService', () => {
   });
 });
 
-describe('AppService updating app.locals', () => {
+describe('AppService updating app.locals and issuing warnings', () => {
   let app;
   let initialEnv;
 
@@ -309,4 +381,56 @@ describe('AppService updating app.locals', () => {
       expect.stringContaining('Both `supportedIds` and `excludedIds` are 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.`,
+      );
+    });
+  });
 });