chore: Bump `reselect` to `^5.1.1` for heterogeneously-typed selectors support #29094

MajorLift · 2024-12-11T12:48:54Z

Motivation

Homogenous selector types:

const selectorOne = (state: State) => state.something;
const selectorTwo = (state: State) => state.other;
createSelector([selectorOne, selectorTwo], () => ...);

Heterogenous selector types:

const selectorOne = (state: { something: string }) => state.something;
const selectorTwo = (state: { other: number }) => state.other;
createSelector([selectorOne, selectorTwo], () => ...);

Support for heterogeneous typing is essential for selectors to function properly, because selectors must be both mergeable and atomic. Without heterogeneous selectors, these becoming conflicting objectives.

Mergeable:
- Without heterogeneous typing for selectors, the size of the state type for all selectors tend to inflate. This is because a selector's state must be a supertype of the intersection of the state types of all of its merged selectors, including selectors nested in the definitions of merged selectors.
- Eventually, many selectors end up being defined with a state type that is close to the entire Redux state.
- Paradoxically, selectors that only need access to very few properties end up needing to have the widest state type, because they tend to be merged into the most selectors across several nested levels.
Atomic:
- When selectors are actually invoked, including in test files, it's not always practical to prepare and pass in a very large state object.
- It's both safer and more convenient to restrict the state being passed into the selector to the minimum size required for the selector to function.
- This requirement becomes incompatible with the mergeability requirement if all selectors must share a common state type.

Enabling merged selectors to accept different, even disjoint state types resolves this issue.

Note

See the MultichainState type for an example of a bloated selector state type which will become unnecessary with this update.

Description

[email protected] supports heterogeneous typing for selector inputs to createSelector and createDeepEqualSelector.
- Version 4.0.0 reduxjs/reselect#351
  - Allow Differently Typed Selectors reduxjs/reselect#274
  - added typings for dynamic array of uniform selectors reduxjs/reselect#315
Upgrade to ^5.1.1 (latest) is necessary to fix type issues in 4.0.0
- https://app.circleci.com/jobs/github/MetaMask/metamask-extension/4320173

Related issues

Blocks TypeScript conversion of selectors for https://github.com/MetaMask/MetaMask-planning/issues/2894.
- refactor: Unflatten selectors and convert to TypeScript #29014

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

I've followed MetaMask Contributor Docs and MetaMask Extension Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

github-actions · 2024-12-11T12:49:12Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

MajorLift · 2024-12-11T12:59:03Z

@metamaskbot update-policies

metamaskbot · 2024-12-11T13:08:52Z

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

MajorLift · 2024-12-11T13:09:44Z

@metamaskbot update-policies

metamaskbot · 2024-12-11T13:20:00Z

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

metamaskbot · 2024-12-11T14:08:47Z

Builds ready [9025606]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 13, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (2023 ± 340 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	316	3514	1787	728	350
		domContentLoaded	1390	3738	1983	680	327
		load	1404	3761	2023	708	340
		domInteractive	26	133	60	34	16
		backgroundConnect	9	198	41	44	21
		firstReactRender	15	142	55	33	16
		getState	5	91	19	22	11
		initialActions	0	0	0	0	0
		loadScripts	991	3082	1508	572	275
		setupStore	7	69	20	19	9
		uiStartup	1603	4541	2290	872	419

Bundle size diffs [🚀 Bundle size reduced!]

background: 0 Bytes (0.00%)
ui: 108 Bytes (0.00%)
common: -1.94 KiB (-0.02%)

…tor-typings

metamaskbot · 2024-12-11T23:36:41Z

Builds ready [f286e48]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 13, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1643 ± 63 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1382	1963	1644	131	63
		domContentLoaded	1350	1905	1619	124	59
		load	1383	1967	1643	131	63
		domInteractive	24	74	39	16	8
		backgroundConnect	7	63	27	20	10
		firstReactRender	16	77	31	21	10
		getState	4	49	15	15	7
		initialActions	0	1	0	0	0
		loadScripts	962	1464	1214	105	50
		setupStore	6	59	17	19	9
		uiStartup	1608	2192	1871	136	65

Bundle size diffs [🚀 Bundle size reduced!]

background: 0 Bytes (0.00%)
ui: 108 Bytes (0.00%)
common: -1.94 KiB (-0.02%)

FrederikBolding · 2024-12-13T13:38:50Z

shared/modules/selectors/util.js


 export const createDeepEqualSelector = createSelectorCreator(
-  defaultMemoize,
+  lruMemoize,


Just to clarify, this implementation is the same under the hood right?

Yes! It was just renamed in v5.

Changelog: https://github.com/reduxjs/reselect/releases/tag/v5.0.1

PR: https://github.com/reduxjs/reselect/pull/654/files#diff-7d67d444a5f198bf0470028f443c81aeaecc6efb8d7dea46636163a0b59f947b

FrederikBolding

Snaps changes LGTM

Bump reselect from ^3.0.1 to ^4.0.0

e67a0f9

MajorLift added dependencies Pull requests that update a dependency file team-tiger Tiger team (for tech debt reduction + performance improvements) labels Dec 11, 2024

MajorLift self-assigned this Dec 11, 2024

metamaskbot added the team-wallet-framework label Dec 11, 2024

MajorLift removed the team-wallet-framework label Dec 11, 2024

Bump reselect to ^5.1.1

76f2574

MajorLift force-pushed the jongsun/fix/redux/241211-heterogenuous-selector-typings branch from 76747ea to 76f2574 Compare December 11, 2024 13:09

Update LavaMoat policies

887c242

Fix type errors

71c3185

MajorLift changed the title ~~chore: Bump reselect from ^3.0.1 to ^4.0.0~~ chore: Bump reselect from ^3.0.1 to ^5.1.1 Dec 11, 2024

defaultMemoize is renamed to lruMemoize in 5.0.0

9025606

MajorLift marked this pull request as ready for review December 11, 2024 13:50

MajorLift requested review from a team as code owners December 11, 2024 13:50

MajorLift changed the title ~~chore: Bump reselect from ^3.0.1 to ^5.1.1~~ chore: Bump reselect to ^5.1.1 for heterogenously-typed selectors support Dec 11, 2024

MajorLift added the team-extension-platform label Dec 11, 2024

MajorLift mentioned this pull request Dec 11, 2024

refactor: Unflatten MetamaskController stores #28723

Draft

7 tasks

Merge branch 'main' into jongsun/fix/redux/241211-heterogenuous-selec…

f286e48

…tor-typings

MajorLift requested a review from a team as a code owner December 11, 2024 23:02

MajorLift enabled auto-merge December 11, 2024 23:03

MajorLift requested a review from a team December 12, 2024 17:21

FrederikBolding reviewed Dec 13, 2024

View reviewed changes

FrederikBolding approved these changes Dec 13, 2024

View reviewed changes

infiniteflower approved these changes Dec 13, 2024

View reviewed changes

MajorLift added this pull request to the merge queue Dec 13, 2024

Merged via the queue into main with commit c671bf3 Dec 13, 2024
83 checks passed

MajorLift deleted the jongsun/fix/redux/241211-heterogenuous-selector-typings branch December 13, 2024 15:41

github-actions bot locked and limited conversation to collaborators Dec 13, 2024

metamaskbot added the release-12.11.0 Issue or pull request that will be included in release 12.11.0 label Dec 13, 2024

MajorLift changed the title ~~chore: Bump reselect to ^5.1.1 for heterogenously-typed selectors support~~ chore: Bump reselect to ^5.1.1 for heterogeneously-typed selectors support Jan 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Bump `reselect` to `^5.1.1` for heterogeneously-typed selectors support #29094

chore: Bump `reselect` to `^5.1.1` for heterogeneously-typed selectors support #29094

MajorLift commented Dec 11, 2024 •

edited

Loading

github-actions bot commented Dec 11, 2024

MajorLift commented Dec 11, 2024

metamaskbot commented Dec 11, 2024

MajorLift commented Dec 11, 2024

metamaskbot commented Dec 11, 2024

metamaskbot commented Dec 11, 2024

metamaskbot commented Dec 11, 2024

FrederikBolding Dec 13, 2024

MajorLift Dec 13, 2024

MajorLift Dec 13, 2024 •

edited

Loading

FrederikBolding left a comment

chore: Bump reselect to ^5.1.1 for heterogeneously-typed selectors support #29094

chore: Bump reselect to ^5.1.1 for heterogeneously-typed selectors support #29094

Conversation

MajorLift commented Dec 11, 2024 • edited Loading

Motivation

Homogenous selector types:

Heterogenous selector types:

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Dec 11, 2024

MajorLift commented Dec 11, 2024

metamaskbot commented Dec 11, 2024

MajorLift commented Dec 11, 2024

metamaskbot commented Dec 11, 2024

metamaskbot commented Dec 11, 2024

metamaskbot commented Dec 11, 2024

FrederikBolding Dec 13, 2024

Choose a reason for hiding this comment

MajorLift Dec 13, 2024

Choose a reason for hiding this comment

MajorLift Dec 13, 2024 • edited Loading

Choose a reason for hiding this comment

FrederikBolding left a comment

Choose a reason for hiding this comment

chore: Bump `reselect` to `^5.1.1` for heterogeneously-typed selectors support #29094

chore: Bump `reselect` to `^5.1.1` for heterogeneously-typed selectors support #29094

MajorLift commented Dec 11, 2024 •

edited

Loading

MajorLift Dec 13, 2024 •

edited

Loading