Added Report.short_id. Fix #178

Author: epou

mosquito_alert/reports/admin.py

@@ -31,7 +31,7 @@ class ReportChildAdmin(NestedPolymorphicModelAdmin, PolymorphicChildModelAdmin):
     show_in_index = True
     inlines = [ReadOnlyPhotoAdminInline, FlaggedContentNestedInlineAdmin]
     list_filter = ["observed_at", "created_at"]
-    list_display = ["id", "user", "observed_at", "created_at", "updated_at"]
+    list_display = ["id", "short_id", "user", "observed_at", "created_at", "updated_at"]
 
     def get_form(self, request, obj=None, **kwargs):
         form = super().get_form(request, obj=obj, **kwargs)

mosquito_alert/reports/migrations/0007_report_short_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.3 on 2024-10-18 09:46
+
+from django.db import migrations
+import mosquito_alert.utils.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("reports", "0006_alter_report_tags"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="report",
+            name="short_id",
+            field=mosquito_alert.utils.fields.ShortIDField(editable=False, size=10),
+        ),
+    ]

mosquito_alert/reports/models.py

@@ -16,6 +16,7 @@
 from mosquito_alert.moderation.models import FlagModeratedModel
 from mosquito_alert.tags.models import UUIDTaggedItem
 from mosquito_alert.taxa.models import Taxon
+from mosquito_alert.utils.fields import ShortIDField
 from mosquito_alert.utils.models import TimeStampedModel
 
 from .managers import IndividualReportManager, ReportManager
@@ -45,6 +46,7 @@ class Report(GeoLocatedModel, FlagModeratedModel, TimeStampedModel, PolymorphicM
     # Attributes - Mandatory
     # NOTE: in case licensing is needed, get inspiration from django-licensing (it does not work)
     # license = models.ForeignKey(License, on_delete=models.PROTECT)
+    short_id = ShortIDField(size=10, editable=False)
     # TODO: add location_is_modified or another location for the event_location.
     observed_at = models.DateTimeField(blank=True)  # TODO: rename to event_datetime
     published = models.BooleanField(default=False)  # TODO: make it published_at

mosquito_alert/reports/tests/test_models.py

@@ -94,6 +94,15 @@ def test_photos_can_be_blank(self):
     def test_photos_can_be_sorted(self):
         assert self.model._meta.get_field("photos").sorted
 
+    def test_short_id_can_not_be_null(self):
+        assert not self.model._meta.get_field("short_id").null
+
+    def test_short_id_size(self):
+        assert self.model._meta.get_field("short_id").size == 10
+
+    def test_short_id_is_not_editable(self):
+        assert not self.model._meta.get_field("short_id").editable
+
     def test_observed_at_can_not_be_null(self):
         assert not self.model._meta.get_field("observed_at").null
 

mosquito_alert/utils/fields.py

@@ -1,4 +1,9 @@
+import math
+import secrets
+from typing import Any
+
 from django.apps import apps
+from django.db import models
 from simple_history.models import HistoricalRecords, registered_models
 
 
@@ -57,3 +62,29 @@ def create_proxy_history_model(self, model, inherited, base_history):
         name = self.get_history_model_name(model)
         registered_models[opts.db_table] = model
         return type(str(name), (base_history,), attrs)
+
+
+class ShortIDField(models.CharField):
+    """
+    A custom model field that generates a short, URL-safe identifier.
+    """
+
+    def __init__(self, size: int, *args, **kwargs) -> None:
+        if not isinstance(size, int) or size <= 0:
+            raise ValueError("Size must be a positive integer.")
+        # See: https://zelark.github.io/nano-id-cc/
+        self.size = size
+        kwargs["max_length"] = size  # Assign max_length from size
+        kwargs["default"] = self.generate_short_id  # Use the method to generate the default value
+        super().__init__(*args, **kwargs)
+
+    def generate_short_id(self):
+        """Generates a URL-safe short ID of specified length."""
+        return secrets.token_urlsafe(nbytes=math.ceil(self.size / 1.3))[: self.size]
+
+    def deconstruct(self) -> Any:
+        name, path, args, kwargs = super().deconstruct()
+        kwargs["size"] = self.size
+        del kwargs["max_length"]
+        del kwargs["default"]
+        return name, path, args, kwargs

mosquito_alert/utils/tests/models.py

@@ -3,6 +3,7 @@
 from treebeard.mp_tree import MP_Node
 from treebeard.ns_tree import NS_Node
 
+from ..fields import ShortIDField
 from ..models import NodeExpandedQueriesMixin, ObservableMixin, ParentManageableNodeMixin, TimeStampedModel
 
 
@@ -44,3 +45,7 @@ class DummyObservableModel(ObservableMixin, models.Model):
 
 class DummyCounterModel(models.Model):
     counter = models.IntegerField(default=0)
+
+
+class DummyShortIDModel(models.Model):
+    short_id = ShortIDField(size=11)

mosquito_alert/utils/tests/test_fields.py

@@ -0,0 +1,36 @@
+import pytest
+
+from ..fields import ShortIDField
+from .models import DummyShortIDModel
+
+
+@pytest.mark.django_db
+class TestShortIDField:
+    def test_short_id_length(self):
+        instance = DummyShortIDModel.objects.create()
+        assert instance.short_id is not None
+        assert len(instance.short_id) == 11  # Ensure length matches the specified size
+
+    def test_short_id_is_url_safe(self):
+        instance = DummyShortIDModel.objects.create()
+        assert all(c.isalnum() or c in "-_" for c in instance.short_id)  # Check for URL-safe characters
+
+    def test_short_id_uniqueness(self):
+        instances = [DummyShortIDModel.objects.create() for _ in range(100)]  # Create multiple instances
+        short_ids = [instance.short_id for instance in instances]
+        assert len(short_ids) == len(set(short_ids))  # Ensure all short IDs are unique
+
+    def test_short_id_generation_on_create(self):
+        instance1 = DummyShortIDModel.objects.create()
+        instance2 = DummyShortIDModel.objects.create()
+        assert instance1.short_id != instance2.short_id  # Ensure different IDs are generated
+
+    def test_size_is_required(self):
+        with pytest.raises(TypeError) as excinfo:
+            ShortIDField()  # Attempt to create a ShortIDField without the size parameter
+        assert "missing 1 required positional argument: 'size'" in str(excinfo.value)
+
+    @pytest.mark.parametrize("size", [-1, 0, "str", None, 1.5])
+    def test_size_raise_if_not_positive_integer(self, size):
+        with pytest.raises(ValueError):
+            ShortIDField(size=size)