Convert video src to HTTPS #1274

hellofromtonya · 2018-07-19T17:04:15Z

This PR automatically handles the conversion of the src ~~and poster~~ attributes from HTTP to HTTPS to generate valid AMP for the <amp-video> and its subsequent child nodes.

Work is focused within the AMP_Video_Sanitizer:

Forces by passing true to $this-maybe_enforce_https_src( $value, true ) for ~~both~~ the src ~~and poster~~ attributes.
Updates the child node(s) src attribute when it changes through the filtering.

Closes #976.

For Example

As noted in #976, when using a shortcode like this (which has a poster attribute added):

[video width="740" height="428" mp4="http://ads-up.fr/app/uploads/2016/06/BingAdsEditor-Mac-Multicomptes.mp4" loop="true" poster="http://www.pngmart.com/files/3/YouTube-Transparent-PNG.png"][/video]

this PR automatically converts the http to https for the valid AMP render:

<amp-video class="wp-video-shortcode i-amphtml-element i-amphtml-layout-responsive i-amphtml-layout-size-defined i-amphtml-video-interface i-amphtml-layout" width="740" height="428" poster="http://www.pngmart.com/files/3/YouTube-Transparent-PNG.png" loop="" autoplay="" controls="" layout="responsive">
  <i-amphtml-sizer style="display: block; padding-top: 57.9048%;"></i-amphtml-sizer>
  <video playsinline="" webkit-playsinline="" poster="https://www.pngmart.com/files/3/YouTube-Transparent-PNG.png" class="i-amphtml-fill-content i-amphtml-replaced-content" loop="" controls="">
    <source type="video/mp4" src="https://ads-up.fr/app/uploads/2016/06/BingAdsEditor-Mac-Multicomptes.mp4?_=1">
  </video>
</amp-video>

This commit forces HTTPS on the `src` attribute. For each child node, it sets the new filtered `src` attribute. Fixes #976.

kienstra

Looks Good, Behaves As Expected

Hi @hellofromtonya,
Thanks, this PR looks really good, and it works as expected. It forces the <amp-video> srctohttps`.

There's just one question below, which might not need a change.

kienstra · 2018-07-19T18:55:21Z

tests/test-amp-video-sanitizer.php

+	<source src="http://example.com/video.mp4" type="video/mp4">
+	<source src="http://example.com/video.ogv" type="video/ogg">
+</video>',
+				'<amp-video width="480" height="300" poster="https://example.com/video-image.gif" layout="responsive"><source src="https://example.com/video.mp4" type="video/mp4"><source src="https://example.com/video.ogv" type="video/ogg"></amp-video>',


Nice tests to ensure HTTPS is forced.

kienstra · 2018-07-19T19:07:58Z

includes/sanitizers/class-amp-video-sanitizer.php

@@ -179,16 +184,16 @@ private function filter_attributes( $attributes ) {

 		foreach ( $attributes as $name => $value ) {
 			switch ( $name ) {
+				case 'poster':


This is an edge case. But do you think the poster should be forced to HTTPS like it is here?

It looks like HTTP is allowed for poster. For example, passing this amp-video with an HTTP poster to the AMP Validator results in a valid page.

The HTTPS request might fail if we upgrade it from HTTP. But we're already upgrading the src to HTTPS, and that might be on the same domain. So this probably wouldn't be a common issue.

Good observation, @kienstra. You're right, it does validate. Therefore, we do not need to force the poster to HTTPS per the edge case you identified. I'll roll that part back.

AMP allows HTTP for the `poster` attribute. It is valid AMP. Therefore, in the edge case where the poster's URL is not HTTPS, we do not want to force a failed request.

kienstra

Approved

Hi @hellofromtonya,
Thanks, this is approved.

kienstra · 2018-07-19T21:55:38Z

Request For Review

Hi @westonruter,
No hurry, but when you have a chance, could you please review this pull request? It looks good, and works as expected.

The task of deciding whether to update and then handling the update is a separate task. By abstracting, we also create a reusable method.

westonruter · 2018-07-22T23:20:16Z

includes/sanitizers/class-amp-video-sanitizer.php

@@ -55,7 +56,7 @@ public function sanitize() {
 			return;
 		}

-		for ( $i = $num_nodes - 1; $i >= 0; $i-- ) {
+		for ( $i = $num_nodes - 1; $i >= 0; $i -- ) {


Is adding a space for increment/decrement now in coding standards? This is the first I've seen it.

@westonruter It's a byproduct of the auto-formatting setup in my PhpStorm style configuration. I'll correct it as it just looks weird.

Interestingly enough, it's valid syntax and passes our sniffers too.

Fixed in commit 06e23e0.

westonruter · 2018-07-22T23:23:28Z

includes/sanitizers/class-amp-video-sanitizer.php

+	 * @param string  $new_src The new src attribute.
+	 * @param string  $old_src The old src attribute.
+	 */
+	protected function update_src( &$node, $new_src, $old_src ) {


Not a problem but curious why this logic isn't inlined in the sanitize method? It seems a bit unnecessary to have a new method for this when putting an if statement would do.

why this logic isn't inlined in the sanitize method?

@westonruter I abstracted to reduce the cognitive load.

At first, I had this if code block inline within that method. But as I read down line-by-line in the method, there's quite of bit of tasks going on.

Now when reading the method and you get to the $this->update_src(), you understand that it handles updating the src without having to worry about the details.

Also, note the pattern in the sanitize method and how it deals with all of the attributes and each node. There is an exception with the layout, which could be abstracted into the set_layout() that first calls the parent and then sets the 'responsive' layout. But other than that, the method works at a bigger level, i.e. all attributes, the node, and its child nodes. Setting the src is a granular task such as setting the layout or video dimensions.

@westonruter If you prefer, I can move back to the inline solution and remove the abstracted method.

hellofromtonya added 2 commits July 19, 2018 09:31

Force HTTPS on video and source src attribute.

56dc958

This commit forces HTTPS on the `src` attribute. For each child node, it sets the new filtered `src` attribute. Fixes #976.

Force HTTPS for video poster.

95259cb

hellofromtonya added the Bug Something isn't working label Jul 19, 2018

hellofromtonya requested review from kienstra and westonruter July 19, 2018 17:09

kienstra mentioned this pull request Jul 19, 2018

Add an admin pointer for version 1.0 #1271

Merged

kienstra self-assigned this Jul 19, 2018

kienstra suggested changes Jul 19, 2018

View reviewed changes

kienstra removed their assignment Jul 19, 2018

Revert poster attribute back to not force HTTPS.

3ebea25

AMP allows HTTP for the `poster` attribute. It is valid AMP. Therefore, in the edge case where the poster's URL is not HTTPS, we do not want to force a failed request.

hellofromtonya changed the title ~~Convert video src and poster to HTTPS~~ Convert video src to HTTPS Jul 19, 2018

kienstra approved these changes Jul 19, 2018

View reviewed changes

Abstract update src functionality to new method.

68ded0a

The task of deciding whether to update and then handling the update is a separate task. By abstracting, we also create a reusable method.

westonruter reviewed Jul 22, 2018

View reviewed changes

Adjust code style format for consistency.

06e23e0

westonruter added this to the v1.0 milestone Jul 23, 2018

westonruter merged commit e3d036c into develop Jul 23, 2018

westonruter deleted the fix/convert-video-src-to-https branch July 23, 2018 21:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert video src to HTTPS #1274

Convert video src to HTTPS #1274

hellofromtonya commented Jul 19, 2018 •

edited

Loading

kienstra left a comment •

edited

Loading

kienstra Jul 19, 2018

kienstra Jul 19, 2018 •

edited

Loading

hellofromtonya Jul 19, 2018

kienstra left a comment

kienstra commented Jul 19, 2018

westonruter Jul 22, 2018

hellofromtonya Jul 23, 2018 •

edited

Loading

westonruter Jul 22, 2018

hellofromtonya Jul 23, 2018 •

edited

Loading

Convert video src to HTTPS #1274

Convert video src to HTTPS #1274

Conversation

hellofromtonya commented Jul 19, 2018 • edited Loading

For Example

kienstra left a comment • edited Loading

Choose a reason for hiding this comment

kienstra Jul 19, 2018

Choose a reason for hiding this comment

kienstra Jul 19, 2018 • edited Loading

Choose a reason for hiding this comment

hellofromtonya Jul 19, 2018

Choose a reason for hiding this comment

kienstra left a comment

Choose a reason for hiding this comment

kienstra commented Jul 19, 2018

westonruter Jul 22, 2018

Choose a reason for hiding this comment

hellofromtonya Jul 23, 2018 • edited Loading

Choose a reason for hiding this comment

westonruter Jul 22, 2018

Choose a reason for hiding this comment

hellofromtonya Jul 23, 2018 • edited Loading

Choose a reason for hiding this comment

hellofromtonya commented Jul 19, 2018 •

edited

Loading

kienstra left a comment •

edited

Loading

kienstra Jul 19, 2018 •

edited

Loading

hellofromtonya Jul 23, 2018 •

edited

Loading

hellofromtonya Jul 23, 2018 •

edited

Loading