Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Promote noscript fallback images with fetchpriority=high to hero and automatically SSR #544

Merged
merged 7 commits into from
Oct 24, 2023
Merged

Promote noscript fallback images with fetchpriority=high to hero and automatically SSR #544

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
387eaff
Add FETCHPRIORITY constant to Attribute interface
thelovekesh Oct 19, 2023
c40d466
Update `OptimizeHeroImages::generateImg()` to add fetchpriority attr …
thelovekesh Oct 24, 2023
3852f92
Add test cases for fetchpriority attr in `OptimizeHeroImages::generat…
thelovekesh Oct 24, 2023
997f03b
Update `OptimizeHeroImages::generateImg()` to auto SSR high fetchprio…
thelovekesh Oct 24, 2023
89707d0
Add test cases for auto ssr img with high fetchpriority in `OptimizeH…
thelovekesh Oct 24, 2023
f08ade9
Update setting `data-hero` attribute on node
thelovekesh Oct 24, 2023
16b9f66
Update `OptimizeHeroImages::generateImg()` test cases
thelovekesh Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Html/Attribute.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,7 @@ interface Attribute
const EXTRA_SPACE = 'extra-space';
const FALLBACK = 'fallback';
const FETCH_ERROR = 'fetch-error';
const FETCHPRIORITY = 'fetchpriority';
const FILL = 'fill';
const FILL_OPACITY = 'fill-opacity';
const FILL_RULE = 'fill-rule';
Expand Down
26 changes: 26 additions & 0 deletions src/Optimizer/Transformer/OptimizeHeroImages.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,13 @@ final class OptimizeHeroImages implements Transformer
*/
const NOSCRIPT_IMG_XPATH_QUERY = './noscript/img';

/**
* XPath query to relatively fetch all noscript > img[fetchpriority="high"] elements.
*
* @var string
*/
const NOSCRIPT_IMG_FETCHPRIORITY_HIGH_XPATH_QUERY = './noscript/img[@fetchpriority="high"]';

/**
* Regular expression pattern to extract the URL from a CSS background-image property.
*
Expand Down Expand Up @@ -215,6 +222,17 @@ private function findHeroImages(Document $document, $maxHeroImageCount)
$seenParagraphCount++;
}

if ($node->tagName === Extension::IMG && ! $node->hasAttribute(Attribute::DATA_HERO)) {
$highFetchpriorityImage = $document->xpath->query(
self::NOSCRIPT_IMG_FETCHPRIORITY_HIGH_XPATH_QUERY,
$node
)->item(0);

if ($highFetchpriorityImage instanceof Element) {
$node->setAttribute(Attribute::DATA_HERO, '');
thelovekesh marked this conversation as resolved.
Show resolved Hide resolved
}
}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this logic in place, we won't need to add data-hero to images with high fetch priority in AMP Image sanitizer.


$heroImage = $this->detectImageWithAttribute($node, Attribute::DATA_HERO);
if ($heroImage) {
westonruter marked this conversation as resolved.
Show resolved Hide resolved
$heroImages[] = $heroImage;
Expand Down Expand Up @@ -566,6 +584,14 @@ private function generateImg(HeroImage $heroImage, Document $document)
$imgElement->setAttribute(Attribute::LOADING, $noscript_img->getAttribute(Attribute::LOADING));
}

// Preserve the original fetchpriority attribute from the noscript fallback img.
if ($noscript_img->hasAttribute(Attribute::FETCHPRIORITY)) {
$imgElement->setAttribute(
Attribute::FETCHPRIORITY,
$noscript_img->getAttribute(Attribute::FETCHPRIORITY)
);
}

// Remove any noscript>img when an amp-img is pre-rendered.
$noscript_img->parentNode->parentNode->removeChild($noscript_img->parentNode);
} elseif (! $this->isMarkedAsHeroImage($element)) {
Expand Down
22 changes: 22 additions & 0 deletions tests/Optimizer/Transformer/OptimizeHeroImagesTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,28 @@ public function dataTransform()
. '</amp-story-player>'
),
],

'preserves fetchpriority attribute from noscript fallback img' => [
$input(
'<amp-img width="500" height="400" src="/img1.png"><noscript><img src="/img1.png" width="500" height="400" fetchpriority="high"></noscript></amp-img>'
),
$output(
'<amp-img data-hero width="500" height="400" src="/img1.png" i-amphtml-ssr><img class="i-amphtml-fill-content i-amphtml-replaced-content" decoding="async" fetchpriority="high" src="/img1.png"></amp-img>'
),
],

Comment on lines +345 to +353
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I right that this test is somewhat redundant with the second?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the test cases in 16b9f66

'automatically ssr img element with high fetchpriority attribute from noscript fallback img' => [
$input(
'<amp-img width="500" height="400" src="/img1.png"><noscript><img src="/img1.png" width="500" height="400" fetchpriority="high"></noscript></amp-img>'
. '<amp-img width="500" height="400" src="/img2.png"><noscript><img src="/img2.png" width="500" height="400"></noscript></amp-img>'
. '<amp-img width="500" height="400" src="/img3.png"><noscript><img src="/img3.png" width="500" height="400" fetchpriority="high"></noscript></amp-img>'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the second image, how about adding data-hero to it to see what happens when preceded by a fetchpriority=high image, and then the third image can have neither data-hero nor fetchpriority (as really the source markup shouldn't have multiple fetchpriority=high.

),
$output(
'<amp-img data-hero width="500" height="400" src="/img1.png" i-amphtml-ssr><img class="i-amphtml-fill-content i-amphtml-replaced-content" decoding="async" fetchpriority="high" src="/img1.png"></amp-img>'
. '<amp-img width="500" height="400" src="/img2.png"><noscript><img src="/img2.png" width="500" height="400"></noscript></amp-img>'
. '<amp-img data-hero width="500" height="400" src="/img3.png" i-amphtml-ssr><img class="i-amphtml-fill-content i-amphtml-replaced-content" decoding="async" fetchpriority="high" src="/img3.png"></amp-img>'
),
],
];
}

Expand Down
Loading