[8.x] Prevent assertStatus() invalid JSON exception for valid JSON response content #38192
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
derekmd
force-pushed
the
assert-status-doesnt-fail-on-json-false
branch
from
a7fde55 to
e1c55d9
Compare
Don't throw exception "Invalid JSON was returned from the route." when asserting a HTTP response status code on a JSON endpoint returning 'false'. A HTTP response body can be: * status code: 200 HTTP OK * header: Content-Type: application/json * body: false Starting in v8.52.0, assertStatus() shows errors messages if any are found in a JSON response body. The TestResponse@json() method should be avoided since it applies additional key/value payload error checking unrelated to the HTTP status code. Instead silently detect JSON response body key 'errors' and only throw the "Invalid JSON" exception when Laravel's JSON assertion methods are called.
Avoid exception "Invalid JSON was returned from the route" when the TestResponse class is unable to discover the JSON response body 'errors' key.
derekmd
force-pushed
the
assert-status-doesnt-fail-on-json-false
branch
from
e1c55d9 to
273dfae
Compare
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #38178
Replaces pull request: #38189 (this pull request adds tabuna's GZIP-encoding test case)
Test suite JSON validation message feedback added in v8.52.0 (#38046 #38088) is causing
assertStatus()to throw "Invalid JSON was returned from the route" on some valid JSON responses. A few known cases:falseand not a key/value payload (described in the linked issue):The new custom validation feedback must avoid the below error checking block intended for the
assertJson*()methods that inspect key/value payloads:framework/src/Illuminate/Testing/TestResponse.php
Lines 851 to 857 in 7bd4e6d
...since validation of a JSON payload is unrelated to the HTTP status code being asserted. Instead silently attempt to gather the JSON
'errors'validation messages and fallback gracefully to the generic PHPUnit failure message.