[Performance] Debounce word counting #5952
Open
+69
−21
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
You guys are all writing too large documents. (/s) Will have a look later! |
|
Trust me, I wish I wasnt! |
nathanlesage
requested changes
Nov 5, 2025
|
|
||
| if (update.selectionSet) { | ||
| this.emit('cursorActivity') | ||
| this.emit('docUpdate') |
There was a problem hiding this comment.
Doesn't this also now need to be emitted from the update branch a few lines above?
| for (const effect of transaction.effects) { | ||
| // Listen for word count updates | ||
| if (effect.is(updateWordCountEffect)) { | ||
| this.emit('docUpdate') |
There was a problem hiding this comment.
Mh, I'm wondering if docUpdate semantically correctly describes when and how this event is being emitted ...?
| // return true. | ||
| if (!transaction.docChanged) { | ||
| return value | ||
| for (let e of transaction.effects) { |
There was a problem hiding this comment.
Suggested change
| for (let e of transaction.effects) { | |
| for (const e of transaction.effects) { |
|
|
||
| export const countPlugin = ViewPlugin.fromClass(class { | ||
| private timeout: number | null = null | ||
| private delay = 750 |
There was a problem hiding this comment.
Please move this as a constant to the top of the file so that we can adjust this if necessary (e.g., something like const WORD_COUNT_DELAY = 750)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR implements a debounced word counting plugin to improve typing performance.
Changes
The word count computation was moved to a
ViewPluginso that it can be debounced usingsetTimeout(). It uses aStateEffectto update the existingcountFieldvalue.Event listeners were added for the new
updateWordCountEffectso that the UI shows updated counts when they arrive rather than waiting for cursor activity.Additional information
Currently, word counts are recomputed every keypress. In larger documents (>50,000 words) this starts to add a small but noticeable, and increasing, delay. By debouncing the counting, typing performance is dramatically improved in large documents.
Word counts are no longer live, however, they are updated the moment the transaction is dispatched.
Tested on: