Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(cli): pin template validator version #8131

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

RostiMelk
Copy link
Member

@RostiMelk RostiMelk commented Dec 22, 2024

Description

Disabling flexible versioning for the @sanity/template-validator package i @sanity/cli

This PR won't really fix the issue before #8115 is released, but I think it's definitely worth pinning this dependency going forward to avoid this type of issue happening again.

Notes for release

Fixed an issue where initiating a project using a remote template crashed the CLI

@RostiMelk RostiMelk requested a review from a team as a code owner December 22, 2024 16:49
@RostiMelk RostiMelk requested review from cngonzalez and removed request for a team December 22, 2024 16:49
Copy link

vercel bot commented Dec 22, 2024

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 Dec 22, 2024 4:59pm
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 22, 2024 4:59pm
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 22, 2024 4:59pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 22, 2024 4:59pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Dec 22, 2024 4:59pm

Copy link
Contributor

No changes to documentation

Copy link
Contributor

Component Testing Report Updated Dec 22, 2024 4:55 PM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 1m 5s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 12s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 37s 6 0 0
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) 25s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 14s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 26s 6 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 1m 6s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 27s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 39s 18 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 42s 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

Copy link
Contributor

⚡️ Editor Performance Report

Updated Sun, 22 Dec 2024 17:00:33 GMT

Benchmark reference
latency of sanity@latest
experiment
latency of this branch
Δ (%)
latency difference
article (title) 26.3 efps (38ms) 27.0 efps (37ms) -1ms (-2.6%)
article (body) 72.5 efps (14ms) 78.1 efps (13ms) -1ms (-/-%)
article (string inside object) 28.6 efps (35ms) 30.3 efps (33ms) -2ms (-5.7%)
article (string inside array) 27.0 efps (37ms) 27.0 efps (37ms) +0ms (-/-%)
recipe (name) 55.6 efps (18ms) 58.8 efps (17ms) -1ms (-5.6%)
recipe (description) 62.5 efps (16ms) 66.7 efps (15ms) -1ms (-6.3%)
recipe (instructions) 99.9+ efps (5ms) 99.9+ efps (5ms) +0ms (-/-%)
synthetic (title) 20.4 efps (49ms) 21.3 efps (47ms) -2ms (-4.1%)
synthetic (string inside object) 22.2 efps (45ms) 21.7 efps (46ms) +1ms (+2.2%)

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) 38ms 42ms 58ms 525ms 956ms 10.2s
article (body) 14ms 16ms 19ms 96ms 364ms 5.5s
article (string inside object) 35ms 39ms 61ms 168ms 155ms 6.7s
article (string inside array) 37ms 40ms 45ms 68ms 128ms 6.5s
recipe (name) 18ms 20ms 22ms 38ms 0ms 7.5s
recipe (description) 16ms 17ms 19ms 38ms 0ms 4.3s
recipe (instructions) 5ms 7ms 8ms 22ms 0ms 3.0s
synthetic (title) 49ms 54ms 82ms 302ms 451ms 13.1s
synthetic (string inside object) 45ms 48ms 55ms 250ms 373ms 8.1s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 37ms 40ms 58ms 345ms 201ms 10.1s
article (body) 13ms 14ms 16ms 125ms 166ms 4.7s
article (string inside object) 33ms 35ms 40ms 86ms 221ms 6.4s
article (string inside array) 37ms 39ms 44ms 71ms 129ms 6.5s
recipe (name) 17ms 18ms 20ms 29ms 0ms 6.9s
recipe (description) 15ms 15ms 17ms 34ms 0ms 4.2s
recipe (instructions) 5ms 7ms 8ms 25ms 0ms 3.0s
synthetic (title) 47ms 48ms 55ms 278ms 408ms 11.9s
synthetic (string inside object) 46ms 48ms 54ms 94ms 683ms 7.7s

📚 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.

Copy link
Member

@cngonzalez cngonzalez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies, I'm a little out of the loop on what happened here. Was the template validator a version ahead of our CLI tooling, and is this something we expect to happen in the future? I'm nervous to pin packages unless necessary (unless it's something we expect renovate bot to handle?)

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