Skip to content

Improve global proxy tests#4035

Open
mbg wants to merge 3 commits into
mainfrom
mbg/improve-global-proxy-tests
Open

Improve global proxy tests#4035
mbg wants to merge 3 commits into
mainfrom
mbg/improve-global-proxy-tests

Conversation

@mbg

@mbg mbg commented Jul 22, 2026

Copy link
Copy Markdown
Member

Improves our global-proxy e2e test. The existing test setup didn't actually verify that the proxy was used or force its usage. This PR improves the test by blocking HTTP(S) connections (for the standard ports). I have verified that this fails without the changes to api-client.ts from #4030 / this PR and succeeds with them.

Additionally, this PR slightly modifies makeProxyRequestOptions to always base the result on githubUtils.defaults.request and only overrides fetch. This should make it more robust if githubUtils.defaults.request includes other properties in the future or agent becomes more critical. I have also added two test cases there to check that the result either matches the default if no custom dispatcher is given, or matches the defaults with a different fetch otherwise. The actual proxy functionality is tested elsewhere.

Risk assessment

For internal use only. Please select the risk level of this change:

  • Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Workflow types:

  • Advanced setup - Impacts users who have custom CodeQL workflows.
  • Managed - Impacts users with dynamic workflows (Default Setup, Code Quality, ...).

Products:

  • Code Scanning - The changes impact analyses when analysis-kinds: code-scanning.
  • Code Quality - The changes impact analyses when analysis-kinds: code-quality.
  • Other first-party - The changes impact other first-party analyses.
  • Third-party analyses - The changes affect the upload-sarif action.

Environments:

  • Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency.
  • GHES - Impacts CodeQL workflows on GitHub Enterprise Server.

How did/will you validate this change?

  • Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).
  • End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

  • Telemetry - I rely on existing telemetry or have made changes to the telemetry.
    • Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.
    • Alerts - New or existing monitors will trip if something goes wrong with this change.

Are there any special considerations for merging or releasing this change?

  • No special considerations - This change can be merged at any time.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Consider adding a changelog entry for this change.
  • Confirm the readme and docs have been updated if necessary.

@mbg mbg self-assigned this Jul 22, 2026
@github-actions github-actions Bot added the size/S Should be easy to review label Jul 22, 2026
@mbg
mbg force-pushed the mbg/improve-global-proxy-tests branch 2 times, most recently from c23c8f4 to a2bfb64 Compare July 22, 2026 06:33
@mbg
mbg marked this pull request as ready for review July 22, 2026 06:41
@mbg
mbg requested a review from a team as a code owner July 22, 2026 06:41
Copilot AI review requested due to automatic review settings July 22, 2026 06:41

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

  • Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.

Pull request overview

Strengthens proxy validation and preserves GitHub API request defaults.

Changes:

  • Forces HTTP(S) traffic through the proxy in the end-to-end test.
  • Preserves default request options when customizing fetch.
  • Adds unit coverage for both proxy configurations.
Show a summary per file
File Description
src/api-client.ts Preserves default request options.
src/api-client.test.ts Tests proxy option construction.
pr-checks/checks/global-proxy.yml Enforces proxy usage.
lib/entry-points.js Generated artifact; excluded from review.
.github/workflows/__global-proxy.yml Generated workflow; excluded from review.

Review details

Files excluded by content exclusion policy (2)
  • .github/workflows/__global-proxy.yml
  • lib/entry-points.js
  • Files reviewed: 3/5 changed files
  • Comments generated: 0
  • Review effort level: Medium

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Should be easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants