[#20] Add an identifier field to the Subscription model

notifications_api_common/admin.py

@@ -34,5 +34,5 @@ def register_webhook(modeladmin, request, queryset):
 
 @admin.register(Subscription)
 class SubscriptionAdmin(admin.ModelAdmin):
-    list_display = ("callback_url", "channels", "_subscription")
+    list_display = ("identifier", "callback_url", "channels", "_subscription")
     actions = [register_webhook]

notifications_api_common/migrations/0009_add_subscription_identifier.py

@@ -0,0 +1,54 @@
+# Generated by Django 5.1.4 on 2024-12-09 08:15
+
+from django.db import migrations, models
+
+
+def generate_missing_identifiers(apps, schema_editor):
+    Subscription = apps.get_model("notifications_api_common", "Subscription")
+
+    count = 1
+    for subscription in Subscription.objects.all():
+        while Subscription.objects.filter(
+            identifier=f"subscription-{count:02d}"
+        ).exists():
+            count += 1
+
+        subscription.identifier = f"subscription-{count:02d}"
+        subscription.save(update_fields=["identifier"])
+        count += 1
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "notifications_api_common",
+            "0008_merge_0006_auto_20221213_0214_0007_auto_20221206_0414",
+        ),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="subscription",
+            name="identifier",
+            field=models.SlugField(
+                help_text="A human-friendly identifier to refer to this subscription.",
+                max_length=64,
+                null=True,
+                unique=True,
+            ),
+        ),
+        migrations.RunPython(
+            generate_missing_identifiers,
+            reverse_code=migrations.RunPython.noop,
+        ),
+        migrations.AlterField(
+            model_name="subscription",
+            name="identifier",
+            field=models.SlugField(
+                help_text="A human-friendly identifier to refer to this subscription.",
+                max_length=64,
+                unique=True,
+            ),
+        ),
+    ]

notifications_api_common/models.py

@@ -76,6 +76,13 @@ class Subscription(models.Model):
     TODO: on change/update, update the subscription
     """
 
+    identifier = models.SlugField(
+        unique=True,
+        blank=False,
+        null=False,
+        max_length=64,
+        help_text=_("A human-friendly identifier to refer to this subscription."),
+    )
     callback_url = models.URLField(
         _("callback url"), help_text=_("Where to send the notifications (webhook url)")
     )

tests/test_register_webhook.py

@@ -27,6 +27,7 @@ def test_register_webhook_success(
     request_with_middleware, notifications_config, *mocks
 ):
     subscription = Subscription.objects.create(
+        identifier="sub",
         callback_url="https://example.com/callback",
         client_id="client_id",
         secret="secret",
@@ -48,6 +49,7 @@ def test_register_webhook_request_exception(
     request_with_middleware, notifications_config
 ):
     Subscription.objects.create(
+        identifier="sub",
         callback_url="https://example.com/callback",
         client_id="client_id",
         secret="secret",
@@ -68,6 +70,7 @@ def test_register_webhook_request_exception(
 @pytest.mark.django_db
 def test_register_webhook_http_error(request_with_middleware, notifications_config):
     Subscription.objects.create(
+        identifier="sub",
         callback_url="https://example.com/callback",
         client_id="client_id",
         secret="secret",