fix(workbench): validate unstable_defineApp config (build fails, dev warns)#1330
Open
gu-stav wants to merge 4 commits into
Open
fix(workbench): validate unstable_defineApp config (build fails, dev warns)#1330gu-stav wants to merge 4 commits into
gu-stav wants to merge 4 commits into
Conversation
Contributor
📦 Bundle Stats —
|
| Metric | Value | vs main (a2deacf) |
|---|---|---|
| Internal (raw) | 2.7 KB | - |
| Internal (gzip) | 1.0 KB | - |
| Bundled (raw) | 11.15 MB | - |
| Bundled (gzip) | 2.10 MB | - |
| Import time | 770ms | -1ms, -0.1% |
bin:sanity
| Metric | Value | vs main (a2deacf) |
|---|---|---|
| Internal (raw) | 782 B | - |
| Internal (gzip) | 423 B | - |
| Bundled (raw) | 9.87 MB | - |
| Bundled (gzip) | 1.77 MB | - |
| Import time | 1.76s | +6ms, +0.4% |
🗺️ View treemap · Artifacts
Details
- Import time regressions over 10% are flagged with
⚠️ - Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.
📦 Bundle Stats — @sanity/cli-core
Compared against main (a2deacf2)
| Metric | Value | vs main (a2deacf) |
|---|---|---|
| Internal (raw) | 106.7 KB | - |
| Internal (gzip) | 26.7 KB | - |
| Bundled (raw) | 21.71 MB | - |
| Bundled (gzip) | 3.45 MB | - |
| Import time | 677ms | -4ms, -0.5% |
🗺️ View treemap · Artifacts
Details
- Import time regressions over 10% are flagged with
⚠️ - Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.
📦 Bundle Stats — create-sanity
Compared against main (a2deacf2)
| Metric | Value | vs main (a2deacf) |
|---|---|---|
| Internal (raw) | 908 B | - |
| Internal (gzip) | 483 B | - |
| Bundled (raw) | 931 B | - |
| Bundled (gzip) | 491 B | - |
| Import time | ❌ ChildProcess denied: node | - |
Details
- Import time regressions over 10% are flagged with
⚠️ - Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 65f9d88. Configure here.
| if (process.env.SANITY_STUDIO_REACT_STRICT_MODE) { | ||
| return process.env.SANITY_STUDIO_REACT_STRICT_MODE === 'true' | ||
| } | ||
| return Boolean(cliConfig?.reactStrictMode) |
There was a problem hiding this comment.
Strict mode default regressed
Low Severity
When neither SANITY_STUDIO_REACT_STRICT_MODE nor reactStrictMode in the CLI config is set, dev now passes reactStrictMode: false into the runtime instead of leaving it unset so renderStudio can apply its own default.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit 65f9d88. Configure here.
…warns) unstable_defineApp is a pure identity wrapper and DefineAppInputSchema was never run on a real config, so an illegal name, missing title, or duplicate view/service names loaded fine and only surfaced later in dev or deploy. Wire the schema in as a gate: sanity build fails on it, sanity dev warns and starts.
gu-stav
force-pushed
the
fix/workbench-validate-app
branch
from
65f9d88 to
caf4f4b
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
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.
unstable_defineAppis a pure identity wrapper and itsDefineAppInputSchemawas never run on a real config, so an illegalname, missingtitle, or duplicate view/service names loaded fine and only surfaced later in dev or deploy (#907 review).Note
Low Risk
CLI-only config validation using an existing Zod schema; no runtime auth, data, or deploy behavior changes beyond failing builds on already-invalid configs.
Overview
Adds
validateWorkbenchAppin@sanity/workbench-cli, running the existingDefineAppInputSchemaon the resolved branded app config and returning a formatted error string (ornull). Becauseunstable_defineAppstays a pure identity wrapper, this is the first time that schema is enforced on realsanity.cli.tsconfigs.sanity build(app and studio paths) calls the validator when a workbench app is detected and exits with code 1 on failure.sanity devruns the same check for branded apps but warns and still starts the dev servers so authors can fix config live.Invalid cases surfaced early include bad
name, missingtitle, duplicate view/service names, and studio configs that declareentry. Tests cover the helper and dev warning behavior.Reviewed by Cursor Bugbot for commit 4387270. Bugbot is set up for automated code reviews on this repo. Configure here.