remove rest hook

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

Author: tdruez

dejacode/settings.py

@@ -327,7 +327,6 @@ def gettext_noop(s):
     "crispy_bootstrap5",
     "guardian",
     "django_filters",
-    "rest_hooks",
     "notifications",
     "axes",
     "django_otp",
@@ -663,18 +662,14 @@ def get_fake_redis_connection(config, use_strict_redis):
 # django-altcha
 ALTCHA_HMAC_KEY = env.str("DEJACODE_ALTCHA_HMAC_KEY", default="")
 
-# https://github.com/zapier/django-rest-hooks
-HOOK_FINDER = "notification.models.find_and_fire_hook"
-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.
-    "request.added": "workflow.Request.created+",
-    "request.updated": "workflow.Request.updated+",
-    "request_comment.added": "workflow.RequestComment.created+",
-    "user.added_or_updated": None,
-    "user.locked_out": None,
-    "vulnerability.data_update": None,
-}
+WEBHOOK_EVENTS = [
+    "request.added",
+    "request.updated",
+    "request_comment.added",
+    "user.added_or_updated",
+    "user.locked_out",
+    "vulnerability.data_update",
+]
 # Provide context variables to WebhookSubscription extra_headers template values.
 HOOK_ENV = env.dict("HOOK_ENV", default={})
 

dje/notification.py

@@ -21,7 +21,7 @@
 from dje.models import History
 from dje.tasks import send_mail_task
 from dje.tasks import send_mail_to_admins_task
-from notification.models import find_and_fire_hook
+from notification.models import fire_webhooks
 
 ADDITION = History.ADDITION
 CHANGE = History.CHANGE
@@ -228,7 +228,7 @@ def notify_on_user_locked_out(request, username, **kwargs):
     if not reference_dataspace:
         return
 
-    find_and_fire_hook(
+    fire_webhooks(
         "user.locked_out",
         instance=None,
         dataspace=reference_dataspace,
@@ -248,7 +248,7 @@ def notify_on_user_added_or_updated(instance, **kwargs):
     if not reference_dataspace:
         return
 
-    find_and_fire_hook(
+    fire_webhooks(
         "user.added_or_updated",
         instance=instance,
         dataspace=reference_dataspace,

dje/tests/test_access.py

@@ -441,6 +441,7 @@ def test_user_locked_out_on_unsuccessful_login_attempts(self):
 
     @mock.patch("requests.post")
     def test_notification_on_unsuccessful_login_attempts(self, method_mock):
+        method_mock.return_value = None
         user = create_user(username="real_user", dataspace=self.dataspace)
         extra_payload = {"username": "DejaCode Webhook"}
         WebhookSubscription.objects.create(

etc/scripts/build_deb_docker.py

@@ -59,9 +59,7 @@ def build_deb_with_docker():
     dependencies = project.get("dependencies", [])
 
     filtered_dependencies = [
-        dep
-        for dep in dependencies
-        if "django_notifications_patched" not in dep
+        dep for dep in dependencies if "django_notifications_patched" not in dep
     ]
 
     docker_cmd = [

etc/scripts/build_rpm_docker.py

@@ -59,9 +59,7 @@ def build_rpm_with_docker():
     dependencies = project["dependencies"]
 
     filtered_dependencies = [
-        dep
-        for dep in dependencies
-        if "django-notifications-patched" not in dep
+        dep for dep in dependencies if "django-notifications-patched" not in dep
     ]
 
     # Create a requirements.txt content for installation

notification/admin.py

@@ -9,21 +9,16 @@
 from django import forms
 from django.conf import settings
 from django.contrib import admin
-from django.core.exceptions import ImproperlyConfigured
 
 from dje.admin import DataspacedAdmin
 from dje.admin import ProhibitDataspaceLookupMixin
 from dje.admin import dejacode_site
 from dje.forms import DataspacedAdminForm
 from notification.models import WebhookSubscription
 
-HOOK_EVENTS = settings.HOOK_EVENTS
-if HOOK_EVENTS is None:
-    raise ImproperlyConfigured("settings.HOOK_EVENTS is not defined")
-
 
 class WebhookSubscriptionForm(DataspacedAdminForm):
-    EVENTS = [(event, event) for event in HOOK_EVENTS.keys()]
+    EVENTS = [(event, event) for event in settings.WEBHOOK_EVENTS]
 
     class Meta:
         model = WebhookSubscription

notification/apps.py

@@ -13,3 +13,21 @@
 class NotificationConfig(AppConfig):
     name = "notification"
     verbose_name = _("Notification")
+
+    def ready(self):
+        from django.db.models.signals import post_save
+
+        from notification.models import fire_webhooks
+        from workflow.models import Request
+        from workflow.models import RequestComment
+
+        def fire_request_webhook(sender, instance, created, **kwargs):
+            event = "request.added" if created else "request.updated"
+            fire_webhooks(event, instance)
+
+        def fire_request_comment_webhook(sender, instance, created, **kwargs):
+            if created:
+                fire_webhooks("request_comment.added", instance)
+
+        post_save.connect(fire_request_webhook, sender=Request, weak=False)
+        post_save.connect(fire_request_comment_webhook, sender=RequestComment, weak=False)

notification/models.py

@@ -90,7 +90,7 @@ def deliver(self, context, timeout=10, payload_override=None):
     def get_payload(self, instance):
         payload = instance.serialize_hook(hook=self)
         if self.extra_payload:
-            payload.update(self.extra_payload)
+            payload["data"].update(self.extra_payload)
         return payload
 
     def create_delivery(self, payload, instance):
@@ -125,18 +125,18 @@ class Meta(AbstractWebhookDelivery.Meta):
         unique_together = [("dataspace", "uuid")]
 
 
-
-def find_and_fire_hook(
+def fire_webhooks(
     event_name,
     instance,
-    user_override=None,
     dataspace=None,
     payload_override=None,
 ):
     """
-    Fire active Webhook instances found in the `dataspace` for the `event_name`.
+    Enqueue async delivery for each active WebhookSubscription in `dataspace` matching `event_name`.
     If `dataspace` is not provided, uses the Dataspace of the `instance`.
     """
+    from notification.tasks import deliver_webhook_task
+
     if not dataspace and instance:
         dataspace = instance.dataspace
     if not dataspace:
@@ -150,4 +150,11 @@ def find_and_fire_hook(
     webhooks = WebhookSubscription.objects.scope(dataspace).filter(**filters)
 
     for webhook in webhooks:
-        webhook.deliver(instance, payload_override=payload_override)
+        task_kwargs = {"webhook_subscription_pk": webhook.pk}
+        if payload_override is not None:
+            task_kwargs["payload_override"] = payload_override
+        if instance is not None:
+            task_kwargs["instance_app_label"] = instance._meta.app_label
+            task_kwargs["instance_model_name"] = instance._meta.model_name
+            task_kwargs["instance_pk"] = instance.pk
+        deliver_webhook_task.delay(**task_kwargs)

notification/tasks.py

@@ -6,55 +6,41 @@
 # See https://aboutcode.org for more information about AboutCode FOSS projects.
 #
 
-import json
+import logging
 
-from django.template.defaultfilters import truncatechars
-
-import requests
 from django_rq import job
-from rest_framework.utils import encoders
 
-from dje.tasks import logger
+logger = logging.getLogger("dje")
 
 
 @job
-def deliver_hook_task(
-    target, payload, instance_id=None, hook_id=None, extra_headers=None, **kwargs
+def deliver_webhook_task(
+    webhook_subscription_pk,
+    payload_override=None,
+    instance_app_label=None,
+    instance_model_name=None,
+    instance_pk=None,
 ):
-    """
-    target: the url to receive the payload.
-    payload: a python primitive data structure
-    instance_id: a possibly None "trigger" instance ID
-    hook_id: the ID of defining Hook object
-    extra_headers: Additional headers such as Authentication ones
-    """
-    session = requests.Session()
-
-    session.headers.update({"Content-Type": "application/json"})
-    if extra_headers:
-        session.headers.update(extra_headers)
-
-    logger.info(f"Delivering Webhook hook_id={hook_id} to target={truncatechars(target, 25)}")
-    try:
-        session.post(url=target, data=payload)
-    except requests.ConnectionError:
-        return
-
+    """Deliver a webhook payload to the target URL of the given WebhookSubscription."""
+    from django.apps import apps
 
-def deliver_hook_wrapper(target, payload, instance, hook):
-    if hook.extra_payload:
-        payload.update(hook.extra_payload)
+    from notification.models import WebhookSubscription
 
-    # Using ID's instead of objects for proper serialization
-    kwargs = {
-        "target": target,
-        "payload": json.dumps(payload, cls=encoders.JSONEncoder),
-        "hook_id": hook.id,
-    }
-
-    if instance:
-        kwargs["instance_id"] = instance.id
-    if hook.extra_headers:
-        kwargs["extra_headers"] = hook.get_extra_headers()
+    try:
+        webhook_subscription = WebhookSubscription.objects.get(pk=webhook_subscription_pk)
+    except WebhookSubscription.DoesNotExist:
+        logger.error(f"WebhookSubscription pk={webhook_subscription_pk} not found.")
+        return
 
-    deliver_hook_task.delay(**kwargs)
+    instance = None
+    if instance_app_label and instance_model_name and instance_pk:
+        try:
+            model_class = apps.get_model(instance_app_label, instance_model_name)
+            instance = model_class.objects.get(pk=instance_pk)
+        except Exception:
+            logger.error(
+                f"Instance {instance_app_label}.{instance_model_name} pk={instance_pk} not found."
+            )
+            return
+
+    webhook_subscription.deliver(instance, payload_override=payload_override)

pyproject.toml

@@ -115,8 +115,6 @@ dependencies = [
     # license expressions
     "boolean.py==5.0",
     "license-expression==30.4.4",
-    # Webhooks
-    "django-rest-hooks==1.6.1",
     # django-notifications
     "django_notifications_patched==2.0.0",
     "jsonfield==3.2.0",