-
Notifications
You must be signed in to change notification settings - Fork 86
Add deepEqual check for getSnapshot collections #717
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
Draft
LukasMod
wants to merge
1
commit into
Expensify:main
Choose a base branch
from
LukasMod:fix/collection-ref
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -248,6 +248,22 @@ function useOnyx<TKey extends OnyxKey, TReturnValue = OnyxValue<TKey>>( | |
| if (!(isFirstConnectionRef.current && options?.initWithStoredValues === false) && !shouldGetCachedValueRef.current) { | ||
| const cachedResult = onyxSnapshotCache.getCachedResult<UseOnyxResult<TReturnValue>>(key, cacheKey); | ||
| if (cachedResult !== undefined) { | ||
| // Collections are rebuilt as new objects each time via getCollectionData, so we need to compare values | ||
| // and preserve reference stability to prevent unnecessary rerenders | ||
| const isCollection = OnyxUtils.isCollectionKey(key); | ||
| if (isCollection) { | ||
| const oldResultRef = resultRef.current; | ||
| const cachedValue = cachedResult[0]; | ||
| const oldValue = oldResultRef[0]; | ||
|
|
||
| // If values are equal but references differ, keep the old reference to prevent unnecessary rerenders | ||
| // This ensures reference stability even when cache gets invalidated and recreated | ||
| // useSyncExternalStore compares return values, so we need to return the same reference when values are equal | ||
| if (deepEqual(cachedValue, oldValue) && cachedResult !== oldResultRef) { | ||
| return oldResultRef; | ||
| } | ||
| } | ||
|
|
||
| resultRef.current = cachedResult; | ||
| return cachedResult; | ||
| } | ||
|
|
@@ -296,11 +312,17 @@ function useOnyx<TKey extends OnyxKey, TReturnValue = OnyxValue<TKey>>( | |
| } | ||
|
|
||
| // Optimized equality checking: | ||
| // - Memoized selectors already handle deep equality internally, so we can use fast reference equality | ||
| // - Non-selector cases use shallow equality for object reference checks | ||
| // - Collections always use deepEqual since they're rebuilt as new objects each time | ||
| // (even with selectors, collection outputs will have different references) | ||
| // - Memoized selectors with non-collections handle deep equality internally, so we can use fast reference equality | ||
| // - Other non-selector cases use shallow equality for object reference checks | ||
| // - Normalize null to undefined to ensure consistent comparison (both represent "no value") | ||
| const isCollection = OnyxUtils.isCollectionKey(key); | ||
| let areValuesEqual: boolean; | ||
| if (memoizedSelector) { | ||
| if (isCollection) { | ||
| // Collections always need deepEqual, even with selectors, because selector outputs are new object references | ||
| areValuesEqual = deepEqual(previousValueRef.current ?? undefined, newValueRef.current); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we do |
||
| } else if (memoizedSelector) { | ||
| const normalizedPrevious = previousValueRef.current ?? undefined; | ||
| const normalizedNew = newValueRef.current ?? undefined; | ||
| areValuesEqual = normalizedPrevious === normalizedNew; | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey, can you clarify what is the
cachedResult[0]andoldResultRef[0]in this case?