✨(webhook) add webhook logic and synchronization utils

adding webhooks logic to send serialized team memberships data
to a designated serie of webhooks.

src/backend/core/utils/scim.py

@@ -0,0 +1,70 @@
+"""A minimalist SCIM client to synchronize with remote service providers."""
+
+import logging
+
+import requests
+from urllib3.util import Retry
+
+logger = logging.getLogger(__name__)
+
+adapter = requests.adapters.HTTPAdapter(
+    max_retries=Retry(
+        total=4,
+        backoff_factor=0.1,
+        status_forcelist=[500, 502],
+        allowed_methods=["PATCH"],
+    )
+)
+
+session = requests.Session()
+session.mount("http://", adapter)
+session.mount("https://", adapter)
+
+
+class SCIMClient:
+    """A minimalist SCIM client for our needs."""
+
+    def add_user_to_group(self, webhook, user):
+        """Add a user to a group from its ID or email."""
+        payload = {
+            "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
+            "Operations": [
+                {
+                    "op": "add",
+                    "path": "members",
+                    "value": [
+                        {"value": str(user.id), "email": user.email, "type": "User"}
+                    ],
+                }
+            ],
+        }
+
+        return session.patch(
+            webhook.url,
+            json=payload,
+            headers=webhook.get_headers(),
+            verify=False,
+            timeout=3,
+        )
+
+    def remove_user_from_group(self, webhook, user):
+        """Remove a user from a group by its ID or email."""
+        payload = {
+            "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
+            "Operations": [
+                {
+                    "op": "remove",
+                    "path": "members",
+                    "value": [
+                        {"value": str(user.id), "email": user.email, "type": "User"}
+                    ],
+                }
+            ],
+        }
+        return session.patch(
+            webhook.url,
+            json=payload,
+            headers=webhook.get_headers(),
+            verify=False,
+            timeout=3,
+        )

src/backend/core/utils/webhooks.py

@@ -0,0 +1,75 @@
+"""Fire webhooks with synchronous retries"""
+
+import logging
+
+import requests
+
+from core.enums import WebhookStatusChoices
+
+from .scim import SCIMClient
+
+logger = logging.getLogger(__name__)
+
+
+class WebhookSCIMClient:
+    """Wraps the SCIM client to record call results on webhooks."""
+
+    def __getattr__(self, name):
+        """Handle calls from webhooks to synchronize a team access with a distant application."""
+
+        def wrapper(team, user):
+            """
+            Wrap SCIMClient calls to handle retries, error handling and storing result in the
+            calling Webhook instance.
+            """
+            for webhook in team.webhooks.all():
+                if not webhook.url:
+                    continue
+
+                client = SCIMClient()
+                status = WebhookStatusChoices.FAILURE
+                try:
+                    response = getattr(client, name)(webhook, user)
+
+                except requests.exceptions.RetryError as exc:
+                    logger.error(
+                        "%s synchronization failed due to max retries exceeded with url %s",
+                        name,
+                        webhook.url,
+                        exc_info=exc,
+                    )
+                except requests.exceptions.RequestException as exc:
+                    logger.error(
+                        "%s synchronization failed with %s.",
+                        name,
+                        webhook.url,
+                        exc_info=exc,
+                    )
+                else:
+                    extra = {
+                        "response": response.content,
+                    }
+                    # pylint: disable=no-member
+                    if response.status_code == requests.codes.ok:
+                        logger.info(
+                            "%s synchronization succeeded with %s",
+                            name,
+                            webhook.url,
+                            extra=extra,
+                        )
+
+                        status = WebhookStatusChoices.SUCCESS
+                    else:
+                        logger.error(
+                            "%s synchronization failed with %s",
+                            name,
+                            webhook.url,
+                            extra=extra,
+                        )
+
+                webhook._meta.model.objects.filter(id=webhook.id).update(status=status)  # noqa
+
+        return wrapper
+
+
+scim_synchronizer = WebhookSCIMClient()