Clear memoized for state while deferring notifications #261
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
shirlynwix
reviewed
Nov 4, 2024
shirlynwix
approved these changes
Nov 4, 2024
itsh01
reviewed
Nov 6, 2024
src/throttledStore.tsx
Outdated
| @@ -279,17 +280,19 @@ export const createThrottledStore = ( | |||
| observableNotify: onObservableNotify, | |||
| resetPendingNotifications: resetAllPendingNotifications, | |||
| hasPendingSubscribers: () => pendingBroadcastNotification, | |||
| deferSubscriberNotifications: async action => { | |||
| deferSubscriberNotifications: async (action, shouldClearMemoizedForState) => { | |||
There was a problem hiding this comment.
I suggest changing to parameter to be {shouldClearMemoizedForState} as options object to allow forward compatibility.
Also, it might be misleading, since it would clear cache only on dispatch, maybe we should name it shouldDispatchClearCache or something like that
There was a problem hiding this comment.
We wanted this to be a temporary solution, so that after we make sure it does not hurt performance, we'll remove this option and do it by default. In that case, do you still want an options object?
regarding the name - changed :)
itsh01
approved these changes
Nov 6, 2024
ShirShintel
changed the title
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.
In this PR, I added an option to clear
memoizeForStatecache on every state change, if deferring notifications.This is done because we normally clear the memoizeForState` cache only when notifying subscribers, which does not happen while deferring notifications. This may cause incorrect results.
Currently this is done only when given an optional argument to
deferSubscriberNotifications(which makes the code temporarily ugly), so we can verify that it does not cause performance issues. In the future we would like to do it by default.