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

trunk/tests/phpunit/tests/rest-api/rest-categories-controller.php

@@ -577 +577 @@
     }
 
-    public function test_get_terms_invalid_parent_arg() {
-        $request = new WP_REST_Request( 'GET', '/wp/v2/categories' );
+    /**
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @param string $method HTTP method to use.
+     */
+    public function test_get_terms_invalid_parent_arg( $method ) {
+        $request = new WP_REST_Request( $method, '/wp/v2/categories' );
         $request->set_param( 'parent', 'invalid-parent' );
         $response = rest_get_server()->dispatch( $request );
@@ -610 +616 @@
     }
 
-    public function test_get_terms_pagination_headers() {
+    /**
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @param string $method HTTP method to use.
+     */
+    public function test_get_terms_pagination_headers( $method ) {
         $total_categories = self::$total_categories;
         $total_pages      = (int) ceil( $total_categories / 10 );
 
         // Start of the index + Uncategorized default term.
-        $request  = new WP_REST_Request( 'GET', '/wp/v2/categories' );
+        $request  = new WP_REST_Request( $method, '/wp/v2/categories' );
         $response = rest_get_server()->dispatch( $request );
         $headers  = $response->get_headers();
         $this->assertSame( $total_categories, $headers['X-WP-Total'] );
         $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
-        $this->assertCount( 10, $response->get_data() );
+        if ( 'HEAD' !== $method ) {
+            $this->assertCount( 10, $response->get_data() );
+        }
         $next_link = add_query_arg(
             array(
@@ -663 +677 @@
         $this->assertSame( $total_categories, $headers['X-WP-Total'] );
         $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
-        $this->assertCount( 1, $response->get_data() );
+        if ( 'HEAD' !== $method ) {
+            $this->assertCount( 1, $response->get_data() );
+        }
         $prev_link = add_query_arg(
             array(
@@ -680 +696 @@
         $this->assertSame( $total_categories, $headers['X-WP-Total'] );
         $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
-        $this->assertCount( 0, $response->get_data() );
+        if ( 'HEAD' !== $method ) {
+            $this->assertCount( 0, $response->get_data() );
+        }
         $prev_link = add_query_arg(
             array(
@@ -1237 +1255 @@
         $this->check_taxonomy_term( $category, $data, $response->get_links() );
     }
+
+    /**
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @param string $method HTTP method to use.
+     */
+    public function test_get_items_only_fetches_ids_for_head_requests( $method ) {
+        $is_head_request = 'HEAD' === $method;
+        $request         = new WP_REST_Request( $method, '/wp/v2/categories' );
+
+        $filter = new MockAction();
+
+        add_filter( 'terms_pre_query', array( $filter, 'filter' ), 10, 2 );
+
+        $response = rest_get_server()->dispatch( $request );
+
+        $this->assertSame( 200, $response->get_status() );
+        if ( $is_head_request ) {
+            $this->assertEmpty( $response->get_data() );
+        } else {
+            $this->assertNotEmpty( $response->get_data() );
+        }
+
+        $args = $filter->get_args();
+        $this->assertTrue( isset( $args[0][1] ), 'Query parameters were not captured.' );
+        $this->assertInstanceOf( WP_Term_Query::class, $args[0][1], 'Query parameters were not captured.' );
+
+        /** @var WP_Term_Query $query */
+        $query = $args[0][1];
+
+        if ( $is_head_request ) {
+            $this->assertArrayHasKey( 'fields', $query->query_vars, 'The fields parameter is not set in the query vars.' );
+            $this->assertSame( 'ids', $query->query_vars['fields'], 'The query must fetch only term IDs.' );
+            $this->assertArrayHasKey( 'update_term_meta_cache', $query->query_vars, 'The update_term_meta_cache key is missing in the query vars.' );
+            $this->assertFalse( $query->query_vars['update_term_meta_cache'], 'The update_term_meta_cache value should be false for HEAD requests.' );
+        } else {
+            $this->assertTrue(
+                ! array_key_exists( 'fields', $query->query_vars ) || 'ids' !== $query->query_vars['fields'],
+                'The fields parameter should not be forced to "ids" for non-HEAD requests.'
+            );
+            $this->assertArrayHasKey( 'update_term_meta_cache', $query->query_vars, 'The update_term_meta_cache key is missing in the query vars.' );
+            $this->assertTrue( $query->query_vars['update_term_meta_cache'], 'The update_term_meta_cache value should be true for HEAD requests.' );
+        }
+
+        if ( ! $is_head_request ) {
+            return;
+        }
+
+        global $wpdb;
+        $terms_table = preg_quote( $wpdb->terms, '/' );
+
+        $pattern = '/SELECT\s+t\.term_id.+FROM\s+' . $terms_table . '\s+AS\s+t\s+INNER\s+JOIN/is';
+
+        // Assert that the SQL query only fetches the term_id column.
+        $this->assertMatchesRegularExpression( $pattern, $query->request, 'The SQL query does not match the expected string.' );
+    }
+
+    /**
+     * 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
+     *
+     * @param string $method The HTTP method to use.
+     */
+    public function test_get_item_should_allow_adding_headers_via_filter( $method ) {
+        $category_id = self::factory()->category->create();
+
+        $request = new WP_REST_Request( $method, sprintf( '/wp/v2/categories/%d', $category_id ) );
+
+        $hook_name = 'rest_prepare_category';
+
+        $filter   = new MockAction();
+        $callback = array( $filter, 'filter' );
+        add_filter( $hook_name, $callback );
+        $header_filter = new class() {
+            public static function add_custom_header( $response ) {
+                $response->header( 'X-Test-Header', 'Test' );
+
+                return $response;
+            }
+        };
+        add_filter( $hook_name, array( $header_filter, 'add_custom_header' ) );
+        $response = rest_get_server()->dispatch( $request );
+        remove_filter( $hook_name, $callback );
+        remove_filter( $hook_name, array( $header_filter, 'add_custom_header' ) );
+
+        $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+        $this->assertSame( 1, $filter->get_call_count(), 'The "' . $hook_name . '" filter was called when it should not be for HEAD requests.' );
+        $headers = $response->get_headers();
+        $this->assertArrayHasKey( 'X-Test-Header', $headers, 'The "X-Test-Header" header should be present in the response.' );
+        $this->assertSame( 'Test', $headers['X-Test-Header'], 'The "X-Test-Header" header value should be equal to "Test".' );
+        if ( 'HEAD' !== $method ) {
+            return null;
+        }
+        $this->assertNull( $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
+    }
 }