feat(cli): add command for visualizing schema bloat #11224

judofyr · 2025-11-21T11:27:27Z

Description

Due to the dynamic nature of sanity.config.ts it's very easy to create enormous schemas without really being aware of this. A common gotcha is to inline types/fields instead of defining a named type.

This adds a command sanity schema validate --debug-metafile-path <path> which writes a file with information about the size of the serialized schema which follows ESBuild's metafile format. This can then be analyzed through https://esbuild.github.io/analyze/.

Here are some screenshots on dev/test-studio's schema:

I've added this to the sanity schema validate command since it seems to be quite similar: It's about analyzing the schema to help the developer understand potential problems.

What to review

Try this out on some Studioes maybe?

Testing

I've tested it on dev/test-studio

Notes for release

sanity schema validate --debug-metafile-path <path> is now available. I think we should have a separate guide for how to explore the schema bloat before this gets merged.

vercel · 2025-11-21T11:27:31Z

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

Project	Deployment	Preview	Comments	Updated (UTC)
page-building-studio	Ready	Preview	Comment	Nov 27, 2025 2:23pm
test-studio	Ready	Preview	Comment	Nov 27, 2025 2:23pm

2 Skipped Deployments

Project	Deployment	Preview	Comments	Updated (UTC)
studio-workshop	Ignored	Preview		Nov 27, 2025 2:23pm
test-next-studio	Ignored			Nov 27, 2025 2:23pm

judofyr · 2025-11-21T11:27:43Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

github-actions · 2025-11-21T11:27:53Z

🧪 E2E Preview environment

🔑 Environment Variables for Local Testing

This is the preview URL for the E2E tests: https://e2e-studio-p2oyipfer.sanity.dev

To run the E2E tests locally, you can use the following environment variables, then run pnpm test:e2e --ui to open the Playwright test runner.

💬 Remember to build the project first with pnpm build:e2e.

  SANITY_E2E_PROJECT_ID=ittbm412
  SANITY_E2E_BASE_URL=https://e2e-studio-p2oyipfer.sanity.dev
  SANITY_E2E_DATASET="update depending the project you want to test (pr-11224-chromium-19739211937 || pr-11224-firefox-19739211937 )"
  SANITY_E2E_DATASET_CHROMIUM=pr-11224-chromium-19739211937
  SANITY_E2E_DATASET_FIREFOX=pr-11224-firefox-19739211937

github-actions · 2025-11-21T11:27:54Z

📊 Playwright Test Report

Download Full E2E Report

This report contains test results, including videos of failing tests.

github-actions · 2025-11-21T11:33:20Z

⚡️ Editor Performance Report

Updated Thu, 27 Nov 2025 17:43:42 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	28.6 efps (35ms)	26.7 efps (38ms)	+3ms (+7.1%)	✅
article (body)	38.8 efps (26ms)	37.3 efps (27ms)	+1ms (+4.1%)	✅
article (string inside object)	29.0 efps (35ms)	29.9 efps (34ms)	-1ms (-2.9%)	✅
article (string inside array)	25.0 efps (40ms)	25.6 efps (39ms)	-1ms (-2.5%)	✅
recipe (name)	54.1 efps (19ms)	55.6 efps (18ms)	-1ms (-2.7%)	✅
recipe (description)	71.4 efps (14ms)	71.4 efps (14ms)	+0ms (-/-%)	✅
recipe (instructions)	99.9+ efps (5ms)	99.9+ efps (5ms)	+0ms (-/-%)	✅
singleString (stringField)	71.4 efps (14ms)	71.4 efps (14ms)	+0ms (-/-%)	✅
synthetic (title)	17.4 efps (58ms)	17.2 efps (58ms)	+1ms (+0.9%)	✅
synthetic (string inside object)	17.5 efps (57ms)	17.5 efps (57ms)	+0ms (-/-%)	✅

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	35ms	40ms	58ms	110ms	29ms	10.1s
article (body)	26ms	34ms	72ms	108ms	52ms	5.9s
article (string inside object)	35ms	43ms	60ms	95ms	0ms	5.5s
article (string inside array)	40ms	44ms	58ms	96ms	0ms	6.2s
recipe (name)	19ms	21ms	24ms	45ms	0ms	6.8s
recipe (description)	14ms	18ms	21ms	31ms	0ms	4.0s
recipe (instructions)	5ms	9ms	11ms	31ms	0ms	3.0s
singleString (stringField)	14ms	18ms	21ms	32ms	0ms	6.0s
synthetic (title)	58ms	60ms	122ms	177ms	374ms	14.9s
synthetic (string inside object)	57ms	59ms	66ms	158ms	217ms	7.9s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	38ms	45ms	65ms	102ms	27ms	10.1s
article (body)	27ms	31ms	63ms	118ms	90ms	6.0s
article (string inside object)	34ms	38ms	43ms	85ms	3ms	5.6s
article (string inside array)	39ms	42ms	62ms	113ms	0ms	6.1s
recipe (name)	18ms	21ms	23ms	49ms	0ms	7.5s
recipe (description)	14ms	17ms	20ms	41ms	0ms	4.1s
recipe (instructions)	5ms	9ms	11ms	29ms	0ms	3.0s
singleString (stringField)	14ms	16ms	18ms	30ms	0ms	5.9s
synthetic (title)	58ms	61ms	65ms	128ms	324ms	15.1s
synthetic (string inside object)	57ms	62ms	126ms	273ms	573ms	8.4s

📚 Glossary

column definitions

benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".

latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.

p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.

p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.

p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.

blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.

test duration — how long the test run took to complete.

github-actions · 2025-11-21T11:43:55Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	44.64%	63658 / 142589
🔵	Statements	44.64%	63658 / 142589
🔵	Functions	48.23%	3397 / 7043
🔵	Branches	79.33%	12920 / 16286

File Coverage

No changed files found.

Generated in workflow #46468 for commit d114d13 by the Vitest Coverage Report Action

stipsan

Fascinating! I think for a guide it would be helpful to show a before/after to demonstrate the impact of refactoring a schema from using inline types to named types, to better understand what to look for in the esbuild visualizer graphs.

I've triggered a preview release so I can try it on some test studios.

Is there a measurable runtime difference in how long prepareConfig spends processing the schema as well? We have to resolve it up front before the studio can load, and it's resolved again during hot reload cycles if the schema is edited in any way 🤔

judofyr · 2025-11-25T09:45:57Z

@stipsan: Nice, nice! I fixed a build error, but now it seems like the publishing failed. I can wait with merging this until you've tested it.

Is there a measurable runtime difference in how long prepareConfig spends processing the schema as well? We have to resolve it up front before the studio can load, and it's resolved again during hot reload cycles if the schema is edited in any way 🤔

Not sure if I follow you. This doesn't change anything related to prepareConfig, but is only in the CLI.

stipsan · 2025-11-25T10:20:50Z

@stipsan: Nice, nice! I fixed a build error, but now it seems like the publishing failed. I can wait with merging this until you've tested it.

Hmmm seems like pkg.pr.new isn't working atm, so we can just merge to main and test with sanity@next 👍

Is there a measurable runtime difference in how long prepareConfig spends processing the schema as well? We have to resolve it up front before the studio can load, and it's resolved again during hot reload cycles if the schema is edited in any way 🤔

Not sure if I follow you. This doesn't change anything related to prepareConfig, but is only in the CLI.

I understand that this PR in itself doesn't affect prepareConfig in any way. What I mean is that if someone uses --debug-metafile-path to refactor inline types to named types it could lead to the schema being significantly smaller.
A much smaller schema should be faster to process by prepareConfig, as it has to resolve schema types at runtime as well as pass the resolved schema to a SchemaBuilder.compile step (createSchema calls SchemaBuilder.compile):

sanity/packages/sanity/src/core/config/prepareConfig.tsx

Lines 214 to 231 in ae1394c

    
           let schemaTypes 
        
           try { 
        
             schemaTypes = resolveSchemaTypes({ 
        
               config: source, 
        
               context: {projectId, dataset}, 
        
             }) 
        
           } catch (e) { 
        
             throw new ConfigResolutionError({ 
        
               name: source.name, 
        
               type: 'source', 
        
               causes: [e], 
        
             }) 
        
           } 
        
           const schema = createSchema({ 
        
             name: source.name, 
        
             types: schemaTypes, 
        
           })

judofyr · 2025-11-25T10:25:16Z

Ah, yes! It's true that interpreting this number can be a bit tricky. It's now only for the "new" server-side schema approach (which even used by anything proper yet). A smaller schema from this file doesn't necessarily mean that prepareConfig will be faster. It will however matter for the long-term server-side schema bits and pieces, and I believe it either way will be a good proxy for overall schema complexity.

This adds a command `sanity schema validate --debug-metafile-path <path>` which writes a file with information about the size of the serialized schema which follows ESBuild's metafile format. This can then be analyzed through https://esbuild.github.io/analyze/

github-actions · 2025-11-27T14:21:00Z

Preview this PR with pkg.pr.new

Create a new project

npx https://pkg.pr.new/create-sanity@23db03f

Note: This installs the latest Sanity Studio from the npm registry. To apply the changes from this PR in your newly created project, run the install commands below for each package listed in your package.json

...Or run the Sanity CLI

npx https://pkg.pr.new/@sanity/cli@23db03f <command>

...Or upgrade project dependencies

Using pnpm

📦 `sanity`

pnpm install https://pkg.pr.new/sanity@d114d13

📦 `@sanity/vision`

pnpm install https://pkg.pr.new/@sanity/vision@d114d13

📦 Other packages…

📦 `create-sanity`

pnpm install https://pkg.pr.new/create-sanity@d114d13

📦 `groq`

pnpm install https://pkg.pr.new/groq@d114d13

📦 `@sanity/cli`

pnpm install https://pkg.pr.new/@sanity/cli@d114d13

📦 `@sanity/codegen`

pnpm install https://pkg.pr.new/@sanity/codegen@d114d13

📦 `@sanity/diff`

pnpm install https://pkg.pr.new/@sanity/diff@d114d13

📦 `@sanity/migrate`

pnpm install https://pkg.pr.new/@sanity/migrate@d114d13

📦 `@sanity/mutator`

pnpm install https://pkg.pr.new/@sanity/mutator@d114d13

📦 `@sanity/schema`

pnpm install https://pkg.pr.new/@sanity/schema@d114d13

📦 `@sanity/types`

pnpm install https://pkg.pr.new/@sanity/types@d114d13

📦 `@sanity/util`

pnpm install https://pkg.pr.new/@sanity/util@d114d13

Using npm

📦 `sanity`

npm install https://pkg.pr.new/sanity@d114d13

📦 `@sanity/vision`

npm install https://pkg.pr.new/@sanity/vision@d114d13

📦 Other packages…

📦 `create-sanity`

npm install https://pkg.pr.new/create-sanity@d114d13

📦 `groq`

npm install https://pkg.pr.new/groq@d114d13

📦 `@sanity/cli`

npm install https://pkg.pr.new/@sanity/cli@d114d13

📦 `@sanity/codegen`

npm install https://pkg.pr.new/@sanity/codegen@d114d13

📦 `@sanity/diff`

npm install https://pkg.pr.new/@sanity/diff@d114d13

📦 `@sanity/migrate`

npm install https://pkg.pr.new/@sanity/migrate@d114d13

📦 `@sanity/mutator`

npm install https://pkg.pr.new/@sanity/mutator@d114d13

📦 `@sanity/schema`

npm install https://pkg.pr.new/@sanity/schema@d114d13

📦 `@sanity/types`

npm install https://pkg.pr.new/@sanity/types@d114d13

📦 `@sanity/util`

npm install https://pkg.pr.new/@sanity/util@d114d13

View Commit (d114d13)

judofyr · 2025-11-27T14:24:09Z

@stipsan: I've now rebased from latest main and did a tiny change in the format.

stipsan

Let's go!

judofyr · 2025-11-28T09:22:48Z

Merge activity

Nov 28, 9:22 AM UTC: A user started a stack merge that includes this pull request via Graphite.
Nov 28, 9:23 AM UTC: @judofyr merged this pull request with Graphite.

judofyr mentioned this pull request Nov 21, 2025

fix(cli): load config properly in sanity schema validate #11223

Merged

judofyr self-assigned this Nov 21, 2025

vercel bot deployed to Preview – test-studio November 21, 2025 11:33 View deployment

judofyr force-pushed the cldx-4337/sanity-validate-metafile branch from 2dededf to 2c36abb Compare November 21, 2025 11:33

vercel bot deployed to Preview – test-studio November 21, 2025 11:39 View deployment

vercel bot deployed to Preview – page-building-studio November 21, 2025 11:41 View deployment

judofyr marked this pull request as ready for review November 21, 2025 11:49

judofyr requested a review from a team as a code owner November 21, 2025 11:49

judofyr requested review from jordanl17 and removed request for a team November 21, 2025 11:49

judofyr force-pushed the cldx-4337/sanity-validate-metafile branch from 2c36abb to 19f4022 Compare November 21, 2025 11:51

vercel bot deployed to Preview – test-studio November 21, 2025 11:56 View deployment

vercel bot deployed to Preview – page-building-studio November 21, 2025 11:57 View deployment

Base automatically changed from sdk-655/resolve-config-in-schema-validate to main November 24, 2025 08:30

judofyr force-pushed the cldx-4337/sanity-validate-metafile branch from 19f4022 to 7e30900 Compare November 24, 2025 08:31

vercel bot deployed to Preview – test-studio November 24, 2025 08:37 View deployment

vercel bot deployed to Preview – page-building-studio November 24, 2025 08:38 View deployment

judofyr mentioned this pull request Nov 24, 2025

feat(schema): cache generated field/type objects #11236

Merged

judofyr force-pushed the cldx-4337/sanity-validate-metafile branch from 7e30900 to b7b96cd Compare November 24, 2025 15:35

This was referenced Nov 24, 2025

refactor(schema): remove unused options to DescriptorConverter #11239

Merged

feat(schema): de-dupe re-used fields in the descriptor #11240

Open

vercel bot had a problem deploying to Preview – test-studio November 24, 2025 15:36 Failure

vercel bot had a problem deploying to Preview – page-building-studio November 24, 2025 15:37 Failure

stipsan added the trigger: preview label Nov 25, 2025

stipsan previously approved these changes Nov 25, 2025

View reviewed changes

judofyr dismissed stipsan’s stale review via c121f06 November 25, 2025 09:29

judofyr force-pushed the cldx-4337/sanity-validate-metafile branch from b7b96cd to c121f06 Compare November 25, 2025 09:29

vercel bot deployed to Preview – test-studio November 25, 2025 09:29 View deployment

vercel bot deployed to Preview – page-building-studio November 25, 2025 09:29 View deployment

stipsan previously approved these changes Nov 25, 2025

View reviewed changes

judofyr dismissed stipsan’s stale review via d114d13 November 27, 2025 14:17

judofyr force-pushed the cldx-4337/sanity-validate-metafile branch from c121f06 to d114d13 Compare November 27, 2025 14:17

This was referenced Nov 27, 2025

refactor(descriptors): make descriptor converter async #11309

Open

feat(descriptors): minimize blocking the UI #11310

Open

vercel bot deployed to Preview – test-studio November 27, 2025 14:22 View deployment

vercel bot deployed to Preview – page-building-studio November 27, 2025 14:22 View deployment

judofyr requested a review from stipsan November 27, 2025 14:24

stipsan approved these changes Nov 27, 2025

View reviewed changes

judofyr merged commit 721e6d2 into main Nov 28, 2025
69 of 73 checks passed

judofyr deleted the cldx-4337/sanity-validate-metafile branch November 28, 2025 09:23

feat(cli): add command for visualizing schema bloat #11224

feat(cli): add command for visualizing schema bloat #11224

Conversation

judofyr commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What to review

Testing

Notes for release

Uh oh!

vercel bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

judofyr commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 E2E Preview environment

Uh oh!

github-actions bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Playwright Test Report

Uh oh!

github-actions bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

Uh oh!

github-actions bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

stipsan left a comment

Choose a reason for hiding this comment

Uh oh!

judofyr commented Nov 25, 2025

Uh oh!

stipsan commented Nov 25, 2025

Uh oh!

judofyr commented Nov 25, 2025

Uh oh!

github-actions bot commented Nov 27, 2025

Preview this PR with pkg.pr.new

Create a new project

...Or run the Sanity CLI

...Or upgrade project dependencies

Using pnpm

📦 sanity

📦 @sanity/vision

📦 create-sanity

📦 groq

📦 @sanity/cli

📦 @sanity/codegen

📦 @sanity/diff

📦 @sanity/migrate

📦 @sanity/mutator

📦 @sanity/schema

📦 @sanity/types

📦 @sanity/util

Using npm

📦 sanity

📦 @sanity/vision

📦 create-sanity

📦 groq

📦 @sanity/cli

📦 @sanity/codegen

📦 @sanity/diff

📦 @sanity/migrate

📦 @sanity/mutator

📦 @sanity/schema

📦 @sanity/types

📦 @sanity/util

Uh oh!

judofyr commented Nov 27, 2025

Uh oh!

stipsan left a comment

judofyr commented Nov 21, 2025 •

edited

Loading

vercel bot commented Nov 21, 2025 •

edited

Loading

judofyr commented Nov 21, 2025 •

edited

Loading

github-actions bot commented Nov 21, 2025 •

edited

Loading

github-actions bot commented Nov 21, 2025 •

edited

Loading

github-actions bot commented Nov 21, 2025 •

edited

Loading

github-actions bot commented Nov 21, 2025 •

edited

Loading

📦 `sanity`

📦 `@sanity/vision`

📦 `create-sanity`

📦 `groq`

📦 `@sanity/cli`

📦 `@sanity/codegen`

📦 `@sanity/diff`

📦 `@sanity/migrate`

📦 `@sanity/mutator`

📦 `@sanity/schema`

📦 `@sanity/types`

📦 `@sanity/util`

📦 `sanity`

📦 `@sanity/vision`

📦 `create-sanity`

📦 `groq`

📦 `@sanity/cli`

📦 `@sanity/codegen`

📦 `@sanity/diff`

📦 `@sanity/migrate`

📦 `@sanity/mutator`

📦 `@sanity/schema`

📦 `@sanity/types`

📦 `@sanity/util`

judofyr commented Nov 28, 2025 •

edited

Loading