feat(api-proxy): forward COPILOT_INTEGRATION_ID from host env#5147
Open
lpcox wants to merge 2 commits into
Open
feat(api-proxy): forward COPILOT_INTEGRATION_ID from host env#5147lpcox wants to merge 2 commits into
lpcox wants to merge 2 commits into
Conversation
Add support for forwarding COPILOT_INTEGRATION_ID environment variable from host to api-proxy container. This allows consumers to override the default 'agentic-workflows' integration ID when needed for specific model allowlists or other integration requirements. Implementation: - Forward COPILOT_INTEGRATION_ID from host env if explicitly set - Trim and validate the value (ignore empty/whitespace-only values) - Fall back to api-proxy's default 'agentic-workflows' when unset This is intentionally undocumented for limited use cases only. Closes #5132 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
✅ Coverage Check PassedOverall Coverage
📁 Per-file Coverage Changes (1 files)
Coverage comparison generated by |
Contributor
There was a problem hiding this comment.
⚠️ Not ready to approve
There’s a mismatch between the claimed --env support and the current implementation plus a test reliability issue due to incomplete env cleanup in existing tests.
Pull request overview
Adds an opt-in mechanism for callers to override the api-proxy’s default Copilot integration ID (agentic-workflows) by forwarding COPILOT_INTEGRATION_ID into the api-proxy container (with trimming and whitespace-only suppression), plus unit tests to validate the forwarding behavior.
Changes:
- Forward
COPILOT_INTEGRATION_IDinto the api-proxy container only when it’s non-empty after trimming. - Keep
GITHUB_COPILOT_INTEGRATION_IDintentionally un-forwarded. - Add Jest coverage for set/empty/whitespace/trim/unset cases.
File summaries
| File | Description |
|---|---|
| src/services/api-proxy-service-config.ts | Adds conditional forwarding of COPILOT_INTEGRATION_ID into the api-proxy container env. |
| src/services/api-proxy-service-api-targets.test.ts | Adds unit tests validating forwarding/omission behavior for COPILOT_INTEGRATION_ID. |
Copilot's findings
- Files reviewed: 2/2 changed files
- Comments generated: 2
Note
Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+125
to
+127
| ...(process.env.COPILOT_INTEGRATION_ID?.trim() && { | ||
| COPILOT_INTEGRATION_ID: process.env.COPILOT_INTEGRATION_ID.trim(), | ||
| }), |
Comment on lines
+544
to
+548
| it('should forward COPILOT_INTEGRATION_ID from host env when explicitly set', () => { | ||
| const origCopilot = process.env.COPILOT_INTEGRATION_ID; | ||
| const origGhCopilot = process.env.GITHUB_COPILOT_INTEGRATION_ID; | ||
| process.env.COPILOT_INTEGRATION_ID = 'my-custom-integration'; | ||
| delete process.env.GITHUB_COPILOT_INTEGRATION_ID; |
Collaborator
Author
|
@copilot address review feedback |
Contributor
|
⏳ Copilot review left inline comments. @lpcox To proceed:
|
- Use getConfigEnvValue() to support --env/--env-file/--env-all for COPILOT_INTEGRATION_ID - Add describe-level beforeEach/afterEach to prevent test flakiness - Add tests for additionalEnv support and precedence - All 9 tests in COPILOT_INTEGRATION_ID forwarding suite passing
Contributor
Review feedback addressed in commit f8a1456:
All 9 tests in the COPILOT_INTEGRATION_ID forwarding suite are passing, including 2 new tests that verify |
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
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.
Summary
Adds support for forwarding
COPILOT_INTEGRATION_IDenvironment variable from host to api-proxy container, allowing consumers to override the default 'agentic-workflows' integration ID when needed for specific model allowlists or other integration requirements.Implementation
COPILOT_INTEGRATION_IDfrom--env,--env-file, or host env (with--env-all)GITHUB_COPILOT_INTEGRATION_ID(remains unused)Testing
Added 7 new test cases covering:
All unit tests pass.
Why This Approach
This is intentionally undocumented for limited use cases:
--envCLI flag, not stdin configUsage
Users can set it via
--envflag:Or via host env with
--env-all:export COPILOT_INTEGRATION_ID=copilot-developer-cli awf --env-all --allow-domains api.githubcopilot.com ...Or in GitHub Actions: