Changeset 47849

Timestamp:

05/23/2020 02:34:38 PM (6 years ago)

Author:

ocean90

Message:

Rest API: Ensure rest_ensure_response() upgrades WP_HTTP_Response to WP_REST_Response.

An instance of WP_HTTP_Response doesn't ensure that the required methods used in WP_REST_Server::dispatch() exist, currently causing a fatal error.

Props ali11007, TimothyBlynJacobs, ocean90.
Fixes #49495.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (3 diffs)
• src/wp-includes/rest-api/class-wp-rest-server.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api.php (modified) (2 diffs)

trunk/src/wp-includes/rest-api.php

@@ -507 +507 @@
  * Ensures a REST response is a response object (for consistency).
  *
- * This implements WP_HTTP_Response, allowing usage of `set_status`/`header`/etc
+ * This implements WP_REST_Response, allowing usage of `set_status`/`header`/etc
  * without needing to double-check the object. Will also allow WP_Error to indicate error
  * responses, so users should immediately check for this value.
@@ -513 +513 @@
  * @since 4.4.0
  *
- * @param WP_HTTP_Response|WP_Error|mixed $response Response to check.
- * @return WP_REST_Response|mixed If response generated an error, WP_Error, if response
- *                                is already an instance, WP_HTTP_Response, otherwise
- *                                returns a new WP_REST_Response instance.
+ * @param WP_REST_Response|WP_Error|WP_HTTP_Response|mixed $response Response to check.
+ * @return WP_REST_Response|WP_Error If response generated an error, WP_Error, if response
+ *                                   is already an instance, WP_REST_Response, otherwise
+ *                                   returns a new WP_REST_Response instance.
  */
 function rest_ensure_response( $response ) {
@@ -523 +523 @@
         }
 
+        if ( $response instanceof WP_REST_Response ) {
+                return $response;
+        }
+
+        // While WP_HTTP_Response is the base class of WP_REST_Response, it doesn't provide
+        // all the required methods used in WP_REST_Server::dispatch().
         if ( $response instanceof WP_HTTP_Response ) {
-                return $response;
+                return new WP_REST_Response(
+                        $response->get_data(),
+                        $response->get_status(),
+                        $response->get_headers()
+                );
         }
 

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -970 +970 @@
                                  * @since 4.7.0
                                  *
-                                 * @param WP_HTTP_Response|WP_Error $response Result to send to the client. Usually a WP_REST_Response or WP_Error.
-                                 * @param array                     $handler  Route handler used for the request.
-                                 * @param WP_REST_Request           $request  Request used to generate the response.
+                                 * @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response Result to send to the client. Usually a WP_REST_Response or WP_Error.
+                                 * @param array                                            $handler  Route handler used for the request.
+                                 * @param WP_REST_Request                                  $request  Request used to generate the response.
                                  */
                                 $response = apply_filters( 'rest_request_before_callbacks', $response, $handler, $request );
@@ -1033 +1033 @@
                                  * @since 4.7.0
                                  *
-                                 * @param WP_HTTP_Response|WP_Error $response Result to send to the client. Usually a WP_REST_Response or WP_Error.
-                                 * @param array                     $handler  Route handler used for the request.
-                                 * @param WP_REST_Request           $request  Request used to generate the response.
+                                 * @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response Result to send to the client. Usually a WP_REST_Response or WP_Error.
+                                 * @param array                                            $handler  Route handler used for the request.
+                                 * @param WP_REST_Request                                  $request  Request used to generate the response.
                                  */
                                 $response = apply_filters( 'rest_request_after_callbacks', $response, $handler, $request );

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

@@ -943 +943 @@
          * @ticket 40614
          */
-        function test_rest_ensure_response_accepts_path_string() {
+        function test_rest_ensure_request_accepts_path_string() {
                 $request = rest_ensure_request( '/wp/v2/posts' );
                 $this->assertInstanceOf( 'WP_REST_Request', $request );
@@ -1316 +1316 @@
                 );
         }
+
+        function test_rest_ensure_response_accepts_wp_error_and_returns_wp_error() {
+                $response = rest_ensure_response( new WP_Error() );
+                $this->assertInstanceOf( 'WP_Error', $response );
+        }
+
+        /**
+         * @dataProvider rest_ensure_response_data_provider
+         * @group test1
+         *
+         * @param mixed $response      The response passed to rest_ensure_response().
+         * @param mixed $expected_data The expected data a response should include.
+         */
+        function test_rest_ensure_response_returns_instance_of_wp_rest_response( $response, $expected_data ) {
+                $response_object = rest_ensure_response( $response );
+                $this->assertInstanceOf( 'WP_REST_Response', $response_object );
+                $this->assertSame( $expected_data, $response_object->get_data() );
+        }
+
+        /**
+         * Data provider for test_rest_ensure_response_returns_instance_of_wp_rest_response().
+         *
+         * @return array
+         */
+        function rest_ensure_response_data_provider() {
+                return array(
+                        array( null, null ),
+                        array( array( 'chocolate' => 'cookies' ), array( 'chocolate' => 'cookies' ) ),
+                        array( 123, 123 ),
+                        array( true, true ),
+                        array( 'chocolate', 'chocolate' ),
+                        array( new WP_HTTP_Response( 'http' ), 'http' ),
+                        array( new WP_REST_Response( 'rest' ), 'rest' ),
+                );
+        }
 }