Don't request the deprecated navigation areas endpoint outside of the Gutenberg plugin #37187
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
adamziel
added
[Type] Bug
adamziel
requested review from
Mamaduka,
noisysocks,
talldan and
hellofromtonya
|
Size Change: +17 B (0%) Total Size: 1.11 MB
ℹ️ View Unchanged
|
Mamaduka
reviewed
Dec 7, 2021
| 'navigation', | ||
| navigationArea | ||
| ); | ||
| let areaMenu, setAreaMenu; |
There was a problem hiding this comment.
I think we should set a default value for setAreaMenu, probably a loadash noop, otherwise calling it will trigger an error.
talldan
reviewed
Dec 8, 2021
| // Navigation areas are deprecated and on their way out. Let's not perform | ||
| // the request unless we're in an environment where the endpoint exists. | ||
| if ( process.env.GUTENBERG_PHASE === 2 ) { | ||
| // eslint-disable-next-line react-hooks/rules-of-hooks |
There was a problem hiding this comment.
I'm not sure it's fine to ignore the rule of hooks. Won't this break other hooks since they need to be accessed in a known order?
There was a problem hiding this comment.
In this case it's okay because we can guarantee that GUTENBERG_PHASE won't change during the lifecycle of the application (it's a constant) and therefore the order in which the hooks are called won't change.
There was a problem hiding this comment.
Yeah, true, I guess that's ok then.
noisysocks
approved these changes
Dec 8, 2021
There was a problem hiding this comment.
I tested this by:
- Adding a Navigation block and seeing that a request to
block-navigation-areaswas in DevTools. - Changing
GUTENBERG_PHASEto 1 inpackage.jsonand rebuilding. - Adding a Navigation block and seeing that there was no request to
block-navigation-areasin DevTools.
noisysocks
removed
the
Backport to WP 6.7 Beta/RC
noisysocks
pushed a commit
that referenced
this pull request
Dec 13, 2021
… Gutenberg plugin (#37187) * Only call useEntityProp when process.env.GUTENBERG_PHASE === 2 ) * Give setAreaMenu a default value so that it can be safely called
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.
Description
Solves #37138
The navigation areas endpoint is not shipped with core, yet the
useEntityPropendpoint causes a HTTP request. This PR restricts that HTTP exchange to when the Gutenberg plugin is active by guarding the call touseEntityPropwith a check forprocess.env.GUTENBERG_PHASE === 2. Normally guarding react hooks is a big no-no, but this should be okay since the variable is fixed.How has this been tested?
/wp/v2/block-navigation-areas