Changeset 59899 for trunk/tests/phpunit/tests/rest-api/rest-pattern-directory-controller.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/rest-pattern-directory-controller.php (modified) (4 diffs)

trunk/tests/phpunit/tests/rest-api/rest-pattern-directory-controller.php

@@ -146 +146 @@
 
     /**
+     * @ticket 56481
+     */
+    public function test_get_items_with_head_request_should_not_prepare_block_patterns_data() {
+        wp_set_current_user( self::$contributor_id );
+        self::mock_successful_response( 'browse-all', true );
+
+        $request = new WP_REST_Request( 'HEAD', '/wp/v2/pattern-directory/patterns' );
+
+        $hook_name = 'rest_prepare_block_pattern';
+        $filter    = new MockAction();
+        $callback  = array( $filter, 'filter' );
+
+        add_filter( $hook_name, $callback );
+        $response = rest_get_server()->dispatch( $request );
+        remove_filter( $hook_name, $callback );
+
+        $this->assertNotWPError( $response );
+        $response = rest_ensure_response( $response );
+
+        $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+
+        $this->assertSame( 0, $filter->get_call_count(), 'The "' . $hook_name . '" filter was called when it should not be for HEAD requests.' );
+        $this->assertNull( $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
+    }
+
+    /**
      * @covers WP_REST_Pattern_Directory_Controller::get_items
      *
@@ -220 +246 @@
 
     /**
-     * @covers WP_REST_Pattern_Directory_Controller::get_items
-     *
-     * @since 5.8.0
-     */
-    public function test_get_items_wdotorg_unavailable() {
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @covers WP_REST_Pattern_Directory_Controller::get_items
+     *
+     * @since 5.8.0
+     *
+     * @param string $method The HTTP method to use.
+     */
+    public function test_get_items_wdotorg_unavailable( $method ) {
         wp_set_current_user( self::$contributor_id );
         self::prevent_requests_to_host( 'api.wordpress.org' );
 
-        $request  = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
+        $request  = new WP_REST_Request( $method, '/wp/v2/pattern-directory/patterns' );
         $response = rest_do_request( $request );
 
@@ -235 +266 @@
 
     /**
-     * @covers WP_REST_Pattern_Directory_Controller::get_items
-     *
-     * @since 5.8.0
-     */
-    public function test_get_items_logged_out() {
-        $request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
+     * Data provider intended to provide HTTP method names for testing GET and HEAD requests.
+     *
+     * @return array
+     */
+    public static function data_readable_http_methods() {
+        return array(
+            'GET request'  => array( 'GET' ),
+            'HEAD request' => array( 'HEAD' ),
+        );
+    }
+
+    /**
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @covers WP_REST_Pattern_Directory_Controller::get_items
+     *
+     * @since 5.8.0
+     *
+     * @param string $method The HTTP method to use.
+     */
+    public function test_get_items_logged_out( $method ) {
+        $request = new WP_REST_Request( $method, '/wp/v2/pattern-directory/patterns' );
         $request->set_query_params( array( 'search' => 'button' ) );
         $response = rest_do_request( $request );
@@ -284 +332 @@
 
     /**
-     * @covers WP_REST_Pattern_Directory_Controller::get_items
-     *
-     * @since 5.8.0
-     */
-    public function test_get_items_invalid_response_data() {
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @covers WP_REST_Pattern_Directory_Controller::get_items
+     *
+     * @since 5.8.0
+     *
+     * @param string $method The HTTP method to use.
+     */
+    public function test_get_items_invalid_response_data( $method ) {
         wp_set_current_user( self::$contributor_id );
         self::mock_successful_response( 'invalid-data', true );
 
-        $request  = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
+        $request  = new WP_REST_Request( $method, '/wp/v2/pattern-directory/patterns' );
         $response = rest_do_request( $request );