Skip to content

LTRAC-2163: feat(cli) - Offer to send an error report after a CLI crash - #3264

Merged
parthshahp merged 1 commit into
parthshah/ltrac-2163-4-deploy-surveyfrom
parthshah/ltrac-2163-add-feedback-submission-to-the-native-hosting-cli-flow
Oct 19, 2026
Merged

parthshahp merged 1 commit into
parthshah/ltrac-2163-4-deploy-surveyfrom
parthshah/ltrac-2163-add-feedback-submission-to-the-native-hosting-cli-flow

Conversation

@parthshahp

@parthshahp parthshahp commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

What/Why?

After an unexpected error, the CLI asks whether to send an error report. Part of a stack that lets Storefront Hosting users send feedback from the CLI. Stacked on #3276.

✖ Failed to create deployment: Something went wrong on our end…
Correlation ID: 3f2c…
? Send an error report to BigCommerce? It includes the error, the CLI version, and the `catalyst debug` report (no secret values). (y/N)
✔ Error report sent. Thank you!
  • index.ts calls offerCrashReport (lib/crash-report.ts) only for unexpected errors (the ones that show the Correlation ID). A UserActionableError (bad input, an expired token, a 4xx) does not ask. Ctrl+C at a prompt is not a crash.
  • The default answer is No, because the report contains the error text and stack.
  • The report contains the first line of the error as the title, the message, the command, the Correlation ID, the CLI version, the stack, and the catalyst debug report. The home directory shows as ~. Source is catalyst-cli-crash. It works when telemetry is off.
  • In CI, without a TTY, or without credentials, the CLI shows "To report this error, run catalyst feedback." --no-hints and CATALYST_NO_HINTS turn off the question and the hint.
  • A preAction hook (recordActiveCommand) records the running command, so the handler can find the credentials from flags, env, or project.json.
  • offerCrashReport never throws, so the handler always exits with code 1.

The feedback endpoint does not accept CLI tokens yet. A backend change for this is in progress.

Testing

  • pnpm lint, pnpm typecheck, and pnpm test pass (890 tests).
  • Manual, in a pseudo-terminal with an unreachable --api-host: the question shows with (y/N), and n exits without sending. Without a TTY, the hint shows. With --no-hints, nothing shows.

Migration

None.

@vercel

vercel Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
catalyst Ready Ready Preview Oct 19, 2026 5:09pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 6ed2baf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes changesets to release 1 package
Name Type
@bigcommerce/catalyst Minor

Click here to learn what changesets are, and how to add one.

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

@parthshahp
parthshahp force-pushed the parthshah/ltrac-2163-add-feedback-submission-to-the-native-hosting-cli-flow branch from 91c2a9e to 077c5ca Compare October 2, 2026 17:54
@parthshahp
parthshahp force-pushed the parthshah/ltrac-2163-add-feedback-submission-to-the-native-hosting-cli-flow branch from 077c5ca to 5a0c265 Compare October 2, 2026 18:05
@parthshahp parthshahp changed the title LTRAC-2163: Add catalyst feedback command LTRAC-2163: Add a CLI feedback survey and the catalyst feedback command Oct 2, 2026
@parthshahp
parthshahp force-pushed the parthshah/ltrac-2163-add-feedback-submission-to-the-native-hosting-cli-flow branch from 5a0c265 to d25f521 Compare October 2, 2026 18:26
@parthshahp parthshahp changed the title LTRAC-2163: Add a CLI feedback survey and the catalyst feedback command LTRAC-2163: Add CLI feedback (survey, error reports, and catalyst feedback) Oct 2, 2026
@github-actions

github-actions Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Unlighthouse Comparison

✅ Resolved: the latest run found no regressions.

Full Unlighthouse report →

@parthshahp
parthshahp force-pushed the parthshah/ltrac-2163-add-feedback-submission-to-the-native-hosting-cli-flow branch from 3948af5 to 775af9d Compare October 13, 2026 16:09
@parthshahp parthshahp changed the title LTRAC-2163: Add CLI feedback (survey, error reports, and catalyst feedback) LTRAC-2163: feat(cli) - Offer to send an error report after a CLI crash Oct 13, 2026
@parthshahp
parthshahp changed the base branch from canary to parthshah/ltrac-2163-4-deploy-survey October 13, 2026 18:09
@parthshahp
parthshahp added this pull request to stack #3277 October 13, 2026 18:10
@parthshahp
parthshahp force-pushed the parthshah/ltrac-2163-add-feedback-submission-to-the-native-hosting-cli-flow branch from 775af9d to 0c15727 Compare October 13, 2026 21:10
@parthshahp
parthshahp force-pushed the parthshah/ltrac-2163-add-feedback-submission-to-the-native-hosting-cli-flow branch from 0c15727 to 6ed2baf Compare October 19, 2026 17:08
@parthshahp
parthshahp marked this pull request as ready for review October 19, 2026 18:43
@parthshahp
parthshahp requested a review from a team as a code owner October 19, 2026 18:43

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

lgtm!

@parthshahp
parthshahp added this pull request to the merge queue Oct 19, 2026
Merged via the queue into canary with commit e7795f3 Oct 19, 2026
24 checks passed
@parthshahp
parthshahp deleted the parthshah/ltrac-2163-add-feedback-submission-to-the-native-hosting-cli-flow branch October 19, 2026 23:15

This branch was successfully deployed

1 active deployment
Preview — 6ed2bafe Deployed Oct 19, 2026 by vercel[bot]
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.

2 participants