feat(cli): use `@sanity/template-validator` package #8014

RostiMelk · 2024-12-11T15:27:22Z

Description

Stripping away all template validation logic away from the CLI
Using the @sanity/template-validator package for validating
remove yaml dependency

Fixes GRO-3004

What to review

The lock file diff seems very large for some reason. Am I doing something wrong?

Testing

N/A

Notes for release

N/A

vercel · 2024-12-11T15:27:29Z

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 13, 2024 0:05am
performance-studio	✅ Ready (Inspect)	Visit Preview		Dec 13, 2024 0:05am
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 13, 2024 0:05am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 13, 2024 0:05am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Dec 13, 2024 0:05am

socket-security · 2024-12-11T15:30:17Z

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@sanity/[email protected]	network Transitive: environment, filesystem, shell, unsafe	`+24`	13 MB	sanity-io

View full report↗︎

github-actions · 2024-12-11T15:34:35Z

No changes to documentation

github-actions · 2024-12-11T15:40:30Z

Component Testing Report Updated Dec 13, 2024 11:51 AM (UTC)

❌ Failed Tests (6) -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 11s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	13s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	40s	6	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	56s	11	7	0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	28s	6	0	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	15s	3	0	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	❌ Failed (Inspect)	4m 27s	0	0	6
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 12s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	2m 52s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 47s	18	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	14s	3	9	0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	41s	9	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	28s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	1m 51s	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 · 2024-12-11T15:42:10Z

⚡️ Editor Performance Report

Updated Fri, 13 Dec 2024 11:52:27 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	26.0 efps (39ms)	24.4 efps (41ms)	+3ms (+6.5%)	✅
article (body)	72.5 efps (14ms)	69.7 efps (14ms)	+1ms (-/-%)	✅
article (string inside object)	25.3 efps (40ms)	24.4 efps (41ms)	+2ms (+3.8%)	✅
article (string inside array)	22.7 efps (44ms)	22.0 efps (46ms)	+2ms (+3.4%)	✅
recipe (name)	50.0 efps (20ms)	50.0 efps (20ms)	+0ms (-/-%)	✅
recipe (description)	55.6 efps (18ms)	55.6 efps (18ms)	+0ms (-/-%)	✅
recipe (instructions)	99.9+ efps (5ms)	99.9+ efps (5ms)	+0ms (-/-%)	✅
synthetic (title)	19.2 efps (52ms)	19.6 efps (51ms)	-1ms (-1.9%)	✅
synthetic (string inside object)	20.0 efps (50ms)	19.6 efps (51ms)	+1ms (+2.0%)	✅

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)	39ms	41ms	46ms	171ms	148ms	11.3s
article (body)	14ms	16ms	18ms	67ms	57ms	4.7s
article (string inside object)	40ms	44ms	50ms	181ms	172ms	7.1s
article (string inside array)	44ms	46ms	52ms	152ms	151ms	7.1s
recipe (name)	20ms	22ms	27ms	58ms	24ms	8.5s
recipe (description)	18ms	20ms	21ms	42ms	0ms	4.6s
recipe (instructions)	5ms	7ms	8ms	8ms	0ms	3.1s
synthetic (title)	52ms	55ms	60ms	322ms	562ms	16.7s
synthetic (string inside object)	50ms	53ms	58ms	273ms	413ms	7.9s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	41ms	43ms	62ms	81ms	159ms	11.5s
article (body)	14ms	18ms	25ms	95ms	220ms	5.4s
article (string inside object)	41ms	43ms	51ms	74ms	259ms	7.2s
article (string inside array)	46ms	48ms	60ms	177ms	147ms	7.3s
recipe (name)	20ms	20ms	22ms	42ms	0ms	7.4s
recipe (description)	18ms	19ms	22ms	40ms	0ms	4.6s
recipe (instructions)	5ms	7ms	8ms	22ms	0ms	3.1s
synthetic (title)	51ms	56ms	62ms	272ms	511ms	12.8s
synthetic (string inside object)	51ms	54ms	60ms	294ms	456ms	8.1s

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

jordanl17 · 2024-12-13T11:23:22Z

packages/@sanity/cli/src/util/remoteTemplate.ts

  const headers: Record<string, string> = {}
  if (bearerToken) {
    headers.Authorization = `Bearer ${bearerToken}`
  }
-


Just want to verify - this is mostly just a copy/paste across to here? - https://github.com/sanity-io/template-validator/blob/main/src/validator.ts

Yes, correct 👍

jordanl17

Neat!

vercel bot deployed to Preview – performance-studio December 11, 2024 15:36 View deployment

vercel bot deployed to Preview – test-studio December 11, 2024 15:36 View deployment

vercel bot deployed to Preview – page-building-studio December 11, 2024 15:37 View deployment

RostiMelk marked this pull request as ready for review December 11, 2024 15:37

RostiMelk requested a review from a team as a code owner December 11, 2024 15:37

RostiMelk requested review from jordanl17 and removed request for a team December 11, 2024 15:37

vercel bot deployed to Preview – test-next-studio December 11, 2024 15:45 View deployment

RostiMelk requested a review from bjoerge December 13, 2024 09:20

jordanl17 reviewed Dec 13, 2024

View reviewed changes

jordanl17 previously approved these changes Dec 13, 2024

View reviewed changes

RostiMelk dismissed jordanl17’s stale review via 081f819 December 13, 2024 11:35

RostiMelk added 2 commits December 13, 2024 12:38

feat: use template validator package

f596c5a

chore: sync pnpm lock

67cba3d

RostiMelk force-pushed the feat/cli/use-template-validator-package branch from 081f819 to 67cba3d Compare December 13, 2024 11:40

jordanl17 approved these changes Dec 13, 2024

View reviewed changes

vercel bot deployed to Preview – page-building-studio December 13, 2024 11:49 View deployment

vercel bot deployed to Preview – performance-studio December 13, 2024 11:51 View deployment

vercel bot deployed to Preview – test-studio December 13, 2024 11:52 View deployment

jordanl17 added this pull request to the merge queue Dec 13, 2024

Merged via the queue into next with commit 27fa7e5 Dec 13, 2024
54 of 55 checks passed

jordanl17 deleted the feat/cli/use-template-validator-package branch December 13, 2024 12:00

vercel bot deployed to Preview – test-next-studio December 13, 2024 12:05 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): use `@sanity/template-validator` package #8014

feat(cli): use `@sanity/template-validator` package #8014

RostiMelk commented Dec 11, 2024 •

edited

Loading

vercel bot commented Dec 11, 2024 •

edited

Loading

socket-security bot commented Dec 11, 2024 •

edited

Loading

github-actions bot commented Dec 11, 2024

github-actions bot commented Dec 11, 2024 •

edited

Loading

github-actions bot commented Dec 11, 2024 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

jordanl17 Dec 13, 2024

RostiMelk Dec 13, 2024

jordanl17 left a comment

feat(cli): use @sanity/template-validator package #8014

feat(cli): use @sanity/template-validator package #8014

Conversation

RostiMelk commented Dec 11, 2024 • edited Loading

Description

What to review

Testing

Notes for release

vercel bot commented Dec 11, 2024 • edited Loading

socket-security bot commented Dec 11, 2024 • edited Loading

github-actions bot commented Dec 11, 2024

github-actions bot commented Dec 11, 2024 • edited Loading

github-actions bot commented Dec 11, 2024 • edited Loading

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

jordanl17 Dec 13, 2024

Choose a reason for hiding this comment

RostiMelk Dec 13, 2024

Choose a reason for hiding this comment

jordanl17 left a comment

Choose a reason for hiding this comment

feat(cli): use `@sanity/template-validator` package #8014

feat(cli): use `@sanity/template-validator` package #8014

RostiMelk commented Dec 11, 2024 •

edited

Loading

vercel bot commented Dec 11, 2024 •

edited

Loading

socket-security bot commented Dec 11, 2024 •

edited

Loading

github-actions bot commented Dec 11, 2024 •

edited

Loading

github-actions bot commented Dec 11, 2024 •

edited

Loading