Add post preview for AMP and allow AMP to be disabled on a per-post basis #813

ThierryA · 2017-11-27T12:56:52Z

This PR adds the AMP preview button on posts which have AMP support.

Merges PR #812. This PR is branched off feature/799-post-preview (#812) which is currently pending for review. Once #812 is reviewed and merged, the develop must be merged into this branch and this PR may be reviewed.

Fixes #709.
Fixes #799.

ThierryA · 2017-11-27T13:02:42Z

includes/admin/class-amp-post-meta-box.php

+			&&
+			isset( $post->post_type )
+			&&
+			post_type_supports( $post->post_type, AMP_QUERY_VAR )


This differ from the acceptance criteria, I would suggest to add the ability to disable AMP on a per post basis for all post types which have AMP post type support set, not only pages (especially now that WordPress Core has Post Type Templates). Thoughts @amedina @westonruter?

This differ from from the acceptance criteria (point 9) in a sense that the AMP status option would not be displayed at all if the post type does not have AMP support set to avoid visual noise. The thinking behind this is that the AMP status (enabled/disabled) should not be editable for post types (page included) if it doesn't have AMP support set.

If we really want to show the status as disabled, one approach would be to change to edit section with a text indicating that AMP post type support is not enabled for the current post with a link to the AMP settings page where user may enable the post type support.

Thoughts @amedina @westonruter?

@ThierryA I think you're right. The AMP status toggle shouldn't be shown at all if the post type doesn't support AMP to begin with.

westonruter · 2017-11-27T19:32:47Z

I've temporarily changed the base branch from develop to feature/799-post-preview for the sake of review.

westonruter · 2017-11-27T19:34:04Z

includes/admin/class-amp-post-meta-box.php

+	 * Render AMP status.
+	 *
+	 * @since 0.6
+	 * @param object $post \WP_POST object.


This line should read:

* @param WP_Post $post Current post.

westonruter · 2017-11-27T19:38:00Z

includes/admin/class-amp-post-meta-box.php

+			update_post_meta(
+				$post_id,
+				self::POST_META_KEY,
+				sanitize_key( wp_unslash( $_POST[ self::POST_META_KEY ] ) )


Note that this line will continue to be valid in WPCS once WordPress/WordPress-Coding-Standards#1222 is merged because sanitize_key() is marked in that PR as an autoSlashingFunctions (because it doesn't return any chars that will include slashes).

Good to know 😄 Would you like to have it removed and add a whitelisting comment until it is merged?

westonruter · 2017-11-27T19:39:47Z

includes/admin/class-amp-post-meta-box.php

+	 * The nonce action.
+	 *
+	 * @since 0.6
+	 * @const string


I think @var is actually what should be used here, counter-intuitively. See https://stackoverflow.com/a/18446766/93579

westonruter · 2017-11-27T19:40:24Z

assets/css/amp-post-meta-box.css

+	background-size: 17px;
+	width: 17px;
+    height: 17px;
+    margin: 0 8px 0 1px;


Looks like some inconsistent indentation here.

westonruter · 2017-11-27T19:42:53Z

templates/admin/amp-status.php

+}
+?>
+<div class="misc-pub-section misc-amp-status">
+	<i></i>


Why an i here and not a span?

I guess there have been a debate for a while as "what should be used for icons". Font awesome, Facebook etc. exclusively use the i tag for icons for example. I am personally in favor of using the i tag because it adds a semantic meaning (even though it doesn't mean icon per se) while span doesn't.
That said, the various places in the WP admin which are not using the dashicon font use the span tag so I think it would be better to keep it as consistent as possible. This commit changes the i tag to a span.

westonruter · 2017-11-27T19:47:35Z

includes/amp-helper-functions.php

@@ -23,6 +23,11 @@ function post_supports_amp( $post ) {
 		return false;
 	}

+	// Listen to post meta.
+	if ( ! isset( $post->ID ) || 'disabled' === get_post_meta( $post->ID, AMP_Post_Meta_Box::POST_META_KEY, true ) ) {
+		return false;


Question: instead of hard-coding a return false here, what if we instead here did:

$skip = true;

If the default value for $skip were false, then this $skip could then be passed in below as value for the amp_skip_post filter. This would allow plugins to still be able to override the value.

But maybe that would be a premature optimization. It would also be bad if a user indicates that they want to disable AMP for a given post, but then it still ends up getting AMP enabled on the frontend due to a filter that they don't know about.

But maybe that would be a premature optimization. It would also be bad if a user indicates that they want to disable AMP for a given post, but then it still ends up getting AMP enabled on the frontend due to a filter that they don't know about.

That would justified if we want to allow plugins to overwrite that admin value. That said doing that wouldn't make the admin option reflect the correct value so it would be better for plugins to use the get_post_metadata filter which would cover both, admin and frontend.

westonruter · 2017-11-27T19:51:52Z

includes/admin/class-amp-post-meta-box.php

+			&&
+			isset( $post->post_type )
+			&&
+			post_type_supports( $post->post_type, AMP_QUERY_VAR )


@ThierryA I think you're right. The AMP status toggle shouldn't be shown at all if the post type doesn't support AMP to begin with.

…r-page

ThierryA · 2017-12-03T19:45:11Z

@westonruter unless we decide to change this, this PR is ready to go.

westonruter · 2017-12-06T19:12:10Z

Merge conflict needs to be resolved.

…eature/709-block-amp-per-page

…t skipped. * Restore focus on edit link for AMP status edit for accessibility. * Do not add AMP preview button if AMP has been disabled. * Change postmeta to be flag indicating whether AMP is disabled. * Fix spelling and clean up phpdoc.

…MP_Post_Template for sake of preview

…een reader text

…ned before use

westonruter

@ThierryA ready for your follow-up review

ThierryA · 2017-12-07T10:19:45Z

Thanks @westonruter, all your changes are approved. I pushed two other commits:

802bcfb which improves the preview button styling, specifically making sure that the preview has the same background color (previously white) as the preview button and keep the exact same disabled styling (the border was previously lighter as the entire button opacity was reduced rather than just the background image).
1b6cc54 which is a slight code improvement to apply DRY principals and avoid using and extra variable unnecessary.

Ready for review final review and merge.

ThierryA added 3 commits November 24, 2017 17:11

Add post AMP preview button

c647dcf

Fix unit test for legacy WP env

600281d

Add AMP status option on a per post basis

ae8a3bb

ThierryA requested review from westonruter and amedina November 27, 2017 12:56

ThierryA commented Nov 27, 2017

View reviewed changes

westonruter changed the base branch from develop to feature/799-post-preview November 27, 2017 19:32

westonruter reviewed Nov 27, 2017

View reviewed changes

ThierryA added 5 commits November 28, 2017 17:54

AMP preview code improvement

0f82014

Fix AMP preview button

779f763

AMP preview code improvement

ce391a0

Merge branch 'feature/799-post-preview' into feature/709-block-amp-pe…

073308c

…r-page

AMP status code improvements

e4f6c87

ThierryA changed the title ~~[WIP] #709 control AMP status on a per page basis~~ #709 control AMP status on a per page basis Dec 3, 2017

westonruter changed the base branch from feature/799-post-preview to develop December 6, 2017 19:11

westonruter added 3 commits December 6, 2017 12:10

Merge branch 'develop' of https://github.com/Automattic/amp-wp into f…

e66e2b2

…eature/709-block-amp-per-page

Use queried object in amp_render() and allow passing post object to A…

18ab955

…MP_Post_Template for sake of preview

westonruter force-pushed the feature/709-block-amp-per-page branch from 18ab955 to 4f58949 Compare December 7, 2017 00:21

westonruter mentioned this pull request Dec 7, 2017

Add AMP preview button #812

Closed

westonruter changed the title ~~#709 control AMP status on a per page basis~~ Add post preview for AMP and allow AMP to be disabled on a per-post basis Dec 7, 2017

westonruter added 3 commits December 6, 2017 17:18

Eliminate need to bind this context in JS; add AMP preview button scr…

ced9461

…een reader text

Add amp prefix for define_query_var function; make sure constant defi…

1134bb1

…ned before use

Improve styling and behavior of AMP preview button

5c5074e

westonruter mentioned this pull request Dec 7, 2017

Add AMP support (experimental) xwp/wp-customize-posts#379

Open

westonruter approved these changes Dec 7, 2017

View reviewed changes

Improve AMP Preview button styling

802bcfb

Slight code improvement

1b6cc54

westonruter merged commit eeb502b into develop Dec 7, 2017

westonruter deleted the feature/709-block-amp-per-page branch December 7, 2017 15:41

westonruter mentioned this pull request Dec 7, 2017

Move AMP initialization logic into after_setup_theme, conditioned on amp_is_enabled filter #826

Merged

westonruter added this to the v0.6 milestone Dec 13, 2017

d4mation mentioned this pull request Dec 28, 2017

Allow AMP to be disabled by default for individual Posts #837

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add post preview for AMP and allow AMP to be disabled on a per-post basis #813

Add post preview for AMP and allow AMP to be disabled on a per-post basis #813

ThierryA commented Nov 27, 2017 •

edited by westonruter

ThierryA Nov 27, 2017 •

edited

ThierryA Nov 27, 2017

westonruter Nov 27, 2017

westonruter commented Nov 27, 2017

westonruter Nov 27, 2017

westonruter Nov 27, 2017

ThierryA Dec 1, 2017

westonruter Nov 27, 2017

westonruter Nov 27, 2017

westonruter Nov 27, 2017

ThierryA Dec 3, 2017

westonruter Nov 27, 2017

ThierryA Dec 3, 2017

westonruter Nov 27, 2017

ThierryA commented Dec 3, 2017

westonruter commented Dec 6, 2017

westonruter left a comment

ThierryA commented Dec 7, 2017

Add post preview for AMP and allow AMP to be disabled on a per-post basis #813

Add post preview for AMP and allow AMP to be disabled on a per-post basis #813

Conversation

ThierryA commented Nov 27, 2017 • edited by westonruter

ThierryA Nov 27, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

westonruter commented Nov 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ThierryA commented Dec 3, 2017

westonruter commented Dec 6, 2017

westonruter left a comment

Choose a reason for hiding this comment

ThierryA commented Dec 7, 2017

ThierryA commented Nov 27, 2017 •

edited by westonruter

ThierryA Nov 27, 2017 •

edited