darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-12 16:22:17 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
734772c1eb962162b07eee98ce3f42ef98b8d797
notifications-api/app/celery/research_mode_tasks.py

126 lines
8.2 KiB
Python
Raw Normal View History

Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
import json
from flask import current_app
from app import notify_celery
from requests import request, RequestException, HTTPError
Use the notification types enum for the notifications.notification_type. Reuse EMAIL_TYPE in template_types and notification_types.
2016-06-29 11:50:54 +01:00
from app.models import SMS_TYPE
The notification.to field is being formatted to be +447... This meant that the research mode task would never work. Also the way we mark data as "temporary-failure" with firetext is with first a pending status callback then a declined callback. This PR changes the research mode task to account for that situation.
2017-01-20 13:17:53 +00:00
temp_fail = "7700900003"
perm_fail = "7700900002"
delivered = "7700900001"
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
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"}
Various tidy ups and changes - use new queue - remove some new lines in AWS response data - migration script to populate new fields
2016-06-01 16:57:57 +01:00
else:
fix firetext research mode requests requests converts dicts into query parameters anyway if you don't specify so dont try and encode the data ourselves, also hardened up tests
2016-06-09 14:14:27 +01:00
headers = {"Content-type": "application/x-www-form-urlencoded"}
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
body = firetext_callback(reference, to)
The notification.to field is being formatted to be +447... This meant that the research mode task would never work. Also the way we mark data as "temporary-failure" with firetext is with first a pending status callback then a declined callback. This PR changes the research mode task to account for that situation.
2017-01-20 13:17:53 +00:00
# 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)
Changed the body of the request to use the right phone number, the phone number is not currently used in the callback logic but if it was then this may cause a problem. Changed the test to use a 077009 series phone number.
2017-01-23 10:43:33 +00:00
# 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
}
The notification.to field is being formatted to be +447... This meant that the research mode task would never work. Also the way we mark data as "temporary-failure" with firetext is with first a pending status callback then a declined callback. This PR changes the research mode task to account for that situation.
2017-01-20 13:17:53 +00:00
Use the notification types enum for the notifications.notification_type. Reuse EMAIL_TYPE in template_types and notification_types.
2016-06-29 11:50:54 +01:00
make_request(SMS_TYPE, provider, body, headers)
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
def send_email_response(provider, 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)
make_request('email', provider, body, headers={"Content-type": "application/json"})
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
)
response.raise_for_status()
except RequestException as e:
api_error = HTTPError(e)
current_app.logger.error(
"API {} request on {} failed with {}".format(
"POST",
api_call,
api_error.response
)
)
raise api_error
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)
"""
The notification.to field is being formatted to be +447... This meant that the research mode task would never work. Also the way we mark data as "temporary-failure" with firetext is with first a pending status callback then a declined callback. This PR changes the research mode task to account for that situation.
2017-01-20 13:17:53 +00:00
if to.strip().endswith(temp_fail):
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
status = "4"
The notification.to field is being formatted to be +447... This meant that the research mode task would never work. Also the way we mark data as "temporary-failure" with firetext is with first a pending status callback then a declined callback. This PR changes the research mode task to account for that situation.
2017-01-20 13:17:53 +00:00
elif to.strip().endswith(perm_fail):
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
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
"""
The notification.to field is being formatted to be +447... This meant that the research mode task would never work. Also the way we mark data as "temporary-failure" with firetext is with first a pending status callback then a declined callback. This PR changes the research mode task to account for that situation.
2017-01-20 13:17:53 +00:00
if to.strip().endswith(perm_fail):
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
status = "1"
The notification.to field is being formatted to be +447... This meant that the research mode task would never work. Also the way we mark data as "temporary-failure" with firetext is with first a pending status callback then a declined callback. This PR changes the research mode task to account for that situation.
2017-01-20 13:17:53 +00:00
elif to.strip().endswith(temp_fail):
status = "2"
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
else:
status = "0"
fix firetext research mode requests requests converts dicts into query parameters anyway if you don't specify so dont try and encode the data ourselves, also hardened up tests
2016-06-09 14:14:27 +01:00
return {
'mobile': to,
'status': status,
'time': '2016-03-10 14:17:00',
'reference': notification_id
}
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
def ses_notification_callback(reference):
Various tidy ups and changes - use new queue - remove some new lines in AWS response data - migration script to populate new fields
2016-06-01 16:57:57 +01:00
return '{ "Type" : "Notification", "MessageId" : "%s", "TopicArn" : "arn:aws:sns:eu-west-1:123456789012:testing", "Message" : "{\\"notificationType\\":\\"Delivery\\",\\"mail\\":{\\"timestamp\\":\\"2016-03-14T12:35:25.909Z\\",\\"source\\":\\"test@test-domain.com\\",\\"sourceArn\\":\\"arn:aws:ses:eu-west-1:123456789012:identity/testing-notify\\",\\"sendingAccountId\\":\\"123456789012\\",\\"messageId\\":\\"%s\\",\\"destination\\":[\\"testing@digital.cabinet-office.gov.uk\\"]},\\"delivery\\":{\\"timestamp\\":\\"2016-03-14T12:35:26.567Z\\",\\"processingTimeMillis\\":658,\\"recipients\\":[\\"testing@digital.cabinet-office.gov.uk\\"],\\"smtpResponse\\":\\"250 2.0.0 OK 1457958926 uo5si26480932wjc.221 - gsmtp\\",\\"reportingMTA\\":\\"a6-238.smtp-out.eu-west-1.amazonses.com\\"}}", "Timestamp" : "2016-03-14T12:35:26.665Z", "SignatureVersion" : "1", "Signature" : "X8d7eTAOZ6wlnrdVVPYanrAlsX0SMPfOzhoTEBnQqYkrNWTqQY91C0f3bxtPdUhUtOowyPAOkTQ4KnZuzphfhVb2p1MyVYMxNKcBFB05/qaCX99+92fjw4x9LeUOwyGwMv5F0Vkfi5qZCcEw69uVrhYLVSTFTrzi/yCtru+yFULMQ6UhbY09GwiP6hjxZMVr8aROQy5lLHglqQzOuSZ4KeD85JjifHdKzlx8jjQ+uj+FLzHXPMAPmPU1JK9kpoHZ1oPshAFgPDpphJe+HwcJ8ezmk+3AEUr3wWli3xF+49y8Z2anASSVp6YI2YP95UT8Rlh3qT3T+V9V8rbSVislxA==", "SigningCertURL" : "https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-bb750dd426d95ee9390147a5624348ee.pem", "UnsubscribeURL" : "https://sns.eu-west-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:eu-west-1:302763885840:preview-emails:d6aad3ef-83d6-4cf3-a470-54e2e75916da"}' % (reference, reference) # noqa
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
def ses_hard_bounce_callback(reference):
Various tidy ups and changes - use new queue - remove some new lines in AWS response data - migration script to populate new fields
2016-06-01 16:57:57 +01:00
return '{ "Type" : "Notification", "MessageId" : "%s", "TopicArn" : "arn:aws:sns:eu-west-1:123456789012:testing", "Message" : "{\\"notificationType\\":\\"Bounce\\",\\"bounce\\":{\\"bounceType\\":\\"Permanent\\",\\"bounceSubType\\":\\"General\\"}, \\"mail\\":{\\"messageId\\":\\"%s\\",\\"timestamp\\":\\"2016-03-14T12:35:25.909Z\\",\\"source\\":\\"test@test-domain.com\\",\\"sourceArn\\":\\"arn:aws:ses:eu-west-1:123456789012:identity/testing-notify\\",\\"sendingAccountId\\":\\"123456789012\\",\\"destination\\":[\\"testing@digital.cabinet-office.gov.uk\\"]},\\"delivery\\":{\\"timestamp\\":\\"2016-03-14T12:35:26.567Z\\",\\"processingTimeMillis\\":658,\\"recipients\\":[\\"testing@digital.cabinet-office.gov.uk\\"],\\"smtpResponse\\":\\"250 2.0.0 OK 1457958926 uo5si26480932wjc.221 - gsmtp\\",\\"reportingMTA\\":\\"a6-238.smtp-out.eu-west-1.amazonses.com\\"}}", "Timestamp" : "2016-03-14T12:35:26.665Z", "SignatureVersion" : "1", "Signature" : "X8d7eTAOZ6wlnrdVVPYanrAlsX0SMPfOzhoTEBnQqYkrNWTqQY91C0f3bxtPdUhUtOowyPAOkTQ4KnZuzphfhVb2p1MyVYMxNKcBFB05/qaCX99+92fjw4x9LeUOwyGwMv5F0Vkfi5qZCcEw69uVrhYLVSTFTrzi/yCtru+yFULMQ6UhbY09GwiP6hjxZMVr8aROQy5lLHglqQzOuSZ4KeD85JjifHdKzlx8jjQ+uj+FLzHXPMAPmPU1JK9kpoHZ1oPshAFgPDpphJe+HwcJ8ezmk+3AEUr3wWli3xF+49y8Z2anASSVp6YI2YP95UT8Rlh3qT3T+V9V8rbSVislxA==", "SigningCertURL" : "https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-bb750dd426d95ee9390147a5624348ee.pem", "UnsubscribeURL" : "https://sns.eu-west-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:eu-west-1:302763885840:preview-emails:d6aad3ef-83d6-4cf3-a470-54e2e75916da"}' % (reference, reference) # noqa
Added research mode tasks - if a service is in research mode the don't send the notifications via the providers (MMG/SES/etc) - instead set up a task to mimic those services callbacks - this completes the loop, and show stats, delivery receipts and so on. - Use the "to" field to choose the response, allows users to create successful and errored notifications temp fail sms, uses "07833333333" perm fail sms, uses = "07822222222" success = "07811111111" (or anything else) success email = "delivered@simulator.notify" perm fail = "perm-fail@simulator.notify" temp fail = "temp-fail@simulator.notify"
2016-05-31 16:55:26 +01:00
def ses_soft_bounce_callback(reference):
Various tidy ups and changes - use new queue - remove some new lines in AWS response data - migration script to populate new fields
2016-06-01 16:57:57 +01:00
return '{ "Type" : "Notification", "MessageId" : "%s", "TopicArn" : "arn:aws:sns:eu-west-1:123456789012:testing", "Message" : "{\\"notificationType\\":\\"Bounce\\",\\"bounce\\":{\\"bounceType\\":\\"Undetermined\\",\\"bounceSubType\\":\\"General\\"}, \\"mail\\":{\\"messageId\\":\\"%s\\",\\"timestamp\\":\\"2016-03-14T12:35:25.909Z\\",\\"source\\":\\"test@test-domain.com\\",\\"sourceArn\\":\\"arn:aws:ses:eu-west-1:123456789012:identity/testing-notify\\",\\"sendingAccountId\\":\\"123456789012\\",\\"destination\\":[\\"testing@digital.cabinet-office.gov.uk\\"]},\\"delivery\\":{\\"timestamp\\":\\"2016-03-14T12:35:26.567Z\\",\\"processingTimeMillis\\":658,\\"recipients\\":[\\"testing@digital.cabinet-office.gov.uk\\"],\\"smtpResponse\\":\\"250 2.0.0 OK 1457958926 uo5si26480932wjc.221 - gsmtp\\",\\"reportingMTA\\":\\"a6-238.smtp-out.eu-west-1.amazonses.com\\"}}", "Timestamp" : "2016-03-14T12:35:26.665Z", "SignatureVersion" : "1", "Signature" : "X8d7eTAOZ6wlnrdVVPYanrAlsX0SMPfOzhoTEBnQqYkrNWTqQY91C0f3bxtPdUhUtOowyPAOkTQ4KnZuzphfhVb2p1MyVYMxNKcBFB05/qaCX99+92fjw4x9LeUOwyGwMv5F0Vkfi5qZCcEw69uVrhYLVSTFTrzi/yCtru+yFULMQ6UhbY09GwiP6hjxZMVr8aROQy5lLHglqQzOuSZ4KeD85JjifHdKzlx8jjQ+uj+FLzHXPMAPmPU1JK9kpoHZ1oPshAFgPDpphJe+HwcJ8ezmk+3AEUr3wWli3xF+49y8Z2anASSVp6YI2YP95UT8Rlh3qT3T+V9V8rbSVislxA==", "SigningCertURL" : "https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-bb750dd426d95ee9390147a5624348ee.pem", "UnsubscribeURL" : "https://sns.eu-west-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:eu-west-1:302763885840:preview-emails:d6aad3ef-83d6-4cf3-a470-54e2e75916da"}' % (reference, reference) # noqa
Reference in New Issue Copy Permalink