Skip to content

Tidy up block patterns selectors #57913

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.

Sign up for GitHub

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

Merged
jsnajdr merged 1 commit into from
Jan 17, 2024
Merged

Tidy up block patterns selectors #57913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 13 additions & 19 deletions packages/block-editor/src/store/private-selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
canInsertBlockType,
__experimentalGetAllowedPatterns,
} from './selectors';
import { getUserPatterns, checkAllowListRecursive } from './utils';
import { getAllPatterns, checkAllowListRecursive } from './utils';

/**
* Returns true if the block interface is hidden, or false otherwise.
Expand Down Expand Up @@ -253,26 +253,20 @@ export const getInserterMediaCategories = createSelector(
*/
export const hasAllowedPatterns = createSelector(
( state, rootClientId = null ) => {
const patterns = state.settings.__experimentalBlockPatterns;
const userPatterns = getUserPatterns( state );
const patterns = getAllPatterns( state );
const { allowedBlockTypes } = getSettings( state );
return [ ...userPatterns, ...patterns ].some(
( { name, inserter = true } ) => {
if ( ! inserter ) {
return false;
}
const { blocks } = __experimentalGetParsedPattern(
state,
name
);
return (
checkAllowListRecursive( blocks, allowedBlockTypes ) &&
blocks.every( ( { name: blockName } ) =>
canInsertBlockType( state, blockName, rootClientId )
)
);
return patterns.some( ( { name, inserter = true } ) => {
if ( ! inserter ) {
return false;
}
);
const { blocks } = __experimentalGetParsedPattern( state, name );
return (
checkAllowListRecursive( blocks, allowedBlockTypes ) &&
blocks.every( ( { name: blockName } ) =>
canInsertBlockType( state, blockName, rootClientId )
)
);
} );
},
( state, rootClientId ) => [
...__experimentalGetAllowedPatterns.getDependants(
Expand Down
60 changes: 19 additions & 41 deletions packages/block-editor/src/store/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { createRegistrySelector } from '@wordpress/data';
* Internal dependencies
*/
import {
getUserPatterns,
getAllPatterns,
checkAllowListRecursive,
checkAllowList,
} from './utils';
Expand Down Expand Up @@ -2015,7 +2015,7 @@ export const getInserterItems = createSelector(
},
( state, rootClientId ) => [
state.blockListSettings[ rootClientId ],
state.blocks.byClientId,
state.blocks.byClientId.get( rootClientId ),
Copy link
Member Author

@jsnajdr jsnajdr Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fixes an omission from #46204: that PR uses the rootClientId substate only in canInsertBlockType, but not in other selectors that call canInsertBlockType or canIncludeBlockTypeInInserter and therefore need to declare the same dependencies, too.

state.blocks.order,
state.preferences.insertUsage,
state.settings.allowedBlockTypes,
Expand Down Expand Up @@ -2086,7 +2086,7 @@ export const getBlockTransformItems = createSelector(
},
( state, blocks, rootClientId ) => [
state.blockListSettings[ rootClientId ],
state.blocks.byClientId,
state.blocks.byClientId.get( rootClientId ),
state.preferences.insertUsage,
state.settings.allowedBlockTypes,
state.settings.templateLock,
Expand Down Expand Up @@ -2118,7 +2118,7 @@ export const hasInserterItems = createSelector(
},
( state, rootClientId ) => [
state.blockListSettings[ rootClientId ],
state.blocks.byClientId,
state.blocks.byClientId.get( rootClientId ),
state.settings.allowedBlockTypes,
state.settings.templateLock,
getReusableBlocks( state ),
Expand All @@ -2143,18 +2143,20 @@ export const getAllowedBlocks = createSelector(
const blockTypes = getBlockTypes().filter( ( blockType ) =>
canIncludeBlockTypeInInserter( state, blockType, rootClientId )
);

const hasReusableBlock =
canInsertBlockTypeUnmemoized( state, 'core/block', rootClientId ) &&
getReusableBlocks( state ).length > 0;

return [
...blockTypes,
...( hasReusableBlock ? [ 'core/block' ] : [] ),
];
if ( hasReusableBlock ) {
blockTypes.push( 'core/block' );
}

return blockTypes;
},
( state, rootClientId ) => [
state.blockListSettings[ rootClientId ],
state.blocks.byClientId,
state.blocks.byClientId.get( rootClientId ),
state.settings.allowedBlockTypes,
state.settings.templateLock,
getReusableBlocks( state ),
Expand Down Expand Up @@ -2237,21 +2239,10 @@ export const __experimentalGetDirectInsertBlock = createSelector(
]
);

export const __experimentalUserPatternCategories = createSelector(
( state ) => {
return state?.settings?.__experimentalUserPatternCategories;
},
( state ) => [ state.settings.__experimentalUserPatternCategories ]
);

export const __experimentalGetParsedPattern = createSelector(
( state, patternName ) => {
const patterns = state.settings.__experimentalBlockPatterns;
const userPatterns = getUserPatterns( state );

const pattern = [ ...patterns, ...userPatterns ].find(
( { name } ) => name === patternName
);
const patterns = getAllPatterns( state );
const pattern = patterns.find( ( { name } ) => name === patternName );
if ( ! pattern ) {
return null;
}
Expand All @@ -2262,21 +2253,15 @@ export const __experimentalGetParsedPattern = createSelector(
} ),
};
},
( state ) => [
state.settings.__experimentalBlockPatterns,
state.settings.__experimentalReusableBlocks,
state?.settings?.__experimentalUserPatternCategories,
]
( state ) => [ getAllPatterns( state ) ]
);

const getAllAllowedPatterns = createSelector(
( state ) => {
const patterns = state.settings.__experimentalBlockPatterns;
const userPatterns = getUserPatterns( state );

const patterns = getAllPatterns( state );
const { allowedBlockTypes } = getSettings( state );

const parsedPatterns = [ ...userPatterns, ...patterns ]
const parsedPatterns = patterns
.filter( ( { inserter = true } ) => !! inserter )
.map( ( { name } ) =>
__experimentalGetParsedPattern( state, name )
Expand All @@ -2286,12 +2271,7 @@ const getAllAllowedPatterns = createSelector(
);
return allowedPatterns;
},
( state ) => [
state.settings.__experimentalBlockPatterns,
state.settings.__experimentalReusableBlocks,
state.settings.allowedBlockTypes,
state?.settings?.__experimentalUserPatternCategories,
]
( state ) => [ getAllPatterns( state ), state.settings.allowedBlockTypes ]
);

/**
Expand All @@ -2315,9 +2295,7 @@ export const __experimentalGetAllowedPatterns = createSelector(
return patternsAllowed;
},
( state, rootClientId ) => [
state.settings.__experimentalBlockPatterns,
state.settings.__experimentalReusableBlocks,
state.settings.allowedBlockTypes,
getAllAllowedPatterns( state ),
state.settings.templateLock,
state.blockListSettings[ rootClientId ],
state.blocks.byClientId.get( rootClientId ),
Expand Down Expand Up @@ -2566,7 +2544,7 @@ export function __experimentalGetLastBlockAttributeChanges( state ) {
* @return {Array} Reusable blocks
*/
function getReusableBlocks( state ) {
return state?.settings?.__experimentalReusableBlocks ?? EMPTY_ARRAY;
return state.settings.__experimentalReusableBlocks ?? EMPTY_ARRAY;
}

/**
Expand Down
69 changes: 43 additions & 26 deletions packages/block-editor/src/store/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,52 @@
/**
* External dependencies
*/
import createSelector from 'rememo';

/**
* Internal dependencies
*/
import { INSERTER_PATTERN_TYPES } from '../components/inserter/block-patterns-tab/utils';

const EMPTY_ARRAY = [];
export const getUserPatterns = createSelector(
( state ) => {
const userPatterns = state.settings.__experimentalReusableBlocks ?? [];
const userPatternCategories =
state.settings.__experimentalUserPatternCategories ?? [];
Copy link
Member Author

@jsnajdr jsnajdr Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two arrays are never returned from the selector, so the static constant EMPTY_ARRAY is not really needed.

Copy link
Member

@ellatrix ellatrix Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be easy to accidentally slip in later though.

Copy link
Member

@ellatrix ellatrix Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although we're anyway mapping below I see now.

return userPatterns.map( ( userPattern ) => {
return {
name: `core/block/${ userPattern.id }`,
id: userPattern.id,
type: INSERTER_PATTERN_TYPES.user,
title: userPattern.title.raw,
categories: userPattern.wp_pattern_category.map( ( catId ) => {
const category = userPatternCategories.find(
( { id } ) => id === catId
);
return category ? category.slug : catId;
} ),
content: userPattern.content.raw,
syncStatus: userPattern.wp_pattern_sync_status,
};
} );
},
( state ) => [
state.settings.__experimentalReusableBlocks,
state.settings.__experimentalUserPatternCategories,
]
);

export function getUserPatterns( state ) {
const userPatterns =
state?.settings?.__experimentalReusableBlocks ?? EMPTY_ARRAY;
const userPatternCategories =
state?.settings?.__experimentalUserPatternCategories ?? [];
const categories = new Map();
userPatternCategories.forEach( ( userCategory ) =>
categories.set( userCategory.id, userCategory )
);
return userPatterns.map( ( userPattern ) => {
return {
name: `core/block/${ userPattern.id }`,
id: userPattern.id,
type: INSERTER_PATTERN_TYPES.user,
title: userPattern.title.raw,
categories: userPattern.wp_pattern_category.map( ( catId ) =>
categories && categories.get( catId )
? categories.get( catId ).slug
: catId
),
content: userPattern.content.raw,
syncStatus: userPattern.wp_pattern_sync_status,
};
} );
}
export const getAllPatterns = createSelector(
( state ) => {
const patterns = state.settings.__experimentalBlockPatterns;
const userPatterns = getUserPatterns( state );
return [ ...userPatterns, ...patterns ];
},
( state ) => [
state.settings.__experimentalBlockPatterns,
getUserPatterns( state ),
]
);

export const checkAllowList = ( list, item, defaultResult = null ) => {
if ( typeof list === 'boolean' ) {
Expand Down