Changeset 45809

Timestamp:

08/15/2019 07:55:13 PM (5 years ago)

Author:

kadamwhite

Message:

REST API: Do not send response body if status is 204 or body is null.

Status code 204 should indicate no response body is sent. Previously, a "null" string was sent, which MacOS Safari would try to parse as JSON and thereby fail to complete the request.

Props TimothyBlynJacobs, andizer, matthias.thiel.
Fixes #43691.

Location:

trunk

Files:

• src/wp-includes/rest-api/class-wp-rest-server.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-server.php (modified) (1 diff)

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

@@ -405 +405 @@
              */
             $result = apply_filters( 'rest_pre_echo_response', $result, $this, $request );
+
+            // The 204 response shouldn't have a body.
+            if ( 204 === $code || null === $result ) {
+                return null;
+            }
 
             $result = wp_json_encode( $result );

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

@@ -1145 +1145 @@
     }
 
+    /**
+     * @ticket 43691
+     */
+    public function test_does_not_echo_body_for_null_responses() {
+        register_rest_route(
+            'test-ns',
+            '/test',
+            array(
+                'methods'  => array( 'GET' ),
+                'callback' => function () {
+                    return new WP_REST_Response();
+                },
+            )
+        );
+
+        $result = rest_get_server()->serve_request( '/test-ns/test' );
+
+        $this->assertNull( $result );
+        $this->assertEquals( '', rest_get_server()->sent_body );
+    }
+
+    /**
+     * @ticket 43691
+     */
+    public function test_does_not_echo_body_for_responses_with_204_status() {
+        register_rest_route(
+            'test-ns',
+            '/test',
+            array(
+                'methods'  => array( 'GET' ),
+                'callback' => function () {
+                    return new WP_REST_Response( 'data', 204 );
+                },
+            )
+        );
+
+        $result = rest_get_server()->serve_request( '/test-ns/test' );
+
+        $this->assertNull( $result );
+        $this->assertEquals( '', rest_get_server()->sent_body );
+    }
+
     public function _validate_as_integer_123( $value, $request, $key ) {
         if ( ! is_int( $value ) ) {