REST API json_encode error returns 500 data->status in body(Correct) but 200 in actual status(Incorrect).

[lalitjalandhar]

<?php
add_action( 'rest_api_init', function() {
        register_rest_route(
                'v3',
                '/my-custom-route',
                array(
                        array(
                                'methods'             => \WP_REST_Server::READABLE,
                                'callback'            => function() {
                                        return new \WP_REST_Response(INF);
                                },
                                'permission_callback' => '__return_true',
                                'args'                => array(),
                        ),
                )
        );
});

[lalitjalandhar]

postman screen shot

[desrosj]

Thanks for this one, @lalitjalandhar. And welcome to Trac!

It seems that there is a missing set_status() call here. Would you be interested in creating a patch?

It would also be nice to add a few tests to confirm the desired behavior after these changes.

Fixes issue in the REST API where a JSON encode failure of the response body does not result in a 500 error.

An automated test is included for this case, requiring an expansion of the test spy.

Trac ticket: https://core.trac.wordpress.org/ticket/53056

[hermpheus]

Thank you @lalitjalandhar for the excellent example, and thank you @desrosj for the excellent suggestion.

I have a patch available that should address this issue. It has an automated test and also works for me in the browser and Postman. Please let me know if any changes should be made. Thanks!

[hellofromTonya]

Today is 5.8 Beta 1. Ran out of time for this one to land. Punting to 5.9 to give it time for code and test review and testing.

[chaion07]

Thanks @lalitjalandhar for reporting the issue. We reviewed this ticket during a [recent triage session at Core]​https://wordpress.slack.com/archives/C02RQBWTW/p1623733904418100. As @hellofromTonya mentioned in here last comment that we need test review and testing as well as coding. We think that having an owner for this would also help determine the future of the ticket better. Also adding the dev-feedback keyword. Thanks!

[TimothyBlynJacobs]

In 51960:

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.

Thanks for the patch @hermpheus! Merged in https://core.trac.wordpress.org/changeset/51960.