Commit 111e0a4
authored
fix(onboard): extend dashboard readiness wait (#9089)
<!-- markdownlint-disable MD041 -->
## Summary
Dashboard-forward startup now gives OpenShell's exact `sandbox is not
ready` handoff up to 1 minute to settle. [Actions run
31767577321](https://github.com/NVIDIA/NemoClaw/actions/runs/31767577321)
showed multiple onboarding lanes exhausting the ordinary three-retry
allowance while the new sandbox was still transitioning to forward-ready
state.
Authentication, ownership, port-conflict, and ordinary listener failures
keep their existing retry and cleanup behavior.
## Changes
- Give the exact OpenShell readiness response a separate default of 12
retries with 5-second delays.
- Preserve `maxRetries` as an explicit override for every retryable
outcome.
- Cover recovery after four consecutive readiness responses and the
persistent 12-retry bound.
- Update the OpenClaw and Hermes quickstarts with the readiness-specific
wait.
## Type of Change
- [ ] Code change (feature, bug fix, or refactor)
- [x] Code change with doc updates
- [ ] Doc only (prose changes, no code sample modifications)
- [ ] Doc only (includes code sample changes)
## Quality Gates
- [x] Tests added or updated for changed behavior
- [ ] Existing tests cover changed behavior — justification:
- [ ] Tests not applicable — justification:
- [x] Docs updated for user-facing behavior changes
- [ ] Docs not applicable — justification:
- [x] Sensitive paths changed (security, policy, credentials, preflight,
onboarding, inference, runner, sandbox, or messaging)
- [x] Sensitive-path review completed or maintainer-approved waiver
recorded — reviewer/approval link/justification: The repository security
checklist covered the complete four-file diff. The longer wait remains
limited to one exact OpenShell diagnostic and one minute;
authentication, ownership, cleanup, and ordinary listener retry
boundaries are unchanged. No security finding was identified.
- [ ] 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: Updated both quickstarts to describe the exact readiness
response, 12 retries, 5-second intervals, and the 1-minute maximum
readiness-specific delay. `npm run docs`, file-scoped hooks, and diff
validation passed.
- Agent: Codex documentation writer subagent
<!-- docs-review-head-sha: 6cb3217 -->
<!-- docs-review-agents-blob-sha: e30afb2 -->
## DGX Station Hardware Evidence
- [ ] Tested on DGX Station
- Tested commit: Not applicable; DGX Station preparation is unchanged.
- Station profile/scenario: Not applicable.
- Result: Not applicable.
- Supporting evidence: Not applicable.
## 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 validate:pr` passed after refreshing `origin/main` when hooks
were skipped or unavailable
- [x] Targeted behavior tests pass for the current change set, or tests
are marked not applicable above — focused forward-start suite: 47
passed; affected test selection: 370 passed across 28 files
- [x] Applicable broad gate passed — `npm run typecheck:cli`, `npm run
docs`, source-shape and test-conditional validation, targeted repository
hooks, and diff validation passed
- [x] Quality Gates section completed with required justifications or
waivers
- [x] No secrets, API keys, or credentials committed
- [x] `npm run docs` builds without warnings (doc changes only) —
result: zero errors; two existing Fern notices
- [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)
---
Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Bug Fixes**
- Improved sandbox startup handoff reliability by retrying “sandbox is
not ready” responses up to 12 times.
- Added five-second delays between readiness retries, allowing up to one
minute for the sandbox to become available.
- Preserved existing sandbox and selected host-port settings throughout
retries.
- Kept standard retry behavior separate and unchanged.
- **Documentation**
- Updated quickstart guides to explain the extended sandbox-readiness
retry behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>1 parent c1ed614 commit 111e0a4
4 files changed
Lines changed: 98 additions & 15 deletions
File tree
- docs/get-started
- src/lib/onboard
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
286 | 286 | | |
287 | 287 | | |
288 | 288 | | |
289 | | - | |
290 | | - | |
| 289 | + | |
| 290 | + | |
291 | 291 | | |
292 | 292 | | |
293 | 293 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
419 | 419 | | |
420 | 420 | | |
421 | 421 | | |
422 | | - | |
423 | | - | |
| 422 | + | |
| 423 | + | |
424 | 424 | | |
425 | 425 | | |
426 | 426 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
30 | 45 | | |
31 | 46 | | |
32 | 47 | | |
| |||
983 | 998 | | |
984 | 999 | | |
985 | 1000 | | |
| 1001 | + | |
| 1002 | + | |
| 1003 | + | |
| 1004 | + | |
| 1005 | + | |
| 1006 | + | |
| 1007 | + | |
| 1008 | + | |
| 1009 | + | |
| 1010 | + | |
| 1011 | + | |
| 1012 | + | |
| 1013 | + | |
| 1014 | + | |
| 1015 | + | |
| 1016 | + | |
| 1017 | + | |
| 1018 | + | |
| 1019 | + | |
| 1020 | + | |
| 1021 | + | |
| 1022 | + | |
| 1023 | + | |
| 1024 | + | |
| 1025 | + | |
| 1026 | + | |
| 1027 | + | |
| 1028 | + | |
| 1029 | + | |
| 1030 | + | |
| 1031 | + | |
| 1032 | + | |
| 1033 | + | |
| 1034 | + | |
| 1035 | + | |
| 1036 | + | |
| 1037 | + | |
| 1038 | + | |
| 1039 | + | |
| 1040 | + | |
| 1041 | + | |
| 1042 | + | |
| 1043 | + | |
| 1044 | + | |
| 1045 | + | |
| 1046 | + | |
| 1047 | + | |
| 1048 | + | |
| 1049 | + | |
| 1050 | + | |
| 1051 | + | |
| 1052 | + | |
| 1053 | + | |
986 | 1054 | | |
987 | 1055 | | |
988 | 1056 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | | - | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
65 | 67 | | |
66 | 68 | | |
67 | 69 | | |
| |||
191 | 193 | | |
192 | 194 | | |
193 | 195 | | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
194 | 201 | | |
195 | 202 | | |
196 | 203 | | |
| |||
515 | 522 | | |
516 | 523 | | |
517 | 524 | | |
| 525 | + | |
518 | 526 | | |
519 | 527 | | |
| 528 | + | |
520 | 529 | | |
521 | 530 | | |
522 | 531 | | |
| |||
534 | 543 | | |
535 | 544 | | |
536 | 545 | | |
537 | | - | |
538 | | - | |
539 | | - | |
540 | | - | |
541 | | - | |
542 | | - | |
543 | | - | |
544 | | - | |
545 | | - | |
| 546 | + | |
| 547 | + | |
| 548 | + | |
| 549 | + | |
| 550 | + | |
546 | 551 | | |
547 | 552 | | |
548 | 553 | | |
| 554 | + | |
| 555 | + | |
| 556 | + | |
| 557 | + | |
| 558 | + | |
| 559 | + | |
| 560 | + | |
| 561 | + | |
| 562 | + | |
| 563 | + | |
| 564 | + | |
549 | 565 | | |
550 | | - | |
551 | 566 | | |
552 | 567 | | |
553 | 568 | | |
| |||
0 commit comments