Changeset 59899 for trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

Timestamp:

03/02/2025 10:05:08 PM (3 months ago)

Author:

TimothyBlynJacobs

Message:

REST API: Improve performance for HEAD requests.

By default, the REST API responds to HEAD rqeuests by calling the GET handler and omitting the body from the response. While convenient, this ends up performing needless work that slows down the API response time.

This commit adjusts the Core controllers to specifically handle HEAD requests by not preparing the response body.

Fixes #56481.
Props antonvlasenko, janusdev, ironprogrammer, swissspidy, spacedmonkey, mukesh27, mamaduka, timothyblynjacobs.

File:

• trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php (modified) (3 diffs)

trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

@@ -177 +177 @@
 
     /**
+     * @ticket 56481
+     *
+     * @covers WP_REST_Templates_Controller::get_items
+     */
+    public function test_get_items_should_return_no_response_body_for_head_requests() {
+        wp_set_current_user( self::$admin_id );
+        $request  = new WP_REST_Request( 'HEAD', '/wp/v2/templates' );
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 200, $response->get_status(), 'Response status is 200.' );
+        $this->assertNull( $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
+    }
+
+    /**
      * @covers WP_REST_Templates_Controller::get_items
      */
@@ -269 +282 @@
 
     /**
+     * @ticket 56481
+     *
+     * @covers WP_REST_Templates_Controller::get_item
+     * @covers WP_REST_Templates_Controller::prepare_item_for_response
+     */
+    public function test_get_item_should_return_no_response_body_for_head_requests() {
+        wp_set_current_user( self::$admin_id );
+        $request  = new WP_REST_Request( 'HEAD', '/wp/v2/templates/default//my_template' );
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 200, $response->get_status(), 'Response status is 200.' );
+        $this->assertNull( $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
+    }
+
+    /**
      * @covers WP_REST_Templates_Controller::get_item
      */
@@ -311 +338 @@
         wp_set_current_user( self::$subscriber_id );
         $request  = new WP_REST_Request( 'GET', '/wp/v2/templates/default//my_template' );
-        $response = rest_get_server()->dispatch( $request );
         $response = rest_get_server()->dispatch( $request );
         $this->assertErrorResponse( 'rest_cannot_manage_templates', $response, 403 );