Lodash: Refactor block editor away from _.map()
#47214
Merged
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
Mamaduka,
sgomes,
aristath,
jsnajdr,
swissspidy,
flootr,
chad1008,
ntsekouras,
fabiankaegy and
brookewp
|
Size Change: -34 B (0%) Total Size: 1.33 MB
ℹ️ View Unchanged
|
tyxla
commented
Jan 17, 2023
| ( block ) => block.name | ||
| ), | ||
| selectedBlocks: getBlocksByClientId( ids ) | ||
| .filter( Boolean ) |
There was a problem hiding this comment.
Always an array since we're calling it on a result of Array.prototype.filter().
| @@ -113,7 +113,7 @@ export function BlockTypesTab( { | |||
| </InserterPanel> | |||
| ) } | |||
|
|
|||
| { map( currentlyRenderedCategories, ( category ) => { | |||
| { currentlyRenderedCategories.map( ( category ) => { | |||
There was a problem hiding this comment.
Always an array:
| @@ -148,8 +148,7 @@ export function BlockTypesTab( { | |||
| </InserterPanel> | |||
| ) } | |||
|
|
|||
| { map( | |||
| currentlyRenderedCollections, | |||
| { currentlyRenderedCollections.map( | |||
| @@ -41,7 +36,7 @@ const usePatternsState = ( onInsert, rootClientId ) => { | |||
| const { createSuccessNotice } = useDispatch( noticesStore ); | |||
| const onClickPattern = useCallback( ( pattern, blocks ) => { | |||
| onInsert( | |||
| map( blocks, ( block ) => cloneBlock( block ) ), | |||
| ( blocks ?? [] ).map( ( block ) => cloneBlock( block ) ), | |||
There was a problem hiding this comment.
Just in case the click handler gets called with a nullish value.
| @@ -260,7 +255,7 @@ const ImageURLInputUI = ( { | |||
| additionalControls={ | |||
| ! linkEditorValue && ( | |||
| <NavigableMenu> | |||
| { map( getLinkDestinations(), ( link ) => ( | |||
| { getLinkDestinations().map( ( link ) => ( | |||
There was a problem hiding this comment.
Always an array:
| @@ -314,13 +313,11 @@ export const __experimentalGetGlobalBlocksByName = createSelector( | |||
| */ | |||
| export const getBlocksByClientId = createSelector( | |||
| ( state, clientIds ) => | |||
| map( | |||
| Array.isArray( clientIds ) ? clientIds : [ clientIds ], | |||
| ( Array.isArray( clientIds ) ? clientIds : [ clientIds ] ).map( | |||
There was a problem hiding this comment.
Always an array as guaranteed by the ternary.
There was a problem hiding this comment.
Offhand comment: fundamental selectors like this one really shouldn't be doing this kind of magic; they get called so often that they should be as simple and do as little work as possible (including instancing new things). Out of scope for this PR, though, your change looks good 👍
| ( clientId ) => getBlock( state, clientId ) | ||
| ), | ||
| ( state, clientIds ) => | ||
| map( | ||
| Array.isArray( clientIds ) ? clientIds : [ clientIds ], | ||
| ( Array.isArray( clientIds ) ? clientIds : [ clientIds ] ).map( |
There was a problem hiding this comment.
Always an array as guaranteed by the ternary.
| @@ -507,18 +504,18 @@ export const getBlockParents = createSelector( | |||
| export const getBlockParentsByBlockName = createSelector( | |||
| ( state, clientId, blockName, ascending = false ) => { | |||
| const parents = getBlockParents( state, clientId, ascending ); | |||
| return map( | |||
| map( parents, ( id ) => ( { | |||
| return parents | |||
There was a problem hiding this comment.
Always an array:
gutenberg/packages/block-editor/src/store/selectors.js
Lines 481 to 488 in 71a3344
| ( { id } ) => id | ||
| ); | ||
| } ) | ||
| .map( ( { id } ) => id ); |
There was a problem hiding this comment.
Already an array as guaranteed by the previous calls.
| @@ -23,7 +18,7 @@ import wrap from './transforms/wrap'; | |||
| * @return {Array} converted rules. | |||
| */ | |||
| const transformStyles = ( styles, wrapperClassName = '' ) => { | |||
| return map( styles, ( { css, baseURL } ) => { | |||
| return Object.values( styles ?? [] ).map( ( { css, baseURL } ) => { | |||
There was a problem hiding this comment.
Can be nullish, which is why the nullish coalescing:
And we're doing the Object.values() because there are instances where we pass an object:
although most of the rest of the usages pass an array of styles. Object.values() will correctly yield us the values for arrays, so we're good with that part, as well.
|
Flaky tests detected in 328e39c. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/3939050354
|
sgomes
approved these changes
Jan 19, 2023
| @@ -314,13 +313,11 @@ export const __experimentalGetGlobalBlocksByName = createSelector( | |||
| */ | |||
| export const getBlocksByClientId = createSelector( | |||
| ( state, clientIds ) => | |||
| map( | |||
| Array.isArray( clientIds ) ? clientIds : [ clientIds ], | |||
| ( Array.isArray( clientIds ) ? clientIds : [ clientIds ] ).map( | |||
There was a problem hiding this comment.
Offhand comment: fundamental selectors like this one really shouldn't be doing this kind of magic; they get called so often that they should be as simple and do as little work as possible (including instancing new things). Out of scope for this PR, though, your change looks good 👍
| @@ -23,7 +18,7 @@ import wrap from './transforms/wrap'; | |||
| * @return {Array} converted rules. | |||
| */ | |||
| const transformStyles = ( styles, wrapperClassName = '' ) => { | |||
| return map( styles, ( { css, baseURL } ) => { | |||
| return Object.values( styles ?? [] ).map( ( { css, baseURL } ) => { | |||
There was a problem hiding this comment.
I'm curious, why did you go for [] instead of {}? They both work fine, in hindsight, I just found it surprising at first.
There was a problem hiding this comment.
Because various usages of transformStyles() across the codebase work with either arrays or objects of styles, and I had to pick one of them 😉 Since we're doing a transformation to an array anyway, it felt better to just default to an array, regardless of the fact that we're doing an Object.values() on it. Also, the function is already documented to expect an array of styles, so we're matching that. Regardless, I think the fact that it works with both objects and arrays is a bit vague and we could definitely improve that in the future.
|
Thanks @sgomes 🙌 |
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 Lodash's
_.map()from the block editor package. There are just a few usages and conversion is pretty straightforward.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're using
Array.prototype.map()instead. We're using nullish coalescing where necessary to cover nullish values, andObject.values()where necessary to convert from an object.Testing Instructions