fix: set strictRequires to auto when building auto updating studios #8367

bjoerge · 2025-01-22T15:40:34Z

Description

When building auto-updating Studios with Vite 6 we ran into an issue caused by the default of commonjsOptions.strictRequires that changed from auto to true between v5 and v6 (mentioned in the advanced section here: https://vite.dev/guide/migration#advanced)

This caused the vendorized react bundle to place all named exports on the default export instead of exporting them all individually which then broke named imports.

This PR explicitly sets commonjsOptions.strictRequires to auto which will produce the same output in both Vite v5 and v6.

We mitigated the earlier issue by reverting back to to Vite 5 (#8362). Now that we know the exact cause, and the fix, it would be good to have this merged so we can safely upgrade to Vite 6 again without affecting auto-updating Studios.

Notes for release

n/a –internal

vercel · 2025-01-22T15:40:39Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
page-building-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2025 11:50am
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2025 11:50am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2025 11:50am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jan 24, 2025 11:50am
test-next-studio	⬜️ Ignored (Inspect)			Jan 24, 2025 11:50am

github-actions · 2025-01-22T15:52:02Z

No changes to documentation

github-actions · 2025-01-22T16:22:13Z

Component Testing Report Updated Jan 24, 2025 11:45 AM (UTC)

❌ Failed Tests (2) -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 6s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	❌ Failed (Inspect)	1m 19s	5	0	1
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	50s	11	7	0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	14s	3	0	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	❌ Failed (Inspect)	1m 6s	5	0	1
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 6s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 30s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	2m 1s	21	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	12s	3	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	1m 43s	21	0	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3	0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3	0

github-actions · 2025-01-22T16:32:40Z

⚡️ Editor Performance Report

Updated Fri, 24 Jan 2025 11:46:45 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	25.3 efps (40ms)	25.0 efps (40ms)	+1ms (+1.3%)	✅
article (body)	67.6 efps (15ms)	72.2 efps (14ms)	-1ms (-/-%)	✅
article (string inside object)	26.3 efps (38ms)	25.6 efps (39ms)	+1ms (+2.6%)	✅
article (string inside array)	23.3 efps (43ms)	22.7 efps (44ms)	+1ms (+2.3%)	✅
recipe (name)	52.6 efps (19ms)	52.6 efps (19ms)	+0ms (-/-%)	✅
recipe (description)	58.8 efps (17ms)	60.6 efps (17ms)	-1ms (-2.9%)	✅
recipe (instructions)	99.9+ efps (5ms)	99.9+ efps (5ms)	+0ms (-/-%)	✅
synthetic (title)	19.6 efps (51ms)	19.6 efps (51ms)	+0ms (-/-%)	✅
synthetic (string inside object)	21.3 efps (47ms)	19.0 efps (53ms)	+6ms (+11.7%)	✅

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)	40ms	45ms	72ms	447ms	823ms	10.8s
article (body)	15ms	17ms	19ms	73ms	218ms	5.6s
article (string inside object)	38ms	41ms	43ms	148ms	150ms	7.0s
article (string inside array)	43ms	46ms	49ms	300ms	412ms	7.2s
recipe (name)	19ms	20ms	23ms	33ms	0ms	7.5s
recipe (description)	17ms	18ms	20ms	37ms	0ms	4.6s
recipe (instructions)	5ms	6ms	7ms	8ms	0ms	3.0s
synthetic (title)	51ms	53ms	68ms	311ms	728ms	13.2s
synthetic (string inside object)	47ms	49ms	51ms	471ms	246ms	7.8s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	40ms	46ms	74ms	494ms	927ms	10.7s
article (body)	14ms	15ms	17ms	35ms	190ms	5.1s
article (string inside object)	39ms	41ms	48ms	246ms	284ms	6.8s
article (string inside array)	44ms	47ms	51ms	246ms	355ms	7.1s
recipe (name)	19ms	21ms	25ms	48ms	0ms	6.7s
recipe (description)	17ms	18ms	20ms	35ms	0ms	4.3s
recipe (instructions)	5ms	7ms	7ms	11ms	0ms	3.0s
synthetic (title)	51ms	54ms	58ms	188ms	572ms	12.1s
synthetic (string inside object)	53ms	57ms	78ms	418ms	1187ms	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.

binoy14 · 2025-01-22T17:14:58Z

Any chance we can get #8364 working first?

bjoerge · 2025-01-22T17:23:45Z

Any chance we can get #8364 working first?

Oh, yes 💯 – would love to see that one merged first

juice49

Thanks for tracking this down 🙏. Looks good to me. I agree with Binoy, it would be good to land #8364 first.

RitaDias · 2025-01-28T09:03:26Z

cc @bjoerge @binoy14
Since the PR that Carolina was closed due to some larger issues she discovered I just want to double check what should be the state of this PR (if we want to put it on ice as well or if we want to move it along review wise)

binoy14 · 2025-01-30T02:36:44Z

cc @bjoerge @binoy14 Since the PR that Carolina was closed due to some larger issues she discovered I just want to double check what should be the state of this PR (if we want to put it on ice as well or if we want to move it along review wise)

I think we can merge this instead of waiting for the tests

* next: fix: set strictRequires to auto when building auto updating studios (#8367) fix(cli): fix issue where core sanity types were appearing in the validation for schemas and documents (#8445) fix(cli): apply write token (#8450)

vercel bot deployed to Preview – test-studio January 22, 2025 15:51 View deployment

vercel bot deployed to Preview – performance-studio January 22, 2025 15:52 View deployment

vercel bot deployed to Preview – page-building-studio January 22, 2025 15:53 View deployment

bjoerge mentioned this pull request Jan 22, 2025

chore(deps): upgrade vite (back) to v6 #8370

Merged

bjoerge marked this pull request as ready for review January 22, 2025 16:54

bjoerge requested a review from a team as a code owner January 22, 2025 16:54

bjoerge requested review from RitaDias, juice49 and binoy14 and removed request for a team January 22, 2025 16:54

bjoerge enabled auto-merge January 22, 2025 16:55

bjoerge disabled auto-merge January 22, 2025 17:23

juice49 force-pushed the next branch from 9caf5d8 to 691aad1 Compare January 23, 2025 13:56

bjoerge force-pushed the set-strict-requires-auto branch from c802690 to 12b330b Compare January 24, 2025 11:33

fix: set strictRequires to auto when building auto updating studios

d9a518f

bjoerge force-pushed the set-strict-requires-auto branch from 12b330b to d9a518f Compare January 24, 2025 11:35

vercel bot deployed to Preview – page-building-studio January 24, 2025 11:47 View deployment

vercel bot deployed to Preview – performance-studio January 24, 2025 11:47 View deployment

juice49 approved these changes Jan 24, 2025

View reviewed changes

vercel bot deployed to Preview – test-studio January 24, 2025 11:50 View deployment

binoy14 approved these changes Jan 30, 2025

View reviewed changes

bjoerge added this pull request to the merge queue Jan 30, 2025

Merged via the queue into next with commit 01a9cd9 Jan 30, 2025
56 checks passed

bjoerge deleted the set-strict-requires-auto branch January 30, 2025 11:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: set strictRequires to auto when building auto updating studios #8367

fix: set strictRequires to auto when building auto updating studios #8367

bjoerge commented Jan 22, 2025

vercel bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

binoy14 commented Jan 22, 2025

bjoerge commented Jan 22, 2025

juice49 left a comment

RitaDias commented Jan 28, 2025

binoy14 commented Jan 30, 2025

fix: set strictRequires to auto when building auto updating studios #8367

fix: set strictRequires to auto when building auto updating studios #8367

Conversation

bjoerge commented Jan 22, 2025

Description

Notes for release

vercel bot commented Jan 22, 2025 • edited Loading

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025 • edited Loading

github-actions bot commented Jan 22, 2025 • edited Loading

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

binoy14 commented Jan 22, 2025

bjoerge commented Jan 22, 2025

juice49 left a comment

Choose a reason for hiding this comment

RitaDias commented Jan 28, 2025

binoy14 commented Jan 30, 2025

vercel bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading