[#2055] Add option to use different template for action required notifications

Author: pi-sigma

src/open_inwoner/conf/parts/maileditor.py

@@ -410,6 +410,67 @@
             },
         ],
     },
+    "case_status_notification_action_required": {
+        "name": _("Case status update notification (action required)"),
+        "description": _(
+            "This email is used to notify people about a new status being set on their case "
+            "that requires action on their part."
+        ),
+        "subject_default": "Action required",
+        "body_default": """
+            <p>Beste</p>
+
+            <p>U ontvangt deze email, omdat de status van een van uw zaken is bijgewerkt.</p>
+
+            <table>
+                <tr>
+                    <th>Zaakidentificatie</th>
+                    <td>{{ identification }}</td>
+                </tr>
+                <tr>
+                    <th>Zaaktype</th>
+                    <td>{{ type_description }}</td>
+                </tr>
+                <tr>
+                    <th>Startdatum</th>
+                    <td>{{ start_date }}</td>
+                </tr>
+            </table>
+
+            <p><a href="{{ case_link }}">Ga naar uw zaak</a> </p>
+
+            <p>Met vriendelijke groet,
+            {{ site_name }} </p>
+       """,
+        "subject": [
+            {
+                "name": "site_name",
+                "description": _("Name of the site."),
+            },
+        ],
+        "body": [
+            {
+                "name": "identification",
+                "description": _("The identification of the case"),
+            },
+            {
+                "name": "type_description",
+                "description": _("The description of the type of the case"),
+            },
+            {
+                "name": "start_date",
+                "description": _("The start date of the case"),
+            },
+            {
+                "name": "case_link",
+                "description": _("The link to the case details."),
+            },
+            {
+                "name": "site_name",
+                "description": _("Name of the site"),
+            },
+        ],
+    },
     "contactform_registration": {
         "name": _("Contact form registration notification"),
         "description": _("This email is used to register a contact form submission"),

src/open_inwoner/openzaak/admin.py

@@ -193,6 +193,7 @@ class ZaakTypeStatusTypeConfigInline(admin.StackedInline):
         "status_indicator",
         "status_indicator_text",
         "notify_status_change",
+        "action_required",
         "document_upload_enabled",
         "document_upload_description",
         "description",

src/open_inwoner/openzaak/migrations/0043_zaaktypestatustypeconfig_action_required.py

@@ -0,0 +1,22 @@
+# Generated by Django 3.2.23 on 2024-01-30 14:23
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("openzaak", "0042_case_notification_mail_template_split"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="zaaktypestatustypeconfig",
+            name="action_required",
+            field=models.BooleanField(
+                default=False,
+                help_text="Whether the status change notification should indicate that an action is required",
+                verbose_name="Action required",
+            ),
+        ),
+    ]

src/open_inwoner/openzaak/models.py

@@ -420,6 +420,13 @@ class ZaakTypeStatusTypeConfig(models.Model):
             "Whether the user should be notfied if a case is set to this type of status"
         ),
     )
+    action_required = models.BooleanField(
+        verbose_name=_("Action required"),
+        default=False,
+        help_text=_(
+            "Whether the status change notification should indicate that an action is required"
+        ),
+    )
     document_upload_enabled = models.BooleanField(
         default=True,
         verbose_name=_("Document uploads"),

src/open_inwoner/openzaak/notifications.py

@@ -477,6 +477,7 @@ def handle_status_update(
     user: User,
     case: Zaak,
     status: Status,
+    status_type_config: ZaakTypeStatusTypeConfig,
 ):
     # hook into userfeed
     hooks.case_status_notification_received(user, case, status)
@@ -505,7 +506,13 @@ def handle_status_update(
         )
         return
 
-    send_case_update_email(user, case, "case_status_notification")
+    # choose template
+    if status_type_config.action_required:
+        template_name = "case_status_notification_action_required"
+    else:
+        template_name = "case_status_notification"
+
+    send_case_update_email(user, case, template_name)
     note.mark_sent()
 
     log_system_action(

src/open_inwoner/openzaak/tests/test_notification_zaak_status.py

@@ -540,8 +540,21 @@ def test_handle_status_update(self, mock_send: Mock, mock_feed_hook: Mock):
         status = factory(Status, data.status_final)
         status.statustype = factory(StatusType, data.status_type_final)
 
+        ztc = ZaakTypeConfigFactory.create(
+            catalogus=None,
+            identificatie=data.zaak_type["identificatie"],
+            # set this to notify
+            notify_status_changes=True,
+        )
+        status_type_config = ZaakTypeStatusTypeConfigFactory.create(
+            zaaktype_config=ztc,
+            omschrijving=data.status_type_final["omschrijving"],
+            statustype_url=data.status_type_final["url"],
+            notify_status_change=True,
+        )
+
         # first call
-        handle_status_update(user, case, status)
+        handle_status_update(user, case, status, status_type_config)
 
         mock_send.assert_called_once()
 
@@ -566,7 +579,7 @@ def test_handle_status_update(self, mock_send: Mock, mock_feed_hook: Mock):
         )
 
         # second call with same case/status
-        handle_status_update(user, case, status)
+        handle_status_update(user, case, status, status_type_config)
 
         # no duplicate mail for this user/case/status
         mock_send.assert_not_called()
@@ -578,7 +591,7 @@ def test_handle_status_update(self, mock_send: Mock, mock_feed_hook: Mock):
         )
         # other user is fine
         other_user = UserFactory.create()
-        handle_status_update(other_user, case, status)
+        handle_status_update(other_user, case, status, status_type_config)
 
         mock_send.assert_called_once()
 
@@ -594,7 +607,7 @@ def test_handle_status_update(self, mock_send: Mock, mock_feed_hook: Mock):
         status.statustype = factory(
             StatusType, copy_with_new_uuid(data.status_type_final)
         )
-        handle_status_update(user, case, status)
+        handle_status_update(user, case, status, status_type_config)
 
         # not sent because we already send to this user within the frequency
         mock_send.assert_not_called()
@@ -611,7 +624,42 @@ def test_handle_status_update(self, mock_send: Mock, mock_feed_hook: Mock):
             status.statustype = factory(
                 StatusType, copy_with_new_uuid(data.status_type_final)
             )
-            handle_status_update(user, case, status)
+            handle_status_update(user, case, status, status_type_config)
 
             # this one succeeds
             mock_send.assert_called_once()
+
+    @patch("open_inwoner.userfeed.hooks.case_status_notification_received")
+    @patch("open_inwoner.openzaak.notifications.send_case_update_email")
+    def test_action_required_template(self, mock_send: Mock, mock_feed_hook: Mock):
+        data = MockAPIData()
+        user = data.user_initiator
+
+        case = factory(Zaak, data.zaak)
+        case.zaaktype = factory(ZaakType, data.zaak_type)
+
+        status = factory(Status, data.status_final)
+        status.statustype = factory(StatusType, data.status_type_final)
+
+        ztc = ZaakTypeConfigFactory.create(
+            catalogus=None,
+            identificatie=data.zaak_type["identificatie"],
+            # set this to notify
+            notify_status_changes=True,
+        )
+        status_type_config = ZaakTypeStatusTypeConfigFactory.create(
+            zaaktype_config=ztc,
+            omschrijving=data.status_type_final["omschrijving"],
+            statustype_url=data.status_type_final["url"],
+            notify_status_change=True,
+            action_required=True,
+        )
+
+        handle_status_update(user, case, status, status_type_config)
+
+        mock_send.assert_called_once()
+        # check call arguments
+        args = mock_send.call_args.args
+        self.assertEqual(args[0], user)
+        self.assertEqual(args[1].url, case.url)
+        self.assertEqual(args[2], "case_status_notification_action_required")