Add status callback url

pyproject.toml

@@ -40,6 +40,7 @@ dependencies = [
     "face-recognition>=1.3.0",
     "opencv-python>=4.9.0.80",
     "django-celery-results>=2.5.1",
+    "requests>=2.32.3",
 ]
 
 [tool.pdm.build]

src/hope_dedup_engine/apps/api/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.0.6 on 2024-05-24 11:45
+# Generated by Django 5.0.6 on 2024-06-04 13:30
 
 import django.db.models.deletion
 import uuid
@@ -32,6 +32,7 @@ class Migration(migrations.Migration):
                 ("error", models.CharField(blank=True, max_length=255, null=True)),
                 ("created_at", models.DateTimeField(auto_now_add=True)),
                 ("updated_at", models.DateTimeField(auto_now=True)),
+                ("notification_url", models.CharField(blank=True, max_length=255, null=True)),
                 (
                     "created_by",
                     models.ForeignKey(

src/hope_dedup_engine/apps/api/models/deduplication.py

@@ -33,6 +33,7 @@ class State(models.IntegerChoices):
         settings.AUTH_USER_MODEL, on_delete=models.CASCADE, null=True, blank=True, related_name="+"
     )
     updated_at = models.DateTimeField(auto_now=True)
+    notification_url = models.CharField(max_length=255, null=True, blank=True)
 
 
 class Image(models.Model):

src/hope_dedup_engine/apps/api/utils.py

@@ -1,3 +1,5 @@
+import requests
+
 from hope_dedup_engine.apps.api.models import DeduplicationSet
 
 
@@ -7,3 +9,11 @@ def start_processing(_: DeduplicationSet) -> None:
 
 def delete_model_data(_: DeduplicationSet) -> None:
     pass
+
+
+REQUEST_TIMEOUT = 5
+
+
+def send_notification(deduplication_set: DeduplicationSet) -> None:
+    if url := deduplication_set.notification_url:
+        requests.get(url, timeout=REQUEST_TIMEOUT)

tests/api/test_utils.py

@@ -0,0 +1,28 @@
+from unittest.mock import MagicMock
+
+from pytest import fixture, mark
+from pytest_mock import MockerFixture
+
+from hope_dedup_engine.apps.api.models import DeduplicationSet
+from hope_dedup_engine.apps.api.utils import REQUEST_TIMEOUT, send_notification
+
+
+@fixture
+def requests_get_mock(mocker: MockerFixture) -> MagicMock:
+    return mocker.patch("hope_dedup_engine.apps.api.utils.requests.get")
+
+
+@mark.parametrize("deduplication_set__notification_url", ("https://example.com",))
+def test_notification_is_sent_when_url_is_set(
+    requests_get_mock: MagicMock, deduplication_set: DeduplicationSet
+) -> None:
+    send_notification(deduplication_set)
+    requests_get_mock.assert_called_once_with(deduplication_set.notification_url, timeout=REQUEST_TIMEOUT)
+
+
+@mark.parametrize("deduplication_set__notification_url", (None,))
+def test_notification_is_not_sent_when_url_is_not_set(
+    requests_get_mock: MagicMock, deduplication_set: DeduplicationSet
+) -> None:
+    send_notification(deduplication_set)
+    requests_get_mock.assert_not_called()

tests/extras/testutils/factories/api.py

@@ -16,6 +16,7 @@ class DeduplicationSetFactory(DjangoModelFactory):
     reference_pk = fuzzy.FuzzyText()
     external_system = SubFactory(ExternalSystemFactory)
     state = DeduplicationSet.State.CLEAN
+    notification_url = fuzzy.FuzzyText()
 
     class Meta:
         model = DeduplicationSet