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

Use useResourcePermissions in block-library and the widgets editor #43305

Merged
merged 5 commits into from
Aug 19, 2022
Merged

Use useResourcePermissions in block-library and the widgets editor #43305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b9cde6b
Use useResourcePermissions in block-library and the widgets editor
adamziel Aug 17, 2022
8405b17
Return an object from useResourcePermissions instead of an array
adamziel Aug 17, 2022
e96f241
Update the usage in useNavigationMenu
adamziel Aug 17, 2022
f379aea
Update the usage in the widgets editor
adamziel Aug 17, 2022
e9f4c40
Assign useResourcePermissions results to named variables
adamziel Aug 18, 2022
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
22 changes: 9 additions & 13 deletions packages/block-library/src/navigation-link/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,10 @@ import {
} from '@wordpress/element';
import { placeCaretAtHorizontalEdge } from '@wordpress/dom';
import { link as linkIcon, addSubmenu } from '@wordpress/icons';
import { store as coreStore } from '@wordpress/core-data';
import {
store as coreStore,
__experimentalUseResourcePermissions as useResourcePermissions,
} from '@wordpress/core-data';
import { decodeEntities } from '@wordpress/html-entities';

/**
Expand Down Expand Up @@ -463,14 +466,15 @@ export default function NavigationLinkEdit( {
const itemLabelPlaceholder = __( 'Add link…' );
const ref = useRef();

const pagesPermissions = useResourcePermissions( 'pages' );
const postsPermissions = useResourcePermissions( 'posts' );

const {
innerBlocks,
isAtMaxNesting,
isTopLevelLink,
isParentOfSelectedBlock,
hasChildren,
userCanCreatePages,
userCanCreatePosts,
} = useSelect(
( select ) => {
const {
Expand All @@ -497,14 +501,6 @@ export default function NavigationLinkEdit( {
true
),
hasChildren: !! getBlockCount( clientId ),
userCanCreatePages: select( coreStore ).canUser(
'create',
'pages'
),
userCanCreatePosts: select( coreStore ).canUser(
'create',
'posts'
),
};
},
[ clientId ]
Expand Down Expand Up @@ -606,9 +602,9 @@ export default function NavigationLinkEdit( {

let userCanCreate = false;
if ( ! type || type === 'page' ) {
userCanCreate = userCanCreatePages;
userCanCreate = pagesPermissions.canCreate;
} else if ( type === 'post' ) {
userCanCreate = userCanCreatePosts;
userCanCreate = postsPermissions.canCreate;
}

async function handleCreate( pageTitle ) {
Expand Down
22 changes: 9 additions & 13 deletions packages/block-library/src/navigation-submenu/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ import {
} from '@wordpress/element';
import { placeCaretAtHorizontalEdge } from '@wordpress/dom';
import { link as linkIcon, removeSubmenu } from '@wordpress/icons';
import { store as coreStore } from '@wordpress/core-data';
import {
__experimentalUseResourcePermissions as useResourcePermissions,
store as coreStore,
} from '@wordpress/core-data';
import { speak } from '@wordpress/a11y';
import { createBlock } from '@wordpress/blocks';

Expand Down Expand Up @@ -294,15 +297,16 @@ export default function NavigationSubmenuEdit( {
const itemLabelPlaceholder = __( 'Add text…' );
const ref = useRef();

const pagesPermissions = useResourcePermissions( 'pages' );
const postsPermissions = useResourcePermissions( 'posts' );

const {
isAtMaxNesting,
isTopLevelItem,
isParentOfSelectedBlock,
isImmediateParentOfSelectedBlock,
hasChildren,
selectedBlockHasChildren,
userCanCreatePages,
userCanCreatePosts,
onlyDescendantIsEmptyLink,
} = useSelect(
( select ) => {
Expand Down Expand Up @@ -348,14 +352,6 @@ export default function NavigationSubmenuEdit( {
),
hasChildren: !! getBlockCount( clientId ),
selectedBlockHasChildren: !! selectedBlockChildren?.length,
userCanCreatePages: select( coreStore ).canUser(
'create',
'pages'
),
userCanCreatePosts: select( coreStore ).canUser(
'create',
'posts'
),
onlyDescendantIsEmptyLink: _onlyDescendantIsEmptyLink,
};
},
Expand Down Expand Up @@ -426,9 +422,9 @@ export default function NavigationSubmenuEdit( {

let userCanCreate = false;
if ( ! type || type === 'page' ) {
userCanCreate = userCanCreatePages;
userCanCreate = pagesPermissions.canCreate;
} else if ( type === 'post' ) {
userCanCreate = userCanCreatePosts;
userCanCreate = postsPermissions.canCreate;
}

async function handleCreate( pageTitle ) {
Expand Down
17 changes: 10 additions & 7 deletions packages/block-library/src/navigation/use-navigation-menu.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,13 @@ export default function useNavigationMenu( ref ) {

return useSelect(
( select ) => {
const [
hasResolvedPermissions,
{ canCreate, canUpdate, canDelete, isResolving },
] = permissions;
const {
canCreate,
canUpdate,
canDelete,
isResolving,
hasResolved,
} = permissions;

const {
navigationMenus,
Expand Down Expand Up @@ -44,16 +47,16 @@ export default function useNavigationMenu( ref ) {

canUserCreateNavigationMenu: canCreate,
isResolvingCanUserCreateNavigationMenu: isResolving,
hasResolvedCanUserCreateNavigationMenu: hasResolvedPermissions,
hasResolvedCanUserCreateNavigationMenu: hasResolved,

canUserUpdateNavigationMenu: canUpdate,
hasResolvedCanUserUpdateNavigationMenu: ref
? hasResolvedPermissions
? hasResolved
: undefined,

canUserDeleteNavigationMenu: canDelete,
hasResolvedCanUserDeleteNavigationMenu: ref
? hasResolvedPermissions
? hasResolved
: undefined,
};
},
Expand Down
64 changes: 28 additions & 36 deletions packages/core-data/src/hooks/test/use-resource-permissions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,28 +50,24 @@ describe( 'useResourcePermissions', () => {
<TestComponent />
</RegistryProvider>
);
expect( data ).toEqual( [
false,
{
status: 'IDLE',
isResolving: false,
canCreate: false,
},
] );
expect( data ).toEqual( {
status: 'IDLE',
isResolving: false,
hasResolved: false,
canCreate: false,
} );

// Required to make sure no updates happen outside of act()
await act( async () => {
jest.advanceTimersByTime( 1 );
} );

expect( data ).toEqual( [
true,
{
status: 'SUCCESS',
isResolving: false,
canCreate: true,
},
] );
expect( data ).toEqual( {
status: 'SUCCESS',
isResolving: false,
hasResolved: true,
canCreate: true,
} );
} );

it( 'retrieves the relevant permissions for a resource with a key', async () => {
Expand All @@ -85,31 +81,27 @@ describe( 'useResourcePermissions', () => {
<TestComponent />
</RegistryProvider>
);
expect( data ).toEqual( [
false,
{
status: 'IDLE',
isResolving: false,
canCreate: false,
canUpdate: false,
canDelete: false,
},
] );
expect( data ).toEqual( {
status: 'IDLE',
isResolving: false,
hasResolved: false,
canCreate: false,
canUpdate: false,
canDelete: false,
} );

// Required to make sure no updates happen outside of act()
await act( async () => {
jest.advanceTimersByTime( 1 );
} );

expect( data ).toEqual( [
true,
{
status: 'SUCCESS',
isResolving: false,
canCreate: true,
canUpdate: false,
canDelete: false,
},
] );
expect( data ).toEqual( {
status: 'SUCCESS',
isResolving: false,
hasResolved: true,
canCreate: true,
canUpdate: false,
canDelete: false,
} );
} );
} );
30 changes: 13 additions & 17 deletions packages/core-data/src/hooks/use-resource-permissions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,12 @@ export default function __experimentalUseResourcePermissions< IdType = void >(
const { canUser } = resolve( coreStore );
const create = canUser( 'create', resource );
if ( ! id ) {
return [
create.hasResolved,
{
status: create.status,
isResolving: create.isResolving,
canCreate: create.hasResolved && create.data,
},
];
return {
status: create.status,
isResolving: create.isResolving,
hasResolved: create.hasResolved,
canCreate: create.hasResolved && create.data,
};
}

const update = canUser( 'update', resource, id );
Expand All @@ -104,16 +102,14 @@ export default function __experimentalUseResourcePermissions< IdType = void >(
} else if ( hasResolved ) {
status = Status.Success;
}
return [
return {
status,
isResolving,
hasResolved,
{
status,
isResolving,
canCreate: hasResolved && create.data,
canUpdate: hasResolved && update.data,
canDelete: hasResolved && _delete.data,
},
];
canCreate: hasResolved && create.data,
canUpdate: hasResolved && update.data,
canDelete: hasResolved && _delete.data,
};
},
[ resource, id ]
);
Expand Down
58 changes: 30 additions & 28 deletions packages/edit-widgets/src/components/widget-areas-block-editor-provider/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
import { SlotFillProvider } from '@wordpress/components';
import { uploadMedia } from '@wordpress/media-utils';
import { useDispatch, useSelect } from '@wordpress/data';
import {
useEntityBlockEditor,
store as coreStore,
__experimentalUseResourcePermissions as useResourcePermissions,
} from '@wordpress/core-data';
import { useMemo } from '@wordpress/element';
import {
BlockEditorProvider,
Expand All @@ -18,7 +23,6 @@ import { store as preferencesStore } from '@wordpress/preferences';
* Internal dependencies
*/
import KeyboardShortcuts from '../keyboard-shortcuts';
import { useEntityBlockEditor, store as coreStore } from '@wordpress/core-data';
import { buildWidgetAreasPostId, KIND, POST_TYPE } from '../../store/utils';
import useLastSelectedWidgetArea from '../../hooks/use-last-selected-widget-area';
import { store as editWidgetsStore } from '../../store';
Expand All @@ -29,36 +33,34 @@ export default function WidgetAreasBlockEditorProvider( {
children,
...props
} ) {
const {
hasUploadPermissions,
reusableBlocks,
isFixedToolbarActive,
keepCaretInsideBlock,
} = useSelect(
( select ) => ( {
hasUploadPermissions:
select( coreStore ).canUser( 'create', 'media' ) ?? true,
widgetAreas: select( editWidgetsStore ).getWidgetAreas(),
widgets: select( editWidgetsStore ).getWidgets(),
reusableBlocks: ALLOW_REUSABLE_BLOCKS
? select( coreStore ).getEntityRecords( 'postType', 'wp_block' )
: [],
isFixedToolbarActive: !! select( preferencesStore ).get(
'core/edit-widgets',
'fixedToolbar'
),
keepCaretInsideBlock: !! select( preferencesStore ).get(
'core/edit-widgets',
'keepCaretInsideBlock'
),
} ),
[]
);
const mediaPermissions = useResourcePermissions( 'media' );
const { reusableBlocks, isFixedToolbarActive, keepCaretInsideBlock } =
useSelect(
( select ) => ( {
widgetAreas: select( editWidgetsStore ).getWidgetAreas(),
widgets: select( editWidgetsStore ).getWidgets(),
reusableBlocks: ALLOW_REUSABLE_BLOCKS
? select( coreStore ).getEntityRecords(
'postType',
'wp_block'
)
: [],
isFixedToolbarActive: !! select( preferencesStore ).get(
'core/edit-widgets',
'fixedToolbar'
),
keepCaretInsideBlock: !! select( preferencesStore ).get(
'core/edit-widgets',
'keepCaretInsideBlock'
),
} ),
[]
);
const { setIsInserterOpened } = useDispatch( editWidgetsStore );

const settings = useMemo( () => {
let mediaUploadBlockEditor;
if ( hasUploadPermissions ) {
if ( mediaPermissions.canCreate ) {
mediaUploadBlockEditor = ( { onError, ...argumentsObject } ) => {
uploadMedia( {
wpAllowedMimeTypes: blockEditorSettings.allowedMimeTypes,
Expand All @@ -80,7 +82,7 @@ export default function WidgetAreasBlockEditorProvider( {
blockEditorSettings,
isFixedToolbarActive,
keepCaretInsideBlock,
hasUploadPermissions,
mediaPermissions.canCreate,
reusableBlocks,
setIsInserterOpened,
] );
Expand Down