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.

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

fix: improve presence menu performance #8039

Open
wants to merge 1 commit into
base: add-million-lint-mode
Choose a base branch
from

Conversation

stipsan
Copy link
Member

@stipsan stipsan commented Dec 13, 2024

Description

Fixes a performance issue in <PresenceMenuItem /> causing edit intent links to constantly unmount and mount new dom nodes on every single render.

What to review

Does it make sense?

Testing

Tested manually, verified with pnpm dev:million-lint that the issue is resolved.

Notes for release

Links in the global presence dropdown menu had a bug that caused nodes to constantly unmount and remount, slowing down exponentially with how many people are in the studio at the same time. It now renders efficiently.

@stipsan stipsan requested a review from a team as a code owner December 13, 2024 14:43
@stipsan stipsan requested review from rexxars and removed request for a team December 13, 2024 14:43
Copy link

vercel bot commented Dec 13, 2024

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 Dec 13, 2024 2:53pm
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 2:53pm
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 2:53pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 2:53pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Dec 13, 2024 2:53pm

Copy link
Contributor

No changes to documentation

Copy link
Contributor

Component Testing Report Updated Dec 13, 2024 2:51 PM (UTC)

❌ Failed Tests (7) -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 1m 15s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 14s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 42s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 58s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 29s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 16s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ❌ Failed (Inspect) 4m 28s 0 0 6
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 1m 16s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 3m 4s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 48s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 14s 3 9 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 42s 9 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 29s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ❌ Failed (Inspect) 2m 32s 20 0 1
formBuilder/tree-editing/TreeEditing.spec.tsx ✅ Passed (Inspect) 0s 0 3 0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx ✅ Passed (Inspect) 0s 0 3 0

Copy link
Contributor

⚡️ Editor Performance Report

Updated Fri, 13 Dec 2024 14:55:18 GMT

Benchmark reference
latency of sanity@latest
experiment
latency of this branch
Δ (%)
latency difference
article (title) 25.6 efps (39ms) 26.7 efps (38ms) -2ms (-3.8%)
article (body) 67.8 efps (15ms) 78.1 efps (13ms) -2ms (-/-%)
article (string inside object) 26.3 efps (38ms) 26.3 efps (38ms) +0ms (-/-%)
article (string inside array) 23.3 efps (43ms) 24.4 efps (41ms) -2ms (-4.7%)
recipe (name) 47.6 efps (21ms) 45.5 efps (22ms) +1ms (+4.8%)
recipe (description) 55.6 efps (18ms) 52.6 efps (19ms) +1ms (+5.6%)
recipe (instructions) 99.9+ efps (6ms) 99.9+ efps (6ms) +0ms (-/-%)
synthetic (title) 19.6 efps (51ms) 19.0 efps (53ms) +2ms (+2.9%)
synthetic (string inside object) 18.9 efps (53ms) 19.2 efps (52ms) -1ms (-1.9%)

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) 39ms 42ms 57ms 176ms 170ms 10.0s
article (body) 15ms 16ms 20ms 153ms 60ms 5.3s
article (string inside object) 38ms 40ms 46ms 91ms 207ms 6.8s
article (string inside array) 43ms 45ms 47ms 63ms 4ms 6.8s
recipe (name) 21ms 23ms 25ms 53ms 0ms 6.9s
recipe (description) 18ms 19ms 22ms 28ms 0ms 4.6s
recipe (instructions) 6ms 8ms 10ms 15ms 0ms 3.2s
synthetic (title) 51ms 54ms 56ms 103ms 252ms 12.6s
synthetic (string inside object) 53ms 57ms 66ms 113ms 847ms 8.5s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 38ms 40ms 47ms 69ms 161ms 11.4s
article (body) 13ms 15ms 16ms 102ms 339ms 5.4s
article (string inside object) 38ms 40ms 45ms 160ms 166ms 6.6s
article (string inside array) 41ms 43ms 46ms 235ms 242ms 7.2s
recipe (name) 22ms 24ms 37ms 49ms 0ms 7.6s
recipe (description) 19ms 20ms 22ms 29ms 0ms 4.6s
recipe (instructions) 6ms 8ms 9ms 21ms 0ms 3.3s
synthetic (title) 53ms 55ms 62ms 255ms 600ms 13.7s
synthetic (string inside object) 52ms 57ms 103ms 472ms 913ms 8.9s

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

Comment on lines -46 to -64
const LinkComponent = useMemo(
() =>
// eslint-disable-next-line @typescript-eslint/no-shadow
forwardRef(function LinkComponent(linkProps, ref: ForwardedRef<HTMLAnchorElement>) {
if (!lastActiveLocation?.path) return null

return (
<IntentLink
{...linkProps}
intent="edit"
params={{
id: lastActiveLocation?.documentId,
path: PathUtils.toString(lastActiveLocation?.path),
}}
ref={ref}
/>
)
}),
[lastActiveLocation],
Copy link
Member Author

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant