Add OCO_API_CUSTOM_HEADERS#467
Merged
di-sukharev merged 3 commits intodi-sukharev:masterfrom May 3, 2025
Merged
Conversation
Add OCO_API_CUSTOM_HEADERS variable to README, config enum, and env parsing to allow JSON string of custom headers. Validate that custom headers are valid JSON in config validator. Extend AiEngineConfig with customHeaders and pass headers to OllamaEngine and OpenAiEngine clients when creating requests. Parse custom headers in utils/engine and warn on invalid format. Add unit tests to ensure OCO_API_CUSTOM_HEADERS is handled correctly and merged from env over global config. This enables users to send additional headers such as Authorization or tracing headers with LLM API calls.
di-sukharev
requested changes
Apr 30, 2025
Owner
di-sukharev
left a comment
di-sukharev
left a comment
There was a problem hiding this comment.
asked for few changes, thank you for contributing! <3
| } else { | ||
| this.client = new OpenAI({ apiKey: config.apiKey, baseURL: config.baseURL }); | ||
| // Configuration options for the OpenAI client | ||
| const clientOptions: any = { |
Owner
There was a problem hiding this comment.
please remove comments and any
| apiKey: config.apiKey | ||
| }; | ||
|
|
||
| // Add baseURL if present |
| clientOptions.baseURL = config.baseURL; | ||
| } | ||
|
|
||
| // Add custom headers if present |
| if (config.customHeaders) { | ||
| try { | ||
| let headers = config.customHeaders; | ||
| // If the headers are a string, try to parse them as JSON |
| let customHeaders = {}; | ||
| if (config.OCO_API_CUSTOM_HEADERS) { | ||
| try { | ||
| // If it's already an object, no need to parse it |
Owner
There was a problem hiding this comment.
could you move this code to a function with a good semantic name please
| if (typeof config.OCO_API_CUSTOM_HEADERS === 'object' && !Array.isArray(config.OCO_API_CUSTOM_HEADERS)) { | ||
| customHeaders = config.OCO_API_CUSTOM_HEADERS; | ||
| } else { | ||
| // Try to parse as JSON |
Owner
|
also please pull latest master and look for failing tests @EmilienMottet, thank you! |
Use OpenAI.ClientOptions for stronger typing and clarity Extract custom headers parsing into parseCustomHeaders util Simplify getEngine by delegating header parsing to helper Improve maintainability and reduce code duplication
di-sukharev
reviewed
Apr 30, 2025
|
|
||
| if (config.customHeaders) { | ||
| try { | ||
| let headers = config.customHeaders; |
Owner
There was a problem hiding this comment.
could parseCustomHeaders be used here too?
Owner
|
added one more comment to reuse the parseCustomHeaders function on one more place and please look into the tests that fail |
Owner
|
Contributor
Author
|
Hi @di-sukharev thanks for your review, I make change now :) |
- export parseCustomHeaders from src/utils/engine.ts - use parseCustomHeaders in OpenAiEngine for config.customHeaders - remove try/catch and inline JSON.parse logic - update config test to expect headers as object and drop JSON.parse Centralize header parsing for reuse and simplify engine code Update tests to match new header format for clarity
Contributor
Author
|
Thank you for your review @di-sukharev , tell me if you want more change :) |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| }); | ||
|
|
||
| expect(config).not.toEqual(null); | ||
| expect(config.OCO_API_CUSTOM_HEADERS).toEqual({"Authorization": "Bearer token123", "X-Custom-Header": "test-value"}); |
Check failure
Code scanning / CodeQL
Hard-coded credentials Critical test
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request implements the feature described in #466 by adding support for custom HTTP headers in API requests via the new
OCO_API_CUSTOM_HEADERSconfiguration option.Main changes
OCO_API_CUSTOM_HEADERSenvironment/config variable.Example usage
Additional context
Close #466