Merge pull request #77 from maykinmedia/feature/76-add-uuids-to-lists

[#76] Add uuids to destruction lists

backend/src/openarchiefbeheer/destruction/admin.py

@@ -8,6 +8,7 @@ class DestructionListAdmin(admin.ModelAdmin):
     list_display = ("name", "status", "created", "end")
     list_filter = ("status", "assignee")
     search_fields = ("name",)
+    readonly_fields = ("uuid",)
 
 
 @admin.register(DestructionListItem)

backend/src/openarchiefbeheer/destruction/api/serializers.py

@@ -77,14 +77,19 @@ class DestructionListSerializer(serializers.ModelSerializer):
     class Meta:
         model = DestructionList
         fields = (
+            "uuid",
             "name",
             "author",
             "contains_sensitive_info",
             "assignees",
             "items",
             "status",
         )
-        extra_kwargs = {"status": {"read_only": True}, "author": {"read_only": True}}
+        extra_kwargs = {
+            "uuid": {"read_only": True},
+            "status": {"read_only": True},
+            "author": {"read_only": True},
+        }
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -151,7 +156,7 @@ class DestructionListResponseSerializer(serializers.ModelSerializer):
     class Meta:
         model = DestructionList
         fields = (
-            "pk",
+            "uuid",
             "name",
             "author",
             "contains_sensitive_info",

backend/src/openarchiefbeheer/destruction/api/viewsets.py

@@ -116,6 +116,7 @@ class DestructionListViewSet(
 ):
     serializer_class = DestructionListSerializer
     queryset = DestructionList.objects.all()
+    lookup_field = "uuid"
     filter_backends = (DjangoFilterBackend,)
     filterset_class = DestructionListFilterset
 

backend/src/openarchiefbeheer/destruction/migrations/0004_destructionlist_uuid.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.2.11 on 2024-06-06 09:17
+
+from django.db import migrations, models
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("destruction", "0003_destructionlist_status_changed"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="destructionlist",
+            name="uuid",
+            field=models.UUIDField(default=uuid.uuid4, null=True, verbose_name="uuid"),
+        ),
+    ]

backend/src/openarchiefbeheer/destruction/migrations/0005_populate_uuid_values.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.11 on 2024-06-06 09:17
+
+from django.db import migrations
+import uuid
+
+
+def generate_uuid(apps, schema_editor):
+    DestructionList = apps.get_model("destruction", "DestructionList")
+    for destruction_list in DestructionList.objects.all():
+        destruction_list.uuid = uuid.uuid4()
+        destruction_list.save(update_fields=["uuid"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("destruction", "0004_destructionlist_uuid"),
+    ]
+
+    operations = [
+        migrations.RunPython(generate_uuid, reverse_code=migrations.RunPython.noop),
+    ]

backend/src/openarchiefbeheer/destruction/migrations/0006_remove_uuid_null.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.11 on 2024-06-06 09:17
+
+from django.db import migrations, models
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("destruction", "0005_populate_uuid_values"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="destructionlist",
+            name="uuid",
+            field=models.UUIDField(
+                default=uuid.uuid4, unique=True, verbose_name="uuid"
+            ),
+        ),
+    ]

backend/src/openarchiefbeheer/destruction/models.py

@@ -1,4 +1,5 @@
 import logging
+import uuid as _uuid
 
 from django.db import models
 from django.utils import timezone
@@ -16,6 +17,7 @@
 
 class DestructionList(models.Model):
     name = models.CharField(_("name"), max_length=200, unique=True)
+    uuid = models.UUIDField(_("uuid"), default=_uuid.uuid4, unique=True)
     author = models.ForeignKey(
         "accounts.User",
         on_delete=models.CASCADE,

backend/src/openarchiefbeheer/destruction/tests/test_endpoints.py

@@ -204,7 +204,7 @@ def test_update_destruction_list(self):
         }
         self.client.force_authenticate(user=record_manager)
         endpoint = reverse(
-            "api:destructionlist-detail", kwargs={"pk": destruction_list.pk}
+            "api:destructionlist-detail", kwargs={"uuid": destruction_list.uuid}
         )
 
         response = self.client.put(
@@ -249,7 +249,7 @@ def test_partially_update_destruction_list(self):
         }
         self.client.force_authenticate(user=record_manager)
         endpoint = reverse(
-            "api:destructionlist-detail", kwargs={"pk": destruction_list.pk}
+            "api:destructionlist-detail", kwargs={"uuid": destruction_list.uuid}
         )
 
         response = self.client.patch(
@@ -287,8 +287,8 @@ def test_destruction_list_filter_on_assignee(self):
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(len(response.json()), 2)
         self.assertEqual(
-            [destruction_list["pk"] for destruction_list in response.json()].sort(),
-            [lists[0].pk, lists[1].pk].sort(),
+            [destruction_list["uuid"] for destruction_list in response.json()].sort(),
+            [lists[0].uuid, lists[1].uuid].sort(),
         )
 
 

frontend/src/lib/api/destructionLists.ts

@@ -5,7 +5,7 @@ import { request } from "./request";
 import { User } from "./reviewers";
 
 export type DestructionList = {
-  pk: number;
+  uuid: string;
   name: string;
   assignees: DestructionListAssignee[];
   items: DestructionListItem[];

frontend/src/pages/landing/Landing.tsx

@@ -77,7 +77,7 @@ export const Landing = () => {
       title: list.name,
       days: timeAgo(list.created),
       assigneeNames: constructAssigneeNames(list.assignees),
-      href: `/destruction-list/${list.pk}`,
+      href: `/destruction-list/${list.uuid}`,
     })),
   ) as unknown as AttributeData[][];