Merge pull request #632 from digitalfabrik/indicate_migrated_jobs_units_words

Indicate in API and CMS if a job, word or unit was migrated from the old data model

Author: sascha11110

CHANGELOG.md

@@ -1,6 +1,8 @@
 UNRELEASED
 ----------
 
+* [ [#632](https://github.com/digitalfabrik/lunes-cms/pull/632) ] Indicate in API and CMS if a job, unit or word was migrated from the old data model
+
 
 2025.11.0
 ---------

lunes_cms/api/v2/serializers/job_serializer.py

@@ -1,3 +1,5 @@
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
 
 from ....cmsv2.models import Job
@@ -9,11 +11,17 @@ class JobSerializer(serializers.ModelSerializer):
     """
 
     number_units = serializers.IntegerField()
+    migrated = serializers.SerializerMethodField()
+
+    @extend_schema_field(OpenApiTypes.BOOL)
+    def get_migrated(self, obj):
+        """Return True if the job was migrated from the old data model"""
+        return obj.v1_id is not None
 
     class Meta:
         """
         Define model and the corresponding fields
         """
 
         model = Job
-        fields = ("id", "name", "icon", "number_units")
+        fields = ("id", "name", "icon", "number_units", "migrated")

lunes_cms/api/v2/serializers/unit_serializer.py

@@ -1,3 +1,5 @@
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
 
 from ....cmsv2.models import Unit
@@ -9,6 +11,12 @@ class UnitSerializer(serializers.ModelSerializer):
     """
 
     number_words = serializers.IntegerField()
+    migrated = serializers.SerializerMethodField()
+
+    @extend_schema_field(OpenApiTypes.BOOL)
+    def get_migrated(self, obj):
+        """Return True if the unit was migrated from the old data model."""
+        return obj.v1_id is not None
 
     class Meta:
         """
@@ -22,4 +30,5 @@ class Meta:
             "description",
             "icon",
             "number_words",
+            "migrated",
         )

lunes_cms/api/v2/serializers/word_serializer.py

@@ -1,3 +1,5 @@
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
 
 from ....cmsv2.models import Word
@@ -13,11 +15,17 @@ class WordSerializer(serializers.ModelSerializer):
         child=serializers.ImageField(), source="images_for_api"
     )
     example_sentence = serializers.SerializerMethodField()
+    migrated = serializers.SerializerMethodField()
 
     def get_example_sentence(self, obj):
         """Return None for empty example sentences instead of empty string."""
         return obj.example_sentence if obj.example_sentence else None
 
+    @extend_schema_field(OpenApiTypes.BOOL)
+    def get_migrated(self, obj):
+        """Return True if the word was migrated from the old data model"""
+        return obj.v1_id is not None
+
     class Meta:
         """
         Define model and the corresponding fields
@@ -32,4 +40,5 @@ class Meta:
             "audio",
             "example_sentence",
             "example_sentence_audio",
+            "migrated",
         )

lunes_cms/cmsv2/admins/job_admin.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import, unicode_literals
 
 from django.contrib import admin
+from django.utils.html import format_html
 from django.utils.translation import gettext_lazy as _
 
 from .base import BaseAdmin
@@ -18,6 +19,46 @@ class UnitInline(admin.TabularInline):
     extra = 1
 
 
+class MigratedFilter(admin.SimpleListFilter):
+    """
+    Admin filter for migration status.
+
+    Allows filtering jobs by whether they were migrated from v1 or created in v2.
+    """
+
+    title = _("migration status")
+    parameter_name = "migrated"
+
+    def lookups(self, request, model_admin):
+        """
+        Return the filter options.
+
+        Returns:
+            list: A list of tuples containing (value, label) pairs for the filter options
+        """
+        return [
+            ("yes", _("Migrated from old data model")),
+            ("no", _("Not migrated from old data model")),
+        ]
+
+    def queryset(self, request, queryset):
+        """
+        Filter the queryset based on the selected option.
+
+        Args:
+            request: The HTTP request
+            queryset: The queryset to filter
+
+        Returns:
+            QuerySet: The filtered queryset
+        """
+        if self.value() == "yes":
+            return queryset.filter(v1_id__isnull=False)
+        if self.value() == "no":
+            return queryset.filter(v1_id__isnull=True)
+        return queryset
+
+
 class JobAdmin(BaseAdmin):
     """
     Admin interface for the Job model.
@@ -28,23 +69,25 @@ class JobAdmin(BaseAdmin):
 
     fields = [
         "name",
+        "migrated_status",
         "icon",
         "image_tag",
         "created_by",
         "released",
     ]
-    readonly_fields = ["created_by", "image_tag"]
+    readonly_fields = ["created_by", "image_tag", "migrated_status"]
     inlines = [UnitInline]
     search_fields = ["name"]
     list_display = [
         "name",
+        "migrated_status",
         "released",
         "list_icon",
         "created_by",
         "created_at_date",
     ]
     list_display_links = ["name"]
-    list_filter = ["released"]
+    list_filter = ["released", MigratedFilter]
     list_per_page = 25
     ordering = ["name"]
 
@@ -86,3 +129,25 @@ def created_at_date(self, obj):
         return obj.created_at.date()
 
     created_at_date.short_description = _("created at")
+
+    def migrated_status(self, obj):
+        """
+        Display a badge indicating whether the job was migrated from v1 or created in v2.
+
+        Args:
+            obj: The job object
+
+        Returns:
+            str: HTML formatted badge showing migration status
+        """
+        if obj.v1_id is not None:
+            return format_html(
+                '<span style="background-color: #28a745; color: white; padding: 3px 8px; '
+                'border-radius: 3px; font-size: 13px; font-weight: 500;">Migrated</span>'
+            )
+        return format_html(
+            '<span style="background-color: #007bff; color: white; padding: 3px 8px; '
+            'border-radius: 3px; font-size: 13px; font-weight: 500;">New</span>'
+        )
+
+    migrated_status.short_description = _("migrated")

lunes_cms/cmsv2/admins/unit_admin.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import, unicode_literals
 
 from django.contrib import admin
+from django.utils.html import format_html
 from django.utils.translation import gettext_lazy as _
 
 from lunes_cms.cmsv2.admins.base import BaseAdmin
@@ -31,6 +32,46 @@ def get_formset(self, request, obj=None, **kwargs):
         return formset
 
 
+class MigratedFilter(admin.SimpleListFilter):
+    """
+    Admin filter for migration status.
+
+    Allows filtering units by whether they were migrated from v1 or created in v2.
+    """
+
+    title = _("migration status")
+    parameter_name = "migrated"
+
+    def lookups(self, request, model_admin):
+        """
+        Return the filter options.
+
+        Returns:
+            list: A list of tuples containing (value, label) pairs for the filter options
+        """
+        return [
+            ("yes", _("Migrated from old data model")),
+            ("no", _("Not migrated from old data model")),
+        ]
+
+    def queryset(self, request, queryset):
+        """
+        Filter the queryset based on the selected option.
+
+        Args:
+            request: The HTTP request
+            queryset: The queryset to filter
+
+        Returns:
+            QuerySet: The filtered queryset
+        """
+        if self.value() == "yes":
+            return queryset.filter(v1_id__isnull=False)
+        if self.value() == "no":
+            return queryset.filter(v1_id__isnull=True)
+        return queryset
+
+
 class UnitAdmin(BaseAdmin):
     """
     Admin interface for the Unit model.
@@ -41,26 +82,28 @@ class UnitAdmin(BaseAdmin):
 
     fields = [
         "title",
+        "migrated_status",
         "description",
         "icon",
         "image_tag",
         "jobs",
         "created_by",
         "released",
     ]
-    readonly_fields = ["created_by", "image_tag"]
+    readonly_fields = ["created_by", "image_tag", "migrated_status"]
     inlines = [WordInline]
     search_fields = ["title"]
     list_display = [
         "title",
+        "migrated_status",
         "released",
         "list_icon",
         "related_jobs",
         "creator_group",
         "created_at_date",
     ]
     list_display_links = ["title"]
-    list_filter = ["released"]
+    list_filter = ["released", MigratedFilter]
     list_per_page = 25
 
     class Media:
@@ -120,3 +163,25 @@ def created_at_date(self, obj):
         return obj.created_at.date()
 
     created_at_date.short_description = _("created at")
+
+    def migrated_status(self, obj):
+        """
+        Display a badge indicating whether the unit was migrated from v1 or created in v2.
+
+        Args:
+            obj: The unit object
+
+        Returns:
+            str: HTML formatted badge showing migration status
+        """
+        if obj.v1_id is not None:
+            return format_html(
+                '<span style="background-color: #28a745; color: white; padding: 3px 8px; '
+                'border-radius: 3px; font-size: 13px; font-weight: 500;">Migrated</span>'
+            )
+        return format_html(
+            '<span style="background-color: #007bff; color: white; padding: 3px 8px; '
+            'border-radius: 3px; font-size: 13px; font-weight: 500;">New</span>'
+        )
+
+    migrated_status.short_description = _("migrated")