feat: ability to edit category slug in django admin (#1543)

* feat: make it possible to edit category slug in django admin

* feat: add feature flag for category slug editability in Django admin

* test: add tests for category slug editability based on feature flag

Author: justiandevs

app/signals/apps/signals/admin/category.py

@@ -2,8 +2,10 @@
 # Copyright (C) 2022 Gemeente Amsterdam
 import csv
 
+from django.conf import settings
 from django.contrib import admin
 from django.db.models import Q
+from django.forms import ModelForm
 from django.http import HttpResponse
 from django.utils import timezone
 from import_export.admin import ExportActionMixin, ImportExportModelAdmin
@@ -69,6 +71,17 @@ class StatusMessageCategoryInline(admin.TabularInline):
     extra = 1
 
 
+class CategoryAdminForm(ModelForm):
+    class Meta:
+        model = Category
+        fields = '__all__'
+        help_texts = {
+            'slug': (
+                "<br><b>Note:</b> After modifying the slug, the machine learning model must be retrained."
+            ),
+        }
+
+
 class CategoryAdmin(ImportExportModelAdmin, ExportActionMixin):
     resource_class = CategoryResource
 
@@ -80,14 +93,24 @@ class CategoryAdmin(ImportExportModelAdmin, ExportActionMixin):
     inlines = (ServiceLevelObjectiveInline, CategoryDepartmentInline, StatusMessageCategoryInline)
     fields = ('name', 'slug', 'parent', 'is_active', 'description', 'handling_message', 'public_name',
               'is_public_accessible', 'icon',)
-    readonly_fields = ('slug',)
     view_on_site = True
 
     search_fields = ('name', 'public_name',)
     ordering = ('parent__name', 'name',)
 
     actions = ['download_csv']
 
+    def get_form(self, request, obj=None, **kwargs):
+        if settings.FEATURE_FLAGS.get('CATEGORY_SLUG_EDITABLE', False):
+            kwargs['form'] = CategoryAdminForm
+        return super().get_form(request, obj, **kwargs)
+
+    def get_readonly_fields(self, request, obj=None):
+        readonly_fields = super().get_readonly_fields(request, obj)
+        if not settings.FEATURE_FLAGS.get('CATEGORY_SLUG_EDITABLE', False):
+            readonly_fields = list(readonly_fields) + ['slug']
+        return readonly_fields
+
     def has_delete_permission(self, request, obj=None):
         return False
 

app/signals/apps/signals/models/category.py

@@ -92,7 +92,8 @@ class Category(TrackFields, models.Model):
                                null=True, blank=True)
 
     # SIG-1135, the slug is auto populated using the django-extensions "AutoSlugField"
-    slug = AutoSlugField(populate_from=['name', ], blank=False, overwrite=False, editable=False)
+    slug = AutoSlugField(populate_from=['name', ], blank=False,
+                         overwrite=False, editable=settings.FEATURE_FLAGS.get('CATEGORY_SLUG_EDITABLE', False))
 
     name = models.CharField(max_length=255)
 
@@ -188,7 +189,7 @@ def has_icon(self):
     def clean(self):
         super().clean()
 
-        if self.pk and self.slug:
+        if self.pk and self.slug and not settings.FEATURE_FLAGS.get('CATEGORY_SLUG_EDITABLE', False):
             if not Category.objects.filter(id=self.pk, slug=self.slug).exists():
                 raise ValidationError('Category slug cannot be changed')
 

app/signals/apps/signals/tests/test_models.py

@@ -703,6 +703,37 @@ def test_invalid_show_in_filter_and_additional_config_parent_category_configurat
                 self.assertIn('Value of "show_children_in_filter" is not a valid boolean', messages)
                 self.assertIn('Only "show_children_in_filter" is allowed', messages)
 
+    @override_settings(FEATURE_FLAGS={'CATEGORY_SLUG_EDITABLE': True})
+    def test_slug_can_be_updated_when_feature_flag_enabled(self):
+        """
+        When CATEGORY_SLUG_EDITABLE feature flag is True, category slug should be editable
+        """
+        category = factories.CategoryFactory(name='Original Name')
+        original_slug = category.slug
+
+        category.slug = 'new-custom-slug'
+        category.save()
+        category.refresh_from_db()
+
+        self.assertEqual(category.slug, 'new-custom-slug')
+        self.assertNotEqual(category.slug, original_slug)
+
+    @override_settings(FEATURE_FLAGS={'CATEGORY_SLUG_EDITABLE': False})
+    def test_slug_cannot_be_updated_when_feature_flag_disabled(self):
+        """
+        When CATEGORY_SLUG_EDITABLE feature flag is False, category slug should not be editable
+        """
+        category = factories.CategoryFactory(name='Original Name')
+        original_slug = category.slug
+
+        category.slug = 'new-custom-slug'
+
+        with self.assertRaises(ValidationError):
+            category.save()
+
+        category.refresh_from_db()
+        self.assertEqual(category.slug, original_slug)
+
 
 class TestCategoryDeclarations(TestCase):
 

app/signals/settings.py

@@ -543,7 +543,10 @@ def is_super_user(user) -> bool:
     'DSL_RUN_ROUTING_EXPRESSIONS_ON_UPDATES': os.getenv('DSL_RUN_ROUTING_EXPRESSIONS_ON_UPDATES', False) in TRUE_VALUES,
 
     # Enable/Disable showing employee details in the PDF export
-    'SHOW_EMPLOYEE_DETAILS_IN_PDF': os.getenv('SHOW_EMPLOYEE_DETAILS_IN_PDF', True) in TRUE_VALUES
+    'SHOW_EMPLOYEE_DETAILS_IN_PDF': os.getenv('SHOW_EMPLOYEE_DETAILS_IN_PDF', True) in TRUE_VALUES,
+
+    # Enable/Disable editing category slug in Django admin
+    'CATEGORY_SLUG_EDITABLE': os.getenv('CATEGORY_SLUG_EDITABLE', False) in TRUE_VALUES
 }
 
 # Per default log to console