feat: propagate `PairListenerOptions`; add telemetry for `OutOfSyncError` #7595

ricokahler · 2024-10-04T21:56:10Z

Description

The following builds off of #7576. This PR:

Propagates the PairListenerOptions through the document-store
Adds telemetry for when the onSyncErrorRecovery fires.

What to review

Did I cover all APIs that need to propagate this? Seemed best to add it to the document-store options instead of each individual method
Am I logging the telemetry event correctly?

Testing

There were no existing tests for the document-store so I just manually tested that this fired
I also went through all the types and ensured that the option was propagated correctly

Notes for release

N/A - this one builds off of #7576 but is mostly internal changes

vercel · 2024-10-04T21:56:14Z

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

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Oct 8, 2024 10:32am

github-actions · 2024-10-04T21:56:56Z

No changes to documentation

github-actions · 2024-10-04T22:09:03Z

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

✅ All Tests Passed -- expand for details

File	Status	Duration	Passed	Skipped
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	43s	15	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	8s	3	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	32s	6	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	38s	11	7
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	17s	6	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	10s	3	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	2m 33s	1	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	45s	15	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 43s	21	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 16s	18	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	9s	3	9
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	26s	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	18s	6	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	35s	12	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3

github-actions · 2024-10-04T22:16:00Z

⚡️ Editor Performance Report

Updated Tue, 08 Oct 2024 10:41:17 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	17.5 efps (57ms)	16.9 efps (59ms)	+2ms (+3.5%)	✅
article (body)	56.3 efps (18ms)	58.1 efps (17ms)	-1ms (-3.1%)	✅
article (string inside object)	18.3 efps (55ms)	17.9 efps (56ms)	+2ms (+2.8%)	✅
article (string inside array)	14.9 efps (67ms)	14.3 efps (70ms)	+3ms (+4.5%)	✅
recipe (name)	30.3 efps (33ms)	31.3 efps (32ms)	-1ms (-3.0%)	✅
recipe (description)	34.5 efps (29ms)	34.5 efps (29ms)	+0ms (-/-%)	✅
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (6ms)	+0ms (-/-%)	✅
synthetic (title)	14.7 efps (68ms)	15.2 efps (66ms)	-2ms (-2.9%)	✅
synthetic (string inside object)	16.0 efps (63ms)	16.1 efps (62ms)	-1ms (-0.8%)	✅

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	63ms	70ms	130ms	1323ms	15.3s
article (body)	18ms	21ms	31ms	85ms	232ms	5.9s
article (string inside object)	55ms	59ms	71ms	219ms	1035ms	9.0s
article (string inside array)	67ms	71ms	81ms	126ms	1766ms	9.8s
recipe (name)	33ms	36ms	47ms	75ms	37ms	9.3s
recipe (description)	29ms	30ms	34ms	61ms	36ms	6.2s
recipe (instructions)	6ms	8ms	10ms	25ms	0ms	3.3s
synthetic (title)	68ms	77ms	88ms	154ms	2265ms	17.8s
synthetic (string inside object)	63ms	65ms	72ms	315ms	1892ms	10.3s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	59ms	65ms	83ms	197ms	1467ms	14.9s
article (body)	17ms	19ms	50ms	115ms	238ms	6.1s
article (string inside object)	56ms	59ms	68ms	187ms	1183ms	9.4s
article (string inside array)	70ms	76ms	94ms	261ms	2195ms	10.5s
recipe (name)	32ms	34ms	37ms	61ms	55ms	9.0s
recipe (description)	29ms	31ms	39ms	65ms	42ms	6.5s
recipe (instructions)	6ms	8ms	9ms	10ms	0ms	3.2s
synthetic (title)	66ms	70ms	77ms	392ms	2270ms	15.8s
synthetic (string inside object)	62ms	65ms	80ms	291ms	2099ms	10.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.

bjoerge

Looks good from my side. Would like a review from @sanity-io/growth on the event name.

...es/sanity/src/core/store/_legacy/document/__telemetry__/documentOutOfSyncEvents.telemetry.ts

The base branch was changed.

…ror` errors

…fSyncError` errors

ricokahler requested a review from bjoerge October 4, 2024 21:56

ricokahler requested review from a team as code owners October 4, 2024 21:56

ricokahler requested review from cngonzalez and removed request for a team October 4, 2024 21:56

ricokahler removed the request for review from cngonzalez October 4, 2024 21:56

vercel bot deployed to Preview – test-next-studio October 4, 2024 21:58 View deployment

vercel bot deployed to Preview – test-compiled-studio October 4, 2024 22:02 View deployment

bjoerge force-pushed the sdx-1652 branch from c60486e to bbcb5ae Compare October 6, 2024 21:37

bjoerge force-pushed the sdk-5 branch from 409d7c1 to 107366e Compare October 6, 2024 22:36

vercel bot deployed to Preview – performance-studio October 6, 2024 22:40 View deployment

vercel bot deployed to Preview – page-building-studio October 6, 2024 22:40 View deployment

vercel bot deployed to Preview – test-studio October 6, 2024 22:40 View deployment

vercel bot deployed to Preview – test-next-studio October 6, 2024 22:44 View deployment

vercel bot deployed to Preview – test-compiled-studio October 6, 2024 22:47 View deployment

bjoerge previously approved these changes Oct 7, 2024

View reviewed changes

...es/sanity/src/core/store/_legacy/document/__telemetry__/documentOutOfSyncEvents.telemetry.ts Outdated Show resolved Hide resolved

bjoerge force-pushed the sdx-1652 branch 4 times, most recently from dcf0a12 to 3f56b8e Compare October 7, 2024 14:55

bjoerge force-pushed the sdk-5 branch from 107366e to c07979c Compare October 7, 2024 15:11

vercel bot deployed to Preview – performance-studio October 7, 2024 15:15 View deployment

vercel bot deployed to Preview – page-building-studio October 7, 2024 15:15 View deployment

vercel bot deployed to Preview – test-studio October 7, 2024 15:16 View deployment

vercel bot deployed to Preview – test-next-studio October 7, 2024 15:20 View deployment

vercel bot deployed to Preview – test-compiled-studio October 7, 2024 15:23 View deployment

bjoerge force-pushed the sdx-1652 branch from 3f56b8e to dba2b56 Compare October 7, 2024 15:42

bjoerge force-pushed the sdk-5 branch from c07979c to 2386340 Compare October 7, 2024 15:43

vercel bot deployed to Preview – performance-studio October 7, 2024 15:46 View deployment

vercel bot deployed to Preview – page-building-studio October 7, 2024 15:46 View deployment

vercel bot deployed to Preview – test-studio October 7, 2024 15:47 View deployment

vercel bot deployed to Preview – test-next-studio October 7, 2024 15:51 View deployment

vercel bot deployed to Preview – test-compiled-studio October 7, 2024 15:54 View deployment

Base automatically changed from sdx-1652 to next October 7, 2024 22:30

feat: propagate PairListenerOptions; add telemetry for `OutOfSyncEr…

e56f8c2

…ror` errors

bjoerge force-pushed the sdk-5 branch from 2386340 to e56f8c2 Compare October 8, 2024 10:14

fixup! feat: propagate PairListenerOptions; add telemetry for `OutO…

7a0eb01

…fSyncError` errors

bjoerge requested review from svirs and bjoerge October 8, 2024 10:17

vercel bot deployed to Preview – performance-studio October 8, 2024 10:19 View deployment

vercel bot deployed to Preview – page-building-studio October 8, 2024 10:19 View deployment

fixup! feat: propagate PairListenerOptions; add telemetry for `OutO…

7482191

…fSyncError` errors

vercel bot deployed to Preview – test-studio October 8, 2024 10:20 View deployment

vercel bot deployed to Preview – performance-studio October 8, 2024 10:24 View deployment

vercel bot deployed to Preview – page-building-studio October 8, 2024 10:24 View deployment

vercel bot deployed to Preview – test-studio October 8, 2024 10:25 View deployment

svirs approved these changes Oct 8, 2024

View reviewed changes

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

vercel bot deployed to Preview – test-compiled-studio October 8, 2024 10:32 View deployment

bjoerge approved these changes Oct 8, 2024

View reviewed changes

bjoerge added this pull request to the merge queue Oct 8, 2024

Merged via the queue into next with commit d96f890 Oct 8, 2024
63 checks passed

bjoerge deleted the sdk-5 branch October 8, 2024 10:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: propagate `PairListenerOptions`; add telemetry for `OutOfSyncError` #7595

feat: propagate `PairListenerOptions`; add telemetry for `OutOfSyncError` #7595

ricokahler commented Oct 4, 2024

vercel bot commented Oct 4, 2024 •

edited

Loading

github-actions bot commented Oct 4, 2024

github-actions bot commented Oct 4, 2024 •

edited

Loading

github-actions bot commented Oct 4, 2024 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

bjoerge left a comment

feat: propagate PairListenerOptions; add telemetry for OutOfSyncError #7595

feat: propagate PairListenerOptions; add telemetry for OutOfSyncError #7595

Conversation

ricokahler commented Oct 4, 2024

Description

What to review

Testing

Notes for release

vercel bot commented Oct 4, 2024 • edited Loading

github-actions bot commented Oct 4, 2024

github-actions bot commented Oct 4, 2024 • edited Loading

github-actions bot commented Oct 4, 2024 • edited Loading

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

bjoerge left a comment

Choose a reason for hiding this comment

feat: propagate `PairListenerOptions`; add telemetry for `OutOfSyncError` #7595

feat: propagate `PairListenerOptions`; add telemetry for `OutOfSyncError` #7595

vercel bot commented Oct 4, 2024 •

edited

Loading

github-actions bot commented Oct 4, 2024 •

edited

Loading

github-actions bot commented Oct 4, 2024 •

edited

Loading