mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 00:40:14 +01:00
🧵 refactor: Migrate Endpoint Initialization to TypeScript (#10794)
* refactor: move endpoint initialization methods to typescript * refactor: move agent init to packages/api - Introduced `initialize.ts` for agent initialization, including file processing and tool loading. - Updated `resources.ts` to allow optional appConfig parameter. - Enhanced endpoint configuration handling in various initialization files to support model parameters. - Added new artifacts and prompts for React component generation. - Refactored existing code to improve type safety and maintainability. * refactor: streamline endpoint initialization and enhance type safety - Updated initialization functions across various endpoints to use a consistent request structure, replacing `unknown` types with `ServerResponse`. - Simplified request handling by directly extracting keys from the request body. - Improved type safety by ensuring user IDs are safely accessed with optional chaining. - Removed unnecessary parameters and streamlined model options handling for better clarity and maintainability. * refactor: moved ModelService and extractBaseURL to packages/api - Added comprehensive tests for the models fetching functionality, covering scenarios for OpenAI, Anthropic, Google, and Ollama models. - Updated existing endpoint index to include the new models module. - Enhanced utility functions for URL extraction and model data processing. - Improved type safety and error handling across the models fetching logic. * refactor: consolidate utility functions and remove unused files - Merged `deriveBaseURL` and `extractBaseURL` into the `@librechat/api` module for better organization. - Removed redundant utility files and their associated tests to streamline the codebase. - Updated imports across various client files to utilize the new consolidated functions. - Enhanced overall maintainability by reducing the number of utility modules. * refactor: replace ModelService references with direct imports from @librechat/api and remove ModelService file * refactor: move encrypt/decrypt methods and key db methods to data-schemas, use `getProviderConfig` from `@librechat/api` * chore: remove unused 'res' from options in AgentClient * refactor: file model imports and methods - Updated imports in various controllers and services to use the unified file model from '~/models' instead of '~/models/File'. - Consolidated file-related methods into a new file methods module in the data-schemas package. - Added comprehensive tests for file methods including creation, retrieval, updating, and deletion. - Enhanced the initializeAgent function to accept dependency injection for file-related methods. - Improved error handling and logging in file methods. * refactor: streamline database method references in agent initialization * refactor: enhance file method tests and update type references to IMongoFile * refactor: consolidate database method imports in agent client and initialization * chore: remove redundant import of initializeAgent from @librechat/api * refactor: move checkUserKeyExpiry utility to @librechat/api and update references across endpoints * refactor: move updateUserPlugins logic to user.ts and simplify UserController * refactor: update imports for user key management and remove UserService * refactor: remove unused Anthropics and Bedrock endpoint files and clean up imports * refactor: consolidate and update encryption imports across various files to use @librechat/data-schemas * chore: update file model mock to use unified import from '~/models' * chore: import order * refactor: remove migrated to TS agent.js file and its associated logic from the endpoints * chore: add reusable function to extract imports from source code in unused-packages workflow * chore: enhance unused-packages workflow to include @librechat/api dependencies and improve dependency extraction * chore: improve dependency extraction in unused-packages workflow with enhanced error handling and debugging output * chore: add detailed debugging output to unused-packages workflow for better visibility into unused dependencies and exclusion lists * chore: refine subpath handling in unused-packages workflow to correctly process scoped and non-scoped package imports * chore: clean up unused debug output in unused-packages workflow and reorganize type imports in initialize.ts
This commit is contained in:
Danny Avila
parent
1a11b64266
commit
04a4a2aa44
103 changed files with 4135 additions and 2647 deletions
|
|
@ -1,28 +0,0 @@
|
|||
const { logger } = require('@librechat/data-schemas');
|
||||
|
||||
/**
|
||||
* Extracts the base URL from the provided URL.
|
||||
* @param {string} fullURL - The full URL.
|
||||
* @returns {string} The base URL.
|
||||
*/
|
||||
function deriveBaseURL(fullURL) {
|
||||
try {
|
||||
const parsedUrl = new URL(fullURL);
|
||||
const protocol = parsedUrl.protocol;
|
||||
const hostname = parsedUrl.hostname;
|
||||
const port = parsedUrl.port;
|
||||
|
||||
// Check if the parsed URL components are meaningful
|
||||
if (!protocol || !hostname) {
|
||||
return fullURL;
|
||||
}
|
||||
|
||||
// Reconstruct the base URL
|
||||
return `${protocol}//${hostname}${port ? `:${port}` : ''}`;
|
||||
} catch (error) {
|
||||
logger.error('Failed to derive base URL', error);
|
||||
return fullURL; // Return the original URL in case of any exception
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = deriveBaseURL;
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
const axios = require('axios');
|
||||
const deriveBaseURL = require('./deriveBaseURL');
|
||||
jest.mock('@librechat/api', () => {
|
||||
const originalUtils = jest.requireActual('@librechat/api');
|
||||
return {
|
||||
...originalUtils,
|
||||
processModelData: jest.fn((...args) => {
|
||||
return originalUtils.processModelData(...args);
|
||||
}),
|
||||
};
|
||||
});
|
||||
|
||||
jest.mock('axios');
|
||||
jest.mock('~/cache/getLogStores', () =>
|
||||
jest.fn().mockImplementation(() => ({
|
||||
get: jest.fn().mockResolvedValue(undefined),
|
||||
set: jest.fn().mockResolvedValue(true),
|
||||
})),
|
||||
);
|
||||
jest.mock('~/config', () => ({
|
||||
logger: {
|
||||
error: jest.fn(),
|
||||
},
|
||||
}));
|
||||
|
||||
axios.get.mockResolvedValue({
|
||||
data: {
|
||||
data: [{ id: 'model-1' }, { id: 'model-2' }],
|
||||
},
|
||||
});
|
||||
|
||||
describe('deriveBaseURL', () => {
|
||||
it('should extract the base URL correctly from a full URL with a port', () => {
|
||||
const fullURL = 'https://example.com:8080/path?query=123';
|
||||
const baseURL = deriveBaseURL(fullURL);
|
||||
expect(baseURL).toEqual('https://example.com:8080');
|
||||
});
|
||||
|
||||
it('should extract the base URL correctly from a full URL without a port', () => {
|
||||
const fullURL = 'https://example.com/path?query=123';
|
||||
const baseURL = deriveBaseURL(fullURL);
|
||||
expect(baseURL).toEqual('https://example.com');
|
||||
});
|
||||
|
||||
it('should handle URLs using the HTTP protocol', () => {
|
||||
const fullURL = 'http://example.com:3000/path?query=123';
|
||||
const baseURL = deriveBaseURL(fullURL);
|
||||
expect(baseURL).toEqual('http://example.com:3000');
|
||||
});
|
||||
|
||||
it('should return only the protocol and hostname if no port is specified', () => {
|
||||
const fullURL = 'http://example.com/path?query=123';
|
||||
const baseURL = deriveBaseURL(fullURL);
|
||||
expect(baseURL).toEqual('http://example.com');
|
||||
});
|
||||
|
||||
it('should handle URLs with uncommon protocols', () => {
|
||||
const fullURL = 'ftp://example.com:2121/path?query=123';
|
||||
const baseURL = deriveBaseURL(fullURL);
|
||||
expect(baseURL).toEqual('ftp://example.com:2121');
|
||||
});
|
||||
|
||||
it('should handle edge case where URL ends with a slash', () => {
|
||||
const fullURL = 'https://example.com/';
|
||||
const baseURL = deriveBaseURL(fullURL);
|
||||
expect(baseURL).toEqual('https://example.com');
|
||||
});
|
||||
|
||||
it('should return the original URL if the URL is invalid', () => {
|
||||
const invalidURL = 'htp:/example.com:8080';
|
||||
const result = deriveBaseURL(invalidURL);
|
||||
expect(result).toBe(invalidURL);
|
||||
});
|
||||
});
|
||||
|
|
@ -1,90 +0,0 @@
|
|||
const { CohereConstants } = require('librechat-data-provider');
|
||||
|
||||
/**
|
||||
* Extracts a valid OpenAI baseURL from a given string, matching "url/v1," followed by an optional suffix.
|
||||
* The suffix can be one of several predefined values (e.g., 'openai', 'azure-openai', etc.),
|
||||
* accommodating different proxy patterns like Cloudflare, LiteLLM, etc.
|
||||
* Returns the original URL if no valid pattern is found.
|
||||
*
|
||||
* Examples:
|
||||
* - `https://open.ai/v1/chat` -> `https://open.ai/v1`
|
||||
* - `https://open.ai/v1/chat/completions` -> `https://open.ai/v1`
|
||||
* - `https://gateway.ai.cloudflare.com/v1/account/gateway/azure-openai/completions` -> `https://gateway.ai.cloudflare.com/v1/account/gateway/azure-openai`
|
||||
* - `https://open.ai/v1/hi/openai` -> `https://open.ai/v1/hi/openai`
|
||||
* - `https://api.example.com/v1/replicate` -> `https://api.example.com/v1/replicate`
|
||||
*
|
||||
* @param {string} url - The URL to be processed.
|
||||
* @returns {string | undefined} The matched pattern or input if no match is found.
|
||||
*/
|
||||
function extractBaseURL(url) {
|
||||
if (!url || typeof url !== 'string') {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
if (url.startsWith(CohereConstants.API_URL)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!url.includes('/v1')) {
|
||||
return url;
|
||||
}
|
||||
|
||||
// Find the index of '/v1' to use it as a reference point.
|
||||
const v1Index = url.indexOf('/v1');
|
||||
|
||||
// Extract the part of the URL up to and including '/v1'.
|
||||
let baseUrl = url.substring(0, v1Index + 3);
|
||||
|
||||
const openai = 'openai';
|
||||
// Find which suffix is present.
|
||||
const suffixes = [
|
||||
'azure-openai',
|
||||
openai,
|
||||
'aws-bedrock',
|
||||
'anthropic',
|
||||
'cohere',
|
||||
'deepseek',
|
||||
'google-ai-studio',
|
||||
'google-vertex-ai',
|
||||
'grok',
|
||||
'groq',
|
||||
'mistral',
|
||||
'openrouter',
|
||||
'perplexity-ai',
|
||||
'replicate',
|
||||
'huggingface',
|
||||
'workers-ai',
|
||||
'aws-bedrock',
|
||||
];
|
||||
const suffixUsed = suffixes.find((suffix) => url.includes(`/${suffix}`));
|
||||
|
||||
if (suffixUsed === 'azure-openai') {
|
||||
return url.split(/\/(chat|completion)/)[0];
|
||||
}
|
||||
|
||||
// Check if the URL has '/openai' immediately after '/v1'.
|
||||
const openaiIndex = url.indexOf(`/${openai}`, v1Index + 3);
|
||||
// Find which suffix is present in the URL, if any.
|
||||
const suffixIndex =
|
||||
suffixUsed === openai ? openaiIndex : url.indexOf(`/${suffixUsed}`, v1Index + 3);
|
||||
|
||||
// If '/openai' is found right after '/v1', include it in the base URL.
|
||||
if (openaiIndex === v1Index + 3) {
|
||||
// Find the next slash or the end of the URL after '/openai'.
|
||||
const nextSlashIndex = url.indexOf('/', openaiIndex + 7);
|
||||
if (nextSlashIndex === -1) {
|
||||
// If there is no next slash, the rest of the URL is the base URL.
|
||||
baseUrl = url.substring(0, openaiIndex + 7);
|
||||
} else {
|
||||
// If there is a next slash, the base URL goes up to but not including the slash.
|
||||
baseUrl = url.substring(0, nextSlashIndex);
|
||||
}
|
||||
} else if (suffixIndex > 0) {
|
||||
// If a suffix is present but not immediately after '/v1', we need to include the reverse proxy pattern.
|
||||
baseUrl = url.substring(0, suffixIndex + suffixUsed.length + 1);
|
||||
}
|
||||
|
||||
return baseUrl;
|
||||
}
|
||||
|
||||
module.exports = extractBaseURL; // Export the function for use in your test file.
|
||||
|
|
@ -1,111 +0,0 @@
|
|||
const extractBaseURL = require('./extractBaseURL');
|
||||
|
||||
describe('extractBaseURL', () => {
|
||||
test('should extract base URL up to /v1 for standard endpoints', () => {
|
||||
const url = 'https://localhost:8080/v1/chat/completions';
|
||||
expect(extractBaseURL(url)).toBe('https://localhost:8080/v1');
|
||||
});
|
||||
|
||||
test('should include /openai in the extracted URL when present', () => {
|
||||
const url = 'https://localhost:8080/v1/openai';
|
||||
expect(extractBaseURL(url)).toBe('https://localhost:8080/v1/openai');
|
||||
});
|
||||
|
||||
test('should stop at /openai and not include any additional paths', () => {
|
||||
const url = 'https://fake.open.ai/v1/openai/you-are-cool';
|
||||
expect(extractBaseURL(url)).toBe('https://fake.open.ai/v1/openai');
|
||||
});
|
||||
|
||||
test('should return the correct base URL for official openai endpoints', () => {
|
||||
const url = 'https://api.openai.com/v1/chat/completions';
|
||||
expect(extractBaseURL(url)).toBe('https://api.openai.com/v1');
|
||||
});
|
||||
|
||||
test('should handle URLs with reverse proxy pattern correctly', () => {
|
||||
const url = 'https://gateway.ai.cloudflare.com/v1/ACCOUNT_TAG/GATEWAY/openai/completions';
|
||||
expect(extractBaseURL(url)).toBe(
|
||||
'https://gateway.ai.cloudflare.com/v1/ACCOUNT_TAG/GATEWAY/openai',
|
||||
);
|
||||
});
|
||||
|
||||
test('should return input if the URL does not match the expected pattern', () => {
|
||||
const url = 'https://someotherdomain.com/notv1';
|
||||
expect(extractBaseURL(url)).toBe(url);
|
||||
});
|
||||
|
||||
// Test our JSDoc examples.
|
||||
test('should extract base URL up to /v1 for open.ai standard endpoint', () => {
|
||||
const url = 'https://open.ai/v1/chat';
|
||||
expect(extractBaseURL(url)).toBe('https://open.ai/v1');
|
||||
});
|
||||
|
||||
test('should extract base URL up to /v1 for open.ai standard endpoint with additional path', () => {
|
||||
const url = 'https://open.ai/v1/chat/completions';
|
||||
expect(extractBaseURL(url)).toBe('https://open.ai/v1');
|
||||
});
|
||||
|
||||
test('should handle URLs with ACCOUNT/GATEWAY pattern followed by /openai', () => {
|
||||
const url = 'https://open.ai/v1/ACCOUNT/GATEWAY/openai/completions';
|
||||
expect(extractBaseURL(url)).toBe('https://open.ai/v1/ACCOUNT/GATEWAY/openai');
|
||||
});
|
||||
|
||||
test('should include /openai in the extracted URL with additional segments', () => {
|
||||
const url = 'https://open.ai/v1/hi/openai';
|
||||
expect(extractBaseURL(url)).toBe('https://open.ai/v1/hi/openai');
|
||||
});
|
||||
|
||||
test('should handle Azure OpenAI Cloudflare endpoint correctly', () => {
|
||||
const url = 'https://gateway.ai.cloudflare.com/v1/account/gateway/azure-openai/completions';
|
||||
expect(extractBaseURL(url)).toBe(
|
||||
'https://gateway.ai.cloudflare.com/v1/account/gateway/azure-openai',
|
||||
);
|
||||
});
|
||||
|
||||
test('should include various suffixes in the extracted URL when present', () => {
|
||||
const urls = [
|
||||
'https://api.example.com/v1/azure-openai/something',
|
||||
'https://api.example.com/v1/replicate/anotherthing',
|
||||
'https://api.example.com/v1/huggingface/yetanotherthing',
|
||||
'https://api.example.com/v1/workers-ai/differentthing',
|
||||
'https://api.example.com/v1/aws-bedrock/somethingelse',
|
||||
];
|
||||
|
||||
const expected = [
|
||||
/* Note: exception for azure-openai to allow credential injection */
|
||||
'https://api.example.com/v1/azure-openai/something',
|
||||
'https://api.example.com/v1/replicate',
|
||||
'https://api.example.com/v1/huggingface',
|
||||
'https://api.example.com/v1/workers-ai',
|
||||
'https://api.example.com/v1/aws-bedrock',
|
||||
];
|
||||
|
||||
urls.forEach((url, index) => {
|
||||
expect(extractBaseURL(url)).toBe(expected[index]);
|
||||
});
|
||||
});
|
||||
|
||||
test('should handle URLs with suffixes not immediately after /v1', () => {
|
||||
const url = 'https://api.example.com/v1/some/path/azure-openai';
|
||||
expect(extractBaseURL(url)).toBe('https://api.example.com/v1/some/path/azure-openai');
|
||||
});
|
||||
|
||||
test('should handle URLs with complex paths after the suffix', () => {
|
||||
const url = 'https://api.example.com/v1/replicate/deep/path/segment';
|
||||
expect(extractBaseURL(url)).toBe('https://api.example.com/v1/replicate');
|
||||
});
|
||||
|
||||
test('should leave a regular Azure OpenAI baseURL as is', () => {
|
||||
const url = 'https://instance-name.openai.azure.com/openai/deployments/deployment-name';
|
||||
expect(extractBaseURL(url)).toBe(url);
|
||||
});
|
||||
|
||||
test('should leave a regular Azure OpenAI baseURL with placeholders as is', () => {
|
||||
const url = 'https://${INSTANCE_NAME}.openai.azure.com/openai/deployments/${DEPLOYMENT_NAME}';
|
||||
expect(extractBaseURL(url)).toBe(url);
|
||||
});
|
||||
|
||||
test('should leave an alternate Azure OpenAI baseURL with placeholders as is', () => {
|
||||
const url = 'https://${INSTANCE_NAME}.com/resources/deployments/${DEPLOYMENT_NAME}';
|
||||
expect(extractBaseURL(url)).toBe(url);
|
||||
});
|
||||
});
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
const { logger } = require('@librechat/data-schemas');
|
||||
|
||||
function findContent(obj) {
|
||||
if (obj && typeof obj === 'object') {
|
||||
if ('kwargs' in obj && 'content' in obj.kwargs) {
|
||||
return obj.kwargs.content;
|
||||
}
|
||||
for (let key in obj) {
|
||||
let content = findContent(obj[key]);
|
||||
if (content) {
|
||||
return content;
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function findMessageContent(message) {
|
||||
let startIndex = Math.min(message.indexOf('{'), message.indexOf('['));
|
||||
let jsonString = message.substring(startIndex);
|
||||
|
||||
let jsonObjectOrArray;
|
||||
try {
|
||||
jsonObjectOrArray = JSON.parse(jsonString);
|
||||
} catch (error) {
|
||||
logger.error('[findMessageContent] Failed to parse JSON:', error);
|
||||
return null;
|
||||
}
|
||||
|
||||
let content = findContent(jsonObjectOrArray);
|
||||
|
||||
return content;
|
||||
}
|
||||
|
||||
module.exports = findMessageContent;
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
const deriveBaseURL = require('./deriveBaseURL');
|
||||
const extractBaseURL = require('./extractBaseURL');
|
||||
const findMessageContent = require('./findMessageContent');
|
||||
|
||||
module.exports = {
|
||||
deriveBaseURL,
|
||||
extractBaseURL,
|
||||
findMessageContent,
|
||||
};
|
||||
Loading…
Add table
Add a link
Reference in a new issue