fix(core): avoid unnecessary re-renders in useDocumentPresence #7365
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
No changes to documentation |
|
Component Testing Report Updated Aug 22, 2024 5:07 PM (UTC) ❌ Failed Tests (1) -- expand for details
|
runeb
commented
Aug 20, 2024
| ) | ||
| .filter((item) => debugIntrospect || item.presence.sessionId !== SESSION_ID), | ||
| ), | ||
| shareReplay(1), |
There was a problem hiding this comment.
I suppose we can eliminate shareReplay this as its introducing new behavior. Thought was that new subscribers could get the latest event sent to them when they subscribe.
There was a problem hiding this comment.
Good call! allSessions$ already replays it's latest value to new subscribers, but this also shares the mapping work done above between all subscribers 👌🏼
bjoerge
approved these changes
Aug 21, 2024
| ) | ||
| .filter((item) => debugIntrospect || item.presence.sessionId !== SESSION_ID), | ||
| ), | ||
| shareReplay(1), |
There was a problem hiding this comment.
Good call! allSessions$ already replays it's latest value to new subscribers, but this also shares the mapping work done above between all subscribers 👌🏼
jordanl17
pushed a commit
that referenced
this pull request
Aug 29, 2024
* fix(core): avoid unnecessary re-renders in useDocumentPresence * fix(core): make sure useDocumentPresence only emits when there are changes
This was referenced Sep 20, 2024
This was referenced Sep 25, 2024
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.
Description
When presence store receives announcements, consumers of
useDocumentPresencereceive subscription updates that relate to thedocumentIdthey are interested in. This patch fixes a bug where the store would continually emit[]to all subscribers that did not have any presence state, which due tosetStatecaused them to re-render.The first fix for this was to leverage
useReducerinuseDocumentPresenceto only cause a re-render when the presence data actually changed, but in a second commit I have attempted to fix this in the presence store itself, making sure to only emit if there are changes. This means we will emit[]when first subscribed, but from then only when there is an update to presence data for the givendocumentId.What to review
The split between common subscription data and
documentIdspecific data, the usage ofshareReplayand the equality checks.Testing
I can confirm that this reduces the amount of re-renders happening in the Studio, since each
PaneItemnow only re-renders when presence data relating to theirdocumentIdhas changed.Notes for release
Optimized rendering of changes in presence