Skip to content
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

Fix: use unique value for NOT_FOUND #709

Merged
merged 3 commits into from
Jun 1, 2024

Conversation

romgrk
Copy link
Contributor

@romgrk romgrk commented Mar 15, 2024

I'm not sure what's the reasoning for using a string constant for the not-found value, but an object feels both safer (real uniqueness, the string 'NOT_FOUND' could make the logic fail) and more performant (no strcmp() if both values are strings) which is handy when the selectors are called very often.

I've used a private class instance for the empty value because you seem to use the value type NOT_FOUND_TYPE, otherwise I would have gone with a Symbol('not-found') or an empty object, but any of these would be fine I think.

Copy link

netlify bot commented Mar 15, 2024

Deploy Preview for reselect-docs canceled.

Name Link
🔨 Latest commit 3692d5c
🔍 Latest deploy log https://app.netlify.com/sites/reselect-docs/deploys/665b983d3138270008c9510f

Copy link

codesandbox-ci bot commented Mar 15, 2024

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.

@aryaemami59
Copy link
Contributor

Seems like a good idea. Though I think in this particular scenario a export const NOT_FOUND = Symbol('NOT_FOUND') will be fine. And now if you add a test to lruMemoize.test.ts:

test('cache miss identifier does not collide with state values', () => {
    const state = ['NOT_FOUND', 'FOUND']

    type State = typeof state

    const createSelector = createSelectorCreator({
      memoize: lruMemoize,
      argsMemoize: lruMemoize
    }).withTypes<State>()

    const selector = createSelector(
      [(state, id: number) => state[id]],
      state => state,
      {
        argsMemoizeOptions: { maxSize: 10 },
        memoizeOptions: { maxSize: 10 }
      }
    )

    const firstResult = selector(state, 0)

    expect(selector(state, 1)).toBe(selector(state, 1))

    const secondResult = selector(state, 0)

    expect(secondResult).toBe('NOT_FOUND')

    expect(firstResult).toBe(secondResult)

    expect(selector.recomputations()).toBe(2)
  })

It would have failed previously as NOT_FOUND would cause a cache miss and selector.recomputations() would be 3 instead of 2. But now it should be good.

@romgrk
Copy link
Contributor Author

romgrk commented Mar 22, 2024

I have added the suggested modifications.

@romgrk
Copy link
Contributor Author

romgrk commented May 30, 2024

Ping, but feel free to close the PR if you're not going to merge it.

src/utils.ts Outdated Show resolved Hide resolved
@aryaemami59
Copy link
Contributor

@romgrk Maintainers are a little busy at the moment, I'm sure they will look at it as soon as they get a chance. In the meantime, if you don't mind, could you update the code with the provided suggestions?

Co-authored-by: Arya Emami <[email protected]>
@markerikson markerikson merged commit 649a63f into reduxjs:master Jun 1, 2024
23 checks passed
@markerikson
Copy link
Contributor

Thanks!

@romgrk romgrk deleted the fix-not-found branch June 2, 2024 05:08
descope bot referenced this pull request in descope/descope-js 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
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/reselect/pull/698](https://togithub.com/reduxjs/reselect/pull/698)
- Fix `resultEqualityCheck` behavior in `weakMapMemoize` by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/reselect/pull/699](https://togithub.com/reduxjs/reselect/pull/699)
- Update TypeScript to 5.4 by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/reselect/pull/708](https://togithub.com/reduxjs/reselect/pull/708)
- Upgrade to Yarn 4 by
[@&#8203;aryaemami59](https://togithub.com/aryaemami59) in
[https://github.com/reduxjs/reselect/pull/705](https://togithub.com/reduxjs/reselect/pull/705)
- Fix: use unique value for NOT_FOUND by
[@&#8203;romgrk](https://togithub.com/romgrk) in
[https://github.com/reduxjs/reselect/pull/709](https://togithub.com/reduxjs/reselect/pull/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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants