darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-04 02:11:11 -05:00
Code Issues Packages Projects Releases Wiki Activity

Remove per-client SMS exception classes

Browse Source 
In response to: [^1].

The stacktrace conveys the same and more information. We don't do
anything different for each exception class, so there's no value
in having three of them over one exception.

I did think about DRYing-up the duplicate exception behaviour into
the base class one. This isn't ideal because the base class would
be making assumptions about how inheriting classes make requests,
which might change with future providers. Although it might be nice
to have more info in the top-level message, we'll still get it in
the stacktrace e.g.

    ValueError: Expected 'code' to be '0'
    During handling of the above exception, another exception occurred:
    app.clients.sms.SmsClientResponseException: SMS client error (Invalid response JSON)

    requests.exceptions.ReadTimeout
    During handling of the above exception, another exception occurred:
    app.clients.sms.SmsClientResponseException: SMS client error (Request failed)

[^1]: https://github.com/alphagov/notifications-api/pull/3493#discussion_r837363717
This commit is contained in:
Ben Thorner
2022-03-29 14:18:00 +01:00
parent 8432be4fc1
commit 7d92a0869a
7 changed files with 34 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/clients/sms/__init__.py
View File

@@ -12,7 +12,7 @@ class SmsClientResponseException(ClientException):
self.message = message
def __str__(self):
return "Message {}".format(self.message)
return f"SMS client error ({self.message})"
class SmsClient(Client):

22
app/clients/sms/firetext.py
View File

@@ -44,18 +44,6 @@ def get_message_status_and_reason_from_firetext_code(detailed_status_code):
return firetext_codes[detailed_status_code]['status'], firetext_codes[detailed_status_code]['reason']
class FiretextClientResponseException(SmsClientResponseException):
def __init__(self, response, exception):
status_code = response.status_code if response is not None else 504
text = response.text if response is not None else "Gateway Time-out"
self.status_code = status_code
self.text = text
self.exception = exception
def __str__(self):
return "Code {} text {} exception {}".format(self.status_code, self.text, str(self.exception))
class FiretextClient(SmsClient):
'''
FireText sms client.
@@ -91,10 +79,10 @@ class FiretextClient(SmsClient):
try:
json.loads(response.text)
if response.json()['code'] != 0:
raise ValueError()
except (ValueError, AttributeError) as e:
raise FiretextClientResponseException(response=response, exception=e)
except RequestException as e:
raise FiretextClientResponseException(response=e.response, exception=e)
raise ValueError("Expected 'code' to be '0'")
except (ValueError, AttributeError):
raise SmsClientResponseException("Invalid response JSON")
except RequestException:
raise SmsClientResponseException("Request failed")
return response

8
app/clients/sms/mmg.py
View File

@@ -102,9 +102,9 @@ class MMGClient(SmsClient):
response.raise_for_status()
try:
json.loads(response.text)
except (ValueError, AttributeError) as e:
raise MMGClientResponseException(response=response, exception=e)
except RequestException as e:
raise MMGClientResponseException(response=e.response, exception=e)
except (ValueError, AttributeError):
raise SmsClientResponseException("Invalid response JSON")
except RequestException:
raise SmsClientResponseException("Request failed")
return response

21
app/clients/sms/reach.py
View File

@@ -16,19 +16,6 @@ def get_reach_responses(status, detailed_status_code=None):
raise KeyError
class ReachClientResponseException(SmsClientResponseException):
def __init__(self, response, exception):
status_code = response.status_code if response is not None else 504
text = response.text if response is not None else "Gateway Time-out"
self.status_code = status_code
self.text = text
self.exception = exception
def __str__(self):
return "Code {} text {} exception {}".format(self.status_code, self.text, str(self.exception))
class ReachClient(SmsClient):
def init_app(self, *args, **kwargs):
super().init_app(*args, **kwargs)
@@ -57,9 +44,9 @@ class ReachClient(SmsClient):
response.raise_for_status()
try:
json.loads(response.text)
except (ValueError, AttributeError) as e:
raise ReachClientResponseException(response=response, exception=e)
except RequestException as e:
raise ReachClientResponseException(response=e.response, exception=e)
except (ValueError, AttributeError):
raise SmsClientResponseException("Invalid response JSON")
except RequestException:
raise SmsClientResponseException("Request failed")
return response