Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: implementation for events in history #7569

Open
wants to merge 8 commits into
base: next
Choose a base branch
from
Open

feat: implementation for events in history #7569

wants to merge 8 commits into from

Conversation

pedrobonamin
Copy link
Contributor

@pedrobonamin pedrobonamin commented Oct 1, 2024 •
edited
Loading

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.
Screenshot 2024-10-14 at 10 02 24

Notes for release

feat: introduces event based history.

@vercel Vercel
Copy link

vercel bot commented Oct 1, 2024 •
edited
Loading

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 14, 2024 10:19am
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 10:19am
test-compiled-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 10:19am
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 10:19am
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 10:19am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Oct 14, 2024 10:19am

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 1, 2024

No changes to documentation

@github-actions GitHub Actions
Copy link
Contributor

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

Component Testing Report Updated Oct 14, 2024 10:17 AM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 45s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 8s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 31s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 39s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 18s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 11s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 3m 0s 0 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 46s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 40s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 17s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 8s 3 9 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 27s 9 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 18s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 36s 12 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

pedrobonamin
pedrobonamin commented Oct 1, 2024
View reviewed changes
packages/sanity/src/core/store/events/types.ts
Comment on lines +194 to +204
export interface EditDocumentVersionEvent extends BaseEvent {
type: 'document.editVersion'

releaseId?: string
versionId: string
versionRevisionId: string
mergedEvents?: EditDocumentVersionEvent[]
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@github-actions GitHub Actions
Copy link
Contributor

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

⚡️ Editor Performance Report

Updated Mon, 14 Oct 2024 10:28:40 GMT

Benchmark reference
latency of sanity@latest		 experiment
latency of this branch		 Δ (%)
latency difference
article (title) 18.7 efps (54ms) 17.7 efps (57ms) +3ms (+5.6%) ✅
article (body) 56.2 efps (18ms) 56.5 efps (18ms) -0ms (-0.6%) ✅
article (string inside object) 18.9 efps (53ms) 18.5 efps (54ms) +1ms (+1.9%) ✅
article (string inside array) 15.2 efps (66ms) 14.7 efps (68ms) +2ms (+3.0%) ✅
recipe (name) 31.3 efps (32ms) 32.3 efps (31ms) -1ms (-3.1%) ✅
recipe (description) 35.7 efps (28ms) 35.7 efps (28ms) +0ms (-/-%) ✅
recipe (instructions) 99.9+ efps (6ms) 99.9+ efps (6ms) +0ms (-/-%) ✅
synthetic (title) 15.4 efps (65ms) 16.1 efps (62ms) -3ms (-4.6%) ✅
synthetic (string inside object) 15.9 efps (63ms) 15.9 efps (63ms) +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) 54ms 60ms 73ms 205ms 1155ms 14.3s
article (body) 18ms 20ms 25ms 102ms 274ms 5.9s
article (string inside object) 53ms 57ms 63ms 143ms 896ms 8.6s
article (string inside array) 66ms 68ms 77ms 302ms 1706ms 9.8s
recipe (name) 32ms 36ms 53ms 90ms 33ms 9.5s
recipe (description) 28ms 31ms 37ms 65ms 75ms 6.4s
recipe (instructions) 6ms 8ms 9ms 22ms 0ms 3.3s
synthetic (title) 65ms 67ms 78ms 203ms 1672ms 15.4s
synthetic (string inside object) 63ms 65ms 72ms 562ms 2250ms 10.3s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 57ms 62ms 74ms 238ms 1263ms 13.6s
article (body) 18ms 20ms 27ms 194ms 315ms 5.8s
article (string inside object) 54ms 57ms 66ms 239ms 1078ms 8.9s
article (string inside array) 68ms 70ms 81ms 269ms 1720ms 9.8s
recipe (name) 31ms 34ms 38ms 64ms 30ms 9.1s
recipe (description) 28ms 29ms 31ms 40ms 21ms 6.1s
recipe (instructions) 6ms 8ms 9ms 20ms 0ms 3.2s
synthetic (title) 62ms 65ms 75ms 198ms 1567ms 15.3s
synthetic (string inside object) 63ms 65ms 83ms 574ms 2204ms 10.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.

@pedrobonamin pedrobonamin changed the title [WIP] implementation for getDocumentEvents feat: implementation for events in history Oct 14, 2024
@pedrobonamin pedrobonamin marked this pull request as ready for review October 14, 2024 10:20
@pedrobonamin pedrobonamin requested a review from a team as a code owner October 14, 2024 10:20
@pedrobonamin pedrobonamin requested review from rexxars and judofyr and removed request for a team October 14, 2024 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codebymatt codebymatt codebymatt left review comments

@rexxars rexxars Awaiting requested review from rexxars rexxars is a code owner automatically assigned from sanity-io/studio-dx

@judofyr judofyr Awaiting requested review from judofyr

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pedrobonamin @codebymatt