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.

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

Block Editor: Fix stale dependencies of selectors depending on editorTool preference #66833

Merged
merged 4 commits into from
Nov 8, 2024
Merged

Block Editor: Fix stale dependencies of selectors depending on editorTool preference #66833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
806557b
Block Editor: Fix dependencies of selectors depending on editorTool pref
mcsf Nov 7, 2024
2c9d260
Update selectors that use __unstableGetEditorMode as a dependency to …
talldan Nov 8, 2024
724f691
Update other selector
talldan Nov 8, 2024
0918125
Fix tests
talldan Nov 8, 2024
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
11 changes: 5 additions & 6 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 @@ -109,17 +109,16 @@ function getEnabledClientIdsTreeUnmemoized( state, rootClientId ) {
*
* @return {Object[]} Tree of block objects with only clientID and innerBlocks set.
*/
export const getEnabledClientIdsTree = createSelector(
getEnabledClientIdsTreeUnmemoized,
( state ) => [
export const getEnabledClientIdsTree = createRegistrySelector( ( select ) =>
createSelector( getEnabledClientIdsTreeUnmemoized, ( state ) => [
state.blocks.order,
state.blockEditingModes,
state.settings.templateLock,
state.blockListSettings,
state.editorMode,
select( STORE_NAME ).__unstableGetEditorMode( state ),
state.zoomLevel,
getSectionRootClientId( state ),
]
] )
);

/**
Expand Down Expand Up @@ -317,7 +316,7 @@ export const hasAllowedPatterns = createRegistrySelector( ( select ) =>
},
( state, rootClientId ) => [
...getAllPatternsDependants( select )( state ),
...getInsertBlockTypeDependants( state, rootClientId ),
...getInsertBlockTypeDependants( select )( state, rootClientId ),
]
)
);
Expand Down
95 changes: 52 additions & 43 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 @@ -1794,10 +1794,12 @@ const canInsertBlockTypeUnmemoized = (
*
* @return {boolean} Whether the given block type is allowed to be inserted.
*/
export const canInsertBlockType = createSelector(
canInsertBlockTypeUnmemoized,
( state, blockName, rootClientId ) =>
getInsertBlockTypeDependants( state, rootClientId )
export const canInsertBlockType = createRegistrySelector( ( select ) =>
createSelector(
canInsertBlockTypeUnmemoized,
( state, blockName, rootClientId ) =>
getInsertBlockTypeDependants( select )( state, rootClientId )
)
);

/**
Expand Down Expand Up @@ -2224,7 +2226,7 @@ export const getInserterItems = createRegistrySelector( ( select ) =>
unlock( select( STORE_NAME ) ).getReusableBlocks(),
state.blocks.order,
state.preferences.insertUsage,
...getInsertBlockTypeDependants( state, rootClientId ),
...getInsertBlockTypeDependants( select )( state, rootClientId ),
]
)
);
Expand Down Expand Up @@ -2255,44 +2257,51 @@ export const getInserterItems = createRegistrySelector( ( select ) =>
* this item.
* @property {number} frecency Heuristic that combines frequency and recency.
*/
export const getBlockTransformItems = createSelector(
( state, blocks, rootClientId = null ) => {
const normalizedBlocks = Array.isArray( blocks ) ? blocks : [ blocks ];
const buildBlockTypeTransformItem = buildBlockTypeItem( state, {
buildScope: 'transform',
} );
const blockTypeTransformItems = getBlockTypes()
.filter( ( blockType ) =>
canIncludeBlockTypeInInserter( state, blockType, rootClientId )
)
.map( buildBlockTypeTransformItem );
export const getBlockTransformItems = createRegistrySelector( ( select ) =>
createSelector(
( state, blocks, rootClientId = null ) => {
const normalizedBlocks = Array.isArray( blocks )
? blocks
: [ blocks ];
const buildBlockTypeTransformItem = buildBlockTypeItem( state, {
buildScope: 'transform',
} );
const blockTypeTransformItems = getBlockTypes()
.filter( ( blockType ) =>
canIncludeBlockTypeInInserter(
state,
blockType,
rootClientId
)
)
.map( buildBlockTypeTransformItem );

const itemsByName = Object.fromEntries(
Object.entries( blockTypeTransformItems ).map( ( [ , value ] ) => [
value.name,
value,
] )
);
const itemsByName = Object.fromEntries(
Object.entries( blockTypeTransformItems ).map(
( [ , value ] ) => [ value.name, value ]
)
);

const possibleTransforms = getPossibleBlockTransformations(
normalizedBlocks
).reduce( ( accumulator, block ) => {
if ( itemsByName[ block?.name ] ) {
accumulator.push( itemsByName[ block.name ] );
}
return accumulator;
}, [] );
return orderBy(
possibleTransforms,
( block ) => itemsByName[ block.name ].frecency,
'desc'
);
},
( state, blocks, rootClientId ) => [
getBlockTypes(),
state.preferences.insertUsage,
...getInsertBlockTypeDependants( state, rootClientId ),
]
const possibleTransforms = getPossibleBlockTransformations(
normalizedBlocks
).reduce( ( accumulator, block ) => {
if ( itemsByName[ block?.name ] ) {
accumulator.push( itemsByName[ block.name ] );
}
return accumulator;
}, [] );
return orderBy(
possibleTransforms,
( block ) => itemsByName[ block.name ].frecency,
'desc'
);
},
( state, blocks, rootClientId ) => [
getBlockTypes(),
state.preferences.insertUsage,
...getInsertBlockTypeDependants( select )( state, rootClientId ),
]
)
);

/**
Expand Down Expand Up @@ -2360,7 +2369,7 @@ export const getAllowedBlocks = createRegistrySelector( ( select ) =>
( state, rootClientId ) => [
getBlockTypes(),
unlock( select( STORE_NAME ) ).getReusableBlocks(),
...getInsertBlockTypeDependants( state, rootClientId ),
...getInsertBlockTypeDependants( select )( state, rootClientId ),
]
)
);
Expand Down Expand Up @@ -2435,7 +2444,7 @@ export const __experimentalGetParsedPattern = createRegistrySelector(

const getAllowedPatternsDependants = ( select ) => ( state, rootClientId ) => [
...getAllPatternsDependants( select )( state ),
...getInsertBlockTypeDependants( state, rootClientId ),
...getInsertBlockTypeDependants( select )( state, rootClientId ),
];

const patternsWithParsedBlocks = new WeakMap();
Expand Down
5 changes: 5 additions & 0 deletions packages/block-editor/src/store/test/private-selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,11 @@ describe( 'private selectors', () => {
'9b9c5c3f-2e46-4f02-9e14-9fe9515b958f': {},
},
};
getEnabledClientIdsTree.registry = {
select: jest.fn( () => ( {
__unstableGetEditorMode: () => 'edit',
} ) ),
};

it( 'should return tree containing only clientId and innerBlocks', () => {
const state = {
Expand Down
23 changes: 12 additions & 11 deletions packages/block-editor/src/store/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,15 @@ export const getAllPatternsDependants = ( select ) => ( state ) => {
];
};

export function getInsertBlockTypeDependants( state, rootClientId ) {
return [
state.blockListSettings[ rootClientId ],
state.blocks.byClientId.get( rootClientId ),
state.settings.allowedBlockTypes,
state.settings.templateLock,
state.blockEditingModes,
state.editorMode,
getSectionRootClientId( state ),
];
}
export const getInsertBlockTypeDependants =
( select ) => ( state, rootClientId ) => {
return [
state.blockListSettings[ rootClientId ],
state.blocks.byClientId.get( rootClientId ),
state.settings.allowedBlockTypes,
state.settings.templateLock,
state.blockEditingModes,
select( STORE_NAME ).__unstableGetEditorMode( state ),
getSectionRootClientId( state ),
];
};
Loading