feat(core): add versions to references and status icons #7690

pedrobonamin · 2024-10-29T07:51:16Z

Description

This PR adds changes to the preview and document status components.
It nows shows the versions of the document.

The preview value correctly reflects the stack of releases when previewing a release.
So if a document is part of the releases asap1, asap2, scheduled1, undecided1 and user is seeing the release scheduled2 the preview value will reflect the value of the document in release scheduled1 which is scheduled to be released before scheduled 2

What to review

Testing

Notes for release

vercel · 2024-10-29T07:51:21Z

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	Oct 29, 2024 7:59am
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 29, 2024 7:59am
test-compiled-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 29, 2024 7:59am
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 29, 2024 7:59am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 29, 2024 7:59am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)			Oct 29, 2024 7:59am

github-actions · 2024-10-29T07:54:44Z

No changes to documentation

github-actions · 2024-10-29T08:01:33Z

Component Testing Report Updated Oct 29, 2024 8:01 AM (UTC)

✅ All Tests Passed -- expand for details

File	Status	Duration	Passed	Skipped
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 12s	15	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	13s	3	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	40s	6	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	53s	11	7
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	27s	6	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	15s	3	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	2m 8s	2	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 9s	15	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	2m 43s	21	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 44s	18	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	13s	3	9
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	41s	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	27s	6	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	54s	12	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3

RitaDias · 2024-10-29T08:07:26Z

packages/sanity/src/core/components/documentStatus/DocumentStatus.tsx

The simplification of this makes me so happy 🥹

github-actions · 2024-10-29T08:14:38Z

⚡️ Editor Performance Report

Updated Tue, 29 Oct 2024 08:14:38 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	17.5 efps (57ms)	12.5 efps (80ms)	+23ms (+40.4%)	🔴
article (body)	59.9 efps (17ms)	59.5 efps (17ms)	+0ms (+0.6%)	✅
article (string inside object)	17.9 efps (56ms)	13.5 efps (74ms)	+18ms (+32.1%)	🔴
article (string inside array)	14.9 efps (67ms)	11.6 efps (86ms)	+19ms (+28.4%)	🔴
recipe (name)	31.3 efps (32ms)	19.4 efps (52ms)	+20ms (+60.9%)	🔴
recipe (description)	34.5 efps (29ms)	20.8 efps (48ms)	+19ms (+65.5%)	🔴
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (8ms)	+2ms (-/-%)	✅
synthetic (title)	15.2 efps (66ms)	5.8 efps (173ms)	+107ms (+162.1%)	🔴
synthetic (string inside object)	14.3 efps (70ms)	5.9 efps (169ms)	+99ms (+140.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)	57ms	65ms	75ms	200ms	496ms	13.9s
article (body)	17ms	19ms	22ms	166ms	168ms	5.6s
article (string inside object)	56ms	60ms	65ms	212ms	270ms	8.4s
article (string inside array)	67ms	70ms	84ms	312ms	1005ms	9.9s
recipe (name)	32ms	34ms	55ms	86ms	2ms	9.6s
recipe (description)	29ms	30ms	34ms	62ms	1ms	5.9s
recipe (instructions)	6ms	8ms	9ms	22ms	0ms	3.3s
synthetic (title)	66ms	68ms	78ms	311ms	1361ms	15.4s
synthetic (string inside object)	70ms	72ms	106ms	349ms	1682ms	10.3s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	80ms	89ms	134ms	298ms	3807ms	17.9s
article (body)	17ms	20ms	34ms	302ms	738ms	6.7s
article (string inside object)	74ms	85ms	91ms	566ms	3734ms	13.1s
article (string inside array)	86ms	90ms	99ms	325ms	3190ms	12.5s
recipe (name)	52ms	56ms	89ms	216ms	2200ms	14.7s
recipe (description)	48ms	56ms	96ms	222ms	2074ms	10.0s
recipe (instructions)	8ms	10ms	13ms	240ms	479ms	4.8s
synthetic (title)	173ms	188ms	422ms	981ms	11645ms	29.8s
synthetic (string inside object)	169ms	178ms	298ms	1051ms	11082ms	23.5s

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

RitaDias

Just a small question regardign commented code but no blockers :) this looks good!

RitaDias · 2024-10-29T08:10:22Z

packages/sanity/src/core/form/studio/inputs/client-adapters/reference.ts

@@ -28,6 +40,7 @@ const NOT_FOUND = {
  reason: 'NOT_FOUND',
 } as const

+// type VersionsPreviewTuple = [bundleId: string, snapshot: PreviewValue | null]


Seems to not be used anywhere, perhaps we can just remove it? :)

absolutely, thanks for catching that!

will remove in next push

feat(core): add versions to references and status icons

d8626cc

pedrobonamin requested a review from a team as a code owner October 29, 2024 07:51

pedrobonamin requested review from rexxars and removed request for a team October 29, 2024 07:51

vercel bot deployed to Preview – test-studio October 29, 2024 07:52 View deployment

vercel bot deployed to Preview – test-next-studio October 29, 2024 07:56 View deployment

vercel bot deployed to Preview – test-compiled-studio October 29, 2024 07:59 View deployment

pedrobonamin requested review from a team and RitaDias and removed request for rexxars October 29, 2024 08:02

RitaDias reviewed Oct 29, 2024

View reviewed changes

RitaDias approved these changes Oct 29, 2024

View reviewed changes

pedrobonamin merged commit ccdb82f into corel Oct 29, 2024
60 of 63 checks passed

pedrobonamin deleted the corel-218 branch October 29, 2024 08:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): add versions to references and status icons #7690

feat(core): add versions to references and status icons #7690

pedrobonamin commented Oct 29, 2024

vercel bot commented Oct 29, 2024 •

edited

Loading

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

RitaDias Oct 29, 2024

github-actions bot commented Oct 29, 2024

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

RitaDias left a comment

RitaDias Oct 29, 2024

pedrobonamin Oct 29, 2024

pedrobonamin Oct 29, 2024

feat(core): add versions to references and status icons #7690

feat(core): add versions to references and status icons #7690

Conversation

pedrobonamin commented Oct 29, 2024

Description

What to review

Testing

Notes for release

vercel bot commented Oct 29, 2024 • edited Loading

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

RitaDias Oct 29, 2024

Choose a reason for hiding this comment

github-actions bot commented Oct 29, 2024

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

RitaDias left a comment

Choose a reason for hiding this comment

RitaDias Oct 29, 2024

Choose a reason for hiding this comment

pedrobonamin Oct 29, 2024

Choose a reason for hiding this comment

pedrobonamin Oct 29, 2024

Choose a reason for hiding this comment

vercel bot commented Oct 29, 2024 •

edited

Loading