Remove the static method from the class and updated to use the constant

Author: hbhalodia

plugins/image-prioritizer/helper.php

@@ -297,7 +297,7 @@ function image_prioritizer_filter_rest_request_before_callbacks( $response, arra
 
 	// Check for class existence and use constant or class method calls accordingly.
 	$route_endpoint = class_exists( 'OD_REST_URL_Metrics_Store_Endpoint' )
-						? OD_REST_URL_Metrics_Store_Endpoint::get_namespace() . OD_REST_URL_Metrics_Store_Endpoint::get_route()
+						? OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE . OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE
 						: OD_REST_API_NAMESPACE . OD_URL_METRICS_ROUTE; // @phpstan-ignore constant.deprecated, constant.deprecated (To be replaced with class method calls in subsequent release.)
 
 	if (

plugins/image-prioritizer/tests/test-helper.php

@@ -727,7 +727,7 @@ public function data_provider_to_test_image_prioritizer_filter_rest_request_befo
 		};
 
 		$create_request = static function ( array $url_metric_data ): WP_REST_Request {
-			$request = new WP_REST_Request( 'POST', '/' . OD_REST_URL_Metrics_Store_Endpoint::get_namespace() . OD_REST_URL_Metrics_Store_Endpoint::get_route() );
+			$request = new WP_REST_Request( 'POST', '/' . OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE . OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE );
 			$request->set_header( 'content-type', 'application/json' );
 			$request->set_body( wp_json_encode( $url_metric_data ) );
 			return $request;

plugins/optimization-detective/deprecated.php

@@ -17,7 +17,7 @@
  *
  * @since 0.1.0
  * @access private
- * @deprecated n.e.x.t This constant should not be used, instead use OD_REST_URL_Metrics_Store_Endpoint::get_namespace() method.
+ * @deprecated n.e.x.t This constant should not be used, instead use OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE method.
  * @var string
  */
 const OD_REST_API_NAMESPACE = 'optimization-detective/v1';
@@ -32,7 +32,7 @@
  * @since 0.1.0
  * @access private
  * @link https://google.aip.dev/136
- * @deprecated n.e.x.t This constant should not be used, instead use OD_REST_URL_Metrics_Store_Endpoint::get_route() method.
+ * @deprecated n.e.x.t This constant should not be used, instead use OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE method.
  * @var string
  */
 const OD_URL_METRICS_ROUTE = '/url-metrics:store';

plugins/optimization-detective/detection.php

@@ -121,7 +121,7 @@ function od_get_detection_script( string $slug, OD_URL_Metric_Group_Collection $
 		'maxViewportAspectRatio' => od_get_maximum_viewport_aspect_ratio(),
 		'isDebug'                => WP_DEBUG,
 		'extensionModuleUrls'    => $extension_module_urls,
-		'restApiEndpoint'        => rest_url( OD_REST_URL_Metrics_Store_Endpoint::get_namespace() . OD_REST_URL_Metrics_Store_Endpoint::get_route() ),
+		'restApiEndpoint'        => rest_url( OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE . OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE ),
 		'currentETag'            => $current_etag,
 		'currentUrl'             => $current_url,
 		'urlMetricSlug'          => $slug,
@@ -169,8 +169,22 @@ function od_register_rest_url_metric_store_endpoint(): void {
 	$endpoint_controller = new OD_REST_URL_Metrics_Store_Endpoint();
 
 	register_rest_route(
-		$endpoint_controller::get_namespace(),
-		$endpoint_controller::get_route(),
+		$endpoint_controller::REST_API_NAMESPACE,
+		$endpoint_controller::REST_API_ROUTE,
 		$endpoint_controller->get_registration_args()
 	);
 }
+
+/**
+ * Triggers the page cache invalidation action for Optimization Detective.
+ *
+ * @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 {
+
+	$endpoint_controller = new OD_REST_URL_Metrics_Store_Endpoint();
+	$endpoint_controller->trigger_page_cache_invalidation( $cache_purge_post_id );
+}

plugins/optimization-detective/hooks.php

@@ -25,4 +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' );
 // @codeCoverageIgnoreEnd

plugins/optimization-detective/site-health.php

@@ -91,7 +91,7 @@ function od_compose_site_health_result( $response ): array {
 		sprintf(
 			/* translators: %s is the REST API endpoint */
 			__( 'To collect URL Metrics from visitors the REST API must be available to unauthenticated users. Specifically, visitors must be able to perform a <code>POST</code> request to the <code>%s</code> endpoint.', 'optimization-detective' ),
-			'/' . OD_REST_URL_Metrics_Store_Endpoint::get_namespace() . OD_REST_URL_Metrics_Store_Endpoint::get_route()
+			'/' . OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE . OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE
 		),
 		array( 'code' => array() )
 	) . '</p>';
@@ -192,7 +192,7 @@ function od_get_rest_api_health_check_response( bool $use_cached ) {
 	if ( false !== $response ) {
 		return $response;
 	}
-	$rest_url = get_rest_url( null, OD_REST_URL_Metrics_Store_Endpoint::get_namespace() . OD_REST_URL_Metrics_Store_Endpoint::get_route() );
+	$rest_url = get_rest_url( null, OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE . OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE );
 	$response = wp_remote_post(
 		$rest_url,
 		array(

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

@@ -21,31 +21,25 @@
 final class OD_REST_URL_Metrics_Store_Endpoint {
 
 	/**
-	 * Gets the namespace for the REST API endpoint.
+	 * Namespace for the REST API endpoint.
 	 *
 	 * @since n.e.x.t
-	 *
-	 * @return non-empty-string Namespace.
+	 * @var string
 	 */
-	public static function get_namespace(): string {
-		return OD_REST_API_NAMESPACE; // @phpstan-ignore constant.deprecated (To be replaced with string literal when constant is removed.)
-	}
+	const REST_API_NAMESPACE = 'optimization-detective/v1';
 
 	/**
-	 * Gets the route for storing a URL Metric.
+	 * Route for storing a URL Metric.
 	 *
 	 * Note the `:store` art of the endpoint follows Google's guidance in AIP-136 for the use of the POST method in a way
 	 * that does not strictly follow the standard usage. Namely, submitting a POST request to this endpoint will either
 	 * create a new `od_url_metrics` post, or it will update an existing post if one already exists for the provided slug.
 	 *
 	 * @since n.e.x.t
 	 * @link https://google.aip.dev/136
-	 *
-	 * @return non-empty-string Route.
+	 * @var string
 	 */
-	public static function get_route(): string {
-		return OD_URL_METRICS_ROUTE; // @phpstan-ignore constant.deprecated (To be replaced with string literal when constant is removed.)
-	}
+	const REST_API_ROUTE = '/url-metrics:store';
 
 	/**
 	 * Gets the arguments for registering the endpoint.
@@ -316,7 +310,7 @@ public function handle_rest_request( WP_REST_Request $request ) {
 	 *
 	 * @param positive-int $cache_purge_post_id Cache purge post ID.
 	 */
-	public static function trigger_page_cache_invalidation( int $cache_purge_post_id ): void {
+	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;

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

@@ -19,33 +19,7 @@ class Test_OD_REST_URL_Metrics_Store_Endpoint extends WP_UnitTestCase {
 	 * @return string Route.
 	 */
 	private function get_route(): string {
-		return '/' . OD_REST_URL_Metrics_Store_Endpoint::get_namespace() . OD_REST_URL_Metrics_Store_Endpoint::get_route();
-	}
-
-	/**
-	 * Test get_namespace().
-	 *
-	 * @covers OD_REST_URL_Metrics_Store_Endpoint::get_namespace
-	 */
-	public function test_get_namespace(): void {
-
-		$expected = 'optimization-detective/v1';
-		$actual   = OD_REST_URL_Metrics_Store_Endpoint::get_namespace();
-
-		$this->assertSame( $expected, $actual );
-	}
-
-	/**
-	 * Test get_route().
-	 *
-	 * @covers OD_REST_URL_Metrics_Store_Endpoint::get_route
-	 */
-	public function test_get_route(): void {
-
-		$expected = '/url-metrics:store';
-		$actual   = OD_REST_URL_Metrics_Store_Endpoint::get_route();
-
-		$this->assertSame( $expected, $actual );
+		return '/' . OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE . OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE;
 	}
 
 	/**
@@ -828,7 +802,8 @@ static function ( string $hook, ...$args ) use ( &$all_hook_callback_args ): voi
 			PHP_INT_MAX
 		);
 
-		OD_REST_URL_Metrics_Store_Endpoint::trigger_page_cache_invalidation( $cache_purge_post_id );
+		$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;
@@ -869,13 +844,15 @@ static function ( string $hook, ...$args ) use ( &$all_hook_callback_args ): voi
 	 * 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' );
-		OD_REST_URL_Metrics_Store_Endpoint::trigger_page_cache_invalidation( 1 );
+		$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' ) );

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

@@ -234,6 +234,6 @@ public function test_od_get_detection_script_returns_script( Closure $set_up, ar
 	public function od_register_rest_url_metric_store_endpoint(): void {
 
 		$routes = rest_get_server()->get_routes();
-		$this->assertArrayHasKey( '/' . OD_REST_URL_Metrics_Store_Endpoint::get_namespace() . OD_REST_URL_Metrics_Store_Endpoint::get_route(), $routes );
+		$this->assertArrayHasKey( '/' . OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE . OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE, $routes );
 	}
 }

plugins/optimization-detective/tests/test-site-health.php

@@ -420,7 +420,7 @@ protected function filter_rest_api_response( $mocked_response ): object {
 		add_filter(
 			'pre_http_request',
 			static function ( $pre, array $args, string $url ) use ( $mocked_response, $observer ) {
-				if ( rest_url( OD_REST_URL_Metrics_Store_Endpoint::get_namespace() . OD_REST_URL_Metrics_Store_Endpoint::get_route() ) === $url ) {
+				if ( rest_url( OD_REST_URL_Metrics_Store_Endpoint::REST_API_NAMESPACE . OD_REST_URL_Metrics_Store_Endpoint::REST_API_ROUTE ) === $url ) {
 					$observer->counter++;
 					return $mocked_response;
 				}