fix(cli): give a clear error on deploy when required env vars are missing#3097
Draft
jorgemoya wants to merge 1 commit into
Draft
Conversation
…sing `catalyst deploy` (and the Commerce Hosting `catalyst build` path) surfaced a raw OpenNext/Next.js build stack trace when required env vars weren't loaded — the values are read during prerender, so a missing/empty `BIGCOMMERCE_STORE_HASH`, `BIGCOMMERCE_STOREFRONT_TOKEN`, or `AUTH_SECRET` failed deep in the build with no hint about the cause or the fix. Pre-check these vars in `buildCatalystProject` before shelling out to the build. When any are missing we throw a `UserActionableError` (printed plainly, without the Correlation-ID bug-report framing) that names each missing variable and suggests loading a `.env.local` via `--env-path`, so the ugly build error never happens. Refs LTRAC-1090 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 63a52cb 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. |
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
|
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
1 participant
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-1090
What/Why?
Running
catalyst deploywithout the required environment variables produced an ugly raw build stack trace with no hint that missing env vars were the cause (the fix is--env-path, but nothing said so). This detects the missing-required-env condition before the build and fails with aUserActionableErrorthat names the missing variables and points at--env-pathand the likely.env.locallocation, instead of surfacing the raw build error.See the PR diff for how "required" vars are determined; the check is intentionally minimal and targeted at the vars the core build asserts on.
Testing
required-build-env.spec.ts+build.spec.ts— 9 tests pass, covering the missing-env path and the pass-through case.typecheckandlintpass.Migration
None.