Fix resultEqualityCheck behavior in weakMapMemoize
#699
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
- Previously `resultEqualityCheck` would be called with empty objects as arguments due to how `inputStabilityCheck` works. This update Fixes `resultEqualityCheck` in `weakMapMemoize` so that when input selectors are stable it does not get called on the first run of the output selector.
- Added runtime unit tests to verify that:
- `resultEqualityCheck` works correctly when set to `shallowEqual`.
- `resultEqualityCheck` is not called on the first output selector call.
- `weakMapMemoize` with `resultEqualityCheck` set to `referenceEqualityCheck` works the same as `weakMapMemoize` without `resultEqualityCheck`.
- Added runtime unit tests to verify that:
- `resultEqualityCheck` works correctly when set to `shallowEqual`.
- `resultEqualityCheck` is not called on the first output selector call.
- `lruMemoize` with `resultEqualityCheck` set to `referenceEqualityCheck` works the same as `lruMemoize` without `resultEqualityCheck`.
✅ Deploy Preview for reselect-docs canceled.
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
|
Thanks for working on this! I believe this PR is related to this issue: #693 |
|
related, but not a complete fix - if inputs aren't stable, your resultEqualityCheck will still be called with an empty object nonetheless the improvements here are nice |
|
@keegan-lillo This should mitigate the problem as long as your input selectors are stable. It will at least make the default configs a tiny bit less problematic. But @EskiMojo14 is correct, it doesn't fully address the issue. |
|
this looks good, but has conflicts - happy to merge once fixed |
EskiMojo14
approved these changes
Feb 20, 2024
…-weakMapMemoize-resultEqualityCheck
|
thanks! |
|
Hey @EskiMojo14, any chance a release could be cut which contains this change? |
|
Sorry for the delay on this. I should have time to get it out on Saturday. |
|
Okay, out in https://github.com/reduxjs/reselect/releases/tag/v5.1.1 ! |
descope bot
added a commit
to descope/descope-js
that referenced
this pull request
Jun 23, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [reselect](https://togithub.com/reduxjs/reselect) | dependencies | patch | [`5.1.0` -> `5.1.1`](https://renovatebot.com/diffs/npm/reselect/5.1.0/5.1.1) | --- ### Release Notes <details> <summary>reduxjs/reselect (reselect)</summary> ### [`v5.1.1`](https://togithub.com/reduxjs/reselect/releases/tag/v5.1.1) [Compare Source](https://togithub.com/reduxjs/reselect/compare/v5.1.0...v5.1.1) This **patch release** fixes behavior of `resultEqualityCheck` in `weakMapMemoize`, fixes the case of `lruMemoize` being given a `maxSize` less than 1, and tweaks the internal implementation of `lruMemoize`. (We've also updated our general build tooling.) ##### Changelog ##### Bug fixes Previously, providing the `resultEqualityCheck` option to `weakMapMemoize` resulted in it being called with empty objects as part of the initialization / dev check process. That could be an issue if your comparison function expected different values. We've updated the logic to avoid that, as well as improving a couple other perf aspects. Previously, passing a `maxSize` < 1 to `lruMemoize` would result in it creating a larger cache. That's now fixed. `lruMemoize` now uses a symbol for its `NOT_FOUND` value instead of a string. ##### What's Changed - Ensure `lruMemoize` correctly memoizes when `maxSize` is set to a number less than 1 by [@​aryaemami59](https://togithub.com/aryaemami59) in [reduxjs/reselect#698 - Fix `resultEqualityCheck` behavior in `weakMapMemoize` by [@​aryaemami59](https://togithub.com/aryaemami59) in [reduxjs/reselect#699 - Update TypeScript to 5.4 by [@​aryaemami59](https://togithub.com/aryaemami59) in [reduxjs/reselect#708 - Upgrade to Yarn 4 by [@​aryaemami59](https://togithub.com/aryaemami59) in [reduxjs/reselect#705 - Fix: use unique value for NOT_FOUND by [@​romgrk](https://togithub.com/romgrk) in [reduxjs/reselect#709 **Full Changelog**: reduxjs/reselect@v5.1.0...v5.1.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNzAuMCIsInVwZGF0ZWRJblZlciI6IjM3LjE3MC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: descope[bot] <descope[bot]@users.noreply.github.com>
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.
Overview
Previously using
weakMapMemoizewithresultEqualityCheckwould cause theresultEqualityCheckto be called with empty objects as arguments due to howinputStabilityCheckworks. Here's a summary of the changes:This PR:
resultEqualityCheckinweakMapMemoizeso that when input selectors are stable,resultEqualityCheckdoes not get called on the first run of the output selector.resultEqualityCheckworks correctly when set toshallowEqual.resultEqualityCheckis not called on the first output selector call.weakMapMemoize/lruMemoizewithresultEqualityCheckset toreferenceEqualityCheckworks the same asweakMapMemoize/lruMemoizewithoutresultEqualityCheck.resultEqualityCheckperformance impact.inputStabilityCheckandresultEqualityCheck.weakMapMemoizewhere settingresultEqualityChecktoreferenceEqualityCheckwould preventmemoizedResultFunc.resultsCount()from incrementing upon result recalculation.weakMapMemoizewhen comparing two memoized functions, one withresultEqualityCheckset toreferenceEqualityCheckand the other withoutresultEqualityCheck. Previously, there was a noticeable discrepancy between the two, which has now been corrected to achieve the desired effect.