[change] Changed zerotier background notifications to "Generic Message" type #1048

Closes #1048

Author: stktyagi

openwisp_controller/config/apps.py

@@ -237,47 +237,6 @@ def register_notification_types(self):
             },
             models=[self.device_model],
         )
-
-        register_notification_type(
-            "api_task_error",
-            {
-                "verbose_name": _("Background API Task ERROR"),
-                "verb": _("encountered an unrecoverable error"),
-                "level": "error",
-                "email_subject": _(
-                    '[{site.name}] ERROR: "{notification.target}" - '
-                    "VPN Server {action} API Task {notification.verb}"
-                ),
-                "message": _(
-                    "Unable to perform {action} operation on the "
-                    "[{notification.target}]({notification.target_link}) VPN server "
-                    "due to an unrecoverable error (status code: {status_code})"
-                ),
-                # Disable email notifications by default
-                "email_notification": False,
-            },
-            models=[self.vpn_model],
-        )
-        register_notification_type(
-            "api_task_recovery",
-            {
-                "verbose_name": _("Background API Task RECOVERY"),
-                "verb": _("has been completed successfully"),
-                "level": "info",
-                "email_subject": _(
-                    '[{site.name}] RECOVERY: "{notification.target}" - '
-                    "VPN Server {action} API Task {notification.verb}"
-                ),
-                "message": _(
-                    "The {action} operation on [{notification.target}]"
-                    "({notification.target_link}) {notification.verb}"
-                ),
-                # Disable email notifications by default
-                "email_notification": False,
-            },
-            models=[self.vpn_model],
-        )
-
         #  Unregister default notification type
         try:
             unregister_notification_type("default")

openwisp_controller/config/migrations/0060_cleanup_api_task_notification_types.py

@@ -0,0 +1,31 @@
+# Generated by Django 5.2.2 on 2025-06-30 11:34
+
+from django.db import migrations
+
+
+def cleanup_api_task_notification_types(apps, schema_editor):
+    if not apps.is_installed("openwisp_notifications"):
+        return
+    Notification = apps.get_model("openwisp_notifications", "Notification")
+    NotificationSetting = apps.get_model(
+        "openwisp_notifications", "NotificationSetting"
+    )
+    NotificationSetting.objects.filter(
+        type__in=["api_task_error", "api_task_recovery"]
+    ).delete()
+    Notification.objects.filter(
+        type__in=["api_task_error", "api_task_recovery"]
+    ).delete()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("config", "0059_zerotier_templates_ow_zt_to_global"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            cleanup_api_task_notification_types, reverse_code=migrations.RunPython.noop
+        ),
+    ]

openwisp_controller/config/tasks_zerotier.py

@@ -5,6 +5,7 @@
 from celery import shared_task
 from django.core.cache import cache
 from django.core.exceptions import ObjectDoesNotExist
+from django.utils.translation import gettext as _
 from openwisp_notifications.signals import notify
 from requests.exceptions import RequestException
 from swapper import load_model
@@ -35,12 +36,37 @@ def _send_api_task_notification(self, type, **kwargs):
         # with the ow-notification container
         # https://github.com/openwisp/openwisp-notifications/issues/264
         sleep(2)
+        message_map = {
+            "error": {
+                "verb": _("encountered an unrecoverable error"),
+                "message": _(
+                    "Unable to perform {action} operation on the "
+                    "{target} VPN server due to an "
+                    "unrecoverable error "
+                    "(status code: {status_code})"
+                ),
+                "level": "error",
+            },
+            "recovery": {
+                "verb": _("has been completed successfully"),
+                "message": _("The {action} operation on {target} {verb}."),
+                "level": "info",
+            },
+        }
+        meta = message_map[type]
         notify.send(
-            type=f"api_task_{type}",
+            type="generic_message",
             sender=vpn,
             target=vpn,
             action=action,
-            status_code=status_code,
+            verb=meta["verb"],
+            message=meta["message"].format(
+                action=action,
+                target=str(vpn),
+                status_code=status_code,
+                verb=meta["verb"],
+            ),
+            level=meta["level"],
         )
 
     def handle_api_call(self, fn, *args, send_notification=True, **kwargs):

openwisp_controller/config/tests/test_notifications.py

@@ -273,7 +273,7 @@ def test_zerotier_api_tasks_notification(
                 notification = notification_qs.first()
                 self.assertEqual(notification.actor, vpn)
                 self.assertEqual(notification.target, vpn)
-                self.assertEqual(notification.type, "api_task_error")
+                self.assertEqual(notification.type, "generic_message")
                 self.assertIn(
                     "Unable to perform update operation", notification.message
                 )
@@ -315,14 +315,14 @@ def test_zerotier_api_tasks_notification(
                 self.assertEqual(mock_info.call_count, 1)
                 self.assertEqual(notification_recovery.actor, vpn)
                 self.assertEqual(notification_recovery.target, vpn)
-                self.assertEqual(notification_recovery.type, "api_task_recovery")
+                self.assertEqual(notification_recovery.type, "generic_message")
                 self.assertIn("The update operation on", notification_recovery.message)
                 # For unrecoverable error
                 self.assertEqual(mock_warn.call_count, 0)
                 self.assertEqual(mock_error.call_count, 1)
                 self.assertEqual(notification_error.actor, vpn)
                 self.assertEqual(notification_error.target, vpn)
-                self.assertEqual(notification_error.type, "api_task_error")
+                self.assertEqual(notification_error.type, "generic_message")
                 self.assertIn(
                     "Unable to perform update member operation",
                     notification_error.message,