fix(core): releases edit events error when calculating differences #8632

pedrobonamin · 2025-02-14T08:54:25Z

Description

Pre-read

The Releases Activity Panel was previously relying on release documents from the releases store. Initially, these documents were complete. However, we recently introduced a projection to the documents, which means they are now partial.

The activity panel retrieves changes using the transactions endpoint and applies Mendoza patches to the documents. However, Mendoza patches require complete documents to function correctly—they do not work with partial documents.

Fix

This PR refactors the getReleaseEditEvents observable to use the new observeDocument observable, which ensures that complete documents are returned. This resolves the issue where Mendoza patches failed due to incomplete data.

Other Changes

The global listener was filtering out system documents, and since releases are classified as system documents, they were also being excluded.
To allow observeDocument to function correctly, this PR removes that filter, ensuring system documents (including releases) are properly observed.

What to review

Any side effect to consider on the listener change?

Testing

The corresponding tests are updated.
Opening a release activity panel should not error in any case.

Notes for release

Fixes an error when getting the release edit events in the release activity panel

…rtial

vercel · 2025-02-14T08:54:30Z

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	Feb 14, 2025 10:18am
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 14, 2025 10:18am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 14, 2025 10:18am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Feb 14, 2025 10:18am
test-next-studio	⬜️ Ignored (Inspect)			Feb 14, 2025 10:18am

github-actions · 2025-02-14T08:55:12Z

No changes to documentation

github-actions · 2025-02-14T08:59:13Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	42.68%	54205 / 126992
🔵	Statements	42.68%	54205 / 126992
🔵	Functions	48.06%	2783 / 5790
🔵	Branches	78.95%	10418 / 13195

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/sanity/src/core/preview/createGlobalListener.ts	100%	100%	33.33%	100%
packages/sanity/src/core/releases/tool/detail/events/getReleaseEditEvents.ts	96.22%	95.65%	100%	96.22%	63-64, 147-148
packages/sanity/src/core/releases/tool/detail/events/getReleaseEvents.ts	26.74%	100%	0%	26.74%	54-131

Generated in workflow #30373 for commit 5e7d36d by the Vitest Coverage Report Action

bjoerge

Nice!

packages/sanity/src/core/preview/createGlobalListener.ts

github-actions · 2025-02-14T09:06:34Z

Component Testing Report Updated Feb 14, 2025 10:26 AM (UTC)

❌ Failed Tests (3) -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 10s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	❌ Failed (Inspect)	2m 35s	3	0	3
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	53s	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)	15s	3	0	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	27s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 8s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 38s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	2m 6s	21	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	13s	3	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	27s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	1m 45s	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-02-14T09:07:03Z

⚡️ Editor Performance Report

Updated Fri, 14 Feb 2025 10:22:53 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	27.8 efps (36ms)	27.8 efps (36ms)	+0ms (-/-%)	✅
article (body)	72.5 efps (14ms)	72.7 efps (14ms)	-0ms (-/-%)	✅
article (string inside object)	28.6 efps (35ms)	27.8 efps (36ms)	+1ms (+2.9%)	✅
article (string inside array)	25.0 efps (40ms)	25.0 efps (40ms)	+0ms (-/-%)	✅
recipe (name)	50.0 efps (20ms)	48.8 efps (21ms)	+1ms (+2.5%)	✅
recipe (description)	52.6 efps (19ms)	55.6 efps (18ms)	-1ms (-5.3%)	✅
recipe (instructions)	99.9+ efps (5ms)	99.9+ efps (5ms)	-0ms (-/-%)	✅
synthetic (title)	21.3 efps (47ms)	20.4 efps (49ms)	+2ms (+4.3%)	✅
synthetic (string inside object)	21.3 efps (47ms)	20.0 efps (50ms)	+3ms (+6.4%)	✅

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)	36ms	38ms	43ms	245ms	139ms	9.8s
article (body)	14ms	15ms	34ms	96ms	247ms	5.6s
article (string inside object)	35ms	38ms	43ms	90ms	372ms	6.8s
article (string inside array)	40ms	43ms	49ms	169ms	292ms	6.8s
recipe (name)	20ms	22ms	24ms	52ms	0ms	7.7s
recipe (description)	19ms	19ms	21ms	31ms	0ms	4.6s
recipe (instructions)	5ms	7ms	8ms	11ms	0ms	3.1s
synthetic (title)	47ms	51ms	74ms	349ms	768ms	12.4s
synthetic (string inside object)	47ms	50ms	57ms	582ms	1028ms	8.3s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	36ms	38ms	44ms	319ms	294ms	10.2s
article (body)	14ms	15ms	22ms	194ms	187ms	5.4s
article (string inside object)	36ms	40ms	47ms	208ms	325ms	6.7s
article (string inside array)	40ms	42ms	45ms	281ms	338ms	6.8s
recipe (name)	21ms	22ms	26ms	48ms	8ms	7.2s
recipe (description)	18ms	18ms	20ms	33ms	0ms	4.5s
recipe (instructions)	5ms	7ms	8ms	16ms	0ms	3.2s
synthetic (title)	49ms	52ms	56ms	425ms	837ms	12.8s
synthetic (string inside object)	50ms	53ms	60ms	112ms	616ms	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.

pedrobonamin · 2025-02-14T11:35:09Z

@bjoerge this needs re approval after removing the [] from the filter 5e7d36d

…8632)

pedrobonamin added 2 commits February 14, 2025 09:44

fix(core): remove system docs filter from global listener

f5316ae

fix(core): use full document in getReleaseEditEvents, store doc is pa…

a89b91d

…rtial

pedrobonamin requested a review from bjoerge February 14, 2025 08:54

pedrobonamin marked this pull request as ready for review February 14, 2025 08:54

pedrobonamin requested review from a team as code owners February 14, 2025 08:54

bjoerge previously approved these changes Feb 14, 2025

View reviewed changes

packages/sanity/src/core/preview/createGlobalListener.ts Outdated Show resolved Hide resolved

fix(core): remove brackets from createGlobalListener

5e7d36d

pedrobonamin dismissed bjoerge’s stale review via 5e7d36d February 14, 2025 10:10

vercel bot deployed to Preview – performance-studio February 14, 2025 10:16 View deployment

vercel bot deployed to Preview – page-building-studio February 14, 2025 10:16 View deployment

vercel bot deployed to Preview – test-studio February 14, 2025 10:18 View deployment

pedrobonamin enabled auto-merge (squash) February 14, 2025 11:25

pedrobonamin requested a review from bjoerge February 14, 2025 11:34

bjoerge approved these changes Feb 14, 2025

View reviewed changes

pedrobonamin merged commit 53aa0fc into next Feb 14, 2025
63 checks passed

pedrobonamin deleted the sapp-2089 branch February 14, 2025 11:36

EoinFalconer pushed a commit that referenced this pull request Feb 16, 2025

fix(core): releases edit events error when calculating differences (#…

926b8ba

…8632)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(core): releases edit events error when calculating differences #8632

fix(core): releases edit events error when calculating differences #8632

pedrobonamin commented Feb 14, 2025

vercel bot commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025

github-actions bot commented Feb 14, 2025 •

edited

Loading

bjoerge left a comment

github-actions bot commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

pedrobonamin commented Feb 14, 2025

fix(core): releases edit events error when calculating differences #8632

fix(core): releases edit events error when calculating differences #8632

Conversation

pedrobonamin commented Feb 14, 2025

Description

Pre-read

Fix

Other Changes

What to review

Testing

Notes for release

vercel bot commented Feb 14, 2025 • edited Loading

github-actions bot commented Feb 14, 2025

github-actions bot commented Feb 14, 2025 • edited Loading

Coverage Report

bjoerge left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 14, 2025 • edited Loading

github-actions bot commented Feb 14, 2025 • edited Loading

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

pedrobonamin commented Feb 14, 2025

vercel bot commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading