Skip to content

fix(onboard): omit TLS servername for IP-literal gateway health probe hosts - #7528

Merged
cv merged 3 commits into
NVIDIA:mainfrom
cdiddy77:fix/gateway-probe-ip-servername
Jul 25, 2026
Merged

fix(onboard): omit TLS servername for IP-literal gateway health probe hosts#7528
cv merged 3 commits into
NVIDIA:mainfrom
cdiddy77:fix/gateway-probe-ip-servername

Conversation

@cdiddy77

@cdiddy77 cdiddy77 commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Summary

On Node.js 25 and newer, the Docker-driver gateway health probe throws at http2.connect because it sets the TLS servername option to the probe URL's IP-literal hostname (127.0.0.1), which Node 25 rejects (ERR_INVALID_ARG_VALUE, formerly deprecation DEP0123); the probe's catch reports each poll as not ready, so nemoclaw onboard fails the gateway health wait against a healthy gateway. This change sends servername only for DNS hostnames — for IP endpoints, certificate verification matches the connection IP against the certificate's IP SANs without SNI, so onboarding passes the health wait on every supported Node version.

Related Issue

Fixes #7527

Changes

  • src/lib/onboard/gateway-http-readiness.ts: dockerDriverGatewayHttp2ConnectOptions sets servername only when the probe hostname is not an IP literal (net.isIP on the bracket-stripped hostname, covering bracketed IPv6).
  • src/lib/onboard/gateway-http-readiness.test.ts: three regression tests — IP-literal host omits servername, bracketed IPv6 host omits servername, DNS hostname keeps servername.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification:
  • Docs updated for user-facing behavior changes
  • Docs not applicable — justification: the fix restores documented onboarding behavior (the health wait succeeding against a healthy gateway); no page under docs/ describes the probe's TLS internals or the failing behavior, so no page is stale.
  • Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging)
  • Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification:
  • Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue:

Documentation Writer Review

  • Documentation writer subagent reviewed the completed changes
  • Result: no-docs-needed
  • Evidence: no documentation paths changed; the reviewer checked docs/ for pages describing the gateway health probe, TLS servername, or Node 25 behavior and found none stale; the dated changelog entry is pre-tag release prep, not a per-PR obligation. Re-run for maintainer commits bd434d8 and 153e375 (test-only teardown change and its revert; head tree is identical to the originally reviewed 464fb0e): pass, no docs impact.
  • Agent: Claude Code

DGX Station Hardware Evidence

  • Tested on DGX Station
  • Tested commit:
  • Station profile/scenario:
  • Result:
  • Supporting evidence:

Verification

  • PR description includes a Signed-off-by: line and every commit appears as Verified in GitHub
  • Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run check:diff passed when hooks were skipped or unavailable
  • Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result: npx vitest run --project cli src/lib/onboard/gateway-http-readiness.test.ts → 5 passed (2 pre-existing, 3 new); npm run typecheck:cli → clean
  • Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result:
  • Quality Gates section completed with required justifications or waivers
  • No secrets, API keys, or credentials committed
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: Charles Parker charles@parkerfolk.net

… hosts

Node 25 turned DEP0123 (TLS ServerName set to an IP address) into a thrown
ERR_INVALID_ARG_VALUE. The Docker-driver gateway health probe passed the probe
URL hostname (127.0.0.1) as servername, so http2.connect threw on every poll,
the catch treated it as not-ready, and onboarding failed the health wait
against a healthy gateway. Send servername only for DNS hostnames; IP
endpoints verify against the certificate's IP SANs without SNI.

Fixes NVIDIA#7527

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: Charles Parker <charles@parkerfolk.net>
Copilot AI review requested due to automatic review settings July 25, 2026 17:35
@copy-pr-bot

copy-pr-bot Bot commented Jul 25, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The gateway readiness probe now omits TLS servername for IPv4 and IPv6 literals while preserving it for DNS hostnames. Tests mock HTTP/2 connections and verify all three host formats.

Changes

Gateway TLS servername handling

Layer / File(s) Summary
IP-aware TLS connection options
src/lib/onboard/gateway-http-readiness.ts
HTTP/2 TLS options strip IPv6 brackets, detect IP literals, and set servername only for DNS hostnames.
TLS servername behavior tests
src/lib/onboard/gateway-http-readiness.test.ts
Mocks HTTP/2 connections and verifies servername omission for IPv4 and bracketed IPv6 hosts, while retaining it for DNS names.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related issues

  • NVIDIA/NemoClaw 7527 — Addresses TLS servername handling for IP-literal gateway hosts.

Suggested labels: area: onboarding

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: omitting TLS servername for IP-literal gateway health probe hosts.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

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.

Pull request overview

Fixes nemoclaw onboard gateway readiness polling on Node.js 25+ by avoiding an invalid TLS servername (SNI) value when the probe target is an IP-literal host (IPv4/IPv6). This restores expected onboarding behavior against healthy OpenShell gateways across supported Node versions.

Changes:

  • Update the Docker-driver HTTP/2 readiness probe to set TLS servername only for DNS hostnames (using net.isIP, including bracketed IPv6 inputs).
  • Add regression tests to ensure servername is omitted for IPv4/IPv6 literals and retained for DNS hostnames.

Security review (nemoclaw-maintainer-security-code-review)

  • PASS Secrets/Credentials (no secrets introduced; test fixtures write non-sensitive placeholder files)
  • PASS Input Validation/Sanitization (tightens handling of URL hostname → TLS option mapping)
  • PASS AuthN/AuthZ (no changes)
  • PASS Dependencies (no changes)
  • PASS Error Handling/Logging (no new logging; same readiness behavior, but avoids deterministic throw path on Node 25)
  • PASS Cryptography/Data Protection (continues mTLS; change is SNI behavior only)
  • PASS Config/Security Headers (no changes)
  • PASS Security Testing (tests added for the sensitive TLS option behavior)
  • PASS System Security (does not weaken controls; avoids a Node runtime incompatibility)

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/lib/onboard/gateway-http-readiness.ts Only sets http2.connect TLS servername for non-IP hostnames to avoid Node 25+ throw on IP-literal SNI.
src/lib/onboard/gateway-http-readiness.test.ts Adds regression tests validating servername omission/retention behavior across IP-literal vs DNS hosts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/lib/onboard/gateway-http-readiness.test.ts
@github-actions

github-actions Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — Informational

Advisor assessment: Informational / high confidence
Next action: No advisor follow-up needed.
Findings: 0 blockers · 0 warnings · 0 suggestions
Status: No actionable findings remain in the canonical review ledger.

Model lanes

  • GPT-5.6 Terra (primary): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions
  • Nemotron 3 Ultra (second opinion): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions
  • Model comparison: normalized findings match; normalized E2E selections differ; severity counts match.

Nemotron output stays in workflow artifacts and does not change the assessment above.

Since last review: 0 prior items resolved · 0 still apply · 0 new items found

E2E guidance

Advisory only. E2E / PR Gate selects and runs jobs independently.

Recommended E2E: onboard-repair, onboard-resume, cloud-onboard

Workflow run details

This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/lib/onboard/gateway-http-readiness.test.ts`:
- Around line 93-146: Update the afterEach cleanup in the
“isDockerDriverGatewayHttpReady TLS servername” suite to call vi.unstubAllEnvs()
and restore the http2.connect spy after each test, while preserving the existing
tlsDirs cleanup. Ensure subsequent tests start with no stubbed environment
values and a restored connect implementation or cleared spy state.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: d493312c-7575-4b7c-a0aa-a80f608bb826

📥 Commits

Reviewing files that changed from the base of the PR and between dbac677 and 464fb0e.

📒 Files selected for processing (2)
  • src/lib/onboard/gateway-http-readiness.test.ts
  • src/lib/onboard/gateway-http-readiness.ts

Comment thread src/lib/onboard/gateway-http-readiness.test.ts
@apurvvkumaria apurvvkumaria added bug-fix PR fixes a bug or regression area: onboarding Onboarding FSM, provider setup, sandbox launch, or first-run flow area: networking DNS, proxy, TLS, ports, host aliases, or connectivity labels Jul 25, 2026
@apurvvkumaria apurvvkumaria self-assigned this Jul 25, 2026
Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>
Copilot AI review requested due to automatic review settings July 25, 2026 18:59

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.

Copilot was unable to review this pull request because the user who requested the review is ineligible. To be eligible to request a review, you need a paid Copilot license, or your organization must enable Copilot code review.

Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>
Copilot AI review requested due to automatic review settings July 25, 2026 19:01

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.

Copilot was unable to review this pull request because the user who requested the review is ineligible. To be eligible to request a review, you need a paid Copilot license, or your organization must enable Copilot code review.

@apurvvkumaria apurvvkumaria left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Maintainer review at exact head 153e375df568090d6c60b25a07388eabade26994: the implementation strips IPv6 brackets only for IP classification, omits TLS servername for IPv4/IPv6 literals, and preserves DNS SNI. Focused IPv4, bracketed-IPv6, and DNS tests cover the behavior; repository-wide mock isolation makes explicit per-test restoration redundant. Automated review has no remaining findings. Approved on code quality; merge still requires the full exact-head CI and E2E gate to finish successfully.

@apurvvkumaria

Copy link
Copy Markdown
Collaborator

Exact-head maintainer status for 153e375df568090d6c60b25a07388eabade26994: the security-reviewed fork workflows were approved, the complete CI matrix passed (all eight CLI shards, aggregate coverage, build/typecheck, static checks, installer integration, reviewed npm audit, plugin tests, CodeQL, macOS, CLI/docs parity, DCO, commit lint, and docs receipt), and the code review is approved. The deterministic E2E plan selected onboard-repair and onboard-resume, but no selected E2E job ran and no repository credential was exposed. Controller run 30171622637 failed closed because approve-credentialed-e2e-for-fork-pr has no required-reviewer protection, so GitHub recorded no deployment approval. This is repository environment configuration, not a PR-code failure. After an administrator adds the documented required reviewer, this PR needs one fresh signed SHA and fresh exact-head CI/E2E; I will not retry or waive the same-head gate.

@cv
cv merged commit 02d50ac into NVIDIA:main Jul 25, 2026
66 of 70 checks passed
@cv cv mentioned this pull request Jul 26, 2026
23 tasks
apurvvkumaria pushed a commit that referenced this pull request Jul 27, 2026
<!-- markdownlint-disable MD041 -->
## Summary

Add the canonical `docs/changelog/2026-07-25.mdx` release entry with the
exact `## v0.0.96` heading.
The entry reconciles all 90 first-parent commits since v0.0.95 with all
92 merged PRs in the live `v0.0.96` label ledger and groups the
user-visible changes by operator journey.

## Changes

- Add the parser-safe dated MDX changelog entry for v0.0.96 with
root-absolute links to the focused user guides.
- Source summary:
- [#7194](#7194) ->
`docs/changelog/2026-07-25.mdx`: Document persistent baseline network
policy exclusions and their inspection, rebuild, and snapshot behavior.
- [#7188](#7188),
[#7427](#7427), and
[#7546](#7546) ->
`docs/changelog/2026-07-25.mdx`: Document DNS-backed HTTPS inference
routing, keyless loopback endpoints, and provider-marker isolation.
- [#7238](#7238) ->
`docs/changelog/2026-07-25.mdx`: Document blueprint sandbox and provider
identifier validation before state writes or OpenShell calls, with
bounded terminal-safe rejection previews.
- [#7319](#7319),
[#7274](#7274),
[#7528](#7528),
[#7353](#7353), and
[#7560](#7560) ->
`docs/changelog/2026-07-25.mdx`: Document the managed default gateway
service, onboarding readiness, and container-runtime identity
safeguards.
- [#7349](#7349),
[#7498](#7498),
[#7406](#7406),
[#7196](#7196),
[#7559](#7559),
[#7421](#7421),
[#7510](#7510),
[#7295](#7295), and
[#7565](#7565) ->
`docs/changelog/2026-07-25.mdx`: Document gateway-scoped status,
lifecycle diagnostics, managed MCP recovery, delete-edge safeguards, and
fail-closed CLI prompt and command output.
- [#7591](#7591) ->
`docs/changelog/2026-07-25.mdx`: Document opt-in authenticated MCP
tool-name discovery, its bounded and names-only contract, probe
interaction, and rebuild requirement.
- [#7305](#7305),
[#7480](#7480),
[#7471](#7471),
[#7365](#7365), and
[#7541](#7541) ->
`docs/changelog/2026-07-25.mdx`: Document installer version checks,
version-tag reporting, license guidance, WSL Ollama selection, and DGX
Station vLLM detection.
- [#7482](#7482),
[#7466](#7466),
[#7208](#7208),
[#7434](#7434), and
[#7586](#7586) ->
`docs/changelog/2026-07-25.mdx`: Document Ollama resource details,
reasoning precedence, Hermes onboarding behavior, and preserved managed
Hermes BuildKit failures.

- [#6830](#6830),
[#7492](#7492),
[#7563](#7563), and
[#7582](#7582) ->
`docs/changelog/2026-07-25.mdx`: Document the authoritative OpenClaw
production lock, fixed managed-image dependencies, immutable Hermes base
adoption, and Hermes image-size reduction.
- [#7505](#7505),
[#7530](#7530),
[#7547](#7547),
[#7508](#7508),
[#7548](#7548),
[#7549](#7549),
[#7537](#7537),
[#7534](#7534),
[#7515](#7515),
[#7511](#7511),
[#7551](#7551),
[#7562](#7562),
[#7575](#7575),
[#7496](#7496),
[#7594](#7594),
[#7595](#7595), and
[#7599](#7599) ->
`docs/changelog/2026-07-25.mdx`: Summarize release validation, transient
and bounded dispatch reconciliation, exact pre-tag qualification,
identity revalidation, npm-audit retry, sharding, image reuse, timeout,
telemetry, and workflow-hardening changes.
- Reconciled without separate changelog prose:
- [#7539](#7539),
[#7526](#7526),
[#7507](#7507),
[#7506](#7506),
[#7519](#7519),
[#7516](#7516),
[#7396](#7396),
[#7254](#7254),
[#7583](#7583),
[#7596](#7596), and
[#7598](#7598): Test-harness or
fixture-only changes.
- [#7403](#7403),
[#7161](#7161),
[#6877](#6877),
[#7531](#7531),
[#7525](#7525),
[#7522](#7522),
[#7536](#7536),
[#7552](#7552),
[#7566](#7566),
[#7553](#7553),
[#7561](#7561),
[#7577](#7577),
[#7569](#7569),
[#7585](#7585),
[#7584](#7584),
[#7592](#7592),
[#7580](#7580),
[#7571](#7571),
[#7517](#7517),
[#7589](#7589),
[#7402](#7402),
[#7558](#7558),
[#7544](#7544), and
[#7601](#7601): Dependency,
internal recovery, validation, contributor-workflow, E2E optimization,
telemetry, or CI trust changes with no separate user-facing release
claim.
- [#7556](#7556),
[#7573](#7573),
[#7576](#7576), and
[#7578](#7578): Experimental
repository-maintainer conflict automation with no canonical user
documentation surface.

## Type of Change

- [ ] Code change (feature, bug fix, or refactor)
- [ ] Code change with doc updates
- [x] Doc only (prose changes, no code sample modifications)
- [ ] Doc only (includes code sample changes)

## Quality Gates

- [ ] Tests added or updated for changed behavior
- [x] Existing tests cover changed behavior — justification:
`test/changelog-docs.test.ts` validates dated changelog structure,
version headings, and published links.
- [ ] Tests not applicable — justification:
- [x] Docs updated for user-facing behavior changes
- [ ] Docs not applicable — justification:
- [ ] Sensitive paths changed (security, policy, credentials, preflight,
onboarding, inference, runner, sandbox, or messaging)
- [ ] Sensitive-path review completed or maintainer-approved waiver
recorded — reviewer/approval link/justification:
- [ ] Non-success, skipped, or missing CI check accepted by maintainer —
check name, approval link, and follow-up issue:

## Documentation Writer Review

- [x] Documentation writer subagent reviewed the completed changes
- Result: `docs-updated`
- Evidence: Reviewed `docs/changelog/2026-07-25.mdx` at exact head
`0f5dedb47` against 90 first-parent release commits and 92 merged PRs
labeled `v0.0.96`. Verified parser-safe MDX SPDX, the exact version
heading, literal CLI names, writing style, skip terms, all 20
root-absolute published links, and the accepted #7591 opt-in
authenticated discovery bounds. #7544, #7599, and #7601 remain internal
or CI-only release-ledger entries. Changelog tests passed 6/6, the docs
build passed with 0 errors and two pre-existing Fern warnings, and `npm
run check:diff` plus the final diff check passed.
- Agent: Codex Desktop documentation-writer subagent
<!-- docs-review-head-sha: 0f5dedb -->
<!-- docs-review-agents-blob-sha: be20a09 -->

## DGX Station Hardware Evidence

- [ ] Tested on DGX Station
- Tested commit:
- Station profile/scenario:
- Result:
- Supporting evidence:

## Verification

- [x] PR description includes a `Signed-off-by:` line and every commit
appears as `Verified` in GitHub
- [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or
`npm run check:diff` passed when hooks were skipped or unavailable
- [x] Targeted behavior tests pass for the current change set, or tests
are marked not applicable above — `npx vitest run
test/changelog-docs.test.ts`: 6/6 passed.
- [ ] Applicable broad gate passed — `npm test` for broad
runtime/test-harness changes; `npm run check` for repo-wide
validation/coverage changes — command/result: Not applicable to this
prose-only changelog entry.
- [x] Quality Gates section completed with required justifications or
waivers
- [x] No secrets, API keys, or credentials committed
- [ ] `npm run docs` builds without warnings (doc changes only) — the
build passed with 0 errors and 2 existing Fern warnings; the
published-route check passed.
- [x] Doc pages follow the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md)
(doc changes only)
- [ ] New doc pages include SPDX header and frontmatter (new pages only)
— native changelog files use the required parser-safe MDX SPDX comment
and no frontmatter.

---
Signed-off-by: Carlos Villela <cvillela@nvidia.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Persistent network policy exclusions with consistent restore/exclusion
reporting across rebuilds/snapshots.
* Opt-in MCP tool discovery via `mcp status --tools` with bounded,
redacted authenticated traffic.
* Improved HTTPS inference switching for custom endpoints and refreshed
onboarding/model menu details.
* Refined OpenShell gateway defaults for port `8080`, including more
reliable readiness checks.
* **Bug Fixes**
* Prevent incorrect provider/model restoration after compatible-provider
update failures.
* Preserve managed MCP state after exec loss and tighten gateway/doctor
status scoping.
* **Tests**
* Stronger, fail-closed release validation with hardened
evidence/artifact handoff and bounded timeouts/retries.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Prekshi Vyas <prekshiv@nvidia.com>
Co-authored-by: Prekshi Vyas <prekshiv@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: networking DNS, proxy, TLS, ports, host aliases, or connectivity area: onboarding Onboarding FSM, provider setup, sandbox launch, or first-run flow bug-fix PR fixes a bug or regression

Projects

None yet

Development

Successfully merging this pull request may close these issues.

onboard gateway health check fails on Node 25: probe sets TLS servername to an IP and the throw is swallowed

4 participants