Skip to content

fix(cli): explain terminal gateway connection failures - #5640

Open
shiju-nv wants to merge 2 commits into
mainfrom
fix/5639-gateway-connection-context/shiju-nv
Open

shiju-nv wants to merge 2 commits into
mainfrom
fix/5639-gateway-connection-context/shiju-nv

Conversation

@shiju-nv

Copy link
Copy Markdown
Collaborator

Summary

Show the selected gateway and attempted endpoint when openshell term cannot
connect, with an offline openshell gateway list hint. Preserve the underlying
TCP or TLS failure instead of reducing it to transport error in the Rust SDK.

Related Issue

Closes #5639

Changes

  • Wrap terminal channel failures with the resolved gateway context, including
    an explicit endpoint override.
  • Retain tonic's source error across the SDK's four channel connection paths,
    preserving the existing connect error code and string constructor.
  • Document connection troubleshooting and cover a refused overridden endpoint
    through the existing isolated CLI integration suite.

Release Notes

openshell term connection errors identify the gateway and address, retain the
transport cause, and suggest how to inspect saved endpoints offline.

Testing

  • CLI registration integration suite: 11 passed.
  • Published docs validation: Fern has 0 errors and 3 warnings; navigation passed.
  • CLI/SDK formatting and diff whitespace checks passed.
  • Regression added for gateway context, actual endpoint and refusal cause.
  • Existing SDK error unit tests: 3 passed.
  • Strict CLI binary and SDK library Clippy passed with warnings denied.
  • E2E was not run; this changes local diagnostics without changing transport behavior.

Checklist

  • Follows Conventional Commits.
  • Commits are signed and signed off for DCO.
  • Published gateway troubleshooting docs updated.

Signed-off-by: Shiju <shiju@nvidia.com>
Signed-off-by: Shiju <shiju@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Nov 17, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@github-actions github-actions Bot added the state:accepted A maintainer decided OpenShell should pursue this issue label Nov 17, 2026
@github-actions

Copy link
Copy Markdown

@shiju-nv

Copy link
Copy Markdown
Collaborator Author

/ok to test 72e7108

@shiju-nv shiju-nv added area:platform SDKs, CLIs, APIs, gateway infrastructure, persistence, configuration, and session management. topic:operability Installing/configuring deployments, upgrades, backup/restore, diagnostics, and maintenance. topic:sdk:rust Rust SDK implementation, maintenance, interfaces, and distribution. topic:ux CLI commands/flags, help, errors/exit codes, human-readable output, TUI, and first-run experience. labels Nov 17, 2026
@github-actions

Copy link
Copy Markdown

Compatibility review (advisory)

New or updated breaking changes; see the full report for all findings.

1. rust-sdk — No explicit risk acceptance found

SdkError::Connect { message: String } gains a required source: Option&lt;Box&lt;tonic::transport::Error&gt;&gt; field.

  • Impact: Downstream Rust consumers constructing SdkError::Connect { message } or destructuring it without .. fail to compile, even though the new field is optional in value.
  • Action: Preserve SdkError::Connect { message } for v0.1.9, deferring the field change to a minor release with notice and guidance to add source: None to literals and .. to patterns.
  • PR: fix(cli): explain terminal gateway connection failures #5640
Review details
  • Execution: complete
  • Candidate: PR #5640 (7135acfb124bd4abb1e69dbeaf346208281b8b53)
  • Baseline: 0be63c5b0de27692df03ba0e4b3bc212312d3b3c (0be63c5b0de27692df03ba0e4b3bc212312d3b3c)
  • Reviewed: rust-sdk, python-sdk, typescript-sdk, api-behavior, cli, configuration, policy, helm, state

Advisory review; publication gates are unchanged.

Branch check run

@shiju-nv
shiju-nv marked this pull request as ready for review November 17, 2026 11:19
@shiju-nv shiju-nv added the topic:api Public APIs, gRPC/protobuf, SDK interfaces, versioning, compatibility, and API design standards. label Nov 18, 2026

This branch has not been deployed

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

Labels

area:platform SDKs, CLIs, APIs, gateway infrastructure, persistence, configuration, and session management. state:accepted A maintainer decided OpenShell should pursue this issue topic:api Public APIs, gRPC/protobuf, SDK interfaces, versioning, compatibility, and API design standards. topic:operability Installing/configuring deployments, upgrades, backup/restore, diagnostics, and maintenance. topic:sdk:rust Rust SDK implementation, maintenance, interfaces, and distribution. topic:ux CLI commands/flags, help, errors/exit codes, human-readable output, TUI, and first-run experience.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(cli): terminal connection errors omit gateway context and transport causes

1 participant