darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-20 23:41:17 -05:00
Code Issues Packages Projects Releases Wiki Activity

Give a more helpful error when token has expired

Browse Source 
We’ve seen quite a few developers encounter the `Invalid token: expired`
error message when they’re getting started using the Notify API. When
this happens they either raise a support ticket or ask for help on
Slack.

In every case this has been because the clock on their
machine/environment/container isn’t accurate. The error message doesn’t
help them figure this out.

This commit adds extra detail to the error message so they can fix the
problem without having to come to us for help.
This commit is contained in:
Chris Hill-Scott
2017-01-17 10:44:00 +00:00
parent 56f1ed11d6
commit b6b9b3b225
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/authentication/auth.py
View File

@@ -94,4 +94,4 @@ def get_decode_errors(auth_token, unsigned_secret):
try: try:
decode_jwt_token(auth_token, unsigned_secret) decode_jwt_token(auth_token, unsigned_secret)
except TokenExpiredError: except TokenExpiredError:
raise AuthError("Invalid token: expired", 403) raise AuthError("Invalid token: expired, check that your system clock is accurate", 403)

4
tests/app/authentication/test_authentication.py
View File

@@ -320,7 +320,9 @@ def test_should_return_403_when_token_is_expired(notify_api,
headers={'Authorization': 'Bearer {}'.format(token)}) headers={'Authorization': 'Bearer {}'.format(token)})
assert response.status_code == 403 assert response.status_code == 403
error_message = json.loads(response.get_data()) error_message = json.loads(response.get_data())
assert error_message['message'] == {'token': ['Invalid token: expired']} assert error_message['message'] == {'token': [
'Invalid token: expired, check that your system clock is accurate'
]}
def __create_get_token(service_id): def __create_get_token(service_id):