Task/delete a service (#2682)

* Notify all team members when service is deleted

* Add migration for delete a service template

* Fix migration

* Fix tests

* Update FR translation

Co-authored-by: Copilot <[email protected]>

* Add exception handling during service archival

* Fix test caused by silly mistake

* pseduo-FF deactivation email sending

- Do not send service deactivated confirmation email if we're in prod

---------

Co-authored-by: Copilot <[email protected]>

Author: whabanks

.vscode/launch.json

@@ -101,5 +101,12 @@
             "jinja": true,
             "justMyCode": false
         }
+    ],
+    "compounds": [
+        {
+            "name": "API/Celery",
+            "configurations": ["Python: Flask", "Python: Celery"],
+            "stopAll": true
+        }
     ]
 }

app/config.py

@@ -330,6 +330,7 @@ class Config(object):
         "65bbee1b-9c2a-48a6-b95a-d7d70e8f6726"  # Sent when a service is deactivated due to a user being deactivated
     )
     USER_DEACTIVATED_TEMPLATE_ID = "d0fe2b8c-ddcf-4f9b-8bb7-d79006e7cfa7"  # Sent when a user deactivates their own account
+    SERVICE_DEACTIVATED_TEMPLATE_ID = "71263145-8606-43b0-9f42-08a2c227523a"  # Sent when a user deactivates a service
 
     # Templates for annual limits
     REACHED_ANNUAL_LIMIT_TEMPLATE_ID = "ca6d9205-d923-4198-acdd-d0aa37725c37"

app/dao/dao_utils.py

@@ -36,7 +36,7 @@ def version_class(*version_options):
     def versioned(func):
         @wraps(func)
         def record_version(*args, **kwargs):
-            func(*args, **kwargs)
+            result = func(*args, **kwargs)
 
             session_objects = []
 
@@ -62,6 +62,8 @@ def record_version(*args, **kwargs):
             for session_object, history_class in session_objects:
                 db.session.add(create_history(session_object, history_cls=history_class))
 
+            return result
+
         return record_version
 
     return versioned

app/dao/services_dao.py

@@ -250,7 +250,7 @@ def dao_archive_service(service_id):
     atomicity.
     """
 
-    dao_archive_service_no_transaction(service_id)
+    return dao_archive_service_no_transaction(service_id)
 
 
 @version_class(
@@ -283,6 +283,7 @@ def dao_archive_service_no_transaction(service_id):
         .filter(Service.id == service_id)
         .one()
     )
+    original_service_name = service.name
 
     time = datetime.utcnow().strftime("%Y-%m-%d_%H:%M:%S")
     service.active = False
@@ -297,6 +298,8 @@ def dao_archive_service_no_transaction(service_id):
         if not api_key.expiry_date:
             api_key.expiry_date = datetime.utcnow()
 
+    return original_service_name
+
 
 def dao_fetch_service_by_id_and_user(service_id, user_id):
     return Service.query.filter(Service.users.any(id=user_id), Service.id == service_id).options(joinedload("users")).one()

app/service/rest.py

@@ -13,7 +13,7 @@
 )
 from psycopg2.errors import UniqueViolation
 from sqlalchemy import func
-from sqlalchemy.exc import IntegrityError
+from sqlalchemy.exc import IntegrityError, SQLAlchemyError
 from sqlalchemy.orm.exc import NoResultFound
 
 from app import redis_store, salesforce_client
@@ -778,10 +778,29 @@ def archive_service(service_id):
     :param service_id:
     :return:
     """
-    service = dao_fetch_service_by_id(service_id)
+    service: Service = dao_fetch_service_by_id(service_id)
 
     if service.active:
-        dao_archive_service(service.id)
+        try:
+            service_name = dao_archive_service(service.id)
+            # FF_USER_SERVICE_DEACTIVATION
+            if current_app.config["NOTIFY_ENVIRONMENT"].lower() != "production":
+                send_notification_to_service_users(
+                    service_id=service_id,
+                    template_id=current_app.config["SERVICE_DEACTIVATED_TEMPLATE_ID"],
+                    personalisation={
+                        "service_name": service_name,
+                    },
+                )
+        except SQLAlchemyError as e:
+            current_app.logger.exception(e)
+            raise InvalidRequest(
+                f"A dao error occurred while archiving service {service_id}. Deactivation confirmation emails were not sent to service users",
+                status_code=500,
+            )
+        except Exception as e:
+            current_app.logger.exception(e)
+
         if current_app.config["FF_SALESFORCE_CONTACT"]:
             try:
                 salesforce_client.engagement_close(service)

migrations/versions/0492_add_service_del_template.py

@@ -0,0 +1,110 @@
+"""
+
+Revision ID: 0492_add_service_del_template
+Revises: 0491_split_deactivate_templates
+Create Date: 2025-10-21 00:00:00
+
+"""
+from datetime import datetime
+
+from alembic import op
+from flask import current_app
+
+revision = "0492_add_service_del_template"
+down_revision = "0491_split_deactivate_templates"
+
+service_deactivated_template_id = current_app.config["SERVICE_DEACTIVATED_TEMPLATE_ID"]
+template_ids = [service_deactivated_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)
+    """
+
+    service_suspended_content = "\n".join(
+        [
+            "[[fr]](la version française suit)[[/fr]]",
+            "",
+            "[[en]]",
+            "You or one of your team members has deleted ((service_name)).",
+            "",
+            "You cannot:",
+            "- Access, manage or make changes to ((service_name)).",
+            "- Send messages from ((service_name)).",
+            "",
+            "If no one on your team deleted this service, immediately [contact us](https://notification.canada.ca/en/contact).",
+            "",
+            "The GC Notify Team",
+            "[[/en]]",
+            "",
+            "---",
+            "",
+            "[[fr]]",
+            "Vous ou un membre de votre équipe avez supprimé le service ((service_name)).",
+            "",
+            "Vous ne pouvez plus :",
+            "- Accéder, gérer ou apporter des changements au service ((service_name)).",
+            "- Envoyer des messages provenant du service ((service_name)).",
+            "",
+            "Si vous ni votre équipe n’avez demandé de supprimer ce service, contactez-nous immédiatement.",
+            "",
+            "L’équipe Notification GC",
+            "[[/fr]]",
+        ]
+    )
+
+    templates = [
+        {
+            "id": service_deactivated_template_id,
+            "name": "Service deleted",
+            "subject": "((service_name)) deleted | ((service_name)) supprimé",
+            "content": service_suspended_content,
+            "template_type": "email",  
+            "process_type": "normal",
+        },
+    ]
+
+    for template in templates:
+        op.execute(
+            template_insert.format(
+                template["id"],
+                template["name"],
+                template["template_type"],
+                datetime.utcnow(),
+                template["content"],
+                current_app.config["NOTIFY_SERVICE_ID"],
+                template["subject"],
+                current_app.config["NOTIFY_USER_ID"],
+                template["process_type"],
+            )
+        )
+
+        op.execute(
+            template_history_insert.format(
+                template["id"],
+                template["name"],
+                template["template_type"],
+                datetime.utcnow(),
+                template["content"],
+                current_app.config["NOTIFY_SERVICE_ID"],
+                template["subject"],
+                current_app.config["NOTIFY_USER_ID"],
+                template["process_type"], 
+            )
+        )
+
+def downgrade():
+    for template_id in template_ids:
+        op.execute("DELETE FROM notifications WHERE template_id = '{}'".format(template_id))
+        op.execute("DELETE FROM notification_history WHERE template_id = '{}'".format(template_id))
+        op.execute("DELETE FROM template_redacted WHERE template_id = '{}'".format(template_id))
+        op.execute("DELETE FROM templates_history WHERE id = '{}'".format(template_id))
+        op.execute("DELETE FROM templates WHERE id = '{}'".format(template_id))
+

tests/app/service/test_archived_service.py

@@ -2,6 +2,7 @@
 from datetime import datetime
 
 import pytest
+from flask import current_app
 from freezegun import freeze_time
 
 from app import db
@@ -25,6 +26,27 @@ def test_archive_service_errors_with_bad_service_id(client, notify_db_session):
     assert response.status_code == 404
 
 
+def test_archiving_service_sends_deletion_email_to_all_users(client, sample_service, mocker):
+    """Test that archiving a service sends deletion email to all service users"""
+    # Mock the send_notification_to_service_users function
+    mock_send_notification = mocker.patch("app.service.rest.send_notification_to_service_users")
+    service_name = sample_service.name
+
+    auth_header = create_authorization_header()
+    response = client.post("/service/{}/archive".format(sample_service.id), headers=[auth_header])
+
+    assert response.status_code == 204
+
+    # Verify that send_notification_to_service_users was called with correct parameters
+    mock_send_notification.assert_called_once_with(
+        service_id=sample_service.id,
+        template_id=current_app.config["SERVICE_DEACTIVATED_TEMPLATE_ID"],
+        personalisation={
+            "service_name": service_name,
+        },
+    )
+
+
 def test_deactivating_inactive_service_does_nothing(client, sample_service):
     auth_header = create_authorization_header()
     sample_service.active = False
@@ -35,7 +57,8 @@ def test_deactivating_inactive_service_does_nothing(client, sample_service):
 
 @pytest.fixture
 @freeze_time("2018-04-21 14:00")
-def archived_service(client, notify_db, sample_service):
+def archived_service(client, notify_db, sample_service, mocker):
+    mocker.patch("app.service.rest.send_notification_to_service_users")
     create_template(sample_service, template_name="a")
     create_template(sample_service, template_name="b")
     create_api_key(sample_service)
@@ -78,7 +101,8 @@ def test_deactivating_service_creates_history(archived_service):
 
 
 @pytest.fixture
-def archived_service_with_deleted_stuff(client, sample_service):
+def archived_service_with_deleted_stuff(client, sample_service, mocker):
+    mocker.patch("app.service.rest.send_notification_to_service_users")
     with freeze_time("2001-01-01"):
         template = create_template(sample_service, template_name="a")
         api_key = create_api_key(sample_service)