feat: implementation for events in history #7569

pedrobonamin · 2024-10-01T15:16:16Z

Warning

Not to be merged yet, this requires approval from the CLDX team on how the events are generated.

Description

Publish is	Draft is created	Draft is deleted	Draft is unedited	Draft is upsert
unedited	document.createVersion (draft)	document.deleteVersion (draft)	no-effect (none)	document.editVersion (draft)
deleted	document.unpublish (published)	document.deleteGroup (published)	maybeUnpublishMaybeDelete (published)	document.unpublish (published)
upsert	document.updateLive (published)	document.publishVersion (published)	document.updateLive (published)	document.updateLive (published)
created	document.createVersion (published)	document.publishVersion (published)	document.createLive (published)	document.createVersion (published)

What to review

This Pr updates how the chunks are defined, using event based actions. This events in a close future will include also the versions.
Eventually, we will have an events API to get them from, so all the mapping won't need to happen in the client.
To create the necessary events we are using the transactions.

Are this changes correct? Are there any missing pieces?

Testing

Open any document and see the history, it should work as always, no visual or functional changes introduced, this is preparing to use the events api.
Tests have been added for the get events functions.

Also, a story has been created showing how the transactions -> events -> chunks logic work.

Notes for release

feat: introduces event based history.

vercel · 2024-10-01T15:16:24Z

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

1 Skipped Deployment

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

packages/sanity/src/core/store/events/getDocumentEvents.ts

github-actions · 2024-10-01T15:19:45Z

No changes to documentation

github-actions · 2024-10-01T15:31:16Z

Component Testing Report Updated Oct 23, 2024 9:53 AM (UTC)

✅ All Tests Passed -- expand for details

File	Status	Duration	Passed	Skipped
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	45s	15	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	8s	3	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	31s	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)	3m 0s	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	45s	15	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 44s	21	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 17s	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)	37s	12	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3

packages/sanity/src/core/store/events/getDocumentEvents.ts

packages/sanity/src/core/store/events/types.ts

pedrobonamin · 2024-10-01T15:46:49Z

packages/sanity/src/core/store/events/types.ts

+export interface EditDocumentVersionEvent extends BaseEvent {
+  type: 'document.editVersion'
+
+  releaseId?: string
+  versionId: string
+  versionRevisionId: string
+  mergedEvents?: EditDocumentVersionEvent[]
+}


This is a new event not mentioned in the initial document.

It won't be part of the events api

github-actions · 2024-10-02T07:40:50Z

⚡️ Editor Performance Report

Updated Wed, 23 Oct 2024 09:55:59 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	15.7 efps (64ms)	16.7 efps (60ms)	-4ms (-5.5%)	✅
article (body)	56.2 efps (18ms)	56.5 efps (18ms)	-0ms (-0.6%)	✅
article (string inside object)	17.2 efps (58ms)	16.7 efps (60ms)	+2ms (+3.4%)	✅
article (string inside array)	13.7 efps (73ms)	13.3 efps (75ms)	+2ms (+2.7%)	✅
recipe (name)	29.4 efps (34ms)	29.4 efps (34ms)	+0ms (-/-%)	✅
recipe (description)	33.3 efps (30ms)	33.3 efps (30ms)	+0ms (-/-%)	✅
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (6ms)	-0ms (-/-%)	✅
synthetic (title)	15.0 efps (67ms)	14.9 efps (67ms)	+1ms (+0.8%)	✅
synthetic (string inside object)	15.6 efps (64ms)	15.6 efps (64ms)	+0ms (-/-%)	✅

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)	64ms	67ms	73ms	293ms	536ms	14.1s
article (body)	18ms	20ms	23ms	79ms	281ms	5.8s
article (string inside object)	58ms	62ms	72ms	333ms	507ms	9.0s
article (string inside array)	73ms	79ms	87ms	340ms	1177ms	10.3s
recipe (name)	34ms	36ms	40ms	60ms	14ms	8.8s
recipe (description)	30ms	31ms	37ms	144ms	0ms	6.2s
recipe (instructions)	6ms	9ms	10ms	33ms	0ms	3.4s
synthetic (title)	67ms	71ms	77ms	348ms	1465ms	15.8s
synthetic (string inside object)	64ms	68ms	82ms	606ms	1613ms	11.1s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	60ms	64ms	81ms	220ms	421ms	13.3s
article (body)	18ms	20ms	27ms	72ms	339ms	5.9s
article (string inside object)	60ms	65ms	84ms	286ms	456ms	9.2s
article (string inside array)	75ms	79ms	90ms	230ms	1353ms	10.4s
recipe (name)	34ms	38ms	49ms	86ms	28ms	9.4s
recipe (description)	30ms	33ms	40ms	69ms	0ms	6.3s
recipe (instructions)	6ms	8ms	9ms	10ms	0ms	3.3s
synthetic (title)	67ms	70ms	81ms	385ms	1490ms	15.5s
synthetic (string inside object)	64ms	68ms	81ms	341ms	1311ms	10.0s

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

…event

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

pedrobonamin commented Oct 1, 2024

View reviewed changes

packages/sanity/src/core/store/events/getDocumentEvents.ts Outdated Show resolved Hide resolved

pedrobonamin force-pushed the events-api-studio branch from 1e5303d to b97e5ae Compare October 1, 2024 15:31

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

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

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

pedrobonamin commented Oct 1, 2024

View reviewed changes

packages/sanity/src/core/store/events/getDocumentEvents.ts Outdated Show resolved Hide resolved

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

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

pedrobonamin commented Oct 1, 2024

View reviewed changes

packages/sanity/src/core/store/events/types.ts Outdated Show resolved Hide resolved

pedrobonamin commented Oct 1, 2024

View reviewed changes

vercel bot deployed to Preview – performance-studio October 2, 2024 07:23 View deployment

vercel bot deployed to Preview – page-building-studio October 2, 2024 07:23 View deployment

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

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

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

vercel bot had a problem deploying to Preview – page-building-studio October 3, 2024 12:48 Failure

vercel bot had a problem deploying to Preview – test-studio October 3, 2024 12:48 Failure

vercel bot had a problem deploying to Preview – performance-studio October 3, 2024 12:48 Failure

vercel bot had a problem deploying to Preview – test-next-studio October 3, 2024 12:49 Failure

vercel bot had a problem deploying to Preview – test-compiled-studio October 3, 2024 12:49 Failure

ricokahler force-pushed the next branch from f1f9c51 to 92de3d9 Compare October 4, 2024 20:16

pedrobonamin force-pushed the events-api-studio branch from 2841ec0 to f638790 Compare October 13, 2024 19:09

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

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

vercel bot deployed to Preview – test-studio October 13, 2024 19:13 View deployment

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

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

vercel bot deployed to Preview – test-compiled-studio October 14, 2024 09:58 View deployment

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

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

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

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

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

pedrobonamin marked this pull request as ready for review October 14, 2024 10:20

pedrobonamin requested a review from a team as a code owner October 14, 2024 10:20

pedrobonamin requested review from rexxars and judofyr and removed request for a team October 14, 2024 10:20

pedrobonamin force-pushed the events-api-studio branch from fcf36e3 to ae3076f Compare October 23, 2024 09:40

pedrobonamin added 8 commits October 23, 2024 11:41

feat(core): wip implementation for getDocumentEvents

f0f4317

fix(core): update versionRevisionId when creating unpublish document …

1a6fd7f

…event

feat(core): add events into timeline

938804f

chore(core): move events story to structure

94b0fa8

chore(core): export DocumentVersionEventType type from core

70e943c

fix(core): update ts definition for getDocumentEvents

02ae874

fix(structure): update DocumentGroup story

16ec450

fix(core): update exports definitions

49d773c

pedrobonamin force-pushed the events-api-studio branch from ae3076f to 49d773c Compare October 23, 2024 09:41

fix(core): update document events tests to vitest

9ab3d53

vercel bot deployed to Preview – test-studio October 23, 2024 09:50 View deployment

vercel bot deployed to Preview – performance-studio October 23, 2024 09:52 View deployment

vercel bot deployed to Preview – page-building-studio October 23, 2024 09:52 View deployment

vercel bot deployed to Preview – test-next-studio October 23, 2024 09:59 View deployment

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

pedrobonamin marked this pull request as draft November 11, 2024 15:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implementation for events in history #7569

feat: implementation for events in history #7569

pedrobonamin commented Oct 1, 2024 •

edited

Loading

vercel bot commented Oct 1, 2024 •

edited

Loading

github-actions bot commented Oct 1, 2024

github-actions bot commented Oct 1, 2024 •

edited

Loading

pedrobonamin Oct 1, 2024

pedrobonamin Nov 13, 2024

github-actions bot commented Oct 2, 2024 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

feat: implementation for events in history #7569

Are you sure you want to change the base?

feat: implementation for events in history #7569

Conversation

pedrobonamin commented Oct 1, 2024 • edited Loading

Description

What to review

Testing

Notes for release

vercel bot commented Oct 1, 2024 • edited Loading

github-actions bot commented Oct 1, 2024

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

pedrobonamin Oct 1, 2024

Choose a reason for hiding this comment

pedrobonamin Nov 13, 2024

Choose a reason for hiding this comment

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

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

pedrobonamin commented Oct 1, 2024 •

edited

Loading

vercel bot commented Oct 1, 2024 •

edited

Loading

github-actions bot commented Oct 1, 2024 •

edited

Loading

github-actions bot commented Oct 2, 2024 •

edited

Loading