Skip to content

feat(upgrade): add progress spinners for version check and download phases#515

Merged
BYK merged 1 commit intomainfrom
feat/upgrade-spinners
Mar 20, 2026
Merged

feat(upgrade): add progress spinners for version check and download phases#515
BYK merged 1 commit intomainfrom
feat/upgrade-spinners

Conversation

@BYK
Copy link
Member

@BYK BYK commented Mar 20, 2026

Show animated spinners during the two long-running phases of sentry cli upgrade that previously had no visual feedback:

  1. "Checking for updates..." — wraps the version resolution network call (resolveTargetWithFallback)
  2. "Downloading {version}..." — wraps the binary download in both executeStandardUpgrade and migrateToStandaloneForNightly

Uses the existing withProgress utility from polling.ts for a consistent look with all other CLI commands. Spinners are automatically suppressed in --json mode.

The setup phase (runSetupOnNewBinary) is intentionally not wrapped since it spawns a child process with stdio: "inherit" that writes its own output.

Before / After

# Before (several seconds of silence between messages):
ℹ Upgrading to 0.5.0...
✓ Upgraded to 0.5.0 (from 0.4.0)

# After:
⠙ Checking for updates...
⠋ Downloading 0.5.0...
✓ Upgraded to 0.5.0 (from 0.4.0)
  Method: curl · Channel: stable

…hases

Show animated spinners during the two long-running phases of `sentry cli
upgrade` that previously had no visual feedback:

1. "Checking for updates..." — wraps the version resolution network call
2. "Downloading {version}..." — wraps the binary download (delta or full)

Uses the existing `withProgress` utility from polling.ts for consistency
with all other CLI commands. Spinners are suppressed in `--json` mode.

The setup phase (`runSetupOnNewBinary`) is intentionally NOT wrapped
since it spawns a child process with `stdio: "inherit"` that writes its
own output.

Changes:
- Add `json?: boolean` to `UpgradeFlags` to access the injected flag
- Wrap `resolveTargetWithFallback` with spinner in `func()`
- Wrap `executeUpgrade` with spinner in `executeStandardUpgrade`
- Wrap `executeUpgrade` with spinner in `migrateToStandaloneForNightly`
- Demote "Upgrading/Downgrading to..." from log.info to log.debug
  (the spinner message replaces it as the primary visual indicator)
- Update test assertions to match new spinner messages
@github-actions
Copy link
Contributor

Semver Impact of This PR

🟡 Minor (new features)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


New Features ✨

  • (telemetry) Track TTY vs non-TTY invocations via metric by betegon in #482
  • (upgrade) Add progress spinners for version check and download phases by BYK in #515
  • Dynamic cache-backed shell completions with fuzzy matching by BYK in #465

Bug Fixes 🐛

  • (help) Hide ASCII banner when stdout is not a TTY by betegon in #501
  • (json) Flatten view command JSON output for --fields filtering by BYK in #495
  • (polling) Throw TimeoutError instead of bare Error on timeout by BYK in #503
  • (project) Fallback to org listing when bare slug matches an organization by betegon in #475
  • Isolate multiregion 403 tests from env-var auth tokens by BYK in #514
  • Only mention token scopes in 403 errors for env-var tokens by BYK in #512
  • Suggest similar projects on project-search miss (CLI-A4) by BYK in #511
  • Preserve ApiError type in Seer handler + suggest trial start command (CLI-N, CLI-1D/BW/98) by BYK in #510
  • Add 403 scope guidance to issue list error handling (CLI-97) by BYK in #508
  • Propagate 403 from multi-region fan-out instead of returning empty list (CLI-89) by BYK in #507
  • Lowercase project slug in URL-parsed issue short IDs (CLI-C8 follow-up) by BYK in #506
  • Handle EIO stream errors gracefully in bin.ts by BYK in #505
  • Use fuzzyMatch for similar project suggestions and add tests (CLI-C0) by BYK in #504
  • Use resolved org in numeric issue ID 404 hint (CLI-BT) by BYK in #502
  • Include API endpoint in error messages for better diagnostics (CLI-BS) by BYK in #500
  • Enrich 403 on org listing with token scope guidance (CLI-89) by BYK in #498
  • Add 400 suggestions to org-all issue list path (CLI-BY) by BYK in #497
  • Lowercase project slug in issue arg parsing (CLI-C8) by BYK in #496
  • Enrich short ID 404 with org context and suggestions (CLI-A1) by BYK in #494
  • Suggest similar projects when project not found in org (CLI-C0) by BYK in #493
  • Event 404 hint should suggest different project, not repeat failing command by BYK in #492
  • Enrich event 404 errors with retention and format suggestions (CLI-6F) by BYK in #491
  • Add actionable suggestions for 400 Bad Request on issue list (CLI-BM, CLI-7B) by BYK in #489
  • Detect issue short IDs passed to issue list (CLI-C3) by BYK in #488
  • Add Glob.match() polyfill + improve auto-detect diagnostics (CLI-7T) by BYK in #487
  • Add org-slug pre-check to dispatchOrgScopedList (CLI-9A) by BYK in #485

Internal Changes 🔧

  • (issue) Skip getProject round-trip in project-search resolution by betegon in #473
  • (resolve) Carry project data through resolution to eliminate redundant getProject calls by BYK in #486
  • (telemetry) Convert is_tty metric to span tag by betegon in #499
  • HTTP latency optimizations — diagnostics, cache warming, concurrency limits by BYK in #490
  • Switch from @sentry/bun to @sentry/node-core/light (~170ms startup savings) by BYK in #474
  • Regenerate skill files by github-actions[bot] in b7b240ec

🤖 This preview updates automatically when you update the PR.

@github-actions
Copy link
Contributor

Codecov Results 📊

126 passed | Total: 126 | Pass Rate: 100% | Execution Time: 0ms

📊 Comparison with Base Branch

Metric Change
Total Tests
Passed Tests
Failed Tests
Skipped Tests

✨ No test changes detected

All tests are passing successfully.

✅ Patch coverage is 100.00%. Project has 1047 uncovered lines.
✅ Project coverage is 95.77%. Comparing base (base) to head (head).

Coverage diff
@@            Coverage Diff             @@
##          main       #PR       +/-##
==========================================
+ Coverage    95.77%    95.77%        —%
==========================================
  Files          180       180         —
  Lines        24767     24777       +10
  Branches         0         0         —
==========================================
+ Hits         23720     23730       +10
- Misses        1047      1047         —
- Partials         0         0         —

Generated by Codecov Action

@BYK BYK marked this pull request as ready for review March 20, 2026 12:56
@BYK BYK merged commit 4b4ed91 into main Mar 20, 2026
22 checks passed
@BYK BYK deleted the feat/upgrade-spinners branch March 20, 2026 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant