[HEAP-42725] Return the same component each time from withHeapNavigationWrapper
#406
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
…tionWrapper`
If `Heap.withHeapNavigationWrapper` is called multiple times, it currently returns a new HOC each time. This means if the app looks like this:
```
const App = () => {
...
const HeapNavigationContainer =
Heap.withReactNavigationAutotrack(NavigationContainer);
return (
<HeapNavigationContainer independent={true}>
...
</HeapNavigationContainer>
);
};
```
And the app contains a `useCallback` or similar, which caused `App` to re-evaluate, the entire contents of `HeapNavigationContainer` will be recreated, sending the app back to start.
The general fix is to move `Heap.withHeapNavigationWrapper` out of a function but this has come up enough that a code fix is warranted.
This simply caches the output of `withReactNavigationAutotrack` on the wrapped component so it can be retrieved the next time it is called.
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
If
Heap.withHeapNavigationWrapperis called multiple times, it currently returns a new HOC each time. This means if the app looks like this:And the app contains a
useEffector similar, which causedAppto re-evaluate, the entire contents ofHeapNavigationContainerwill be considered new and will be recreated, sending the app back to start.The general fix is to move
Heap.withHeapNavigationWrapperout of a function but this has come up enough that a code fix is warranted.This simply caches the output of
withReactNavigationAutotrackon the wrapped component so it can be retrieved the next time it is called.Test Plan
Unit tests were added and executed. This behavior was vetted in a test app.
It would be possible to write an integration test on this, if someone wants to.
Checklist