Fix leaking Ref in weakMapMemoize #729
Merged
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.
This PR contains the following changes:
weakMapMemoize.ts
to check if thelastResult
is aRef
before dereferencing it.Context:
The previous code could leak a
WeakRef
if the dereferenced value wasundefined
(which I think happens when the original object is forcefully garbage collected):Let
lastResult
be aRef
toundefined
:With this new change, we will return the new value (even when the old garbage collected value would've passed the
resultEqualityCheck
and would've been memoized).I chose the
instanceof
check becauseRef
is defined above as aWeakRef
if it is available, else it is aStrongRef
which is a locally defined class.I tried to add a unit test which reproduced the issue by garbage collecting values in the cache so they would be
Ref
s toundefined
, but I didn't have any luck. I followed a similar strategy to this test by using aFinalizationRegistry
. I also tried a test whichunmount
ed a React component containing the original state. Please let me know if you have any ideas for this unit test :)(aside) How we discovered the issue:
weakMapMemoized
array).weakMapMemoized
result got garbage collected.shallowEquals
resultEqualityCheck
(Object.keys(WeakRef{undefined})
==Object.keys([])
==[]
)WeakRef
into the code which expected an array, and caused an exception.