Skip to content

fix(cli): await the next-steps outro so post-command output prints below it - #435

Merged
rafa-thayto merged 3 commits into
mainfrom
rafa-thayto/slack-thread-fix-issue
Aug 21, 2026
Merged

fix(cli): await the next-steps outro so post-command output prints below it#435
rafa-thayto merged 3 commits into
mainfrom
rafa-thayto/slack-thread-fix-issue

Conversation

@rafa-thayto

Copy link
Copy Markdown
Contributor

Summary

Fixes the garbled "Update available" output reported in Slack: after clerk switch-env, the update notice printed on top of the "Next steps" block (Update available: 3.0.1 → 3.1.0henticate for this environment), with missing spaces, doubled backticks, and a stray duplicate "Next steps" header.

Root cause: outro(steps) in lib/spinner.ts is async — it awaits animateHeader, which parks the cursor on the header line for ~450ms of shine animation before restoring it. Several commands called outro(...) without await (a floating promise), so the command's promise resolved at the animation's first frame. Commander's postAction hook then ran maybeNotifyUpdate, whose lines printed at the parked cursor position — overwriting the step lines mid-block, while the animation's remaining frames repainted the header further down.

Fix: await every outro(...) call site (47 sites across 18 command files; deploy and webhooks token already awaited correctly). Output printed after a command now always lands below the finished block — the ordering .claude/rules/interrupts.md already documents as the post-command tail.

Test plan

  • New regression test switch-env/update-notice-race.test.ts runs the real spinner/gradient on a forced-interactive TTY, prints the update notice the instant switchEnv() resolves (exactly what postAction does), and asserts it lands after the animation's cursor-restore escape. Red before the fix (notice at stream index 606, cursor restored at 4377), green after. The assertion is enforced by promise sequencing, not wall-clock timing.
  • bun run format:check / lint / typecheck clean; full unit suite 2654 pass / 0 fail.
  • Changeset: clerk patch.

…low it

The next-steps outro animation moves the cursor back onto the header line
for ~450ms, but several commands (switch-env, auth logout, unlink,
users create, apps create, and others) did not await outro(). The command's
promise resolved mid-animation, so the postAction update check printed the
"Update available" notice at the parked cursor position — overwriting the
step lines and leaving a stray duplicate "Next steps" header.

Await every outro() call so output printed after a command lands below the
finished block. Adds a regression test that runs the real spinner/gradient
on a forced-interactive TTY and asserts the notice prints after the
animation's cursor-restore.
@changeset-bot

changeset-bot Bot commented Aug 21, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: fa65fd7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
clerk Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 671e13dc-38ab-416d-97e9-46a7cbe79c21

📥 Commits

Reviewing files that changed from the base of the PR and between 186689a and fa65fd7.

📒 Files selected for processing (1)
  • packages/cli-core/src/commands/switch-env/update-notice-race.test.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go (manual)
  • clerk/dashboard (manual)
  • clerk/accounts (manual)
  • clerk/backoffice (manual)
  • clerk/clerk (manual)
  • clerk/clerk-docs (manual)
  • clerk/cloudflare-workers (manual)
  • clerk/javascript (auto-detected)

Included review availability: 6 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour.


📝 Walkthrough

Walkthrough

CLI command exit paths now await asynchronous outro(...) operations across command areas. A regression test verifies update-notice ordering after switchEnv resolves. Version resolution now separates Bun macro fallback generation from CLI_VERSION handling and development-build classification. Changesets and versioning documentation were updated.

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

Merge Risk: ⚪ Minimal · up to fa65f

This change ensures post-command update notices print after the completed Next steps block. No actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 9.38% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 32 functions across 21 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the primary fix: awaiting the next-steps outro to prevent post-command output corruption.
Description check ✅ Passed The description accurately explains the update-notice race, the await fix, regression test, validation results, and changeset.
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.

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

@thiskevinwang thiskevinwang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! Looks like repeated applying of missed await to outro()

Consider a eslint or oxlint rule to catch this at compiler level

@wyattjoh
wyattjoh self-requested a review August 21, 2026 17:11
… Bun 1.4

Bun 1.4 runs macros in a sealed transpiler context that --define globals no
longer reach, so resolveVersionAtBuildTime() always took the checkout-derived
fallback and the compiled-version tests failed on CI (which floats to the
latest Bun satisfying engines).

Move the injected-vs-fallback choice and dev classification into version.ts
module scope, where define substitution still applies on every Bun version.
The macro now only derives the Git checkout fallback, so the compiled CLI
still never runs Git at runtime. Verified: version tests and the full suite
pass under both Bun 1.3.14 and 1.4.0.

@wyattjoh wyattjoh 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.

Checked that the regression test genuinely goes red on the un-awaited code and green on the fix, and that the Bun 1.4 define change still resolves correctly on Bun 1.3.14 across all three build shapes (release define, no define, dev-flavored define). Two nits below; neither blocks.

Sent from Claude
  • reviewed by Wyatt Johnson

Comment thread packages/cli-core/src/commands/switch-env/update-notice-race.test.ts Outdated
…e poll

On fixed code the animation completes before switchEnv() resolves, so the
700ms unconditional sleep was pure dead time on every green run. Poll for
the cursor-restore escape with a 2s bound instead: green runs return
immediately, and a regression still drains the orphaned animation so the
ordering assertion fails with its precise message.
@rafa-thayto
rafa-thayto requested a review from wyattjoh August 21, 2026 17:27
@rafa-thayto
rafa-thayto merged commit 432ea9f into main Aug 21, 2026
11 checks passed
@rafa-thayto
rafa-thayto deleted the rafa-thayto/slack-thread-fix-issue branch August 21, 2026 17:33
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.

3 participants