mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-22 08:21:13 -05:00
f223446f73
Removed all existing statsd logging and replaced with: - statsd decorator. Infers the stat name from the decorated function call. Delegates statsd call to statsd client. Calls incr and timing for each decorated method. This is applied to all tasks and all dao methods that touch the notifications/notification_history tables - statsd client changed to prefix all stats with "notification.api." - Relies on https://github.com/alphagov/notifications-utils/pull/61 for request logging. Once integrated we pass the statsd client to the logger, allowing us to statsd all API calls. This passes in the start time and the method to be called (NOT the url) onto the global flask object. We then construct statsd counters and timers in the following way notifications.api.POST.notifications.send_notification.200 This should allow us to aggregate to the level of - API or ADMIN - POST or GET etc - modules - methods - status codes Finally we count the callbacks received from 3rd parties to mapped status.
77 lines
3.2 KiB
Python
77 lines
3.2 KiB
Python
import uuid
|
|
from flask import current_app
|
|
|
|
from app import statsd_client
|
|
from app.dao import notifications_dao
|
|
from app.clients.sms.firetext import get_firetext_responses
|
|
from app.clients.sms.mmg import get_mmg_responses
|
|
|
|
sms_response_mapper = {'MMG': get_mmg_responses,
|
|
'Firetext': get_firetext_responses
|
|
}
|
|
|
|
|
|
def validate_callback_data(data, fields, client_name):
|
|
errors = []
|
|
for f in fields:
|
|
if not str(data.get(f, '')):
|
|
error = "{} callback failed: {} missing".format(client_name, f)
|
|
errors.append(error)
|
|
return errors if len(errors) > 0 else None
|
|
|
|
|
|
def process_sms_client_response(status, reference, client_name):
|
|
success = None
|
|
errors = None
|
|
# validate reference
|
|
if reference == 'send-sms-code':
|
|
success = "{} callback succeeded: send-sms-code".format(client_name)
|
|
return success, errors
|
|
|
|
try:
|
|
uuid.UUID(reference, version=4)
|
|
except ValueError:
|
|
message = "{} callback with invalid reference {}".format(client_name, reference)
|
|
return success, message
|
|
|
|
try:
|
|
response_parser = sms_response_mapper[client_name]
|
|
except KeyError:
|
|
return success, 'unknown sms client: {}'.format(client_name)
|
|
|
|
statsd_client.incr('callback.{}.status.{}'.format(client_name.lower(), status))
|
|
|
|
# validate status
|
|
try:
|
|
response_dict = response_parser(status)
|
|
current_app.logger.info('{} callback return status of {} for reference: {}'.format(client_name,
|
|
status, reference))
|
|
except KeyError:
|
|
msg = "{} callback failed: status {} not found.".format(client_name, status)
|
|
return success, msg
|
|
|
|
notification_status = response_dict['notification_status']
|
|
notification_statistics_status = response_dict['notification_statistics_status']
|
|
notification_status_message = response_dict['message']
|
|
notification_success = response_dict['success']
|
|
|
|
# record stats
|
|
if not notifications_dao.update_notification_status_by_id(reference,
|
|
notification_status,
|
|
notification_statistics_status):
|
|
status_error = "{} callback failed: notification {} either not found or already updated " \
|
|
"from sending. Status {}".format(client_name,
|
|
reference,
|
|
notification_status_message)
|
|
return success, status_error
|
|
|
|
if not notification_success:
|
|
current_app.logger.info(
|
|
"{} delivery failed: notification {} has error found. Status {}".format(client_name,
|
|
reference,
|
|
notification_status_message))
|
|
|
|
statsd_client.incr('notifications.callback.{}.{}'.format(client_name.lower(), notification_statistics_status))
|
|
success = "{} callback succeeded. reference {} updated".format(client_name, reference)
|
|
return success, errors
|