fix(cli): don't frame clear user-actionable errors as bugs to report#3088
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: dd87c45 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
Contributor
Bundle Size ReportComparing against baseline from No bundle size changes detected. |
jorgemoya
force-pushed
the
jorgemoya/ltrac-1115-user-actionable-cli-errors
branch
from
c1f4d54 to
5892381
Compare
jorgemoya
force-pushed
the
jorgemoya/ltrac-1106-implement-domain-claiming-functionality-in-the-cli
branch
from
431b401 to
6d780bc
Compare
jorgemoya
force-pushed
the
jorgemoya/ltrac-1115-user-actionable-cli-errors
branch
2 times, most recently
from
e3269c2 to
a85abd2
Compare
Contributor
Unlighthouse Performance Comparison — VercelComparing PR preview deployment Unlighthouse scores vs production Unlighthouse scores. Summary ScoreAggregate score across all categories as reported by Unlighthouse.
Category Scores
Core Web Vitals
|
jordanarldt
approved these changes
Jul 8, 2026
Base automatically changed from
jorgemoya/ltrac-1106-implement-domain-claiming-functionality-in-the-cli
to
canary
July 8, 2026 19:46
A clear 4xx API response (validation error, not-found, not-enabled, conflict) or bad command input was printed through the top-level handler's bug-report path, appending a Correlation ID and "share this with BigCommerce support" to an already-actionable message. Add a reusable UserActionableError base class that the top-level handler prints plainly (UnauthorizedError now extends it). Adopt it across the API clients for their 4xx / input-validation cases: - domains: 4xx responses, "API not enabled", ownership-verification errors - project: validation errors, "not enabled", project-not-found - logs: "not enabled", project-not-found, invalid query, bad time-window input - channel: channel-site auth/scope failures - auth/login: missing or unvalidatable credentials 5xx server-side failures and unexpected errors stay plain Errors and keep the Correlation ID + support framing. Refs LTRAC-1115 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
jorgemoya
force-pushed
the
jorgemoya/ltrac-1115-user-actionable-cli-errors
branch
from
a85abd2 to
dd87c45
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Linear: LTRAC-1115
What/Why?
A clear, user-actionable error — a 4xx API response (validation, not-found, not-enabled, conflict) or bad command input — was printed through the top-level fatal handler's bug-report path, appending a Correlation ID and "share this with BigCommerce support" to a message that already told the user what to do. That framing should be reserved for genuine bugs and server-side failures.
Introduces a reusable
UserActionableErrorbase class that the top-level handler inindex.tsprints plainly (no Correlation ID), then adopts it across the API clients for their clearly-user-actionable cases:--since/--start/--endinputUnauthorizedErrornow extendsUserActionableError(same behavior as before, just generalized). 5xx server-side failures and unexpected errors stay plainErrors and keep the Correlation ID + support framing.Testing
pnpm typecheck,pnpm lint, and the affected specs (domains,observability,index,project,channels,logs,auth,create) — 200 passing. New assertions lock the contract: a 4xx / bad-input error is aUserActionableError; a 5xx stays a plainError(notUserActionableError).Migration
None.