From 9b06bf7312ec670de3afd3262bbcc4be62ca334b Mon Sep 17 00:00:00 2001
From: Dave Smith <getdavemail@gmail.com>
Date: Wed, 20 Mar 2024 12:00:28 +0000
Subject: [PATCH] Update Nav block permissions variable naming accuracy
 (#59882)

* Rename vars for increased clarity

* Pluralise canCreate permission

* Update tests

* Improve comments

* Fix resolver naming

* Update tests

Co-authored-by: getdave <get_dave@git.wordpress.org>
Co-authored-by: scruffian <scruffian@git.wordpress.org>
---
 .../src/navigation/edit/index.js              | 24 ++++++-----
 .../edit/navigation-menu-selector.js          |  8 ++--
 .../src/navigation/edit/placeholder/index.js  |  8 ++--
 .../edit/test/navigation-menu-selector.js     | 36 ++++++++--------
 .../navigation/test/use-navigation-menu.js    | 42 +++++++++----------
 .../src/navigation/use-navigation-menu.js     | 32 ++++++++++----
 6 files changed, 83 insertions(+), 67 deletions(-)

diff --git a/packages/block-library/src/navigation/edit/index.js b/packages/block-library/src/navigation/edit/index.js
index 0ae0a770f2062..3069bee213114 100644
--- a/packages/block-library/src/navigation/edit/index.js
+++ b/packages/block-library/src/navigation/edit/index.js
@@ -187,9 +187,9 @@ function Navigation( {
 		hasResolvedCanUserUpdateNavigationMenu,
 		canUserDeleteNavigationMenu,
 		hasResolvedCanUserDeleteNavigationMenu,
-		canUserCreateNavigationMenu,
-		isResolvingCanUserCreateNavigationMenu,
-		hasResolvedCanUserCreateNavigationMenu,
+		canUserCreateNavigationMenus,
+		isResolvingCanUserCreateNavigationMenus,
+		hasResolvedCanUserCreateNavigationMenus,
 	} = useNavigationMenu( ref );
 
 	const navMenuResolvedButMissing =
@@ -467,8 +467,8 @@ function Navigation( {
 
 			if (
 				! ref &&
-				hasResolvedCanUserCreateNavigationMenu &&
-				! canUserCreateNavigationMenu
+				hasResolvedCanUserCreateNavigationMenus &&
+				! canUserCreateNavigationMenus
 			) {
 				showNavigationMenuPermissionsNotice(
 					__(
@@ -482,8 +482,8 @@ function Navigation( {
 		isInnerBlockSelected,
 		canUserUpdateNavigationMenu,
 		hasResolvedCanUserUpdateNavigationMenu,
-		canUserCreateNavigationMenu,
-		hasResolvedCanUserCreateNavigationMenu,
+		canUserCreateNavigationMenus,
+		hasResolvedCanUserCreateNavigationMenus,
 		ref,
 		hideNavigationMenuPermissionsNotice,
 		showNavigationMenuPermissionsNotice,
@@ -491,7 +491,7 @@ function Navigation( {
 	] );
 
 	const hasManagePermissions =
-		canUserCreateNavigationMenu || canUserUpdateNavigationMenu;
+		canUserCreateNavigationMenus || canUserUpdateNavigationMenu;
 
 	const overlayMenuPreviewClasses = classnames(
 		'wp-block-navigation__overlay-menu-preview',
@@ -801,9 +801,11 @@ function Navigation( {
 					isSelected={ isSelected }
 					currentMenuId={ ref }
 					clientId={ clientId }
-					canUserCreateNavigationMenu={ canUserCreateNavigationMenu }
-					isResolvingCanUserCreateNavigationMenu={
-						isResolvingCanUserCreateNavigationMenu
+					canUserCreateNavigationMenus={
+						canUserCreateNavigationMenus
+					}
+					isResolvingCanUserCreateNavigationMenus={
+						isResolvingCanUserCreateNavigationMenus
 					}
 					onSelectNavigationMenu={ onSelectNavigationMenu }
 					onSelectClassicMenu={ onSelectClassicMenu }
diff --git a/packages/block-library/src/navigation/edit/navigation-menu-selector.js b/packages/block-library/src/navigation/edit/navigation-menu-selector.js
index ab9d5ec399deb..e232cb089a00b 100644
--- a/packages/block-library/src/navigation/edit/navigation-menu-selector.js
+++ b/packages/block-library/src/navigation/edit/navigation-menu-selector.js
@@ -59,7 +59,7 @@ function NavigationMenuSelector( {
 		navigationMenus,
 		isResolvingNavigationMenus,
 		hasResolvedNavigationMenus,
-		canUserCreateNavigationMenu,
+		canUserCreateNavigationMenus,
 		canSwitchNavigationMenu,
 	} = useNavigationMenu();
 
@@ -100,7 +100,7 @@ function NavigationMenuSelector( {
 	const hasNavigationMenus = !! navigationMenus?.length;
 	const hasClassicMenus = !! classicMenus?.length;
 	const showNavigationMenus = !! canSwitchNavigationMenu;
-	const showClassicMenus = !! canUserCreateNavigationMenu;
+	const showClassicMenus = !! canUserCreateNavigationMenus;
 
 	const noMenuSelected = hasNavigationMenus && ! currentMenuId;
 	const noBlockMenus = ! hasNavigationMenus && hasResolvedNavigationMenus;
@@ -129,7 +129,7 @@ function NavigationMenuSelector( {
 	}, [
 		hasResolvedNavigationMenus,
 		createNavigationMenuIsSuccess,
-		canUserCreateNavigationMenu,
+		canUserCreateNavigationMenus,
 		createNavigationMenuIsError,
 		isUpdatingMenuRef,
 		menuUnavailable,
@@ -187,7 +187,7 @@ function NavigationMenuSelector( {
 						</MenuGroup>
 					) }
 
-					{ canUserCreateNavigationMenu && (
+					{ canUserCreateNavigationMenus && (
 						<MenuGroup label={ __( 'Tools' ) }>
 							<MenuItem
 								onClick={ async () => {
diff --git a/packages/block-library/src/navigation/edit/placeholder/index.js b/packages/block-library/src/navigation/edit/placeholder/index.js
index 61fd13c8d9779..0d7c1a7c863b5 100644
--- a/packages/block-library/src/navigation/edit/placeholder/index.js
+++ b/packages/block-library/src/navigation/edit/placeholder/index.js
@@ -18,8 +18,8 @@ export default function NavigationPlaceholder( {
 	isSelected,
 	currentMenuId,
 	clientId,
-	canUserCreateNavigationMenu = false,
-	isResolvingCanUserCreateNavigationMenu,
+	canUserCreateNavigationMenus = false,
+	isResolvingCanUserCreateNavigationMenus,
 	onSelectNavigationMenu,
 	onSelectClassicMenu,
 	onCreateEmpty,
@@ -41,7 +41,7 @@ export default function NavigationPlaceholder( {
 	}, [ hasResolvedMenus, isResolvingMenus, isSelected ] );
 
 	const isResolvingActions =
-		isResolvingMenus && isResolvingCanUserCreateNavigationMenu;
+		isResolvingMenus && isResolvingCanUserCreateNavigationMenus;
 
 	return (
 		<>
@@ -74,7 +74,7 @@ export default function NavigationPlaceholder( {
 
 						<hr />
 
-						{ canUserCreateNavigationMenu && (
+						{ canUserCreateNavigationMenus && (
 							<Button
 								variant="tertiary"
 								onClick={ onCreateEmpty }
diff --git a/packages/block-library/src/navigation/edit/test/navigation-menu-selector.js b/packages/block-library/src/navigation/edit/test/navigation-menu-selector.js
index 4343b05f00423..6ed21c82ed07b 100644
--- a/packages/block-library/src/navigation/edit/test/navigation-menu-selector.js
+++ b/packages/block-library/src/navigation/edit/test/navigation-menu-selector.js
@@ -93,7 +93,7 @@ describe( 'NavigationMenuSelector', () => {
 			useNavigationMenu.mockReturnValue( {
 				navigationMenus: [],
 				hasResolvedNavigationMenus: true,
-				canUserCreateNavigationMenu: true,
+				canUserCreateNavigationMenus: true,
 				canSwitchNavigationMenu: true,
 			} );
 
@@ -115,7 +115,7 @@ describe( 'NavigationMenuSelector', () => {
 				navigationMenus: [],
 				isResolvingNavigationMenus: true,
 				hasResolvedNavigationMenus: false,
-				canUserCreateNavigationMenu: false,
+				canUserCreateNavigationMenus: false,
 				canSwitchNavigationMenu: true,
 			} );
 
@@ -152,7 +152,7 @@ describe( 'NavigationMenuSelector', () => {
 				useNavigationMenu.mockReturnValue( {
 					navigationMenus: [],
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -203,7 +203,7 @@ describe( 'NavigationMenuSelector', () => {
 				useNavigationMenu.mockReturnValue( {
 					navigationMenus: [],
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: false,
+					canUserCreateNavigationMenus: false,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -226,7 +226,7 @@ describe( 'NavigationMenuSelector', () => {
 				useNavigationMenu.mockReturnValue( {
 					navigationMenus: [],
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -254,7 +254,7 @@ describe( 'NavigationMenuSelector', () => {
 				useNavigationMenu.mockReturnValue( {
 					navigationMenus: [],
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -278,7 +278,7 @@ describe( 'NavigationMenuSelector', () => {
 					navigationMenus: [],
 					hasResolvedNavigationMenus: false,
 					isResolvingNavigationMenus: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -303,7 +303,7 @@ describe( 'NavigationMenuSelector', () => {
 					navigationMenus: [],
 					hasResolvedNavigationMenus: true,
 					isResolvingNavigationMenus: false,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -331,7 +331,7 @@ describe( 'NavigationMenuSelector', () => {
 				useNavigationMenu.mockReturnValue( {
 					navigationMenus: navigationMenusFixture,
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 					canSwitchNavigationMenu: false,
 				} );
 
@@ -352,7 +352,7 @@ describe( 'NavigationMenuSelector', () => {
 				useNavigationMenu.mockReturnValue( {
 					navigationMenus: navigationMenusFixture,
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: false,
+					canUserCreateNavigationMenus: false,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -391,7 +391,7 @@ describe( 'NavigationMenuSelector', () => {
 				useNavigationMenu.mockReturnValue( {
 					navigationMenus: menusWithNoTitle,
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -425,7 +425,7 @@ describe( 'NavigationMenuSelector', () => {
 				useNavigationMenu.mockReturnValue( {
 					navigationMenus: navigationMenusFixture,
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -453,7 +453,7 @@ describe( 'NavigationMenuSelector', () => {
 				useNavigationMenu.mockReturnValue( {
 					navigationMenus: navigationMenusFixture,
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 					canSwitchNavigationMenu: true,
 				} );
 
@@ -504,7 +504,7 @@ describe( 'NavigationMenuSelector', () => {
 				const user = userEvent.setup();
 
 				useNavigationMenu.mockReturnValue( {
-					canUserCreateNavigationMenu: false,
+					canUserCreateNavigationMenus: false,
 				} );
 
 				useNavigationEntities.mockReturnValue( {
@@ -526,7 +526,7 @@ describe( 'NavigationMenuSelector', () => {
 				const user = userEvent.setup();
 
 				useNavigationMenu.mockReturnValue( {
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 				} );
 
 				useNavigationEntities.mockReturnValue( {
@@ -563,7 +563,7 @@ describe( 'NavigationMenuSelector', () => {
 					isResolvingNavigationMenus: false,
 					hasResolvedNavigationMenus: true,
 					canSwitchNavigationMenu: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 				} );
 
 				useNavigationEntities.mockReturnValue( {
@@ -595,7 +595,7 @@ describe( 'NavigationMenuSelector', () => {
 					navigationMenus: [],
 					isResolvingNavigationMenus: true,
 					hasResolvedNavigationMenus: false,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 				} );
 
 				useNavigationEntities.mockReturnValue( {
@@ -628,7 +628,7 @@ describe( 'NavigationMenuSelector', () => {
 					navigationMenus: [],
 					isResolvingNavigationMenus: false,
 					hasResolvedNavigationMenus: true,
-					canUserCreateNavigationMenu: true,
+					canUserCreateNavigationMenus: true,
 				} );
 
 				useNavigationEntities.mockReturnValue( {
diff --git a/packages/block-library/src/navigation/test/use-navigation-menu.js b/packages/block-library/src/navigation/test/use-navigation-menu.js
index f82acca835884..eb7e90aff22d1 100644
--- a/packages/block-library/src/navigation/test/use-navigation-menu.js
+++ b/packages/block-library/src/navigation/test/use-navigation-menu.js
@@ -117,16 +117,16 @@ describe( 'useNavigationMenus', () => {
 			navigationMenus: null,
 			navigationMenu: undefined,
 			canSwitchNavigationMenu: false,
-			canUserCreateNavigationMenu: false,
+			canUserCreateNavigationMenus: false,
 			canUserDeleteNavigationMenu: undefined,
 			canUserUpdateNavigationMenu: undefined,
-			hasResolvedCanUserCreateNavigationMenu: false,
+			hasResolvedCanUserCreateNavigationMenus: false,
 			hasResolvedCanUserDeleteNavigationMenu: undefined,
 			hasResolvedCanUserUpdateNavigationMenu: undefined,
 			hasResolvedNavigationMenus: false,
 			isNavigationMenuMissing: true,
 			isNavigationMenuResolved: false,
-			isResolvingCanUserCreateNavigationMenu: false,
+			isResolvingCanUserCreateNavigationMenus: false,
 			isResolvingNavigationMenus: false,
 		} );
 	} );
@@ -139,16 +139,16 @@ describe( 'useNavigationMenus', () => {
 			navigationMenus,
 			navigationMenu: undefined,
 			canSwitchNavigationMenu: true,
-			canUserCreateNavigationMenu: true,
+			canUserCreateNavigationMenus: true,
 			canUserDeleteNavigationMenu: undefined,
 			canUserUpdateNavigationMenu: undefined,
-			hasResolvedCanUserCreateNavigationMenu: true,
+			hasResolvedCanUserCreateNavigationMenus: true,
 			hasResolvedCanUserDeleteNavigationMenu: undefined,
 			hasResolvedCanUserUpdateNavigationMenu: undefined,
 			hasResolvedNavigationMenus: true,
 			isNavigationMenuMissing: true,
 			isNavigationMenuResolved: false,
-			isResolvingCanUserCreateNavigationMenu: false,
+			isResolvingCanUserCreateNavigationMenus: false,
 			isResolvingNavigationMenus: false,
 		} );
 	} );
@@ -159,16 +159,16 @@ describe( 'useNavigationMenus', () => {
 			navigationMenu: navigationMenu1,
 			navigationMenus,
 			canSwitchNavigationMenu: true,
-			canUserCreateNavigationMenu: false,
+			canUserCreateNavigationMenus: false,
 			canUserDeleteNavigationMenu: false,
 			canUserUpdateNavigationMenu: false,
-			hasResolvedCanUserCreateNavigationMenu: false,
+			hasResolvedCanUserCreateNavigationMenus: false,
 			hasResolvedCanUserDeleteNavigationMenu: false,
 			hasResolvedCanUserUpdateNavigationMenu: false,
 			hasResolvedNavigationMenus: true,
 			isNavigationMenuMissing: false,
 			isNavigationMenuResolved: false,
-			isResolvingCanUserCreateNavigationMenu: false,
+			isResolvingCanUserCreateNavigationMenus: false,
 			isResolvingNavigationMenus: false,
 		} );
 	} );
@@ -181,16 +181,16 @@ describe( 'useNavigationMenus', () => {
 			navigationMenu: navigationMenuDraft,
 			navigationMenus: testMenus,
 			canSwitchNavigationMenu: true,
-			canUserCreateNavigationMenu: false,
+			canUserCreateNavigationMenus: false,
 			canUserDeleteNavigationMenu: false,
 			canUserUpdateNavigationMenu: false,
-			hasResolvedCanUserCreateNavigationMenu: false,
+			hasResolvedCanUserCreateNavigationMenus: false,
 			hasResolvedCanUserDeleteNavigationMenu: false,
 			hasResolvedCanUserUpdateNavigationMenu: false,
 			hasResolvedNavigationMenus: true,
 			isNavigationMenuMissing: false,
 			isNavigationMenuResolved: false,
-			isResolvingCanUserCreateNavigationMenu: false,
+			isResolvingCanUserCreateNavigationMenus: false,
 			isResolvingNavigationMenus: false,
 		} );
 	} );
@@ -205,16 +205,16 @@ describe( 'useNavigationMenus', () => {
 			navigationMenu: navigationMenu1,
 			navigationMenus,
 			canSwitchNavigationMenu: true,
-			canUserCreateNavigationMenu: true,
+			canUserCreateNavigationMenus: true,
 			canUserDeleteNavigationMenu: false,
 			canUserUpdateNavigationMenu: true,
-			hasResolvedCanUserCreateNavigationMenu: true,
+			hasResolvedCanUserCreateNavigationMenus: true,
 			hasResolvedCanUserDeleteNavigationMenu: true,
 			hasResolvedCanUserUpdateNavigationMenu: true,
 			hasResolvedNavigationMenus: true,
 			isNavigationMenuMissing: false,
 			isNavigationMenuResolved: false,
-			isResolvingCanUserCreateNavigationMenu: false,
+			isResolvingCanUserCreateNavigationMenus: false,
 			isResolvingNavigationMenus: false,
 		} );
 	} );
@@ -229,16 +229,16 @@ describe( 'useNavigationMenus', () => {
 			navigationMenu: navigationMenu1,
 			navigationMenus,
 			canSwitchNavigationMenu: true,
-			canUserCreateNavigationMenu: false,
+			canUserCreateNavigationMenus: false,
 			canUserDeleteNavigationMenu: true,
 			canUserUpdateNavigationMenu: false,
-			hasResolvedCanUserCreateNavigationMenu: true,
+			hasResolvedCanUserCreateNavigationMenus: true,
 			hasResolvedCanUserDeleteNavigationMenu: true,
 			hasResolvedCanUserUpdateNavigationMenu: true,
 			hasResolvedNavigationMenus: true,
 			isNavigationMenuMissing: false,
 			isNavigationMenuResolved: false,
-			isResolvingCanUserCreateNavigationMenu: false,
+			isResolvingCanUserCreateNavigationMenus: false,
 			isResolvingNavigationMenus: false,
 		} );
 	} );
@@ -254,16 +254,16 @@ describe( 'useNavigationMenus', () => {
 			navigationMenu: requestedMenu,
 			navigationMenus,
 			canSwitchNavigationMenu: true,
-			canUserCreateNavigationMenu: false,
+			canUserCreateNavigationMenus: false,
 			canUserDeleteNavigationMenu: false,
 			canUserUpdateNavigationMenu: false,
-			hasResolvedCanUserCreateNavigationMenu: false,
+			hasResolvedCanUserCreateNavigationMenus: false,
 			hasResolvedCanUserDeleteNavigationMenu: false,
 			hasResolvedCanUserUpdateNavigationMenu: false,
 			hasResolvedNavigationMenus: true,
 			isNavigationMenuMissing: false,
 			isNavigationMenuResolved: false,
-			isResolvingCanUserCreateNavigationMenu: false,
+			isResolvingCanUserCreateNavigationMenus: false,
 			isResolvingNavigationMenus: false,
 		} );
 	} );
diff --git a/packages/block-library/src/navigation/use-navigation-menu.js b/packages/block-library/src/navigation/use-navigation-menu.js
index 02df0ba2831dc..3834661ed6101 100644
--- a/packages/block-library/src/navigation/use-navigation-menu.js
+++ b/packages/block-library/src/navigation/use-navigation-menu.js
@@ -27,8 +27,18 @@ export default function useNavigationMenu( ref ) {
 		[ ref ]
 	);
 
-	const { canCreate, canUpdate, canDelete, isResolving, hasResolved } =
-		permissions;
+	const {
+		// Can the user create navigation menus?
+		canCreate: canCreateNavigationMenus,
+
+		// Can the user update the specific navigation menu with the given post ID?
+		canUpdate: canUpdateNavigationMenu,
+
+		// Can the user delete the specific navigation menu with the given post ID?
+		canDelete: canDeleteNavigationMenu,
+		isResolving: isResolvingPermissions,
+		hasResolved: hasResolvedPermissions,
+	} = permissions;
 
 	const {
 		records: navigationMenus,
@@ -52,13 +62,17 @@ export default function useNavigationMenu( ref ) {
 		isResolvingNavigationMenus,
 		hasResolvedNavigationMenus,
 		canSwitchNavigationMenu,
-		canUserCreateNavigationMenu: canCreate,
-		isResolvingCanUserCreateNavigationMenu: isResolving,
-		hasResolvedCanUserCreateNavigationMenu: hasResolved,
-		canUserUpdateNavigationMenu: canUpdate,
-		hasResolvedCanUserUpdateNavigationMenu: ref ? hasResolved : undefined,
-		canUserDeleteNavigationMenu: canDelete,
-		hasResolvedCanUserDeleteNavigationMenu: ref ? hasResolved : undefined,
+		canUserCreateNavigationMenus: canCreateNavigationMenus,
+		isResolvingCanUserCreateNavigationMenus: isResolvingPermissions,
+		hasResolvedCanUserCreateNavigationMenus: hasResolvedPermissions,
+		canUserUpdateNavigationMenu: canUpdateNavigationMenu,
+		hasResolvedCanUserUpdateNavigationMenu: ref
+			? hasResolvedPermissions
+			: undefined,
+		canUserDeleteNavigationMenu: canDeleteNavigationMenu,
+		hasResolvedCanUserDeleteNavigationMenu: ref
+			? hasResolvedPermissions
+			: undefined,
 	};
 }