Update the trigger page cache validation function to remove from class and add it separate method

Author: hbhalodia

plugins/optimization-detective/detection.php

@@ -176,15 +176,47 @@ function od_register_rest_url_metric_store_endpoint(): void {
 }
 
 /**
- * Triggers the page cache invalidation action for Optimization Detective.
+ * Triggers actions for page caches to invalidate their caches related to the supplied cache purge post ID.
+ *
+ * This is intended to flush any page cache for the URL after the new URL Metric was submitted so that the optimizations
+ * which depend on that URL Metric can start to take effect.
  *
  * @since n.e.x.t
- * @access private
  *
  * @param positive-int $cache_purge_post_id Cache purge post ID.
  */
-function od_trigger_page_cache_invalidation_callback( int $cache_purge_post_id ): void {
+function od_handle_trigger_page_cache_invalidation( int $cache_purge_post_id ): void {
 
-	$endpoint_controller = new OD_REST_URL_Metrics_Store_Endpoint();
-	$endpoint_controller->trigger_page_cache_invalidation( $cache_purge_post_id );
+	$post = get_post( $cache_purge_post_id );
+	if ( ! ( $post instanceof WP_Post ) ) {
+		return;
+	}
+
+	// Fire actions that page caching plugins listen to flush caches.
+
+	/*
+	* The clean_post_cache action is used to flush page caches by:
+	* - Pantheon Advanced Cache <https://github.com/pantheon-systems/pantheon-advanced-page-cache/blob/e3b5552b0cb9268d9b696cb200af56cc044920d9/pantheon-advanced-page-cache.php#L185>
+	* - WP Super Cache <https://github.com/Automattic/wp-super-cache/blob/73b428d2fce397fd874b3056ad3120c343bc1a0c/wp-cache-phase2.php#L1615>
+	* - Batcache <https://github.com/Automattic/batcache/blob/ed0e6b2d9bcbab3924c49a6c3247646fb87a0957/batcache.php#L18>
+	*/
+	/** This action is documented in wp-includes/post.php. */
+	do_action( 'clean_post_cache', $post->ID, $post );
+
+	/*
+	* The transition_post_status action is used to flush page caches by:
+	* - Jetpack Boost <https://github.com/Automattic/jetpack-boost-production/blob/4090a3f9414c2171cd52d8a397f00b0d1151475f/app/modules/optimizations/page-cache/pre-wordpress/Boost_Cache.php#L76>
+	* - WP Super Cache <https://github.com/Automattic/wp-super-cache/blob/73b428d2fce397fd874b3056ad3120c343bc1a0c/wp-cache-phase2.php#L1616>
+	* - LightSpeed Cache <https://github.com/litespeedtech/lscache_wp/blob/7c707469b3c88b4f45d9955593b92f9aeaed54c3/src/purge.cls.php#L68>
+	*/
+	/** This action is documented in wp-includes/post.php. */
+	do_action( 'transition_post_status', $post->post_status, $post->post_status, $post );
+
+	/*
+	* The clean_post_cache action is used to flush page caches by:
+	* - W3 Total Cache <https://github.com/BoldGrid/w3-total-cache/blob/ab08f104294c6a8dcb00f1c66aaacd0615c42850/Util_AttachToActions.php#L32>
+	* - WP Rocket <https://github.com/wp-media/wp-rocket/blob/e5bca6673a3669827f3998edebc0c785210fe561/inc/common/purge.php#L283>
+	*/
+	/** This action is documented in wp-includes/post.php. */
+	do_action( 'save_post', $post->ID, $post, /* $update */ true );
 }

plugins/optimization-detective/hooks.php

@@ -25,5 +25,5 @@
 add_action( 'admin_init', 'od_maybe_run_rest_api_health_check' );
 add_action( 'after_plugin_row_meta', 'od_render_rest_api_health_check_admin_notice_in_plugin_row', 30 );
 add_action( 'rest_api_init', 'od_register_rest_url_metric_store_endpoint' );
-add_action( 'od_trigger_page_cache_invalidation', 'od_trigger_page_cache_invalidation_callback' );
+add_action( 'od_trigger_page_cache_invalidation', 'od_handle_trigger_page_cache_invalidation' );
 // @codeCoverageIgnoreEnd

plugins/optimization-detective/storage/class-od-rest-url-metrics-store-endpoint.php

@@ -299,49 +299,4 @@ public function handle_rest_request( WP_REST_Request $request ) {
 			)
 		);
 	}
-
-	/**
-	 * Triggers actions for page caches to invalidate their caches related to the supplied cache purge post ID.
-	 *
-	 * This is intended to flush any page cache for the URL after the new URL Metric was submitted so that the optimizations
-	 * which depend on that URL Metric can start to take effect.
-	 *
-	 * @since n.e.x.t
-	 *
-	 * @param positive-int $cache_purge_post_id Cache purge post ID.
-	 */
-	public function trigger_page_cache_invalidation( int $cache_purge_post_id ): void {
-		$post = get_post( $cache_purge_post_id );
-		if ( ! ( $post instanceof WP_Post ) ) {
-			return;
-		}
-
-		// Fire actions that page caching plugins listen to flush caches.
-
-		/*
-		* The clean_post_cache action is used to flush page caches by:
-		* - Pantheon Advanced Cache <https://github.com/pantheon-systems/pantheon-advanced-page-cache/blob/e3b5552b0cb9268d9b696cb200af56cc044920d9/pantheon-advanced-page-cache.php#L185>
-		* - WP Super Cache <https://github.com/Automattic/wp-super-cache/blob/73b428d2fce397fd874b3056ad3120c343bc1a0c/wp-cache-phase2.php#L1615>
-		* - Batcache <https://github.com/Automattic/batcache/blob/ed0e6b2d9bcbab3924c49a6c3247646fb87a0957/batcache.php#L18>
-		*/
-		/** This action is documented in wp-includes/post.php. */
-		do_action( 'clean_post_cache', $post->ID, $post );
-
-		/*
-		* The transition_post_status action is used to flush page caches by:
-		* - Jetpack Boost <https://github.com/Automattic/jetpack-boost-production/blob/4090a3f9414c2171cd52d8a397f00b0d1151475f/app/modules/optimizations/page-cache/pre-wordpress/Boost_Cache.php#L76>
-		* - WP Super Cache <https://github.com/Automattic/wp-super-cache/blob/73b428d2fce397fd874b3056ad3120c343bc1a0c/wp-cache-phase2.php#L1616>
-		* - LightSpeed Cache <https://github.com/litespeedtech/lscache_wp/blob/7c707469b3c88b4f45d9955593b92f9aeaed54c3/src/purge.cls.php#L68>
-		*/
-		/** This action is documented in wp-includes/post.php. */
-		do_action( 'transition_post_status', $post->post_status, $post->post_status, $post );
-
-		/*
-		* The clean_post_cache action is used to flush page caches by:
-		* - W3 Total Cache <https://github.com/BoldGrid/w3-total-cache/blob/ab08f104294c6a8dcb00f1c66aaacd0615c42850/Util_AttachToActions.php#L32>
-		* - WP Rocket <https://github.com/wp-media/wp-rocket/blob/e5bca6673a3669827f3998edebc0c785210fe561/inc/common/purge.php#L283>
-		*/
-		/** This action is documented in wp-includes/post.php. */
-		do_action( 'save_post', $post->ID, $post, /* $update */ true );
-	}
 }

plugins/optimization-detective/tests/storage/test-class-od-rest-url-metrics-store-endpoint.php

@@ -74,7 +74,6 @@ static function ( array $properties ) use ( $property_name ): array {
 	 *
 	 * @covers OD_REST_URL_Metrics_Store_Endpoint::get_registration_args
 	 * @covers OD_REST_URL_Metrics_Store_Endpoint::handle_rest_request
-	 * @covers OD_REST_URL_Metrics_Store_Endpoint::trigger_page_cache_invalidation
 	 * @covers OD_Strict_URL_Metric::set_additional_properties_to_false
 	 * @covers OD_URL_Metric_Store_Request_Context::__construct
 	 * @covers OD_URL_Metric_Store_Request_Context::__get
@@ -144,7 +143,7 @@ function ( OD_URL_Metric_Store_Request_Context $context ) use ( &$stored_context
 
 		$this->assertInstanceOf( OD_URL_Metric_Store_Request_Context::class, $stored_context );
 
-		// Now check that trigger_page_cache_invalidation() cleaned caches as expected.
+		// Now check that od_handle_trigger_page_cache_invalidation() cleaned caches as expected.
 		$this->assertSame( $url_metrics[0]->jsonSerialize(), $stored_context->url_metric->jsonSerialize() );
 		if ( isset( $valid_params['cache_purge_post_id'] ) ) {
 			$cache_purge_post_id = $stored_context->request->get_param( 'cache_purge_post_id' );
@@ -784,80 +783,6 @@ static function () use ( $breakpoint_width ): array {
 		$this->assertSame( 403, $response->get_status(), 'Response: ' . wp_json_encode( $response->get_data() ) );
 	}
 
-	/**
-	 * Test trigger_page_cache_invalidation().
-	 *
-	 * @covers OD_REST_URL_Metrics_Store_Endpoint::trigger_page_cache_invalidation
-	 */
-	public function test_trigger_page_cache_invalidation(): void {
-		$cache_purge_post_id = self::factory()->post->create();
-
-		$all_hook_callback_args = array();
-		add_action(
-			'all',
-			static function ( string $hook, ...$args ) use ( &$all_hook_callback_args ): void {
-				$all_hook_callback_args[ $hook ][] = $args;
-			},
-			10,
-			PHP_INT_MAX
-		);
-
-		$url_metric_endpoint = new OD_REST_URL_Metrics_Store_Endpoint();
-		$url_metric_endpoint->trigger_page_cache_invalidation( $cache_purge_post_id );
-
-		$this->assertArrayHasKey( 'clean_post_cache', $all_hook_callback_args );
-		$found = false;
-		foreach ( $all_hook_callback_args['clean_post_cache'] as $args ) {
-			if ( $args[0] === $cache_purge_post_id ) {
-				$this->assertInstanceOf( WP_Post::class, $args[1] );
-				$this->assertSame( $cache_purge_post_id, $args[1]->ID );
-				$found = true;
-			}
-		}
-		$this->assertTrue( $found, 'Expected clean_post_cache to have been fired for the post queried object.' );
-
-		$this->assertArrayHasKey( 'transition_post_status', $all_hook_callback_args );
-		$found = false;
-		foreach ( $all_hook_callback_args['transition_post_status'] as $args ) {
-			$this->assertInstanceOf( WP_Post::class, $args[2] );
-			if ( $args[2]->ID === $cache_purge_post_id ) {
-				$this->assertSame( $args[2]->post_status, $args[0] );
-				$this->assertSame( $args[2]->post_status, $args[1] );
-				$found = true;
-			}
-		}
-		$this->assertTrue( $found, 'Expected transition_post_status to have been fired for the post queried object.' );
-
-		$this->assertArrayHasKey( 'save_post', $all_hook_callback_args );
-		$found = false;
-		foreach ( $all_hook_callback_args['save_post'] as $args ) {
-			if ( $args[0] === $cache_purge_post_id ) {
-				$this->assertInstanceOf( WP_Post::class, $args[1] );
-				$this->assertSame( $cache_purge_post_id, $args[1]->ID );
-				$found = true;
-			}
-		}
-		$this->assertTrue( $found, 'Expected save_post to have been fired for the post queried object.' );
-	}
-
-	/**
-	 * Test trigger_page_cache_invalidation() for an invalid post.
-	 *
-	 * @covers OD_REST_URL_Metrics_Store_Endpoint::trigger_page_cache_invalidation
-	 * @covers ::od_trigger_page_cache_invalidation_callback
-	 */
-	public function test_trigger_page_cache_invalidation_invalid_post_id(): void {
-		wp_delete_post( 1, true );
-		$before_clean_post_cache_count       = did_action( 'clean_post_cache' );
-		$before_transition_post_status_count = did_action( 'transition_post_status' );
-		$before_save_post_count              = did_action( 'save_post' );
-		$url_metric_endpoint                 = new OD_REST_URL_Metrics_Store_Endpoint();
-		$url_metric_endpoint->trigger_page_cache_invalidation( 1 );
-		$this->assertSame( $before_clean_post_cache_count, did_action( 'clean_post_cache' ) );
-		$this->assertSame( $before_transition_post_status_count, did_action( 'transition_post_status' ) );
-		$this->assertSame( $before_save_post_count, did_action( 'save_post' ) );
-	}
-
 	/**
 	 * Populate URL Metrics.
 	 *

plugins/optimization-detective/tests/test-detection.php

@@ -236,4 +236,75 @@ public function od_register_rest_url_metric_store_endpoint(): void {
 		$routes = rest_get_server()->get_routes();
 		$this->assertArrayHasKey( '/' . OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE . OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE, $routes );
 	}
+
+	/**
+	 * Test od_handle_trigger_page_cache_invalidation().
+	 *
+	 * @covers ::od_handle_trigger_page_cache_invalidation
+	 */
+	public function test_trigger_page_cache_invalidation(): void {
+		$cache_purge_post_id = self::factory()->post->create();
+
+		$all_hook_callback_args = array();
+		add_action(
+			'all',
+			static function ( string $hook, ...$args ) use ( &$all_hook_callback_args ): void {
+				$all_hook_callback_args[ $hook ][] = $args;
+			},
+			10,
+			PHP_INT_MAX
+		);
+
+		od_handle_trigger_page_cache_invalidation( $cache_purge_post_id );
+
+		$this->assertArrayHasKey( 'clean_post_cache', $all_hook_callback_args );
+		$found = false;
+		foreach ( $all_hook_callback_args['clean_post_cache'] as $args ) {
+			if ( $args[0] === $cache_purge_post_id ) {
+				$this->assertInstanceOf( WP_Post::class, $args[1] );
+				$this->assertSame( $cache_purge_post_id, $args[1]->ID );
+				$found = true;
+			}
+		}
+		$this->assertTrue( $found, 'Expected clean_post_cache to have been fired for the post queried object.' );
+
+		$this->assertArrayHasKey( 'transition_post_status', $all_hook_callback_args );
+		$found = false;
+		foreach ( $all_hook_callback_args['transition_post_status'] as $args ) {
+			$this->assertInstanceOf( WP_Post::class, $args[2] );
+			if ( $args[2]->ID === $cache_purge_post_id ) {
+				$this->assertSame( $args[2]->post_status, $args[0] );
+				$this->assertSame( $args[2]->post_status, $args[1] );
+				$found = true;
+			}
+		}
+		$this->assertTrue( $found, 'Expected transition_post_status to have been fired for the post queried object.' );
+
+		$this->assertArrayHasKey( 'save_post', $all_hook_callback_args );
+		$found = false;
+		foreach ( $all_hook_callback_args['save_post'] as $args ) {
+			if ( $args[0] === $cache_purge_post_id ) {
+				$this->assertInstanceOf( WP_Post::class, $args[1] );
+				$this->assertSame( $cache_purge_post_id, $args[1]->ID );
+				$found = true;
+			}
+		}
+		$this->assertTrue( $found, 'Expected save_post to have been fired for the post queried object.' );
+	}
+
+	/**
+	 * Test od_handle_trigger_page_cache_invalidation() for an invalid post.
+	 *
+	 * @covers ::od_handle_trigger_page_cache_invalidation
+	 */
+	public function test_trigger_page_cache_invalidation_invalid_post_id(): void {
+		wp_delete_post( 1, true );
+		$before_clean_post_cache_count       = did_action( 'clean_post_cache' );
+		$before_transition_post_status_count = did_action( 'transition_post_status' );
+		$before_save_post_count              = did_action( 'save_post' );
+		od_handle_trigger_page_cache_invalidation( 1 );
+		$this->assertSame( $before_clean_post_cache_count, did_action( 'clean_post_cache' ) );
+		$this->assertSame( $before_transition_post_status_count, did_action( 'transition_post_status' ) );
+		$this->assertSame( $before_save_post_count, did_action( 'save_post' ) );
+	}
 }