feat: add HTTP/HTTPS proxy and TLS support (#40) - #43
Open
alerizzo wants to merge 3 commits into
Open
Conversation
Node's global fetch — used by the generated API client and the MITRE CVE lookup in commands/finding.ts — ignores HTTP_PROXY/HTTPS_PROXY/NO_PROXY, so the CLI was unusable behind a corporate proxy. Rather than reimplement it, delegate to configureProxy() from @codacy/tooling (bumped 0.1.0 -> ^0.22.0), the same function the Codacy Analysis CLI calls. It installs a global undici dispatcher with per-request protocol and NO_PROXY routing, bare host:port normalization, and SSL_CERT_FILE/NODE_EXTRA_CA_CERTS CA loading. Keeping the implementation upstream is what keeps the environment contract identical across the Codacy tools; a local copy would drift. src/utils/proxy.ts is a thin seam: configureProxyFromEnv() calls it and routes its deliberate fail-loud throw (unreadable or non-PEM CA bundle) into handleError(), giving red `Error: <message>` and exit 1 like every other failure here. analysis-cli exits 2 because it has a documented exit-code scheme; this CLI does not, and exits 1 everywhere. Called at the top of src/index.ts. Ordering is only constrained to precede program.parse, since the dispatcher is resolved per request — it goes first so the network stack is set up before we point it at the API. Kept top-level rather than in the preAction hook so a typo'd SSL_CERT_FILE fails even on --version. Also add a CI smoke step that runs the built entry point three ways (plain, with HTTPS_PROXY set, and with a bad SSL_CERT_FILE expected to fail). Nothing previously executed src/index.ts — every command test builds a bare new Command() — which is how a proxy dependency that cannot even load on Node 20 could pass CI. Upstream owns the proxy semantics and their 24 tests, so only the seam is tested here (4 new tests, 614 total). Supersedes #39. Co-Authored-By: rattalur <145406381+rattalur@users.noreply.github.com> Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 17 |
| Duplication | 0 |
AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.
TIP This summary will be updated as you push new changes.
Follow-up to an adversarial review of this branch. Three claims were wrong and one dependency range did not do what it was chosen to do. - Pin @codacy/tooling to exact 0.22.0, was ^0.22.0. The caret was chosen so upstream proxy fixes would arrive without a bump PR, but for a pre-1.0 package the caret spans patches only (^0.22.0 resolves to >=0.22.0 <0.23.0-0), so it never would have picked up a 0.23.0. It bought silent patch drift with no proxy coverage in this repo to catch a regression, and none of the upside. Bumps are now deliberate. Also drops the claim that every other dependency here is pinned exactly -- cli-table3 was already ^0.6.3 before this branch. - configureProxyFromEnv's doc claimed a bad CA bundle is "the one thing configureProxy throws on". It is not: a malformed proxy URL throws too, as whatever new URL() or undici's ProxyAgent raises. Verified against the installed 0.22.0 -- HTTPS_PROXY="not a url" gives `Error: Invalid URL`, ftp:// gives `Error: invalid url`. The catch is intentionally broad, so the comment now states that contract instead of enumerating a list that rots. - "No-op when nothing is set" was true of behavior but not of cost. 0.22.0 imports undici at module scope rather than behind configureProxy's early-out, so every invocation pays it, --help and --version included. Measured ~27 ms median against a ~119 ms baseline (20 interleaved runs, Node 20). Disclosed in the module header and the changeset rather than left implied. Upstream 0.23.0 (published today) moves that import behind a lazy factory and adds proxy-URL validation with credential redaction. Not taken here: it cannot be installed or verified in this environment. Its CA-bundle error text is unchanged, so the CI smoke step's substring assertion survives the bump. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
0.23.0 ships the two fixes filed from this branch's review (recorded in
analysis-cli's docs/tech-debt.md), and both land here:
- undici now loads lazily, behind configureProxy's "nothing configured"
early-out. An unproxied run pays nothing: `--version` measures 0 ms delta
against a `main` build, down from 27 ms on 0.22.0 (20 interleaved runs,
Node 20, median). Verified the property directly too -- requiring the
tooling barrel and calling configureProxy() with no proxy env leaves undici
out of require.cache, while a configured proxy still loads it.
- a malformed proxy URL now names the offending setting and redacts
credentials, replacing a bare `Invalid URL`:
HTTPS_PROXY="ftp://user:hunter2@proxy.corp:8080"
-> Error: Invalid HTTPS_PROXY value "ftp://user:***@proxy.corp:8080":
unsupported scheme "ftp:"; expected a URL such as http://proxy.corp:8080
Checked for upgrade breakage: the CA-bundle error text is unchanged, so the
CI smoke step's substring assertion still holds. Bare `host:port` and
credentialed proxy URLs still resolve.
Installing this required scoping npm's supply-chain guard rather than
weakening it. ~/.npmrc has min-release-age=3, which blocked a package
published an hour earlier; it now also carries
`min-release-age-exclude[]=@codacy/*` (npm's documented pattern for exactly
this). Verified the guard still blocks a 1-day-old third-party version.
Docs updated to match: the module header no longer claims a cost that is gone,
and the changeset no longer warns about it.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Closes #40. Supersedes #39.
Node's global
fetch— used by the generated API client and the MITRE CVE lookup incommands/finding.ts— ignoresHTTP_PROXY/HTTPS_PROXY/NO_PROXY, so the CLI is unusable behind a corporate proxy.Approach
Delegate to
configureProxy()from@codacy/tooling(0.1.0→0.22.0) — the same function the Codacy Analysis CLI calls. We write no proxy logic. Upstream installs a globalundicidispatcher with per-request protocol +NO_PROXYrouting, barehost:portnormalization, andSSL_CERT_FILE/NODE_EXTRA_CA_CERTSCA loading.Keeping the implementation upstream is the point: it's what makes the environment contract identical across the Codacy tools. A local copy would drift.
AGENTS.mdnow records that proxy behavior changes belong inanalysis-cli'spackages/tooling/src/proxy.ts, followed by a dependency bump here.src/utils/proxy.tsis a thin seam —configureProxyFromEnv()calls upstream and routes its throw intohandleError(), giving redError: <message>and exit 1 like every other failure here. It's a module rather than an inlinetry/catchbecause nothing in this repo has ever executedsrc/index.ts, so inline logic would be the only untestable branch in the feature.Supported variables — same names as the Analysis CLI and the VS Code extension:
HTTPS_PROXY/HTTP_PROXY(or lowercase)host:portacceptedNO_PROXY/no_proxy*,.suffix), matched per requestSSL_CERT_FILE/NODE_EXTRA_CA_CERTSCODACY_CLI_INSECUREBehaviorally a no-op when none are set — though not free; see the cost note below.
Why not #39
@rattalur found a real gap and their PR's docs — particularly the curl-works-but-the-CLI-doesn't diagnostic — were better than most. But that implementation hand-rolled the proxy logic with
undici@8.10.1as a direct dependency, and review found:undici@8.10.1requires Node >= 22.19.0, against this package'sengines: ">=20". Verified on Node v20.20.2 (latest 20.x):require("undici")throwsTypeError: webidl.util.markAsUncloneable is not a functionat module load, socodacy --versioncrashed for every Node 20 user with no proxy configured. Tooling'sundici@^6.21.0supports Node >= 18.17.NO_PROXYwas evaluated once against the Codacy host, then a process-global agent was installed — soNO_PROXY=cveawg.mitre.orgwas ignored, andNO_PROXY=app.codacy.comdisabled the proxy for everything.host:portcrashed the CLI with a raw undici stack trace. That form is what curl accepts, i.e. exactly this feature's audience.SSL_CERT_FILEwas silently ignored.That Node 20 regression passed CI, because the proxy tests mocked
undiciwholesale and nothing executed the entry point. So this PR also adds a smoke step running the built CLI three ways (plain, withHTTPS_PROXY, and with a badSSL_CERT_FILEexpected to fail) on both matrix legs.Verification
Beyond
tsc --noEmitand 614 passing tests, verified against a local CONNECT-logging proxy:dist/index.js --versionstarts fine (the Add undici-based HTTP/HTTPS proxy support with tests and documentation #39 failure mode)NO_PROXY→ bothapp.codacy.comandcveawg.mitre.orgloggedNO_PROXY=app.codacy.com→ onlycveawg.mitre.orglogged; Codacy went direct. This is the per-request routing Add undici-based HTTP/HTTPS proxy support with tests and documentation #39 could not doNO_PROXY=*→ nothing proxiedHTTPS_PROXY=proxy.corp:8080(bare host) → normalized, no crashSSL_CERT_FILE→Error: Failed to read CA certificate .../No PEM certificate found ..., exit 1codacy infoend-to-end through the proxy with real credentials → succeeded, CONNECT loggedStartup cost — measured, and now zero
@codacy/tooling@0.22.0importedundiciat module scope rather than behindconfigureProxy's "nothing configured" early-out, so every invocation paid for loading it —--helpand--versionincluded, proxy or not. Measured at 27 ms median against amainbuild.0.23.0 fixes it, and this branch takes it. The import now sits behind a memoized lazy factory:
Verified the property directly, not just by timing: requiring the tooling barrel and calling
configureProxy()with no proxy env leavesundiciout ofrequire.cache, while a configured proxy still loads it.0.23.0 also replaces the bare
Invalid URLa malformed proxy value used to produce with a message that names the setting and redacts credentials:Both changes were filed upstream from this branch's review and are recorded in
analysis-cli'sdocs/tech-debt.md. Checked for upgrade breakage before taking it: the CA-bundle error text is unchanged, so the CI smoke step's substring assertion still holds, and barehost:portplus credentialed proxy URLs still resolve.Note
@codacy/toolingalso stops being a phantom dependency:src/types/codacy-config.tsusesexport type, which tsc erases, sodist/previously contained norequire("@codacy/tooling")at all.Dependency is pinned exactly, after a correction
This branch first used
^0.22.0, on the reasoning that upstream proxy fixes would then arrive without a bump PR. That reasoning was wrong, and an adversarial review caught it: for a pre-1.0 package the caret spans patches only (^0.22.0→>=0.22.0 <0.23.0-0), so it would never have picked up the 0.23.0 that actually carries the fixes. It bought silent patch-level drift — against a dependency this repo has no proxy coverage for, since the 4 unit tests mock it away — and none of the intended upside. Now0.23.0, pinned exactly, bumps deliberate.For the record, the related claim that "every other dependency here is pinned exactly" was also wrong:
cli-table3was already^0.6.3before this branch.Known gap
The 4 unit tests mock
@codacy/toolingentirely, so they pin only this repo's seam — that we delegate with no overrides, and that a throw becomes exit 1 with the message intact.NO_PROXYmatching, scheme routing and bare-host handling are verified upstream and by the manual runs above, but nothing in this repo's CI would catch a regression in them. The smoke step covers construction plus the CA-failure message only. Called out rather than papered over; closing it properly means either integration tests with a local proxy here, or trusting upstream's suite, and that's a judgement call worth making explicitly.🤖 Generated with Claude Code