remove the legacy Webhook model

Signed-off-by: tdruez <tdruez@aboutcode.org>

Author: tdruez

dejacode/settings.py

@@ -665,7 +665,6 @@ def get_fake_redis_connection(config, use_strict_redis):
 
 # https://github.com/zapier/django-rest-hooks
 HOOK_FINDER = "notification.models.find_and_fire_hook"
-HOOK_DELIVERER = "notification.tasks.deliver_hook_wrapper"
 HOOK_EVENTS = {
     # 'any.event.name': 'App.Model.Action' (created/updated/deleted)
     # If you want a Hook to be triggered for all users, add '+' to built-in Hooks.
@@ -676,7 +675,7 @@ def get_fake_redis_connection(config, use_strict_redis):
     "user.locked_out": None,
     "vulnerability.data_update": None,
 }
-# Provide context variables to the `Webhook` values such as `extra_headers`.
+# Provide context variables to WebhookSubscription extra_headers template values.
 HOOK_ENV = env.dict("HOOK_ENV", default={})
 
 # Django-axes

dje/management/commands/flushdataset.py

@@ -17,7 +17,8 @@
 from dje.models import ExternalReference
 from dje.models import ExternalSource
 from dje.models import get_unsecured_manager
-from notification.models import Webhook
+from notification.models import WebhookDelivery
+from notification.models import WebhookSubscription
 from vulnerabilities.models import Vulnerability
 
 
@@ -55,7 +56,8 @@ def handle(self, *args, **options):
                 UsagePolicy,
                 ExternalReference,
                 ExternalSource,
-                Webhook,
+                WebhookDelivery,
+                WebhookSubscription,
                 Vulnerability,
             ]
         )

dje/tests/test_access.py

@@ -41,7 +41,7 @@
 from dje.tests import create_user
 from dje.tests import refresh_url_cache
 from license_library.models import License
-from notification.models import Webhook
+from notification.models import WebhookSubscription
 from product_portfolio.models import Product
 
 
@@ -439,14 +439,13 @@ def test_user_locked_out_on_unsuccessful_login_attempts(self):
         attempt = AccessAttempt.objects.get(username=credentials["username"])
         self.assertEqual(2, attempt.failures_since_start)
 
-    @mock.patch("requests.Session.post", autospec=True)
+    @mock.patch("requests.post")
     def test_notification_on_unsuccessful_login_attempts(self, method_mock):
         user = create_user(username="real_user", dataspace=self.dataspace)
         extra_payload = {"username": "DejaCode Webhook"}
-        Webhook.objects.create(
+        WebhookSubscription.objects.create(
             dataspace=self.dataspace,
-            target="http://127.0.0.1:8000/",
-            user=user,
+            target_url="http://127.0.0.1:8000/",
             event="user.locked_out",
             extra_payload=extra_payload,
         )

etc/scripts/build_deb_docker.py

@@ -61,7 +61,7 @@ def build_deb_with_docker():
     filtered_dependencies = [
         dep
         for dep in dependencies
-        if "django-rest-hooks" not in dep and "django_notifications_patched" not in dep
+        if "django_notifications_patched" not in dep
     ]
 
     docker_cmd = [
@@ -98,7 +98,6 @@ def build_deb_with_docker():
             rm -rf build/
 
             # Install non-PyPI dependencies
-            pip install https://github.com/aboutcode-org/django-rest-hooks/releases/download/1.6.1/django_rest_hooks-1.6.1-py2.py3-none-any.whl
             pip install https://github.com/dejacode/django-notifications-patched/archive/refs/tags/2.0.0.tar.gz
 
             # Install dependencies directly

etc/scripts/build_nix_docker.py

@@ -242,21 +242,9 @@ def create_defualt_nix(dependencies_list, meta_dict):
         print("Processing {}/{}: {}".format(idx + 1, deps_size, dep["name"]))
         name = dep["name"]
         version = dep["version"]
-        # Handle 'django_notifications_patched' and 'django-rest-hooks' seperately
-        if name == "django-rest-hooks" or name == "django_notifications_patched":
-            if name == "django-rest-hooks" and version == "1.6.1":
-                nix_content += "    " + name + " = python.pkgs.buildPythonPackage {\n"
-                nix_content += '        pname = "django-rest-hooks";\n'
-                nix_content += '        version = "1.6.1";\n'
-                nix_content += '        format = "wheel";\n'
-                nix_content += "        src = pkgs.fetchurl {\n"
-                nix_content += '          url = "https://github.com/aboutcode-org/django-rest-hooks/releases/download/1.6.1/django_rest_hooks-1.6.1-py2.py3-none-any.whl";\n'
-                nix_content += (
-                    '          sha256 = "1byakq3ghpqhm0mjjkh8v5y6g3wlnri2vvfifyi9ky36l12vqx74";\n'
-                )
-                nix_content += "        };\n"
-                nix_content += "    };\n"
-            elif name == "django_notifications_patched" and version == "2.0.0":
+        # Handle 'django_notifications_patched' seperately
+        if name == "django_notifications_patched":
+            if name == "django_notifications_patched" and version == "2.0.0":
                 nix_content += "    " + name + " = self.buildPythonPackage rec {\n"
                 nix_content += '        pname = "django_notifications_patched";\n'
                 nix_content += '        version = "2.0.0";\n'

etc/scripts/build_rpm_docker.py

@@ -61,7 +61,7 @@ def build_rpm_with_docker():
     filtered_dependencies = [
         dep
         for dep in dependencies
-        if "django-rest-hooks" not in dep and "django-notifications-patched" not in dep
+        if "django-notifications-patched" not in dep
     ]
 
     # Create a requirements.txt content for installation
@@ -189,8 +189,6 @@ def build_rpm_with_docker():
 dnf install -y postgresql-devel
 
 # Install non-PyPI dependencies
-/tmp/venv_build/bin/python -m pip install \\
-    https://github.com/aboutcode-org/django-rest-hooks/releases/download/1.6.1/django_rest_hooks-1.6.1-py2.py3-none-any.whl
 /tmp/venv_build/bin/python -m pip install \\
     https://github.com/dejacode/django-notifications-patched/archive/refs/tags/2.0.0.tar.gz
 

notification/admin.py

@@ -15,20 +15,20 @@
 from dje.admin import ProhibitDataspaceLookupMixin
 from dje.admin import dejacode_site
 from dje.forms import DataspacedAdminForm
-from notification.models import Webhook
+from notification.models import WebhookSubscription
 
 HOOK_EVENTS = settings.HOOK_EVENTS
 if HOOK_EVENTS is None:
     raise ImproperlyConfigured("settings.HOOK_EVENTS is not defined")
 
 
-class WebookForm(DataspacedAdminForm):
+class WebhookSubscriptionForm(DataspacedAdminForm):
     EVENTS = [(event, event) for event in HOOK_EVENTS.keys()]
 
     class Meta:
-        model = Webhook
+        model = WebhookSubscription
         fields = [
-            "target",
+            "target_url",
             "event",
             "is_active",
             "extra_payload",
@@ -39,15 +39,11 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.fields["event"] = forms.ChoiceField(choices=self.EVENTS)
 
-        add = not kwargs.get("instance")
-        if add:
-            self.instance.user = self.request.user
 
-
-@admin.register(Webhook, site=dejacode_site)
-class WebookAdmin(ProhibitDataspaceLookupMixin, DataspacedAdmin):
-    list_display = ("__str__", "event", "target", "is_active", "dataspace")
-    form = WebookForm
+@admin.register(WebhookSubscription, site=dejacode_site)
+class WebhookSubscriptionAdmin(ProhibitDataspaceLookupMixin, DataspacedAdmin):
+    list_display = ("__str__", "event", "target_url", "is_active", "dataspace")
+    form = WebhookSubscriptionForm
     list_filter = ("is_active", "event")
     activity_log = False
     actions = []

notification/migrations/0004_delete_webhook.py

@@ -0,0 +1,16 @@
+# Generated by Django 6.0.6 on 2026-07-03 13:50
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('notification', '0003_migrate_webhook_to_webhooksubscription'),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name='Webhook',
+        ),
+    ]

notification/models.py

@@ -13,8 +13,6 @@
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
-from rest_hooks.models import AbstractHook
-
 from aboutcode.notifications import AbstractWebhookDelivery
 from aboutcode.notifications import AbstractWebhookSubscription
 from dje.models import DataspacedModel
@@ -83,6 +81,12 @@ def get_headers(self):
             headers.update(self.get_extra_headers())
         return headers
 
+    def deliver(self, context, timeout=10, payload_override=None):
+        if payload_override and self.extra_payload:
+            payload_override = {**payload_override}
+            payload_override.update(self.extra_payload)
+        return super().deliver(context, timeout=timeout, payload_override=payload_override)
+
     def get_payload(self, instance):
         payload = instance.serialize_hook(hook=self)
         if self.extra_payload:
@@ -121,46 +125,6 @@ class Meta(AbstractWebhookDelivery.Meta):
         unique_together = [("dataspace", "uuid")]
 
 
-# DataspacedModel is first as we want to apply it last for proper overrides
-class Webhook(DataspacedModel, AbstractHook):
-    is_active = models.BooleanField(default=True)
-    extra_payload = models.JSONField(
-        blank=True,
-        default=dict,
-        help_text=_("Extra data as JSON to be included in the payload"),
-    )
-    extra_headers = models.JSONField(
-        blank=True,
-        default=dict,
-        help_text=_("Extra headers as JSON to be included in the request"),
-    )
-
-    class Meta:
-        unique_together = ("dataspace", "uuid")
-
-    def __str__(self):
-        return f"{self.event} => {self.target}"
-
-    def dict(self):
-        return {"uuid": str(self.uuid), "event": self.event, "target": self.target}
-
-    def get_extra_headers(self):
-        """Inject `hook_env` context in headers template values."""
-        if hook_env := settings.HOOK_ENV:
-            hook_env_context = template.Context(hook_env)
-            return {
-                key: self.render_template(value, hook_env_context)
-                for key, value in self.extra_headers.items()
-            }
-
-        return self.extra_headers
-
-    @staticmethod
-    def render_template(value, hook_env_context):
-        if "{{" in value and "}}" in value:
-            return template.Template(value).render(hook_env_context)
-        return value
-
 
 def find_and_fire_hook(
     event_name,

notification/tests/test_models.py

@@ -11,39 +11,38 @@
 
 from dje.models import Dataspace
 from dje.tests import create_superuser
-from notification.models import Webhook
+from notification.models import WebhookSubscription
 
 
-class NotificationModelsTestCase(TestCase):
+class WebhookSubscriptionModelTestCase(TestCase):
     def setUp(self):
         self.nexb_dataspace = Dataspace.objects.create(name="nexB")
         self.nexb_user = create_superuser("nexb_user", self.nexb_dataspace)
 
-        self.webhook1 = Webhook.objects.create(
+        self.webhook = WebhookSubscription.objects.create(
             dataspace=self.nexb_dataspace,
-            target="http://1.2.3.4/",
-            user=self.nexb_user,
+            target_url="http://1.2.3.4/",
             event="request.added",
         )
 
-    def test_notification_webhook_model_str(self):
-        self.assertEqual("request.added => http://1.2.3.4/", str(self.webhook1))
+    def test_webhook_subscription_str(self):
+        self.assertEqual("request.added => http://1.2.3.4/", str(self.webhook))
 
-    def test_notification_webhook_model_dict(self):
+    def test_webhook_subscription_dict(self):
         expected = {
-            "uuid": str(self.webhook1.uuid),
-            "event": self.webhook1.event,
-            "target": self.webhook1.target,
+            "uuid": str(self.webhook.uuid),
+            "event": self.webhook.event,
+            "target": self.webhook.target_url,
         }
-        self.assertEqual(expected, self.webhook1.dict())
+        self.assertEqual(expected, self.webhook.dict())
 
-    def test_notification_webhook_model_get_extra_headers(self):
-        self.webhook1.extra_headers = {"Header": "{{ENV_VALUE}}"}
-        self.webhook1.save()
+    def test_webhook_subscription_get_extra_headers(self):
+        self.webhook.extra_headers = {"Header": "{{ENV_VALUE}}"}
+        self.webhook.save()
 
         expected = {"Header": "{{ENV_VALUE}}"}
-        self.assertEqual(expected, self.webhook1.get_extra_headers())
+        self.assertEqual(expected, self.webhook.get_extra_headers())
 
         expected = {"Header": "some_value"}
         with override_settings(HOOK_ENV={"ENV_VALUE": "some_value"}):
-            self.assertEqual(expected, self.webhook1.get_extra_headers())
+            self.assertEqual(expected, self.webhook.get_extra_headers())