SanicTestClient throws error with response.text(...)

[wochinge]

Describe the bug
When an endpoint does not return a json und we are using the SanicTestClient, it gives an error:

        if exceptions:
>           raise ValueError("Exception during request: {}".format(exceptions))
E           ValueError: Exception during request: [JSONDecodeError('Expecting value: line 1 column 1 (char 0)',)]

This is because sanic.testing import JSONDecodeError from json, but requests (used by requests_async) uses simplejson, which means that this

 try:
    response.json = response.json()
except (JSONDecodeError, UnicodeDecodeError):
    response.json = None

does not work cause it does not handle the actual type simplejson.errors.JSONDecodeError

Code snippet

Endpoint:

@blueprint.route("/")
async def do_something(request: Request) -> HTTPResponse:
    return response.text("", 200)

Request:

test_client = app.test_client
_ = test_client.get("/")

Expected behavior
No error.

Environment (please complete the following information):

• OS: MacOS
• Version: 19.6.3

Additional context
Add any other context about the problem here.

[wochinge]

A simple quickfix would be to import JSONDecodeError from simplejson, I can submit a PR for that if you want.

[harshanarayana]

@wochinge Hi Tobias, mind if I ask what are you using the SanicTestClient for? If you are using that to test your application then you should probably try https://github.com/yunstanford/pytest-sanic instead of the test client.

[wochinge]

Hi @harshanarayana What speaks against using the test_client which is described here https://sanic.readthedocs.io/en/latest/sanic/testing.html ?

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If this is incorrect, please respond with an update. Thank you for your contributions.

[fabschn]

Trying to revive the discussion since I am currently facing the same issue.

I'm not explicitly calling response.text() but using the abort() function from sanic.exceptions.

I this case, the proposed solution of importing the JSONDecodeError from simplejson (from simplejson import JSONDecodeError) in sanic.testing leads to the expected behavior.

@wochinge Did you solve the issue in some way?
Also interested in arguments against using the test_client described in the documentation.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If this is incorrect, please respond with an update. Thank you for your contributions.