Refactor conditional checks in is_amp_endpoint() and improve guidance when _doing_it_wrong() by hansschuijff · Pull Request #4574 · ampproject/amp-wp

hansschuijff · 2020-04-12T09:18:58Z

Moved checking against is_embed() and is_feed() after
checking if parse_query has run and $wp_query has been filled, since
both these functions will fire _doing_it_wrong when $wp_query
is not yet set.

Summary

Fixes #4525

Checklist

My pull request is addressing an open issue (please create one otherwise).
My code is tested and passes existing tests.
My code follows the Engineering Guidelines (updates are often made to the guidelines, check it out periodically).

Moved checking against is_embed() and is_feed() after checking if parse_query has run and $wp_query has been filled, since both these functions will fire _doing_it_wrong when $wp_query is not yet set.

googlebot · 2020-04-12T09:19:02Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

schlessera

Thanks so much for the pull request @hansschuijff !

There's a code style issue right now that prevents the actual tests from running. See my review comment on how to fix it.

googlebot · 2020-04-12T10:25:41Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

schlessera · 2020-04-13T06:06:11Z

@hansschuijff It looks like there's no obvious way right now to add a regression test for the above fix. I've opened an issue to that regard: #4576

westonruter · 2020-04-13T18:06:37Z

 	global $pagenow, $wp_query;

-	if ( is_admin() || is_embed() || is_feed() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) || in_array( $pagenow, [ 'wp-login.php', 'wp-signup.php', 'wp-activate.php' ], true ) ) {
+	if ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) || in_array( $pagenow, [ 'wp-login.php', 'wp-signup.php', 'wp-activate.php' ], true ) ) {


I just realized that REST_REQUEST maybe being checked too early here. It is defined in the rest_api_loaded() function which is called at the parse_request action. So perhaps we need to add another check for whether the parse_request action was done.

If I understand it correctly, that seems to not lead to problems, since than REST_REQUEST just won't be defined and it will pass through the conditional and just fire _doing_it_wrong until the parse_request action is performed and the $wp_query is filled. Is_embed and is_feed just needed to move since otherwise the error reported had no obvious relation with is_amp_endpoint. It might be right to let the function report an error anyway if the function is called too early in the process, so that the plugin developers get to see where what they did wrong?

I think the issue is just that during REST API requests, the wp action is never triggered so it's somewhat misleading. In order to check the constant we need to check if the parse_request action was fired, or else it's not good to check this constant since it will never be defined. I'm going to push up a change to this to account for this and you can see what I mean.

OK, I've rearranged the checks in 0bdf639 which I think will produce better results. This change will also ensure that a call to is_amp_endpoint() won't cause a warning in addition to warnings about calling is_embed() and is_feed().

…g_it_wrong warnings

westonruter · 2020-04-13T19:59:41Z

One more thing that comes to mind to improve this is to look at the call stack to find out which theme/plugin is actually responsible for calling is_amp_endpoint() prematurely. While this is out of scope of this PR, it's something that we can either add here or look at in another PR.

…ition in redirects

schlessera · 2020-04-14T08:02:56Z

+		if ( current_theme_supports( AMP_Theme_Support::SLUG ) ) {
+			$availability = AMP_Theme_Support::get_template_availability( $wp_query );
+			$supported    = $availability['supported'];
+		} else {
+			$queried_object = get_queried_object();
+			$supported      = ( $wp_query->is_singular() || $wp_query->is_posts_page ) && $queried_object instanceof WP_Post && post_supports_amp( $queried_object );
+		}


Early bails should be preferred over if/else constructs. This is easier to reason about and keeps the level of indentation down.

Suggested change

if ( current_theme_supports( AMP_Theme_Support::SLUG ) ) {

$availability = AMP_Theme_Support::get_template_availability( $wp_query );

$supported = $availability['supported'];

} else {

$queried_object = get_queried_object();

$supported = ( $wp_query->is_singular() || $wp_query->is_posts_page ) && $queried_object instanceof WP_Post && post_supports_amp( $queried_object );

}

if ( current_theme_supports( AMP_Theme_Support::SLUG ) ) {

$availability = AMP_Theme_Support::get_template_availability( $wp_query );

return $availability['supported'];

}

$queried_object = get_queried_object();

return ( $wp_query->is_singular() || $wp_query->is_posts_page ) && $queried_object instanceof WP_Post && post_supports_amp( $queried_object );

I can't provide a suggestion for the rest of this piece of code, as suggestions don't seem to work across deleted lines.
But the change should basically be from this:

if () { if () { $supported = ... else { $supported = ... } } else { $supported = ... } return $supported;

...to this:

if () { if () { return ...; } return ...; } return ...;

Addressed in 751c645

schlessera · 2020-04-14T08:09:25Z

-		// @codeCoverageIgnoreStart
-		if ( $exit ) {
+		if ( wp_safe_redirect( $non_amp_url, $status ) ) {
+			// @codeCoverageIgnoreStart


Why is code coverage being ignored here? This would warrant an explanatory comment.

Because exit cannot be tested.

Co-Authored-By: Alain Schlesser <alain.schlesser@gmail.com>

* 'develop' of github.com:ampproject/amp-wp: Update tests after block-library/style.css changes in Gutenberg 7.9 (ampproject#4579) Restrict doing plugin upgrade routine when not in admin (ampproject#4538)

westonruter · 2020-04-14T19:47:22Z

@hansschuijff Sorry for increasing the scope of the PR so greatly. Your original change was very needed, and then it identified a whole bunch of other improvements that also needed to be made.

hansschuijff · 2020-04-14T20:20:57Z

@westonruter No worries. I'm glad I could help, even if it was just in a small way. Seeing you guys work is educational too and having done my first pr. Sometimes just initiating something is enough and glad it inspired to enhance amp even more.

Feedback addressed

fixed issue ampproject#4525

f346c04

Moved checking against is_embed() and is_feed() after checking if parse_query has run and $wp_query has been filled, since both these functions will fire _doing_it_wrong when $wp_query is not yet set.

googlebot added the cla: no Has not signed the Google CLA label Apr 12, 2020

schlessera requested changes Apr 12, 2020

View reviewed changes

Comment thread includes/amp-helper-functions.php Outdated

schlessera changed the title ~~fixes issue #4525~~ Only use is_embed() & is_feed() after $did_parse_query to fix error in is_amp_endpoint() Apr 12, 2020

schlessera added the Routing Handling URLs label Apr 12, 2020

Commit suggestion: end inline comment with .

25366b7

googlebot added cla: yes Signed the Google CLA and removed cla: no Has not signed the Google CLA labels Apr 12, 2020

westonruter reviewed Apr 13, 2020

View reviewed changes

Comment thread includes/amp-helper-functions.php Outdated

Start comment with upper-case letter

fa4504f

westonruter reviewed Apr 13, 2020

View reviewed changes

Only check REST_REQUEST after parse_request; prevent duplicated _doin…

0bdf639

…g_it_wrong warnings

westonruter added 6 commits April 13, 2020 14:04

Update version for _doing_it_wrong() from 1.5.3 to 1.6.0

f22c4c7

Add comment explaining short-circuit behavior when query var is present

27a5192

Fix translators comment

b498d91

Remove special conditions for Reader mode; remove need for $exit cond…

47926ce

…ition in redirects

Fix typo in global phpdoc

5995ee0

Add conditions for comment feed, trackback, robots, and favicon

d79097c

schlessera previously requested changes Apr 14, 2020

View reviewed changes

westonruter and others added 3 commits April 14, 2020 12:39

Improve phpdoc and logic conditions

d56b990

Co-Authored-By: Alain Schlesser <alain.schlesser@gmail.com>

Return early instead of storing eventual return value in variable

751c645

Merge branch 'develop' of github.com:ampproject/amp-wp into fix/4525

88e9403

* 'develop' of github.com:ampproject/amp-wp: Update tests after block-library/style.css changes in Gutenberg 7.9 (ampproject#4579) Restrict doing plugin upgrade routine when not in admin (ampproject#4538)

westonruter requested a review from schlessera April 14, 2020 19:45

westonruter approved these changes Apr 15, 2020

View reviewed changes

westonruter changed the title ~~Only use is_embed() & is_feed() after $did_parse_query to fix error in is_amp_endpoint()~~ Refactor conditional checks in is_amp_endpoint() and improve guidance when _doing_it_wrong() Apr 16, 2020

westonruter merged commit 85e45e8 into ampproject:develop Apr 16, 2020

westonruter mentioned this pull request Apr 17, 2020

Theme/plugin responsible for prematurely calling is_amp_endpoint() should be identified #4602

Closed

westonruter added this to the v1.6 milestone Jun 2, 2020

westonruter mentioned this pull request Jun 9, 2020

AMP plugin comaptibility: Notice: is_amp_endpoint was called incorrectly google/site-kit-wp#1650

Closed

westonruter added the Changelogged Whether the issue/PR has been added to release notes. label Jul 17, 2020

Conversation

hansschuijff commented Apr 12, 2020 • edited by westonruter Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

googlebot commented Apr 12, 2020

What to do if you already signed the CLA

Individual signers

Corporate signers

Uh oh!

schlessera left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

googlebot commented Apr 12, 2020

Uh oh!

schlessera commented Apr 13, 2020

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

westonruter commented Apr 13, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

westonruter commented Apr 14, 2020

Uh oh!

hansschuijff commented Apr 14, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hansschuijff commented Apr 12, 2020 •

edited by westonruter

Loading