Changeset 59970 for trunk/tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php

Timestamp:

03/11/2025 02:17:41 PM (12 months ago)

Author:

TimothyBlynJacobs

Message:

REST API: Fix fatal error when making HEAD requests with _fields filter.

In [59889] the REST API controllers were adjusted to perform less work when responding to HEAD requests. The WP_REST_Response body would now be null, which caused issues with filters that expected the response body to be an array.

This commit sets the response body to be an empty array when preparing the response instead. The body will still be discarded, but this provides better backward comppatibility with code that assumes an array will be used.

See #56481.
Props antonvlasenko, timothyblynjacobs, mamaduka, wildworks.

File:

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

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

@@ -438 +438 @@
         $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.' );
+        $this->assertSame( array(), $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
     }
 
@@ -628 +628 @@
         $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.' );
+        $this->assertSame( array(), $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
     }
 
@@ -641 +641 @@
             'template parts' => array( 'template_part_post', 'template-parts', self::TEST_THEME . '//' . self::TEMPLATE_PART_NAME ),
         );
+    }
+
+    /**
+     * @dataProvider data_get_item_with_data_provider
+     * @covers       WP_REST_Template_Revisions_Controller::get_item
+     * @ticket 56922
+     *
+     * @param string $parent_post_property_name A class property name that contains the parent post object.
+     * @param string $rest_base Base part of the REST API endpoint to test.
+     * @param string $template_id Template ID to use in the test.
+     */
+    public function test_get_item_head_request_with_specified_fields_returns_success_response( $parent_post_property_name, $rest_base, $template_id ) {
+        wp_set_current_user( self::$admin_id );
+
+        $parent_post = self::$$parent_post_property_name;
+
+        $revisions   = wp_get_post_revisions( $parent_post, array( 'fields' => 'ids' ) );
+        $revision_id = array_shift( $revisions );
+
+        $request = new WP_REST_Request(
+            'HEAD',
+            '/wp/v2/' . $rest_base . '/' . $template_id . '/revisions/' . $revision_id
+        );
+        $request->set_param( '_fields', 'id' );
+        $server   = rest_get_server();
+        $response = $server->dispatch( $request );
+        add_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10, 3 );
+        $response = apply_filters( 'rest_post_dispatch', $response, $server, $request );
+        remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 );
+
+        $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+    }
+
+    /**
+     * @dataProvider data_get_items_with_data_provider
+     * @covers       WP_REST_Template_Revisions_Controller::get_items
+     * @ticket 56922
+     *
+     * @param string $parent_post_property_name A class property name that contains the parent post object.
+     * @param string $rest_base Base part of the REST API endpoint to test.
+     * @param string $template_id Template ID to use in the test.
+     */
+    public function test_get_items_head_request_with_specified_fields_returns_success_response( $parent_post_property_name, $rest_base, $template_id ) {
+        wp_set_current_user( self::$admin_id );
+        $parent_post = self::$$parent_post_property_name;
+
+        $request = new WP_REST_Request(
+            'HEAD',
+            '/wp/v2/' . $rest_base . '/' . $template_id . '/revisions'
+        );
+
+        $request->set_param( '_fields', 'id' );
+        $server   = rest_get_server();
+        $response = $server->dispatch( $request );
+        add_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10, 3 );
+        $response = apply_filters( 'rest_post_dispatch', $response, $server, $request );
+        remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 );
+
+        $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
     }