Add callback failure warning email #2190
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| """ | ||
| Revision ID: 0453_add_callback_failure_email | ||
| Revises: 0452_set_pgaudit_config | ||
| Create Date: 2024-06-04 16:09:00 | ||
| """ | ||
| from datetime import datetime | ||
|
|
||
| from alembic import op | ||
| from flask import current_app | ||
|
|
||
| revision = "0453_add_callback_failure_email" | ||
| down_revision = "0452_set_pgaudit_config" | ||
|
|
||
| callback_failure_template_id = current_app.config["CALLBACK_FAILURE_TEMPLATE_ID"] | ||
|
|
||
|
|
||
| def upgrade(): | ||
| template_insert = """ | ||
| INSERT INTO templates (id, name, template_type, created_at, content, archived, service_id, subject, | ||
| created_by_id, version, process_type, hidden) | ||
| VALUES('{}', '{}', '{}', '{}', '{}', False, '{}', '{}', '{}', 1, '{}', false) | ||
| """ | ||
| template_history_insert = """ | ||
| INSERT INTO templates_history (id, name, template_type, created_at, content, archived, service_id, subject, | ||
| created_by_id, version, process_type, hidden) | ||
| VALUES ('{}', '{}', '{}', '{}', '{}', False, '{}', '{}', '{}', 1, '{}', false) | ||
| """ | ||
|
|
||
| callback_failure_content = "\n".join( | ||
| [ | ||
| "[[fr]]", | ||
| "(la version française suit)", | ||
| "[[/fr]]", | ||
| "", | ||
| "[[en]]", | ||
| "Hello ((name)),", | ||
| "", | ||
| "The callbacks for “((service_name))” are not working. This could mean that:", | ||
| "", | ||
| "(1) Your callback service is down.", | ||
| "(2) Your service is using a proxy that we cannot access.", | ||
| "(3) We’re able to reach your service, but it responds with errors.", | ||
| "", | ||
| "It’s important to check your callback service is running, check your callback service’s logs for errors and repair any errors in your logs. To find your callback configuration, sign into your account, visit the API integration page for “((service_name))” and select callbacks.", | ||
| "", | ||
| "Once you’ve taken these steps, request confirmation that your callbacks are working again by [contacting us](((contact_url))). For more information, you can also access our [API documentation on callbacks](((callback_docs_url))).", | ||
| "", | ||
| "The GC Notify team", | ||
| "[[/en]]", | ||
| "", | ||
| "---", | ||
| "", | ||
| "[[fr]]", | ||
| "Bonjour ((name)),", | ||
| "", | ||
| "Les rappels pour « ((service_name)) » ne fonctionnent pas. Cela pourrait signifier que :" "", | ||
whabanks marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "(1) Votre service de rappel est hors service.", | ||
| "(2) Votre service utilise un proxy auquel nous ne pouvons pas accéder.", | ||
| "(3) Nous parvenons à joindre votre service, mais il répond avec des erreurs.", | ||
| "", | ||
| "Il est important de vérifier que votre service de rappel fonctionne, de vérifier les journaux de votre service de rappel pour détecter des erreurs et de corriger toute erreur dans vos journaux. Pour trouver votre configuration de rappel, connectez-vous à votre compte, visitez la page d’intégration API pour « ((service_name)) » et sélectionnez rappels.", | ||
| "", | ||
| "Une fois ces étapes effectuées, demandez une confirmation que vos rappels fonctionnent à nouveau en nous contactant. Pour plus d’informations, vous pouvez également consulter notre documentation API sur les rappels.", | ||
| "", | ||
| "L’équipe GC Notify", | ||
| "[[/fr]]", | ||
| ] | ||
| ) | ||
|
|
||
| templates = [ | ||
| { | ||
| "id": callback_failure_template_id, | ||
| "name": "Callback failures EMAIL", | ||
| "subject": "Your callbacks are not working | Vos rappels ne fonctionnent pas", | ||
| "content": callback_failure_content, | ||
| } | ||
| ] | ||
|
|
||
| for template in templates: | ||
| op.execute( | ||
| sqltext=template_insert.format( | ||
| template["id"], | ||
| template["name"], | ||
| "email", | ||
| datetime.utcnow(), | ||
| template["content"], | ||
| current_app.config["NOTIFY_SERVICE_ID"], | ||
| template["subject"], | ||
| current_app.config["NOTIFY_USER_ID"], | ||
| "normal", | ||
| ) | ||
| ) | ||
|
|
||
| op.execute( | ||
| template_history_insert.format( | ||
| template["id"], | ||
| template["name"], | ||
| "email", | ||
| datetime.utcnow(), | ||
| template["content"], | ||
| current_app.config["NOTIFY_SERVICE_ID"], | ||
| template["subject"], | ||
| current_app.config["NOTIFY_USER_ID"], | ||
| "normal", | ||
| ) | ||
| ) | ||
|
|
||
|
|
||
| def downgrade(): | ||
| op.execute("DELETE FROM notifications WHERE template_id = '{}'".format(callback_failure_template_id)) | ||
| op.execute("DELETE FROM notification_history WHERE template_id = '{}'".format(callback_failure_template_id)) | ||
| op.execute("DELETE FROM template_redacted WHERE template_id = '{}'".format(callback_failure_template_id)) | ||
| op.execute("DELETE FROM templates_history WHERE id = '{}'".format(callback_failure_template_id)) | ||
| op.execute("DELETE FROM templates WHERE id = '{}'".format(callback_failure_template_id)) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the limits feature, we use an expiring redis key to ensure only one email is sent within a particular time period. For example, if they reach the threshold, we send the email then set this key in redis to true. Then if they hit the threshold again within the time period the redis key will still be true and we will check it before sending another email.