Fix the error feedbacks

1. Related to comments and common naming convention.

Author: hbhalodia

plugins/optimization-detective/detection.php

@@ -159,21 +159,18 @@ static function ( OD_URL_Metric_Group $group ): array {
 }
 
 /**
- * Create the rest request and register the endpoint routes for the URL Metrics Store.
+ * Registers the REST API endpoint for storing URL Metrics.
  *
  * @since n.e.x.t
+ * @access private
  */
-function od_create_rest_url_metric_store_rest_request(): void {
+function od_register_rest_url_metric_store_endpoint(): void {
 
 	$endpoint_controller = new OD_REST_URL_Metrics_Store_Endpoint();
-	$route_args          = $endpoint_controller->get_registration_args();
 
-	/**
-	 * Register the endpoint.
-	 */
 	register_rest_route(
 		$endpoint_controller::get_namespace(),
 		$endpoint_controller::get_route(),
-		$route_args
+		$endpoint_controller->get_registration_args()
 	);
 }

plugins/optimization-detective/hooks.php

@@ -24,5 +24,5 @@
 add_filter( 'site_status_tests', 'od_add_rest_api_availability_test' );
 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_create_rest_url_metric_store_rest_request' );
+add_action( 'rest_api_init', 'od_register_rest_url_metric_store_endpoint' );
 // @codeCoverageIgnoreEnd

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

@@ -16,15 +16,15 @@
  * OD_REST_URL_Metrics_Store_Endpoint class
  *
  * @since n.e.x.t
- *
  * @access private
  */
-class OD_REST_URL_Metrics_Store_Endpoint {
+final class OD_REST_URL_Metrics_Store_Endpoint {
 
 	/**
-	 * Get the namespace for optimization-detective
+	 * Gets the namespace for the REST API endpoint.
 	 *
 	 * @since n.e.x.t
+	 *
 	 * @return non-empty-string Namespace.
 	 */
 	public static function get_namespace(): string {
@@ -39,7 +39,6 @@ public static function get_namespace(): string {
 	 * 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.
@@ -49,7 +48,7 @@ public static function get_route(): string {
 	}
 
 	/**
-	 * Get the args for the URL Metric storage endpoint.
+	 * Gets the arguments for registering the endpoint.
 	 *
 	 * @since n.e.x.t
 	 *
@@ -100,18 +99,13 @@ public function get_registration_args(): array {
 			),
 		);
 
-		/**
-		 * Create route args.
-		 */
-		$route_args = array(
+		return array(
 			'methods'             => 'POST',
 			'args'                => array_merge(
 				$args,
 				rest_get_endpoint_args_for_schema( OD_Strict_URL_Metric::get_json_schema() )
 			),
-			'callback'            => static function ( WP_REST_Request $request ) {
-				return self::handle_rest_request( $request );
-			},
+			'callback'            => array( $this, 'handle_rest_request' ),
 			'permission_callback' => static function () {
 				// Needs to be available to unauthenticated visitors.
 				if ( OD_Storage_Lock::is_locked() ) {
@@ -124,8 +118,6 @@ public function get_registration_args(): array {
 				return true;
 			},
 		);
-
-		return $route_args;
 	}
 
 	/**
@@ -136,31 +128,28 @@ public function get_registration_args(): array {
 	 * the `is_allowed_http_origin()` function in core for some reason returns a string rather than a boolean.
 	 *
 	 * @since n.e.x.t
-	 *
 	 * @see is_allowed_http_origin()
 	 *
 	 * @param string $origin Origin to check.
-	 *
 	 * @return bool Whether the origin is allowed.
 	 */
-	private static function is_allowed_http_origin( string $origin ): bool {
+	protected static function is_allowed_http_origin( string $origin ): bool {
 		// Strip out the port number since core does not account for it yet as noted in get_allowed_http_origins().
 		$origin = preg_replace( '/:\d+$/', '', $origin );
 		return '' !== is_allowed_http_origin( $origin );
 	}
 
 	/**
-	 * Handles REST API request to store metrics.
+	 * Handles the REST API request to store a URL Metric.
 	 *
 	 * @since n.e.x.t
 	 *
 	 * @phpstan-param WP_REST_Request<array<string, mixed>> $request
 	 *
 	 * @param WP_REST_Request $request Request.
-	 *
 	 * @return WP_REST_Response|WP_Error Response.
 	 */
-	private static function handle_rest_request( WP_REST_Request $request ) {
+	public function handle_rest_request( WP_REST_Request $request ) {
 		// Block cross-origin storage requests since by definition URL Metrics data can only be sourced from the frontend of the site.
 		$origin = $request->get_header( 'origin' );
 		if ( null === $origin || ! self::is_allowed_http_origin( $origin ) ) {

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

@@ -227,25 +227,13 @@ public function test_od_get_detection_script_returns_script( Closure $set_up, ar
 	}
 
 	/**
-	 * Test od_create_rest_url_metric_store_rest_request().
+	 * Test od_register_rest_url_metric_store_endpoint().
 	 *
-	 * @covers ::od_create_rest_url_metric_store_rest_request
+	 * @covers ::od_register_rest_url_metric_store_endpoint
 	 */
-	public function test_od_create_rest_url_metric_store_rest_request(): void {
+	public function od_register_rest_url_metric_store_endpoint(): void {
 
-		global $wp_rest_server;
-
-		if ( ! isset( $wp_rest_server ) ) {
-			$wp_rest_server = new WP_REST_Server();
-
-			// Run the action to register the routes.
-			do_action( 'rest_api_init' );
-		}
-
-		// Get the routes.
-		$routes = $wp_rest_server->get_routes();
-
-		// Check that the route is present.
+		$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 );
 	}
 }