Implement speculative prerendering

.phpstorm.meta.php

@@ -85,6 +85,7 @@
 			'remove_transients'            => \Google\Web_Stories\Remove_Transients::class,
 			'web_stories_block'            => \Google\Web_Stories\Block\Web_Stories_Block::class,
 			'injector'                     => \Google\Web_Stories\Infrastructure\Injector::class,
+			'speculative_prerendering'     => \Google\Web_Stories\Speculative_Prerendering::class,
 		] )
 	);
 

includes/Plugin.php

@@ -140,6 +140,7 @@ class Plugin extends ServiceBasedPlugin {
 		'user_preferences'             => User\Preferences::class,
 		'remove_transients'            => Remove_Transients::class,
 		'web_stories_block'            => Block\Web_Stories_Block::class,
+		'speculative_prerendering'     => Speculative_Prerendering::class,
 	];
 
 	/**
@@ -192,6 +193,7 @@ protected function get_shared_instances(): array {
 			Settings::class,
 			Stories_Script_Data::class,
 			User\Preferences::class,
+			Admin\Dashboard::class,
 		];
 	}
 

includes/Speculative_Prerendering.php

@@ -0,0 +1,168 @@
+<?php
+/**
+ * Class Speculative_Prerendering
+ *
+ * @link      https://github.com/googleforcreators/web-stories-wp
+ *
+ * @copyright 2024 Google LLC
+ * @license   https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
+ */
+
+/**
+ * Copyright 2024 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.
+ */
+
+declare(strict_types = 1);
+
+namespace Google\Web_Stories;
+
+use Google\Web_Stories\Admin\Dashboard;
+
+/**
+ * Speculative_Prerendering class.
+ */
+class Speculative_Prerendering extends Service_Base {
+	/**
+	 * Context instance.
+	 *
+	 * @var Context Context instance.
+	 */
+	private Context $context;
+
+	/**
+	 * Story_Post_Type instance.
+	 *
+	 * @var Story_Post_Type Story_Post_Type instance.
+	 */
+	private Story_Post_Type $story_post_type;
+
+	/**
+	 * Dashboard instance.
+	 *
+	 * @var Dashboard Dashboard instance.
+	 */
+	private Dashboard $dashboard;
+
+	/**
+	 * Speculative_Prerendering constructor.
+	 *
+	 * @param Context         $context          Context instance.
+	 * @param Story_Post_Type $story_post_type  Story_Post_Type instance.
+	 * @param Dashboard       $dashboard        Dashboard instance.
+	 */
+	public function __construct( Context $context, Story_Post_Type $story_post_type, Dashboard $dashboard ) {
+		$this->context         = $context;
+		$this->story_post_type = $story_post_type;
+		$this->dashboard       = $dashboard;
+	}
+
+	/**
+	 * Runs on instantiation.
+	 */
+	public function register(): void {
+		add_action( 'admin_enqueue_scripts', [ $this, 'load_rules' ] );
+	}
+
+	/**
+	 * Loads the prerendering rules based on the current page.
+	 *
+	 * @param string $hook The current page hook.
+	 */
+	public function load_rules( string $hook ): void {
+		$rules = [];
+
+		$hook_suffix = $this->dashboard->get_hook_suffix( 'stories-dashboard' );
+		if ( false !== $hook_suffix && $hook_suffix === $hook ) {
+			$rules = $this->get_rules( 'dashboard' );
+		} elseif ( $this->story_post_type->get_slug() === $this->context->get_screen_post_type() && 'edit' === $this->context->get_screen_base() ) {
+			$rules = $this->get_rules( 'all_stories' );
+		}
+		$this->print_rules( $rules );
+	}
+
+	/**
+	 * Retrieves the prerendering rules for a specific page.
+	 *
+	 * @param string $page The page identifier.
+	 * @return array An array containing prerendering rules.
+	 */
+	public function get_rules( string $page ): array {
+		$rules = [
+			[
+				'source'    => 'document',
+				'where'     => [
+					'and' => [
+						[
+							'href_matches' => $this->get_matches_for_page( $page ),
+						],
+					],
+				],
+				'eagerness' => 'moderate',
+			],
+		];
+
+		return [ 'prerender' => $rules ];
+	}
+
+	/**
+	 * Prints the prerendering rules as an inline script tag.
+	 *
+	 * @param array $rules The prerendering rules to print.
+	 */
+	public function print_rules( array $rules ): void {
+		if ( empty( $rules ) ) {
+			return;
+		}
+
+		$encoded_rules = wp_json_encode( $rules );
+
+		if ( false !== $encoded_rules ) {
+			wp_print_inline_script_tag( $encoded_rules, [ 'type' => 'speculationrules' ] );
+		}
+	}
+
+	/**
+	 * Generates the URL matches array for different pages.
+	 *
+	 * @return array The URL matches array containing URLs for different pages.
+	 */
+	private function generate_matches(): array {
+		$new_story_url  = sprintf(
+			'post-new.php?post_type=%s',
+			$this->story_post_type->get_slug()
+		);
+		$edit_story_url = 'post.php?post=*&action=edit';
+		$view_story_url = sprintf(
+			'/%s/*',
+			$this->story_post_type::REWRITE_SLUG
+		);
+
+		return [
+			'dashboard'   => [ $edit_story_url, $new_story_url ],
+			'all_stories' => [ $edit_story_url, $new_story_url, $view_story_url ],
+		];
+	}
+
+	/**
+	 * Retrieves the URL matches for the specified page.
+	 *
+	 * @param string $page The page for which to retrieve URL matches.
+	 * @return array The URL matches for the specified page.
+	 */
+	private function get_matches_for_page( string $page ): array {
+		$matches = $this->generate_matches();
+		return $matches[ $page ];
+	}
+}

tests/phpunit/integration/tests/Speculative_Prerendering.php

@@ -0,0 +1,176 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * 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;
+
+use Google\Web_Stories\Admin\Dashboard;
+use Google\Web_Stories\Context;
+use Google\Web_Stories\Story_Post_Type;
+use PHPUnit\Framework\MockObject\MockObject;
+
+/**
+ * @coversDefaultClass \Google\Web_Stories\Speculative_Prerendering
+ */
+class Speculative_Prerendering extends DependencyInjectedTestCase {
+	/**
+	 * @var Context & MockObject
+	 */
+	private $context;
+
+	/**
+	 * @var Story_Post_Type & MockObject
+	 */
+	private $story_post_type;
+
+	/**
+	 * @var Dashboard & MockObject
+	 */
+	private $dashboard;
+
+	protected \Google\Web_Stories\Speculative_Prerendering $instance;
+
+	public function set_up(): void {
+		parent::set_up();
+
+		$this->dashboard       = $this->createMock( Dashboard::class );
+		$this->story_post_type = $this->createMock( Story_Post_Type::class );
+		$this->context         = $this->createMock( Context::class );
+
+		$this->instance = new \Google\Web_Stories\Speculative_Prerendering(
+			$this->context,
+			$this->story_post_type,
+			$this->dashboard,
+		);
+	}
+
+	/**
+	 * @covers ::register
+	 */
+	public function test_register(): void {
+		$this->instance->register();
+		$this->assertSame( 10, has_action( 'admin_enqueue_scripts', [ $this->instance, 'load_rules' ] ) );
+	}
+
+	/**
+	 * @covers ::load_rules
+	 */
+	public function test_load_rules_dashboard(): void {
+		$this->dashboard->method( 'get_hook_suffix' )->willReturn( 'web-story_page_stories-dashboard' );
+
+		$prerendering_class = $this->getMockBuilder( \Google\Web_Stories\Speculative_Prerendering::class )
+		->onlyMethods( [ 'get_rules', 'print_rules' ] )
+		->setConstructorArgs( [ $this->context, $this->story_post_type, $this->dashboard ] )
+		->getMock();
+
+		$prerendering_class->expects( $this->once() )
+		->method( 'get_rules' )
+		->with( 'dashboard' );
+
+		$prerendering_class->expects( $this->once() )
+		->method( 'print_rules' );
+
+		$prerendering_class->load_rules( 'web-story_page_stories-dashboard' );
+	}
+
+	/**
+	 * @covers ::load_rules
+	 */
+	public function test_load_rules_all_stories(): void {
+		$this->story_post_type->method( 'get_slug' )->willReturn( 'web-story' );
+		$this->context->method( 'get_screen_post_type' )->willReturn( 'web-story' );
+		$this->context->method( 'get_screen_base' )->willReturn( 'edit' );
+
+		$prerendering_class = $this->getMockBuilder( \Google\Web_Stories\Speculative_Prerendering::class )
+			->onlyMethods( [ 'get_rules', 'print_rules' ] )
+			->setConstructorArgs( [ $this->context, $this->story_post_type, $this->dashboard ] )
+			->getMock();
+
+		$prerendering_class->expects( $this->once() )
+		->method( 'get_rules' )
+		->with( 'all_stories' );
+
+		$prerendering_class->expects( $this->once() )
+		->method( 'print_rules' );
+
+		$prerendering_class->load_rules( 'edit' );
+	}
+
+	/**
+	 * @covers ::get_rules
+	 */
+	public function test_get_rules_for_dashboard(): void {
+		$new_story_url  = sprintf(
+			'post-new.php?post_type=%s',
+			$this->story_post_type->get_slug()
+		);
+		$edit_story_url = 'post.php?post=*&action=edit';
+
+		$expected = [
+			'prerender' => [
+				[
+					'source'    => 'document',
+					'where'     => [
+						'and' => [
+							[
+								'href_matches' => [ $edit_story_url, $new_story_url ],
+							],
+						],
+					],
+					'eagerness' => 'moderate',
+				],
+			],
+		];
+
+		$this->assertEquals( $expected, $this->instance->get_rules( 'dashboard' ) );
+	}
+
+	/**
+	 * @covers ::get_rules
+	 */
+	public function test_get_rules_for_all_stories(): void {
+		$new_story_url  = sprintf(
+			'post-new.php?post_type=%s',
+			$this->story_post_type->get_slug()
+		);
+		$edit_story_url = 'post.php?post=*&action=edit';
+		$view_story_url = sprintf(
+			'/%s/*',
+			$this->story_post_type::REWRITE_SLUG
+		);
+
+		$expected = [
+			'prerender' => [
+				[
+					'source'    => 'document',
+					'where'     => [
+						'and' => [
+							[
+								'href_matches' => [ $edit_story_url, $new_story_url, $view_story_url ],
+							],
+						],
+					],
+					'eagerness' => 'moderate',
+				],
+			],
+		];
+
+		$this->assertEquals( $expected, $this->instance->get_rules( 'all_stories' ) );
+	}
+}