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

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

@@ -162 +162 @@
 
     /**
+     * Test pagination headers.
+     *
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @param string $method HTTP method to use.
+     */
+    public function test_get_items_pagination_headers( $method ) {
+        $total_posts = count( self::$my_title_post_ids ) + count( self::$my_title_page_ids ) + count( self::$my_content_post_ids );
+        $per_page    = 3;
+        $total_pages = (int) ceil( $total_posts / $per_page );
+
+        // Start of the index.
+        $response = $this->do_request_with_params(
+            array(
+                'per_page' => $per_page,
+            ),
+            $method
+        );
+        $headers  = $response->get_headers();
+        $this->assertSame( $total_posts, $headers['X-WP-Total'] );
+        $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
+
+        $next_link = add_query_arg(
+            array(
+                'per_page' => $per_page,
+                'page'     => 2,
+            ),
+            rest_url( '/wp/v2/search' )
+        );
+        $this->assertStringNotContainsString( 'rel="prev"', $headers['Link'] );
+        $this->assertStringContainsString( '<' . $next_link . '>; rel="next"', $headers['Link'] );
+
+        $response = $this->do_request_with_params(
+            array(
+                'per_page' => $per_page,
+                'page'     => 3,
+            ),
+            $method
+        );
+        $headers  = $response->get_headers();
+        $this->assertSame( $total_posts, $headers['X-WP-Total'] );
+        $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
+        $prev_link = add_query_arg(
+            array(
+                'per_page' => $per_page,
+                'page'     => 2,
+            ),
+            rest_url( '/wp/v2/search' )
+        );
+        $this->assertStringContainsString( '<' . $prev_link . '>; rel="prev"', $headers['Link'] );
+        $next_link = add_query_arg(
+            array(
+                'per_page' => $per_page,
+                'page'     => 4,
+            ),
+            rest_url( '/wp/v2/search' )
+        );
+        $this->assertStringContainsString( '<' . $next_link . '>; rel="next"', $headers['Link'] );
+
+        // Last page.
+        $response = $this->do_request_with_params(
+            array(
+                'per_page' => $per_page,
+                'page'     => $total_pages,
+            ),
+            $method
+        );
+        $headers  = $response->get_headers();
+        $this->assertSame( $total_posts, $headers['X-WP-Total'] );
+        $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
+        $prev_link = add_query_arg(
+            array(
+                'per_page' => $per_page,
+                'page'     => $total_pages - 1,
+            ),
+            rest_url( '/wp/v2/search' )
+        );
+        $this->assertStringContainsString( '<' . $prev_link . '>; rel="prev"', $headers['Link'] );
+        $this->assertStringNotContainsString( 'rel="next"', $headers['Link'] );
+    }
+
+    /**
+     * 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' ),
+        );
+    }
+
+    /**
      * Search through all content with a low limit.
      */
@@ -240 +335 @@
     /**
      * Search through an invalid type
-     */
-    public function test_get_items_search_type_invalid() {
+     *
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @param string $method HTTP method to use.
+     */
+    public function test_get_items_search_type_invalid( $method ) {
         $response = $this->do_request_with_params(
             array(
                 'per_page' => 100,
                 'type'     => 'invalid',
-            )
+            ),
+            $method
         );
 
@@ -254 +355 @@
     /**
      * Search through posts of an invalid post type.
+     *
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @param string $method HTTP method to use.
      */
     public function test_get_items_search_type_post_subtype_invalid() {
@@ -463 +569 @@
     /**
      * Tests that non-public post types are not allowed.
-     */
-    public function test_non_public_post_type() {
+     *
+     * @dataProvider data_readable_http_methods
+     * @ticket 56481
+     *
+     * @param string $method HTTP method to use.
+     */
+    public function test_non_public_post_type( $method ) {
         $response = $this->do_request_with_params(
             array(
                 'type'    => 'post',
                 'subtype' => 'post,nav_menu_item',
-            )
+            ),
+            $method
         );
         $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
@@ -633 +745 @@
      * Search through posts of an invalid post type.
      *
+     *
+     * @dataProvider data_readable_http_methods
      * @ticket 51458
-     */
-    public function test_get_items_search_term_subtype_invalid() {
+     * @ticket 56481
+     *
+     * @param string $method HTTP method to use.
+     */
+    public function test_get_items_search_term_subtype_invalid( $method ) {
         $response = $this->do_request_with_params(
             array(
@@ -641 +758 @@
                 'type'     => 'term',
                 'subtype'  => 'invalid',
-            )
+            ),
+            $method
         );
 
@@ -891 +1009 @@
 
     /**
+     * @dataProvider data_readable_http_methods
      * @ticket 60771
-     */
-    public function test_sanitize_subtypes_validates_type() {
+     * @ticket 56481
+     *
+     * @param string $method HTTP method to use.
+     */
+    public function test_sanitize_subtypes_validates_type( $method ) {
         $response = $this->do_request_with_params(
             array(
                 'subtype' => 'page',
                 'type'    => array( 'invalid' ),
-            )
+            ),
+            $method
         );