feat(api-proxy): Azure OpenAI BYOK routing support #4024
+328
−12
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| /** | ||
| * Tests for Copilot Azure OpenAI BYOK routing. | ||
| * | ||
| * Covers: isAzureOpenAITarget detection, api-key header injection, | ||
| * and api-version query parameter injection via transformRequestUrl. | ||
| */ | ||
|
|
||
| const { | ||
| createCopilotAdapter, | ||
| _testing: { | ||
| isAzureOpenAITarget, | ||
| shouldInjectAzureApiVersion, | ||
| AZURE_DEFAULT_API_VERSION, | ||
| }, | ||
| } = require('./providers/copilot'); | ||
|
|
||
| describe('isAzureOpenAITarget', () => { | ||
| it('detects *.openai.azure.com', () => { | ||
| expect(isAzureOpenAITarget('my-resource.openai.azure.com')).toBe(true); | ||
| }); | ||
|
|
||
| it('detects *.cognitiveservices.azure.com', () => { | ||
| expect(isAzureOpenAITarget('my-resource.cognitiveservices.azure.com')).toBe(true); | ||
| }); | ||
|
|
||
| it('does not match standard Copilot target', () => { | ||
| expect(isAzureOpenAITarget('api.githubcopilot.com')).toBe(false); | ||
| }); | ||
|
|
||
| it('does not match partial hostname match', () => { | ||
| expect(isAzureOpenAITarget('evil.openai.azure.com.attacker.com')).toBe(false); | ||
| expect(isAzureOpenAITarget('openai.azure.com')).toBe(true); | ||
| }); | ||
|
|
||
| it('does not match GitHub catalog targets', () => { | ||
| expect(isAzureOpenAITarget('models.inference.ai.azure.com')).toBe(false); | ||
| }); | ||
| }); | ||
|
|
||
| describe('shouldInjectAzureApiVersion', () => { | ||
| it('returns true for Azure deployment-style base paths', () => { | ||
| expect(shouldInjectAzureApiVersion('/openai/deployments/gpt-4o', '/chat/completions')).toBe(true); | ||
| }); | ||
|
|
||
| it('returns false for Azure v1 base path', () => { | ||
| expect(shouldInjectAzureApiVersion('/openai/v1', '/chat/completions')).toBe(false); | ||
| }); | ||
|
|
||
| it('returns false when request path is Azure v1 formatted', () => { | ||
| expect(shouldInjectAzureApiVersion('', '/openai/v1/chat/completions')).toBe(false); | ||
| }); | ||
| }); | ||
|
|
||
| describe('Azure OpenAI BYOK adapter', () => { | ||
| const azureEnv = { | ||
| COPILOT_API_KEY: 'my-azure-api-key', | ||
| COPILOT_API_TARGET: 'https://my-resource.openai.azure.com', | ||
| COPILOT_API_BASE_PATH: '/openai/deployments/gpt-4o', | ||
| }; | ||
|
|
||
| describe('getAuthHeaders', () => { | ||
| it('uses api-key header for Azure targets', () => { | ||
| const adapter = createCopilotAdapter(azureEnv); | ||
| const req = { url: '/chat/completions', method: 'POST', headers: {} }; | ||
| const headers = adapter.getAuthHeaders(req); | ||
| expect(headers).toEqual({ 'api-key': 'my-azure-api-key' }); | ||
| }); | ||
|
|
||
| it('does not include Copilot-Integration-Id for Azure targets', () => { | ||
| const adapter = createCopilotAdapter(azureEnv); | ||
| const req = { url: '/chat/completions', method: 'POST', headers: {} }; | ||
| const headers = adapter.getAuthHeaders(req); | ||
| expect(headers['Copilot-Integration-Id']).toBeUndefined(); | ||
| expect(headers['Authorization']).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('still uses Bearer auth for non-Azure targets', () => { | ||
| const adapter = createCopilotAdapter({ | ||
| COPILOT_API_KEY: 'my-key', | ||
| COPILOT_API_TARGET: 'https://api.githubcopilot.com', | ||
| }); | ||
| const req = { url: '/chat/completions', method: 'POST', headers: {} }; | ||
| const headers = adapter.getAuthHeaders(req); | ||
| expect(headers['Authorization']).toBe('Bearer my-key'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('transformRequestUrl', () => { | ||
| it('appends api-version when absent for Azure targets', () => { | ||
|
Collaborator
There was a problem hiding this comment. @copilot |
||
| const adapter = createCopilotAdapter(azureEnv); | ||
| const result = adapter.transformRequestUrl('/chat/completions'); | ||
| expect(result).toBe(`/chat/completions?api-version=${AZURE_DEFAULT_API_VERSION}`); | ||
| }); | ||
|
|
||
| it('preserves existing api-version parameter', () => { | ||
| const adapter = createCopilotAdapter(azureEnv); | ||
| const result = adapter.transformRequestUrl('/chat/completions?api-version=2025-01-01'); | ||
| expect(result).toBe('/chat/completions?api-version=2025-01-01'); | ||
| }); | ||
|
|
||
| it('preserves other query parameters', () => { | ||
| const adapter = createCopilotAdapter(azureEnv); | ||
| const result = adapter.transformRequestUrl('/chat/completions?stream=true'); | ||
| expect(result).toContain('stream=true'); | ||
| expect(result).toContain(`api-version=${AZURE_DEFAULT_API_VERSION}`); | ||
| }); | ||
|
|
||
| it('respects COPILOT_AZURE_API_VERSION override', () => { | ||
| const adapter = createCopilotAdapter({ | ||
| ...azureEnv, | ||
| COPILOT_AZURE_API_VERSION: '2025-03-01', | ||
| }); | ||
| const result = adapter.transformRequestUrl('/chat/completions'); | ||
| expect(result).toBe('/chat/completions?api-version=2025-03-01'); | ||
| }); | ||
|
|
||
| it('does not append api-version for Azure OpenAI v1 base path', () => { | ||
| const adapter = createCopilotAdapter({ | ||
| ...azureEnv, | ||
| COPILOT_API_BASE_PATH: '/openai/v1', | ||
| }); | ||
| const result = adapter.transformRequestUrl('/chat/completions?stream=true'); | ||
| expect(result).toBe('/chat/completions?stream=true'); | ||
| }); | ||
|
|
||
| it('does not append api-version for Azure OpenAI v1 request path', () => { | ||
| const adapter = createCopilotAdapter({ | ||
| ...azureEnv, | ||
| COPILOT_API_BASE_PATH: '', | ||
| }); | ||
| const result = adapter.transformRequestUrl('/openai/v1/chat/completions?stream=true'); | ||
| expect(result).toBe('/openai/v1/chat/completions?stream=true'); | ||
| }); | ||
|
|
||
| it('is a no-op for non-Azure targets', () => { | ||
| const adapter = createCopilotAdapter({ | ||
| COPILOT_API_KEY: 'my-key', | ||
| COPILOT_API_TARGET: 'https://api.githubcopilot.com', | ||
| }); | ||
| const result = adapter.transformRequestUrl('/v1/chat/completions'); | ||
| expect(result).toBe('/v1/chat/completions'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('cognitiveservices.azure.com target', () => { | ||
| it('also uses api-key header', () => { | ||
| const adapter = createCopilotAdapter({ | ||
| COPILOT_API_KEY: 'cog-key', | ||
| COPILOT_API_TARGET: 'https://my-resource.cognitiveservices.azure.com', | ||
| COPILOT_API_BASE_PATH: '/openai/deployments/gpt-4o', | ||
| }); | ||
| const req = { url: '/chat/completions', method: 'POST', headers: {} }; | ||
| const headers = adapter.getAuthHeaders(req); | ||
| expect(headers).toEqual({ 'api-key': 'cog-key' }); | ||
| }); | ||
| }); | ||
| }); | ||
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just tested and
api-keyheader does NOT work for Entra access tokens - butAuthorization: Bearer ...appears to work for both Foundry API keys and Entra tokens.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confirmed for both API forms: