Changeset 51960

Timestamp:

10/31/2021 06:06:02 AM (3 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Send a 500 status code when JSON encoding fails.

Previously, a 200 status code would be sent despite the 500 status code present in the response body.

Props hermpheus, lalitjalandhar.
Fixes #53056.

Location:

trunk

Files:

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

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

@@ -498 +498 @@
 
             if ( $json_error_message ) {
+                $this->set_status( 500 );
                 $json_error_obj = new WP_Error(
                     'rest_encode_error',

trunk/tests/phpunit/includes/spy-rest-server.php

@@ -7 +7 @@
     public $last_request        = null;
     public $override_by_default = false;
+    public $status              = null;
 
     /**
@@ -36 +37 @@
     public function send_header( $header, $value ) {
         $this->sent_headers[ $header ] = $value;
+    }
+
+    /**
+     * Stores last set status.
+     * @param int $code HTTP status.
+     */
+    public function set_status( $status ) {
+        $this->status = $status;
     }
 

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

@@ -2023 +2023 @@
     }
 
+    /**
+     * @ticket 53056
+     */
+    public function test_json_encode_error_results_in_500_status_code() {
+        register_rest_route(
+            'test-ns/v1',
+            '/test',
+            array(
+                array(
+                    'methods'             => \WP_REST_Server::READABLE,
+                    'callback'            => function() {
+                        return new \WP_REST_Response( INF );
+                    },
+                    'permission_callback' => '__return_true',
+                    'args'                => array(),
+                ),
+            )
+        );
+        rest_get_server()->serve_request( '/test-ns/v1/test' );
+        $this->assertSame( 500, rest_get_server()->status );
+    }
+
     public function _validate_as_integer_123( $value, $request, $key ) {
         if ( ! is_int( $value ) ) {