Shortpixel Image Optimizer Incompatibility

.phpstorm.meta.php

@@ -30,6 +30,7 @@
 			'integrations.cfi'             => \Google\Web_Stories\Integrations\Conditional_Featured_Image::class,
 			'integrations.sitekit'         => \Google\Web_Stories\Integrations\Site_Kit::class,
 			'integrations.themes_support'  => \Google\Web_Stories\Integrations\Core_Themes_Support::class,
+			'integrations.shortpixel'         => \Google\Web_Stories\Integrations\ShortPixel::class,
 			'imgareaselect_patch'          => \Google\Web_Stories\Admin\ImgAreaSelect_Patch::class,
 			'kses'                         => \Google\Web_Stories\KSES::class,
 			'media.base_color'             => \Google\Web_Stories\Media\Base_Color::class,

includes/Integrations/ShortPixel.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * Class ShortPixel.
+ *
+ * @link      https://github.com/googleforcreators/web-stories-wp
+ *
+ * @copyright 2022 Google LLC
+ * @license   https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
+ */
+
+/**
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Google\Web_Stories\Integrations;
+
+use Google\Web_Stories\Service_Base;
+
+/**
+ * Class ShortPixel
+ */
+class ShortPixel extends Service_Base {
+
+	/**
+	 * Runs on instantiation.
+	 *
+	 * @since 1.23.0
+	 */
+	public function register(): void {
+		add_filter( 'shortpixel_image_urls', [ $this, 'image_urls' ], 10, 1 );
+	}
+
+	/**
+	 * Ensures page template urls bypass optimisation.
+	 *
+	 * @since 1.23.0
+	 *
+	 * @param string[] $urls  Urls that will be sent to optimisation.
+	 * @return string[] The filtered Urls.
+	 */
+	public function image_urls( $urls ): array {
+		if ( false !== strpos( $urls[0], 'web-stories-page-template' ) ) {
+			return [];
+		}
+		return $urls;
+	}
+}

includes/Plugin.php

@@ -85,6 +85,7 @@ class Plugin extends ServiceBasedPlugin {
 		'integrations.cfi'             => Integrations\Conditional_Featured_Image::class,
 		'integrations.sitekit'         => Integrations\Site_Kit::class,
 		'integrations.themes_support'  => Integrations\Core_Themes_Support::class,
+		'integrations.shortpixel'      => Integrations\ShortPixel::class,
 		'imgareaselect_patch'          => Admin\ImgAreaSelect_Patch::class,
 		'kses'                         => KSES::class,
 		'font_post_type'               => Font_Post_Type::class,

tests/phpunit/integration/tests/Integrations/ShortPixel.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Google\Web_Stories\Tests\Integration\Integrations;
+
+use Google\Web_Stories\Tests\Integration\TestCase;
+
+/**
+ * @coversDefaultClass \Google\Web_Stories\Integrations\ShortPixel
+ */
+class ShortPixel extends TestCase {
+	/**
+	 * @covers ::register
+	 */
+	public function test_register(): void {
+		$short_pixel = new \Google\Web_Stories\Integrations\ShortPixel();
+		$short_pixel->register();
+		$this->assertSame( 10, has_filter( 'shortpixel_image_urls', [ $short_pixel, 'image_urls' ] ) );
+	}
+
+	/**
+	 * @covers ::image_urls
+	 */
+	public function test_image_urls(): void {
+		$short_pixel = new \Google\Web_Stories\Integrations\ShortPixel();
+		$urls        = [ 'http://localhost:8899/wp-content/uploads/2022/03/web-stories-page-template-768.jpg' ];
+		$result      = $short_pixel->image_urls( $urls, 10 );
+		$this->assertEqualSets( [], $result );
+	}
+
+	/**
+	 * @covers ::image_urls
+	 */
+	public function test_image_urls_non_page_template_image(): void {
+		$short_pixel = new \Google\Web_Stories\Integrations\ShortPixel();
+		/* given a non "page-template" image the urls should pass thru */
+		$urls   = [ 'http://localhost:8899/wp-content/uploads/2022/03/example-750.jpg' ];
+		$result = $short_pixel->image_urls( $urls, 10 );
+		$this->assertEqualSets( $urls, $result );
+	}
+}