Skip to content

GitHub API requests ignore proxy environment variables on GitHub Enterprise Server #331

Description

@zaa4wz

Description

ctrf-io/github-test-reporter cannot post or update comments when the GitHub Enterprise Server API is accessible from the runner only through an HTTP forward proxy.

The proxy environment variables are configured, but the reporter appears to connect directly to the GitHub Enterprise Server host instead of using the proxy. Because direct access is blocked by the firewall, the connection times out.

This affects features that use the GitHub API, including pull request comments, issue comments, historical reports, and artifact retrieval.

Environment

  • Action: ctrf-io/github-test-reporter@v1
  • GitHub platform: GitHub Enterprise Server
  • Runner: self-hosted
  • Action runtime: Node.js 24
  • Target API: https://github.example.com/api/v3
  • Network: GitHub Enterprise Server is reachable from the runner only through an HTTP forward proxy

All company-specific hostnames, repository names, and proxy addresses in this report have been replaced with placeholders.

Proxy configuration

The standard proxy environment variables are configured for the action:

env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  HTTP_PROXY: http://proxy.example.com:8080
  HTTPS_PROXY: http://proxy.example.com:8080
  http_proxy: http://proxy.example.com:8080
  https_proxy: http://proxy.example.com:8080

A proxy-aware client such as curl can reach the same GitHub Enterprise API endpoint from the runner when configured to use this proxy.

Steps to reproduce

Run the reporter on a self-hosted runner where direct access to GitHub Enterprise Server is blocked, but access through an HTTP forward proxy is available:

- name: Publish test report
  uses: ctrf-io/github-test-reporter@v1
  if: always()
  with:
    report-path: path/to/ctrf-report.json
    pull-request-report: true
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    HTTP_PROXY: http://proxy.example.com:8080
    HTTPS_PROXY: http://proxy.example.com:8080
    http_proxy: http://proxy.example.com:8080
    https_proxy: http://proxy.example.com:8080

Actual behavior

The request is retried three times and then fails with a connection timeout:

GET /repos/example-org/example-repo/issues/143/comments?per_page=100 - 500 with id UNKNOWN in 10598ms
GET /repos/example-org/example-repo/issues/143/comments?per_page=100 - 500 with id UNKNOWN in 10510ms
GET /repos/example-org/example-repo/issues/143/comments?per_page=100 - 500 with id UNKNOWN in 10545ms
GET /repos/example-org/example-repo/issues/143/comments?per_page=100 - 500 with id UNKNOWN in 10516ms
Warning: Failed to post PR comment: Connect Timeout Error
(attempted address: github.example.com:443, timeout: 10000ms)

The 500 with id UNKNOWN entries appear to be generated by Octokit's retry plugin for the connection failure. They do not appear to represent HTTP 500 responses returned by GitHub Enterprise Server, because the underlying error is a connection timeout.

The attempted address also indicates that the client is trying to connect directly to github.example.com:443.

Expected behavior

GitHub API requests made by the action should use the proxy configured through the standard environment variables:

  • HTTPS_PROXY or https_proxy
  • HTTP_PROXY or http_proxy
  • NO_PROXY or no_proxy

If additional configuration is required, it should be documented.

Suspected cause

The reporter creates its own @octokit/rest client here:

https://github.com/ctrf-io/github-test-reporter/blob/main/src/client/github/client.ts

The client currently configures authentication, the GitHub API base URL, and retries, but it does not provide a proxy-aware request.fetch implementation or dispatcher:

const options = {
  auth: GITHUB_TOKEN,
  retry: {
    enabled: true,
    retries: 3,
  },
};

According to the Octokit documentation, its API client does not use standard proxy environment variables by default. A proxy-aware fetch implementation or dispatcher must be provided:

https://github.com/octokit/octokit.js#proxy-servers-nodejs-only

For comparison, @actions/github configures Octokit with proxy-aware request handling through @actions/http-client:

The action currently declares a Node.js 24 runtime. Node.js 24 supports HTTP_PROXY, HTTPS_PROXY, and NO_PROXY, but environment-based proxy handling must be enabled with NODE_USE_ENV_PROXY=1, --use-env-proxy, or programmatically:

Setting only HTTP_PROXY or HTTPS_PROXY does not automatically enable proxy handling for Node.js fetch.

Suggested solution

Please make the GitHub API client proxy-aware. Possible approaches include:

  1. Use the proxy-aware Octokit configuration provided by @actions/github.
  2. Provide Octokit with a proxy-aware request.fetch implementation or Undici dispatcher.
  3. Explicitly enable Node.js environment-proxy support before creating the Octokit client.

Ideally, the implementation should support:

  • HTTPS_PROXY and https_proxy
  • HTTP_PROXY and http_proxy
  • NO_PROXY and no_proxy
  • HTTPS destinations through an HTTP CONNECT proxy
  • Proxy authentication, if supported

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions