Lodash: Remove completely from @wordpress/viewport package
#44572
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
tyxla
added
[Type] Performance
tyxla
requested review from
sgomes,
mirka,
aristath,
jsnajdr,
gziolo,
swissspidy,
ciampo,
jorgefilipecosta,
chad1008,
ntsekouras and
fabiankaegy
|
Size Change: +2.36 kB (0%) Total Size: 1.27 MB
ℹ️ View Unchanged
|
sgomes
approved these changes
Sep 30, 2022
jsnajdr
approved these changes
Sep 30, 2022
| return select( store ).isViewportMatch( query ); | ||
| } ); | ||
| return Object.fromEntries( | ||
| Object.entries( queries ).map( ( [ key, query ] ) => { |
There was a problem hiding this comment.
A little optimization idea: in both versions of withViewportMatch, we could extract the Object.entries call so that it's executed only once when creating the HOC, not on each render or state update.
packages/viewport/src/listener.js
Outdated
| breakpoints, | ||
| ( result, width, name ) => { | ||
| const queries = Object.entries( breakpoints ).reduce( | ||
| ( result, [ name, width ] ) => { | ||
| Object.entries( operators ).forEach( |
There was a problem hiding this comment.
Here operators is a constant, so Object.entries( operators ) could be moved out of the loop.
packages/viewport/src/listener.js
Outdated
| const queries = reduce( | ||
| breakpoints, | ||
| ( result, width, name ) => { | ||
| const queries = Object.entries( breakpoints ).reduce( |
There was a problem hiding this comment.
The queries object is used only inside the setIsMatching callback, where it's de-objectified with Object.entries. What if it was an [ [ string, MediaQueryList ] ] from the beginning? This could be achieved with .flatMap instead of .reduce:
queries = Object.entries( breakpoints ).flatMap( ( [ name, width ] ) => {
return operators.map( ( [ operator, condition ] ) => {
const list = window.matchMedia( ... );
list.addListener( ... );
return [ `${ operator } ${ name }`, list ];
} );
} );By the way TypeScript flags list.addListener as deprecated and MDN recommends list.addEventListener( 'change', fn ) instead.
| breakpoints, | ||
| ( result, width, name ) => { | ||
| const matches = Object.entries( breakpoints ).reduce( | ||
| ( result, [ name, width ] ) => { | ||
| Object.entries( operators ).forEach( |
There was a problem hiding this comment.
Here both operators and breakpoints are also static and Object.entries could be lifted up.
tyxla
force-pushed
the
remove/lodash-viewport
branch
from
3c12dc9 to
7f17ee9
Compare
|
@jsnajdr thanks for the suggestions, mind taking another look? |
jsnajdr
reviewed
Oct 5, 2022
| }, | ||
| {} | ||
| ); | ||
| const matches = breakpointEntries.flatMap( ( [ name, width ] ) => { |
There was a problem hiding this comment.
There's a missing Object.fromEntries here. The setIsMatching action expects an object.
There was a problem hiding this comment.
Good find. Would have been useful to have a test to catch this.
Addressed in 92e074e
| } ); | ||
| return Object.fromEntries( | ||
| queryEntries.map( ( [ key, query ] ) => { | ||
| return [ key, select( store ).isViewportMatch( query ) ]; |
There was a problem hiding this comment.
Maybe the select( store ) call could be extracted out of the loop, too, if you think it makes sense.
There was a problem hiding this comment.
I think I'm leaning towards keeping it as-is. Do you see any potential big performance improvements from that change?
There was a problem hiding this comment.
Not really, it's just a double map lookup, equivalent to registry[ store ][ method ]. On the other hand, Object.entries is in a different ballpark, it would allocate and deallocate memory on each loop iteration.
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.
What?
This PR removes all of the Lodash from the
@wordpress/viewportpackage, including thelodashdependency altogether. There are just a few usages and they're straightforward to replace.Why?
Lodash is known to unnecessarily inflate the bundle size of packages, and in most cases, it can be replaced with native language functionality. See these for more information and rationale:
@wordpress/api-fetchpackage haslodashas a dependency #39495How?
We have to deal essentially with 2 methods (
mapValues, andreduce), and migration away from them is pretty straightforward, especially because the functionality is covered by unit tests.Testing Instructions