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(vision): debounce type setState to fix cursor jump #8238

Merged
merged 1 commit into from
Jan 14, 2025
Merged

Conversation

pedrobonamin
Copy link
Contributor

@pedrobonamin pedrobonamin commented Jan 10, 2025

Description

When typing in vision , in some cases, you could get into an scenario in which the cursor jumped to the beginning of the editor.
So user was typing:

a
ab
abc

and when typed d, the cursor jumps to the start

dabc

I identified this as an issue generated by multiple setStates called when typing, adding a debounce helps with this, so the setState will only be executed 300ms after the user finishes typing.

The onPaste handle needs to be modified, so that when the CodeMirror component captures an onPaste event this one is not propagated to the global, neither to the CodeMirror component, applying the event only once and not triggering a subsequent queryChange.

What to review

Testing

Notes for release

fixes Vision cursor jump

@pedrobonamin pedrobonamin requested a review from a team as a code owner January 10, 2025 17:13
@pedrobonamin pedrobonamin requested review from ryanbonial and removed request for a team January 10, 2025 17:13
Copy link

vercel bot commented Jan 10, 2025

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

Copy link
Contributor

No changes to documentation

@pedrobonamin pedrobonamin changed the title fix(vision): debounce type setState to fix scroll jump fix(vision): debounce type setState to fix cursor jump Jan 10, 2025
Copy link
Contributor

github-actions bot commented Jan 10, 2025

Component Testing Report Updated Jan 13, 2025 1:40 PM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 1m 6s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 13s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 40s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 51s 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) 14s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 27s 6 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 1m 7s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 28s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 40s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 13s 3 9 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 26s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 1m 44s 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

Copy link
Contributor

github-actions bot commented Jan 10, 2025

⚡️ Editor Performance Report

Updated Mon, 13 Jan 2025 13:41:36 GMT

Benchmark reference
latency of sanity@latest
experiment
latency of this branch
Δ (%)
latency difference
article (title) 25.6 efps (39ms) 26.0 efps (39ms) -1ms (-1.3%)
article (body) 69.9 efps (14ms) 67.8 efps (15ms) +0ms (-/-%)
article (string inside object) 27.0 efps (37ms) 27.0 efps (37ms) +0ms (-/-%)
article (string inside array) 24.4 efps (41ms) 25.6 efps (39ms) -2ms (-4.9%)
recipe (name) 52.6 efps (19ms) 50.0 efps (20ms) +1ms (+5.3%)
recipe (description) 52.6 efps (19ms) 55.6 efps (18ms) -1ms (-5.3%)
recipe (instructions) 99.9+ efps (6ms) 99.9+ efps (6ms) +0ms (-/-%)
synthetic (title) 17.5 efps (57ms) 17.9 efps (56ms) -1ms (-1.8%)
synthetic (string inside object) 18.7 efps (54ms) 17.9 efps (56ms) +3ms (+4.7%)

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 52ms 339ms 255ms 10.0s
article (body) 14ms 18ms 29ms 155ms 217ms 5.5s
article (string inside object) 37ms 41ms 45ms 209ms 145ms 6.7s
article (string inside array) 41ms 44ms 53ms 191ms 218ms 6.9s
recipe (name) 19ms 21ms 24ms 39ms 0ms 6.8s
recipe (description) 19ms 20ms 22ms 33ms 0ms 4.5s
recipe (instructions) 6ms 8ms 9ms 13ms 0ms 3.2s
synthetic (title) 57ms 61ms 69ms 340ms 1186ms 13.1s
synthetic (string inside object) 54ms 58ms 76ms 570ms 1005ms 9.2s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 39ms 47ms 62ms 439ms 752ms 10.2s
article (body) 15ms 17ms 19ms 152ms 229ms 5.2s
article (string inside object) 37ms 39ms 47ms 228ms 235ms 6.6s
article (string inside array) 39ms 42ms 46ms 150ms 143ms 6.5s
recipe (name) 20ms 22ms 27ms 49ms 0ms 7.4s
recipe (description) 18ms 19ms 21ms 29ms 0ms 4.5s
recipe (instructions) 6ms 8ms 9ms 9ms 0ms 3.2s
synthetic (title) 56ms 58ms 70ms 329ms 1042ms 12.6s
synthetic (string inside object) 56ms 60ms 80ms 541ms 1344ms 8.8s

📚 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 added this pull request to the merge queue Jan 14, 2025
Merged via the queue into next with commit 15cba9a Jan 14, 2025
56 checks passed
@pedrobonamin pedrobonamin deleted the sapp-2009 branch January 14, 2025 08:50
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.

2 participants