-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use pinpoint for designated templates (#2152)
- Loading branch information
Showing
9 changed files
with
501 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| from datetime import datetime | ||
| from typing import Union | ||
|
|
||
| from flask import current_app, json | ||
| from notifications_utils.statsd_decorators import statsd | ||
| from sqlalchemy.orm.exc import NoResultFound | ||
|
|
||
| from app import notify_celery, statsd_client | ||
| from app.config import QueueNames | ||
| from app.dao import notifications_dao | ||
| from app.models import ( | ||
| NOTIFICATION_DELIVERED, | ||
| NOTIFICATION_PERMANENT_FAILURE, | ||
| NOTIFICATION_SENT, | ||
| NOTIFICATION_TECHNICAL_FAILURE, | ||
| NOTIFICATION_TEMPORARY_FAILURE, | ||
| PINPOINT_PROVIDER, | ||
| ) | ||
| from app.notifications.callbacks import _check_and_queue_callback_task | ||
| from celery.exceptions import Retry | ||
|
|
||
| # Pinpoint receipts are of the form: | ||
| # { | ||
| # "eventType": "TEXT_DELIVERED", | ||
| # "eventVersion": "1.0", | ||
| # "eventTimestamp": 1712944268877, | ||
| # "isFinal": true, | ||
| # "originationPhoneNumber": "+13655550100", | ||
| # "destinationPhoneNumber": "+16135550123", | ||
| # "isoCountryCode": "CA", | ||
| # "mcc": "302", | ||
| # "mnc": "610", | ||
| # "carrierName": "Bell Cellular Inc. / Aliant Telecom", | ||
| # "messageId": "221bc70c-7ee6-4987-b1ba-9684ba25be20", | ||
| # "messageRequestTimestamp": 1712944267685, | ||
| # "messageEncoding": "GSM", | ||
| # "messageType": "TRANSACTIONAL", | ||
| # "messageStatus": "DELIVERED", | ||
| # "messageStatusDescription": "Message has been accepted by phone", | ||
| # "totalMessageParts": 1, | ||
| # "totalMessagePrice": 0.00581, | ||
| # "totalCarrierFee": 0.006 | ||
| # } | ||
|
|
||
|
|
||
| @notify_celery.task(bind=True, name="process-pinpoint-result", max_retries=5, default_retry_delay=300) | ||
| @statsd(namespace="tasks") | ||
| def process_pinpoint_results(self, response): | ||
| try: | ||
| receipt = json.loads(response["Message"]) | ||
| reference = receipt["messageId"] | ||
| status = receipt["messageStatus"] | ||
| provider_response = receipt["messageStatusDescription"] | ||
|
|
||
| notification_status = determine_pinpoint_status(status, provider_response) | ||
| if not notification_status: | ||
| current_app.logger.warning(f"unhandled provider response for reference {reference}, received '{provider_response}'") | ||
| notification_status = NOTIFICATION_TECHNICAL_FAILURE # revert to tech failure by default | ||
|
|
||
| try: | ||
| notification = notifications_dao.dao_get_notification_by_reference(reference) | ||
| except NoResultFound: | ||
| try: | ||
| current_app.logger.warning( | ||
| f"RETRY {self.request.retries}: notification not found for Pinpoint reference {reference} (update to {notification_status}). " | ||
| f"Callback may have arrived before notification was persisted to the DB. Adding task to retry queue" | ||
| ) | ||
| self.retry(queue=QueueNames.RETRY) | ||
| except self.MaxRetriesExceededError: | ||
| current_app.logger.warning( | ||
| f"notification not found for Pinpoint reference: {reference} (update to {notification_status}). Giving up." | ||
| ) | ||
| return | ||
| if notification.sent_by != PINPOINT_PROVIDER: | ||
| current_app.logger.exception(f"Pinpoint callback handled notification {notification.id} not sent by Pinpoint") | ||
| return | ||
|
|
||
| if notification.status != NOTIFICATION_SENT: | ||
| notifications_dao._duplicate_update_warning(notification, notification_status) | ||
| return | ||
|
|
||
| notifications_dao._update_notification_status( | ||
| notification=notification, | ||
| status=notification_status, | ||
| provider_response=provider_response, | ||
| ) | ||
|
|
||
| if notification_status != NOTIFICATION_DELIVERED: | ||
| current_app.logger.info( | ||
| ( | ||
| f"Pinpoint delivery failed: notification id {notification.id} and reference {reference} has error found. " | ||
| f"Provider response: {provider_response}" | ||
| ) | ||
| ) | ||
| else: | ||
| current_app.logger.info( | ||
| f"Pinpoint callback return status of {notification_status} for notification: {notification.id}" | ||
| ) | ||
|
|
||
| statsd_client.incr(f"callback.pinpoint.{notification_status}") | ||
|
|
||
| if notification.sent_at: | ||
| statsd_client.timing_with_dates("callback.pinpoint.elapsed-time", datetime.utcnow(), notification.sent_at) | ||
|
|
||
| _check_and_queue_callback_task(notification) | ||
|
|
||
| except Retry: | ||
| raise | ||
|
|
||
| except Exception as e: | ||
| current_app.logger.exception(f"Error processing Pinpoint results: {str(e)}") | ||
| self.retry(queue=QueueNames.RETRY) | ||
|
|
||
|
|
||
| def determine_pinpoint_status(status: str, provider_response: str) -> Union[str, None]: | ||
| """Determine the notification status based on the SMS status and provider response. | ||
| Args: | ||
| status (str): message status from AWS | ||
| provider_response (str): detailed status from the SMS provider | ||
| Returns: | ||
| Union[str, None]: the notification status or None if the status is not handled | ||
| """ | ||
|
|
||
| if status == "DELIVERED": | ||
| return NOTIFICATION_DELIVERED | ||
|
|
||
| response_lower = provider_response.lower() | ||
|
|
||
| if "blocked" in response_lower: | ||
| return NOTIFICATION_TECHNICAL_FAILURE | ||
| elif "invalid" in response_lower: | ||
| return NOTIFICATION_TECHNICAL_FAILURE | ||
| elif "is opted out" in response_lower: | ||
| return NOTIFICATION_PERMANENT_FAILURE | ||
| elif "unknown error" in response_lower: | ||
| return NOTIFICATION_TECHNICAL_FAILURE | ||
| elif "exceed max price" in response_lower: | ||
| return NOTIFICATION_TECHNICAL_FAILURE | ||
| elif "phone carrier is currently unreachable/unavailable" in response_lower: | ||
| return NOTIFICATION_TEMPORARY_FAILURE | ||
| elif "phone is currently unreachable/unavailable" in response_lower: | ||
| return NOTIFICATION_PERMANENT_FAILURE | ||
| else: | ||
| return None |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| from time import monotonic | ||
|
|
||
| import boto3 | ||
| import phonenumbers | ||
|
|
||
| from app.clients.sms import SmsClient | ||
|
|
||
|
|
||
| class AwsPinpointClient(SmsClient): | ||
| """ | ||
| AWS Pinpoint SMS client | ||
| """ | ||
|
|
||
| def init_app(self, current_app, statsd_client, *args, **kwargs): | ||
| self._client = boto3.client("pinpoint-sms-voice-v2", region_name="ca-central-1") | ||
| super(AwsPinpointClient, self).__init__(*args, **kwargs) | ||
| # super(SmsClient, self).__init__(*args, **kwargs) | ||
| self.current_app = current_app | ||
| self.name = "pinpoint" | ||
| self.statsd_client = statsd_client | ||
|
|
||
| def get_name(self): | ||
| return self.name | ||
|
|
||
| def send_sms(self, to, content, reference, multi=True, sender=None): | ||
| pool_id = self.current_app.config["AWS_PINPOINT_SC_POOL_ID"] | ||
| messageType = "TRANSACTIONAL" | ||
| matched = False | ||
|
|
||
| for match in phonenumbers.PhoneNumberMatcher(to, "US"): | ||
| matched = True | ||
| to = phonenumbers.format_number(match.number, phonenumbers.PhoneNumberFormat.E164) | ||
| destinationNumber = to | ||
|
|
||
| try: | ||
| start_time = monotonic() | ||
| response = self._client.send_text_message( | ||
| DestinationPhoneNumber=destinationNumber, | ||
| OriginationIdentity=pool_id, | ||
| MessageBody=content, | ||
| MessageType=messageType, | ||
| ConfigurationSetName=self.current_app.config["AWS_PINPOINT_CONFIGURATION_SET_NAME"], | ||
| ) | ||
| except Exception as e: | ||
| self.statsd_client.incr("clients.pinpoint.error") | ||
| raise Exception(e) | ||
| finally: | ||
| elapsed_time = monotonic() - start_time | ||
| self.current_app.logger.info("AWS Pinpoint request finished in {}".format(elapsed_time)) | ||
| self.statsd_client.timing("clients.pinpoint.request-time", elapsed_time) | ||
| self.statsd_client.incr("clients.pinpoint.success") | ||
| return response["MessageId"] | ||
|
|
||
| if not matched: | ||
| self.statsd_client.incr("clients.pinpoint.error") | ||
| self.current_app.logger.error("No valid numbers found in {}".format(to)) | ||
| raise ValueError("No valid numbers found for SMS delivery") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.