Merge pull request #1087 from maykinmedia/fix/2193-replace-better-adm…

…in-arrayfield ♻️ [#2193] Replace django-better-admin-arrayfield with django-jsonform
maykinmedia · Mar 12, 2024 · 3bbd1a3 · 3bbd1a3
2 parents 3a27bb2 + 646b1ec
commit 3bbd1a3
Show file tree

Hide file tree

Showing 30 changed files with 161 additions and 98 deletions.
diff --git a/requirements/base.in b/requirements/base.in
@@ -33,7 +33,7 @@ django-colorfield
 django-registration
 django-view-breadcrumbs
 markdown
-django_better_admin_arrayfield
+django-jsonform
 humanfriendly
 git+https://github.com/maykinmedia/[email protected]#egg=mail-editor
 fontawesomefree

diff --git a/requirements/base.txt b/requirements/base.txt
@@ -103,6 +103,7 @@ django==4.2.10
     #   django-htmx
     #   django-import-export
     #   django-js-asset
+    #   django-jsonform
     #   django-localflavor
     #   django-log-outgoing-requests
     #   django-open-forms-client
@@ -144,10 +145,6 @@ django-autoslug==1.9.8
     # via -r requirements/base.in
 django-axes==5.25.0
     # via -r requirements/base.in
-django-better-admin-arrayfield==1.4.2
-    # via
-    #   -r requirements/base.in
-    #   mozilla-django-oidc-db
 django-choices==2.0.0
     # via mail-editor
 django-ckeditor==6.7.0
@@ -201,6 +198,10 @@ django-ipware==4.0.0
     # via django-axes
 django-js-asset==2.2.0
     # via django-ckeditor
+django-jsonform==2.22.0
+    # via
+    #   -r requirements/base.in
+    #   mozilla-django-oidc-db
 django-localflavor==3.1
     # via -r requirements/base.in
 django-log-outgoing-requests==0.6.1
@@ -374,7 +375,7 @@ messagebird==2.1.0
     # via -r requirements/base.in
 mozilla-django-oidc==2.0.0
     # via mozilla-django-oidc-db
-mozilla-django-oidc-db==0.12.0
+mozilla-django-oidc-db==0.14.1
     # via -r requirements/base.in
 notifications-api-common==0.2.2
     # via -r requirements/base.in

diff --git a/requirements/ci.txt b/requirements/ci.txt
@@ -179,6 +179,7 @@ django==4.2.10
     #   django-htmx
     #   django-import-export
     #   django-js-asset
+    #   django-jsonform
     #   django-localflavor
     #   django-log-outgoing-requests
     #   django-open-forms-client
@@ -231,11 +232,6 @@ django-axes==5.25.0
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
-django-better-admin-arrayfield==1.4.2
-    # via
-    #   -c requirements/base.txt
-    #   -r requirements/base.txt
-    #   mozilla-django-oidc-db
 django-choices==2.0.0
     # via
     #   -c requirements/base.txt
@@ -329,6 +325,11 @@ django-js-asset==2.2.0
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   django-ckeditor
+django-jsonform==2.22.0
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
+    #   mozilla-django-oidc-db
 django-localflavor==3.1
     # via
     #   -c requirements/base.txt
@@ -665,7 +666,7 @@ mozilla-django-oidc==2.0.0
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   mozilla-django-oidc-db
-mozilla-django-oidc-db==0.12.0
+mozilla-django-oidc-db==0.14.1
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt

diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -217,6 +217,7 @@ django==4.2.10
     #   django-htmx
     #   django-import-export
     #   django-js-asset
+    #   django-jsonform
     #   django-localflavor
     #   django-log-outgoing-requests
     #   django-open-forms-client
@@ -270,11 +271,6 @@ django-axes==5.25.0
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
-django-better-admin-arrayfield==1.4.2
-    # via
-    #   -c requirements/ci.txt
-    #   -r requirements/ci.txt
-    #   mozilla-django-oidc-db
 django-choices==2.0.0
     # via
     #   -c requirements/ci.txt
@@ -372,6 +368,11 @@ django-js-asset==2.2.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-ckeditor
+django-jsonform==2.22.0
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   mozilla-django-oidc-db
 django-localflavor==3.1
     # via
     #   -c requirements/ci.txt
@@ -767,7 +768,7 @@ mozilla-django-oidc==2.0.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   mozilla-django-oidc-db
-mozilla-django-oidc-db==0.12.0
+mozilla-django-oidc-db==0.14.1
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt

diff --git a/src/digid_eherkenning_oidc_generics/admin.py b/src/digid_eherkenning_oidc_generics/admin.py
@@ -1,14 +1,13 @@
 from django.contrib import admin
 from django.utils.translation import gettext_lazy as _
 
-from django_better_admin_arrayfield.admin.mixins import DynamicArrayMixin
 from solo.admin import SingletonModelAdmin
 
 from .forms import OpenIDConnectDigiDConfigForm, OpenIDConnectEHerkenningConfigForm
 from .models import OpenIDConnectDigiDConfig, OpenIDConnectEHerkenningConfig
 
 
-class OpenIDConnectConfigBaseAdmin(DynamicArrayMixin, SingletonModelAdmin):
+class OpenIDConnectConfigBaseAdmin(SingletonModelAdmin):
     fieldsets = (
         (
             _("Activation"),

diff --git a/src/digid_eherkenning_oidc_generics/migrations/0001_initial.py b/src/digid_eherkenning_oidc_generics/migrations/0001_initial.py
@@ -2,7 +2,7 @@
 
 import digid_eherkenning_oidc_generics.models
 from django.db import migrations, models
-import django_better_admin_arrayfield.models.fields
+import django_jsonform.models.fields
 import mozilla_django_oidc_db.models
 
 
@@ -127,7 +127,7 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "oidc_exempt_urls",
-                    django_better_admin_arrayfield.models.fields.ArrayField(
+                    django_jsonform.models.fields.ArrayField(
                         base_field=models.CharField(
                             max_length=1000, verbose_name="Exempt URL"
                         ),
@@ -188,7 +188,7 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "oidc_rp_scopes_list",
-                    django_better_admin_arrayfield.models.fields.ArrayField(
+                    django_jsonform.models.fields.ArrayField(
                         base_field=models.CharField(
                             max_length=50, verbose_name="OpenID Connect scope"
                         ),
@@ -319,7 +319,7 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "oidc_exempt_urls",
-                    django_better_admin_arrayfield.models.fields.ArrayField(
+                    django_jsonform.models.fields.ArrayField(
                         base_field=models.CharField(
                             max_length=1000, verbose_name="Exempt URL"
                         ),
@@ -380,7 +380,7 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "oidc_rp_scopes_list",
-                    django_better_admin_arrayfield.models.fields.ArrayField(
+                    django_jsonform.models.fields.ArrayField(
                         base_field=models.CharField(
                             max_length=50, verbose_name="OpenID Connect scope"
                         ),

diff --git a/...oidc_generics/migrations/0003_alter_openidconnectdigidconfig_oidc_exempt_urls_and_more.py b/...oidc_generics/migrations/0003_alter_openidconnectdigidconfig_oidc_exempt_urls_and_more.py
@@ -0,0 +1,38 @@
+# Generated by Django 4.2.10 on 2024-03-11 16:12
+
+from django.db import migrations, models
+import django_jsonform.models.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("digid_eherkenning_oidc_generics", "0002_auto_20240109_1055"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="openidconnectdigidconfig",
+            name="oidc_exempt_urls",
+            field=django_jsonform.models.fields.ArrayField(
+                base_field=models.CharField(max_length=1000, verbose_name="Exempt URL"),
+                blank=True,
+                default=list,
+                help_text="This is a list of absolute url paths, regular expressions for url paths, or Django view names. This plus the mozilla-django-oidc urls are exempted from the session renewal by the SessionRefresh middleware.",
+                size=None,
+                verbose_name="URLs exempt from session renewal",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="openidconnecteherkenningconfig",
+            name="oidc_exempt_urls",
+            field=django_jsonform.models.fields.ArrayField(
+                base_field=models.CharField(max_length=1000, verbose_name="Exempt URL"),
+                blank=True,
+                default=list,
+                help_text="This is a list of absolute url paths, regular expressions for url paths, or Django view names. This plus the mozilla-django-oidc urls are exempted from the session renewal by the SessionRefresh middleware.",
+                size=None,
+                verbose_name="URLs exempt from session renewal",
+            ),
+        ),
+    ]
diff --git a/src/digid_eherkenning_oidc_generics/models.py b/src/digid_eherkenning_oidc_generics/models.py
@@ -2,7 +2,7 @@
 from django.utils.functional import classproperty
 from django.utils.translation import gettext_lazy as _
 
-from django_better_admin_arrayfield.models.fields import ArrayField
+from django_jsonform.models.fields import ArrayField
 from mozilla_django_oidc_db.models import CachingMixin, OpenIDConnectConfigBase
 
 from .digid_settings import DIGID_CUSTOM_OIDC_DB_PREFIX

diff --git a/src/open_inwoner/conf/base.py b/src/open_inwoner/conf/base.py
@@ -178,7 +178,7 @@
     "solo",
     "colorfield",
     "view_breadcrumbs",
-    "django_better_admin_arrayfield",
+    "django_jsonform",
     "simple_certmanager",
     "zgw_consumers",
     "notifications_api_common",

diff --git a/src/open_inwoner/configurations/migrations/0058_siteconfiguration_recipients_email_digest.py b/src/open_inwoner/configurations/migrations/0058_siteconfiguration_recipients_email_digest.py
@@ -1,7 +1,7 @@
 # Generated by Django 3.2.23 on 2024-01-22 10:18
 
 from django.db import migrations, models
-import django_better_admin_arrayfield.models.fields
+import django_jsonform.models.fields
 
 
 class Migration(migrations.Migration):
@@ -14,7 +14,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name="siteconfiguration",
             name="recipients_email_digest",
-            field=django_better_admin_arrayfield.models.fields.ArrayField(
+            field=django_jsonform.models.fields.ArrayField(
                 base_field=models.EmailField(max_length=254),
                 blank=True,
                 default=list,

diff --git a/src/open_inwoner/configurations/models.py b/src/open_inwoner/configurations/models.py
@@ -10,7 +10,7 @@
 from django.utils.translation import gettext_lazy as _
 
 from colorfield.fields import ColorField
-from django_better_admin_arrayfield.models.fields import ArrayField
+from django_jsonform.models.fields import ArrayField
 from filer.fields.image import FilerImageField
 from ordered_model.models import OrderedModel, OrderedModelManager
 from solo.models import SingletonModel

diff --git a/src/open_inwoner/configurations/tests/test_admin.py b/src/open_inwoner/configurations/tests/test_admin.py
@@ -118,6 +118,10 @@ def setUp(self):
         self.form["secondary_font_color"] = "#FFFFFF"
         self.form["accent_color"] = "#FFFFFF"
         self.form["accent_font_color"] = "#FFFFFF"
+        # django-jsonform requires JS to work properly and with Webtest the default
+        # value for ArrayFields is an empty string, causing it crash to when trying to parse
+        # that value as JSON
+        self.form["recipients_email_digest"] = "[]"
 
     def test_valid_path_is_saved(self):
         config = SiteConfiguration.get_solo()

diff --git a/src/open_inwoner/configurations/tests/test_colors.py b/src/open_inwoner/configurations/tests/test_colors.py
@@ -27,6 +27,10 @@ def test_contrast_is_checked(self):
         form["secondary_font_color"] = "#FFFFFF"
         form["accent_color"] = "#FFFFFF"
         form["accent_font_color"] = "#FFFFFF"
+        # django-jsonform requires JS to work properly and with Webtest the default
+        # value for ArrayFields is an empty string, causing it crash to when trying to parse
+        # that value as JSON
+        form["recipients_email_digest"] = "[]"
         response = form.submit("_continue").follow()
 
         messages = list(response.context["messages"])

diff --git a/src/open_inwoner/configurations/tests/test_upload.py b/src/open_inwoner/configurations/tests/test_upload.py
@@ -23,6 +23,11 @@ def setUp(self):
             reverse("admin:configurations_siteconfiguration_change"), user=self.user
         ).forms["siteconfiguration_form"]
 
+        # django-jsonform requires JS to work properly and with Webtest the default
+        # value for ArrayFields is an empty string, causing it crash to when trying to parse
+        # that value as JSON
+        self.form["recipients_email_digest"] = "[]"
+
     def test_upload_font_correct_filetype(self):
         font_file = Upload("valid.ttf", b"content", content_type="font/ttf")
         self.form["name"] = "Test"

diff --git a/src/open_inwoner/openzaak/migrations/0006_auto_20230123_1619.py b/src/open_inwoner/openzaak/migrations/0006_auto_20230123_1619.py
@@ -1,7 +1,7 @@
 # Generated by Django 3.2.15 on 2023-01-23 15:19
 
 from django.db import migrations, models
-import django_better_admin_arrayfield.models.fields
+import django_jsonform.models.fields
 
 
 class Migration(migrations.Migration):
@@ -14,7 +14,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name="openzaakconfig",
             name="allowed_file_extensions",
-            field=django_better_admin_arrayfield.models.fields.ArrayField(
+            field=django_jsonform.models.fields.ArrayField(
                 base_field=models.CharField(
                     max_length=8, verbose_name="Allowed file extensions"
                 ),

diff --git a/src/open_inwoner/openzaak/migrations/0007_alter_openzaakconfig_allowed_file_extensions.py b/src/open_inwoner/openzaak/migrations/0007_alter_openzaakconfig_allowed_file_extensions.py
@@ -1,7 +1,7 @@
 # Generated by Django 3.2.15 on 2023-01-25 10:12
 
 from django.db import migrations, models
-import django_better_admin_arrayfield.models.fields
+import django_jsonform.models.fields
 import open_inwoner.openzaak.models
 
 
@@ -15,7 +15,7 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name="openzaakconfig",
             name="allowed_file_extensions",
-            field=django_better_admin_arrayfield.models.fields.ArrayField(
+            field=django_jsonform.models.fields.ArrayField(
                 base_field=models.CharField(
                     max_length=8, verbose_name="Allowed file extensions"
                 ),

diff --git a/src/open_inwoner/openzaak/migrations/0009_auto_20230131_1253.py b/src/open_inwoner/openzaak/migrations/0009_auto_20230131_1253.py
@@ -3,7 +3,7 @@
 import django.db.models.deletion
 from django.db import migrations, models
 
-import django_better_admin_arrayfield.models.fields
+import django_jsonform.models.fields
 
 
 class Migration(migrations.Migration):
@@ -49,7 +49,7 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "zaaktype_uuids",
-                    django_better_admin_arrayfield.models.fields.ArrayField(
+                    django_jsonform.models.fields.ArrayField(
                         base_field=models.UUIDField(verbose_name="Zaaktype UUID"),
                         default=list,
                         size=None,

diff --git a/src/open_inwoner/openzaak/migrations/0025_auto_20231016_0957.py b/src/open_inwoner/openzaak/migrations/0025_auto_20231016_0957.py
@@ -2,7 +2,7 @@
 
 from django.db import migrations, models
 import django.db.models.deletion
-import django_better_admin_arrayfield.models.fields
+import django_jsonform.models.fields
 
 
 class Migration(migrations.Migration):
@@ -38,7 +38,7 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "zaaktype_uuids",
-                    django_better_admin_arrayfield.models.fields.ArrayField(
+                    django_jsonform.models.fields.ArrayField(
                         base_field=models.UUIDField(verbose_name="Zaaktype UUID"),
                         default=list,
                         size=None,

diff --git a/src/open_inwoner/openzaak/migrations/0027_zaaktype_resultaattype_config.py b/src/open_inwoner/openzaak/migrations/0027_zaaktype_resultaattype_config.py
@@ -2,7 +2,7 @@
 
 from django.db import migrations, models
 import django.db.models.deletion
-import django_better_admin_arrayfield.models.fields
+import django_jsonform.models.fields
 
 
 class Migration(migrations.Migration):
@@ -34,7 +34,7 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "zaaktype_uuids",
-                    django_better_admin_arrayfield.models.fields.ArrayField(
+                    django_jsonform.models.fields.ArrayField(
                         base_field=models.UUIDField(verbose_name="Zaaktype UUID"),
                         default=list,
                         size=None,