Update Nav block permissions variable naming accuracy #59882
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
getdave
added
[Type] Code Quality
|
Size Change: +2.44 kB (0%) Total Size: 1.71 MB
ℹ️ View Unchanged
|
|
Looks like e2e coverage pick up a regression here somewhere. |
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Flaky tests detected in 5fcf1e4. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/8346020365
|
scruffian
approved these changes
Mar 20, 2024
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Mar 27, 2024
* 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>
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?
Improves the comprehension around the create/update/delete permissions used within the Nav block codebase.
Why?
The current code mixes the concepts of:
This is problematic when it comes to permissions because it is my understanding that:
createpermission is not related to any single Navigation Menu.update/deletepermission are only related to a single Navigation Menu Post.In the code however, the naming of the
canUser{Create|Update|Delete}NavigationMenumakes is seem as though all 3 permissions are related to a single post.It's important that we distinguish that the
createpermission is plural and thus why I renamed the variable.How do I know this?
canUser.OPTIONSrequests to the related endpoint for whatever resource (in our castnavigation).Allowheader of the response to theOPTIONSrequest.canUsertakes the result and maps it to the create/read/update/deleteThe
createhandler for the Navigation REST API endpoint doesn't require an ID. Therefore we know it's a permission that relates to all Navigation Menus rather than a specific one (like the way Update/Delete do require an ID).How?
Renames the variables to be clear what the permission relates to. It's a small change but it improves comprehension.
Longer term this will help us as we refactor towards using slugs are refs in the Nav block.
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast