Fix: Error handlers respond with json if applicable #442
Conversation
|
Code Climate has analyzed commit 7a7cc70 and detected 0 issues on this pull request. View more on Code Climate. |
natlas-server/app/errors/handlers.py
Outdated
| from app.errors import bp | ||
| from app import db | ||
| import elasticsearch | ||
| import sentry_sdk | ||
|
|
||
|
|
||
| def json_response(status: int, msg: str) -> str: | ||
| err = json.dumps({"status": status, "message": msg}) |
There was a problem hiding this comment.
Hey sir, not sure if you noticed, but this is technically part of your API contract that you've added here, but what's the forcing function to ensure that you use a consistent format. Can we share an object, method, something to make sure this "API contract schema" is actually enforced and shared?
There was a problem hiding this comment.
Technically this is enforced and shared because all of these handlers return build_response, and build_response always calls it the same way. So the keys in the dict will always be the same so long as we exit through an error handler.
There was a problem hiding this comment.
They always call build_response?
natlas/natlas-server/app/api/routes.py
Line 28 in 2d99d2e
Or here?
natlas/natlas-server/app/api/routes.py
Line 48 in 2d99d2e
Here?
natlas/natlas-server/app/api/routes.py
Line 68 in 2d99d2e
Here?
natlas/natlas-server/app/api/routes.py
Line 111 in 2d99d2e
natlas/natlas-server/app/api/routes.py
Line 141 in 2d99d2e
natlas/natlas-server/app/api/routes.py
Line 192 in 2d99d2e
0xdade
force-pushed
the
jsonify_errors
branch
3 times, most recently
from
a31d5ff
to
9498b5d
Compare
| return {"status": self.status_code, "message": self.message} | ||
|
|
||
| def get_json(self): | ||
| return json.dumps(self.get_dict(), sort_keys=True, indent=4) |
There was a problem hiding this comment.
Indentions in my serialized responses?
Return json by default unless the client explicitly says text/html is what they want.
This actually changes the default behavior of the error handlers to json and then if
text/htmlis in theAcceptheader then we'll serve up html instead.