perf: actually debounce rich text editor field value updates to only process latest state #12086
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
Follow-up work to payloadcms#12046: Debounces rich text editor `setState()` calls. Using `requestIdleCallback` leads to better scheduling of change event handling in the rich text editor, but on CPU-starved clients, this leads to a large backlog of unprocessed idle callbacks. Since idle callbacks are called by the browser in submission order, the latest callback will be processed last, potentially leading to large time delays between a user typing, and the form state having been updated. An example: When a user types "I", and the change events for the character "I" is scheduled to happen in the next browser idle time, but then the user goes on to type "love Payload", there will be 12 more callbacks scheduled. On a slow system it's preferable if the browser right away only processes the event that has the full editor state "I love Payload", instead of only processing that after 11 other idle callbacks. So this code change keeps track when requesting an idle callback and cancels the previous one when a new change event with an updated editor state occurrs.
philipp-tailor
force-pushed
the
improve-rich-text-editor-reactivity-2
branch
from
7f86b5b to
c2472ac
Compare
GermanJablo
requested changes
May 6, 2025
There was a problem hiding this comment.
The linter indicates that the "React Hook useCallback has a missing dependency: 'updateFieldValue'."
Previously, the eslint rule could be disabled on this line, since the only external dependency on updateFiledValue is setValue, which is already in the dependency array.
However, with the introduction of the React compiler, even if we know what we're doing, it's necessary not to violate the linter rules, since they are the same ones used by the React compiler, and a violation would mean the file would be skipped.
The solution here is either to add updateFieldValue to the dependency array or use our useEffectEvent hook, which mimics the experimental React hook with the same name.
You didn't need to know this, of course. Our codebase doesn't yet have 100% coverage of the React compiler, but that's the goal we're aiming for.
Inlines function into `useCallback`, which solves the linting issue that the `useCallback` had a missing dependency `updateFieldValue`. Addresses payloadcms#12086 (review).
|
@GermanJablo Thank you for the pointer, addressed the dependencies of |
GermanJablo
requested changes
May 14, 2025
kendelljoseph
pushed a commit
that referenced
this pull request
May 15, 2025
…process latest state (#12086) Follow-up work to #12046, which was misnamed. It improved UI responsiveness of the rich text field on CPU-limited clients, but didn't actually reduce work by debouncing. It only improved scheduling. Using `requestIdleCallback` lead to better scheduling of change event handling in the rich text editor, but on CPU-starved clients, this leads to a large backlog of unprocessed idle callbacks. Since idle callbacks are called by the browser in submission order, the latest callback will be processed last, potentially leading to large time delays between a user typing, and the form state having been updated. An example: When a user types "I", and the change events for the character "I" is scheduled to happen in the next browser idle time, but then the user goes on to type "love Payload", there will be 12 more callbacks scheduled. On a slow system it's preferable if the browser right away only processes the event that has the full editor state "I love Payload", instead of only processing that after 11 other idle callbacks. So this code change keeps track when requesting an idle callback and cancels the previous one when a new change event with an updated editor state occurs.
|
🚀 This is included in version v3.38.0 |
kendelljoseph
pushed a commit
that referenced
this pull request
May 19, 2025
…process latest state (#12086) Follow-up work to #12046, which was misnamed. It improved UI responsiveness of the rich text field on CPU-limited clients, but didn't actually reduce work by debouncing. It only improved scheduling. Using `requestIdleCallback` lead to better scheduling of change event handling in the rich text editor, but on CPU-starved clients, this leads to a large backlog of unprocessed idle callbacks. Since idle callbacks are called by the browser in submission order, the latest callback will be processed last, potentially leading to large time delays between a user typing, and the form state having been updated. An example: When a user types "I", and the change events for the character "I" is scheduled to happen in the next browser idle time, but then the user goes on to type "love Payload", there will be 12 more callbacks scheduled. On a slow system it's preferable if the browser right away only processes the event that has the full editor state "I love Payload", instead of only processing that after 11 other idle callbacks. So this code change keeps track when requesting an idle callback and cancels the previous one when a new change event with an updated editor state occurs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Follow-up work to #12046, which was misnamed. It improved UI responsiveness of the rich text field on CPU-limited clients, but didn't actually reduce work by debouncing. It only improved scheduling.
Using
requestIdleCallbacklead to better scheduling of change event handling in the rich text editor, but on CPU-starved clients, this leads to a large backlog of unprocessed idle callbacks. Since idle callbacks are called by the browser in submission order, the latest callback will be processed last, potentially leading to large time delays between a user typing, and the form state having been updated. An example: When a user types "I", and the change events for the character "I" is scheduled to happen in the next browser idle time, but then the user goes on to type "love Payload", there will be 12 more callbacks scheduled. On a slow system it's preferable if the browser right away only processes the event that has the full editor state "I love Payload", instead of only processing that after 11 other idle callbacks.So this code change keeps track when requesting an idle callback and cancels the previous one when a new change event with an updated editor state occurs.