mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-16 18:22:17 -05:00
fae7e917b5
We have been getting log lines of the following: `API POST request on https://api.notifications.service.gov.uk/notifications/sms/mmg failed with None` It's not clear what error caused the request to fail because the value of `api_error.response` is always `None`. There appears to be something wrong with this logging. `raise_for_status` will raise an `HTTPError`, so then there should be no reason to then pass that error into another `HTTPError` (which is causing the response to be lost). We can instead simply catch the `HTTPError` and log it's status code. This might not be perfect, but it's definitely an improvement and should give us some more context about why these requests occasionally fail.
303 lines
10 KiB
Python
303 lines
10 KiB
Python
import random
|
|
from datetime import datetime, timedelta
|
|
import json
|
|
|
|
from flask import current_app
|
|
from requests import request, HTTPError
|
|
|
|
from notifications_utils.s3 import s3upload
|
|
|
|
from app import notify_celery
|
|
from app.aws.s3 import file_exists
|
|
from app.models import SMS_TYPE
|
|
from app.config import QueueNames
|
|
from app.celery.process_ses_receipts_tasks import process_ses_results
|
|
|
|
temp_fail = "7700900003"
|
|
perm_fail = "7700900002"
|
|
delivered = "7700900001"
|
|
|
|
delivered_email = "delivered@simulator.notify"
|
|
perm_fail_email = "perm-fail@simulator.notify"
|
|
temp_fail_email = "temp-fail@simulator.notify"
|
|
|
|
|
|
def send_sms_response(provider, reference, to):
|
|
if provider == "mmg":
|
|
body = mmg_callback(reference, to)
|
|
headers = {"Content-type": "application/json"}
|
|
else:
|
|
headers = {"Content-type": "application/x-www-form-urlencoded"}
|
|
body = firetext_callback(reference, to)
|
|
# to simulate getting a temporary_failure from firetext
|
|
# we need to send a pending status updated then a permanent-failure
|
|
if body['status'] == '2': # pending status
|
|
make_request(SMS_TYPE, provider, body, headers)
|
|
# 1 is a declined status for firetext, will result in a temp-failure
|
|
body = {'mobile': to,
|
|
'status': "1",
|
|
'time': '2016-03-10 14:17:00',
|
|
'reference': reference
|
|
}
|
|
|
|
make_request(SMS_TYPE, provider, body, headers)
|
|
|
|
|
|
def send_email_response(reference, to):
|
|
if to == perm_fail_email:
|
|
body = ses_hard_bounce_callback(reference)
|
|
elif to == temp_fail_email:
|
|
body = ses_soft_bounce_callback(reference)
|
|
else:
|
|
body = ses_notification_callback(reference)
|
|
|
|
process_ses_results.apply_async([body], queue=QueueNames.RESEARCH_MODE)
|
|
|
|
|
|
def make_request(notification_type, provider, data, headers):
|
|
api_call = "{}/notifications/{}/{}".format(current_app.config["API_HOST_NAME"], notification_type, provider)
|
|
|
|
try:
|
|
response = request(
|
|
"POST",
|
|
api_call,
|
|
headers=headers,
|
|
data=data,
|
|
timeout=60
|
|
)
|
|
response.raise_for_status()
|
|
except HTTPError as e:
|
|
current_app.logger.error(
|
|
"API POST request on {} failed with status {}".format(
|
|
api_call,
|
|
e.response.status_code
|
|
)
|
|
)
|
|
raise e
|
|
finally:
|
|
current_app.logger.info("Mocked provider callback request finished")
|
|
return response.json()
|
|
|
|
|
|
def mmg_callback(notification_id, to):
|
|
"""
|
|
status: 3 - delivered
|
|
status: 4 - expired (temp failure)
|
|
status: 5 - rejected (perm failure)
|
|
"""
|
|
|
|
if to.strip().endswith(temp_fail):
|
|
status = "4"
|
|
elif to.strip().endswith(perm_fail):
|
|
status = "5"
|
|
else:
|
|
status = "3"
|
|
|
|
return json.dumps({"reference": "mmg_reference",
|
|
"CID": str(notification_id),
|
|
"MSISDN": to,
|
|
"status": status,
|
|
"deliverytime": "2016-04-05 16:01:07"})
|
|
|
|
|
|
def firetext_callback(notification_id, to):
|
|
"""
|
|
status: 0 - delivered
|
|
status: 1 - perm failure
|
|
"""
|
|
if to.strip().endswith(perm_fail):
|
|
status = "1"
|
|
elif to.strip().endswith(temp_fail):
|
|
status = "2"
|
|
else:
|
|
status = "0"
|
|
return {
|
|
'mobile': to,
|
|
'status': status,
|
|
'time': '2016-03-10 14:17:00',
|
|
'reference': notification_id
|
|
}
|
|
|
|
|
|
@notify_celery.task(bind=True, name="create-fake-letter-response-file", max_retries=5, default_retry_delay=300)
|
|
def create_fake_letter_response_file(self, reference):
|
|
now = datetime.utcnow()
|
|
dvla_response_data = '{}|Sent|0|Sorted'.format(reference)
|
|
|
|
# try and find a filename that hasn't been taken yet - from a random time within the last 30 seconds
|
|
for i in sorted(range(30), key=lambda _: random.random()):
|
|
upload_file_name = 'NOTIFY-{}-RSP.TXT'.format((now - timedelta(seconds=i)).strftime('%Y%m%d%H%M%S'))
|
|
if not file_exists(current_app.config['DVLA_RESPONSE_BUCKET_NAME'], upload_file_name):
|
|
break
|
|
else:
|
|
raise ValueError(
|
|
'cant create fake letter response file for {} - too many files for that time already exist on s3'.format(
|
|
reference
|
|
)
|
|
)
|
|
|
|
s3upload(
|
|
filedata=dvla_response_data,
|
|
region=current_app.config['AWS_REGION'],
|
|
bucket_name=current_app.config['DVLA_RESPONSE_BUCKET_NAME'],
|
|
file_location=upload_file_name
|
|
)
|
|
current_app.logger.info("Fake DVLA response file {}, content [{}], uploaded to {}, created at {}".format(
|
|
upload_file_name, dvla_response_data, current_app.config['DVLA_RESPONSE_BUCKET_NAME'], now))
|
|
|
|
# on development we can't trigger SNS callbacks so we need to manually hit the DVLA callback endpoint
|
|
if current_app.config['NOTIFY_ENVIRONMENT'] == 'development':
|
|
make_request('letter', 'dvla', _fake_sns_s3_callback(upload_file_name), None)
|
|
|
|
|
|
def _fake_sns_s3_callback(filename):
|
|
message_contents = '{"Records":[{"s3":{"object":{"key":"%s"}}}]}' % (filename) # noqa
|
|
return json.dumps({
|
|
"Type": "Notification",
|
|
"MessageId": "some-message-id",
|
|
"Message": message_contents
|
|
})
|
|
|
|
|
|
def ses_notification_callback(reference):
|
|
ses_message_body = {
|
|
'delivery': {
|
|
'processingTimeMillis': 2003,
|
|
'recipients': ['success@simulator.amazonses.com'],
|
|
'remoteMtaIp': '123.123.123.123',
|
|
'reportingMTA': 'a7-32.smtp-out.eu-west-1.amazonses.com',
|
|
'smtpResponse': '250 2.6.0 Message received',
|
|
'timestamp': '2017-11-17T12:14:03.646Z'
|
|
},
|
|
'mail': {
|
|
'commonHeaders': {
|
|
'from': ['TEST <TEST@notify.works>'],
|
|
'subject': 'lambda test',
|
|
'to': ['success@simulator.amazonses.com']
|
|
},
|
|
'destination': ['success@simulator.amazonses.com'],
|
|
'headers': [
|
|
{
|
|
'name': 'From',
|
|
'value': 'TEST <TEST@notify.works>'
|
|
},
|
|
{
|
|
'name': 'To',
|
|
'value': 'success@simulator.amazonses.com'
|
|
},
|
|
{
|
|
'name': 'Subject',
|
|
'value': 'lambda test'
|
|
},
|
|
{
|
|
'name': 'MIME-Version',
|
|
'value': '1.0'
|
|
},
|
|
{
|
|
'name': 'Content-Type',
|
|
'value': 'multipart/alternative; boundary="----=_Part_617203_1627511946.1510920841645"'
|
|
}
|
|
],
|
|
'headersTruncated': False,
|
|
'messageId': reference,
|
|
'sendingAccountId': '12341234',
|
|
'source': '"TEST" <TEST@notify.works>',
|
|
'sourceArn': 'arn:aws:ses:eu-west-1:12341234:identity/notify.works',
|
|
'sourceIp': '0.0.0.1',
|
|
'timestamp': '2017-11-17T12:14:01.643Z'
|
|
},
|
|
'notificationType': 'Delivery'
|
|
}
|
|
|
|
return {
|
|
'Type': 'Notification',
|
|
'MessageId': '8e83c020-1234-1234-1234-92a8ee9baa0a',
|
|
'TopicArn': 'arn:aws:sns:eu-west-1:12341234:ses_notifications',
|
|
'Subject': None,
|
|
'Message': json.dumps(ses_message_body),
|
|
'Timestamp': '2017-11-17T12:14:03.710Z',
|
|
'SignatureVersion': '1',
|
|
'Signature': '[REDACTED]',
|
|
'SigningCertUrl': 'https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-[REDACTED].pem',
|
|
'UnsubscribeUrl': 'https://sns.eu-west-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=[REACTED]',
|
|
'MessageAttributes': {}
|
|
}
|
|
|
|
|
|
def ses_hard_bounce_callback(reference):
|
|
return _ses_bounce_callback(reference, 'Permanent')
|
|
|
|
|
|
def ses_soft_bounce_callback(reference):
|
|
return _ses_bounce_callback(reference, 'Temporary')
|
|
|
|
|
|
def _ses_bounce_callback(reference, bounce_type):
|
|
ses_message_body = {
|
|
'bounce': {
|
|
'bounceSubType': 'General',
|
|
'bounceType': bounce_type,
|
|
'bouncedRecipients': [{
|
|
'action': 'failed',
|
|
'diagnosticCode': 'smtp; 550 5.1.1 user unknown',
|
|
'emailAddress': 'bounce@simulator.amazonses.com',
|
|
'status': '5.1.1'
|
|
}],
|
|
'feedbackId': '0102015fc9e676fb-12341234-1234-1234-1234-9301e86a4fa8-000000',
|
|
'remoteMtaIp': '123.123.123.123',
|
|
'reportingMTA': 'dsn; a7-31.smtp-out.eu-west-1.amazonses.com',
|
|
'timestamp': '2017-11-17T12:14:05.131Z'
|
|
},
|
|
'mail': {
|
|
'commonHeaders': {
|
|
'from': ['TEST <TEST@notify.works>'],
|
|
'subject': 'ses callback test',
|
|
'to': ['bounce@simulator.amazonses.com']
|
|
},
|
|
'destination': ['bounce@simulator.amazonses.com'],
|
|
'headers': [
|
|
{
|
|
'name': 'From',
|
|
'value': 'TEST <TEST@notify.works>'
|
|
},
|
|
{
|
|
'name': 'To',
|
|
'value': 'bounce@simulator.amazonses.com'
|
|
},
|
|
{
|
|
'name': 'Subject',
|
|
'value': 'lambda test'
|
|
},
|
|
{
|
|
'name': 'MIME-Version',
|
|
'value': '1.0'
|
|
},
|
|
{
|
|
'name': 'Content-Type',
|
|
'value': 'multipart/alternative; boundary="----=_Part_596529_2039165601.1510920843367"'
|
|
}
|
|
],
|
|
'headersTruncated': False,
|
|
'messageId': reference,
|
|
'sendingAccountId': '12341234',
|
|
'source': '"TEST" <TEST@notify.works>',
|
|
'sourceArn': 'arn:aws:ses:eu-west-1:12341234:identity/notify.works',
|
|
'sourceIp': '0.0.0.1',
|
|
'timestamp': '2017-11-17T12:14:03.000Z'
|
|
},
|
|
'notificationType': 'Bounce'
|
|
}
|
|
return {
|
|
'Type': 'Notification',
|
|
'MessageId': '36e67c28-1234-1234-1234-2ea0172aa4a7',
|
|
'TopicArn': 'arn:aws:sns:eu-west-1:12341234:ses_notifications',
|
|
'Subject': None,
|
|
'Message': json.dumps(ses_message_body),
|
|
'Timestamp': '2017-11-17T12:14:05.149Z',
|
|
'SignatureVersion': '1',
|
|
'Signature': '[REDACTED]', # noqa
|
|
'SigningCertUrl': 'https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-[REDACTED]].pem',
|
|
'UnsubscribeUrl': 'https://sns.eu-west-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=[REDACTED]]',
|
|
'MessageAttributes': {}
|
|
}
|