[change] Replaced thirdparty JSONField with Django built-in JSONField #1061

Replaced jsonfield package's JSONField with Django's built-in JSONField across all models to use the modern, maintained Django implementation.

Fixes #1061

Author: Eeshu-Yadav

openwisp_controller/config/admin.py

@@ -15,6 +15,7 @@
     ObjectDoesNotExist,
     ValidationError,
 )
+from django.db import models
 from django.http import Http404, HttpResponse, HttpResponseRedirect, JsonResponse
 from django.http.response import HttpResponseForbidden
 from django.shortcuts import get_object_or_404
@@ -217,6 +218,9 @@ def _get_preview_instance(self, request):
                 key = "{relation}_id".format(relation=key)
                 # pass non-empty string or None
                 kwargs[key] = value or None
+            # parse JSON strings for JSONField fields
+            elif isinstance(field, models.JSONField) and isinstance(value, str):
+                kwargs[key] = json.loads(value) if value else None
             # put regular field values in kwargs dict
             else:
                 kwargs[key] = value

openwisp_controller/config/base/base.py

@@ -1,16 +1,16 @@
-import collections
 import hashlib
 import json
 import logging
 from copy import deepcopy
 
 from cache_memoize import cache_memoize
 from django.core.exceptions import ValidationError
+from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models
+from django.db.models import JSONField
 from django.utils.functional import cached_property
 from django.utils.module_loading import import_string
 from django.utils.translation import gettext_lazy as _
-from jsonfield import JSONField
 from netjsonconfig.exceptions import ValidationError as SchemaError
 
 from openwisp_utils.base import TimeStampedEditableModel
@@ -126,8 +126,7 @@ class BaseConfig(BaseModel):
         _("configuration"),
         default=dict,
         help_text=_("configuration in NetJSON DeviceConfiguration format"),
-        load_kwargs={"object_pairs_hook": collections.OrderedDict},
-        dump_kwargs={"indent": 4},
+        encoder=DjangoJSONEncoder,
     )
 
     __template__ = False

openwisp_controller/config/base/config.py

@@ -6,9 +6,10 @@
 from cache_memoize import cache_memoize
 from django.core.cache import cache
 from django.core.exceptions import ObjectDoesNotExist, PermissionDenied, ValidationError
+from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models, transaction
+from django.db.models import JSONField
 from django.utils.translation import gettext_lazy as _
-from jsonfield import JSONField
 from model_utils import Choices
 from model_utils.fields import StatusField
 from netjsonconfig import OpenWrt
@@ -90,8 +91,7 @@ class AbstractConfig(ChecksumCacheMixin, BaseConfig):
             '" target="_blank">'
             "configuration variables</a>"
         ),
-        load_kwargs={"object_pairs_hook": collections.OrderedDict},
-        dump_kwargs={"indent": 4},
+        encoder=DjangoJSONEncoder,
     )
     checksum_db = models.CharField(
         _("configuration checksum"),

openwisp_controller/config/base/device_group.py

@@ -1,11 +1,11 @@
-import collections
 from copy import deepcopy
 
 import jsonschema
 from django.core.exceptions import ValidationError
+from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models
+from django.db.models import JSONField
 from django.utils.translation import gettext_lazy as _
-from jsonfield import JSONField
 from jsonschema.exceptions import ValidationError as SchemaError
 from swapper import get_model_name, load_model
 
@@ -39,24 +39,22 @@ class AbstractDeviceGroup(OrgMixin, TimeStampedEditableModel):
     meta_data = JSONField(
         blank=True,
         default=dict,
-        load_kwargs={"object_pairs_hook": collections.OrderedDict},
-        dump_kwargs={"indent": 4},
         help_text=_(
             "Store custom metadata related to this group. This field is intended "
             "for arbitrary data that does not affect device configuration and can "
             "be retrieved via the REST API for integrations or external tools."
         ),
         verbose_name=_("Metadata"),
+        encoder=DjangoJSONEncoder,
     )
     context = JSONField(
         blank=True,
         default=dict,
-        load_kwargs={"object_pairs_hook": collections.OrderedDict},
-        dump_kwargs={"indent": 4},
         help_text=_(
             "Define configuration variables available to all devices in this group"
         ),
         verbose_name=_("Configuration Variables"),
+        encoder=DjangoJSONEncoder,
     )
 
     def __str__(self):

openwisp_controller/config/base/multitenancy.py

@@ -1,11 +1,11 @@
-import collections
 from copy import deepcopy
 
 import swapper
 from django.core.exceptions import ValidationError
+from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models
+from django.db.models import JSONField
 from django.utils.translation import gettext_lazy as _
-from jsonfield import JSONField
 
 from openwisp_utils.base import KeyField, UUIDModel
 from openwisp_utils.fields import FallbackBooleanChoiceField
@@ -47,13 +47,12 @@ class AbstractOrganizationConfigSettings(UUIDModel):
     context = JSONField(
         blank=True,
         default=dict,
-        load_kwargs={"object_pairs_hook": collections.OrderedDict},
-        dump_kwargs={"indent": 4},
         help_text=_(
             "Define reusable configuration variables available "
             "to all devices in this organization"
         ),
         verbose_name=_("Configuration Variables"),
+        encoder=DjangoJSONEncoder,
     )
 
     class Meta:

openwisp_controller/config/base/template.py

@@ -4,9 +4,10 @@
 from copy import copy
 
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
+from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models, transaction
+from django.db.models import JSONField
 from django.utils.translation import gettext_lazy as _
-from jsonfield import JSONField
 from netjsonconfig.exceptions import ValidationError as NetjsonconfigValidationError
 from swapper import get_model_name, load_model
 from taggit.managers import TaggableManager
@@ -101,8 +102,7 @@ class AbstractTemplate(ShareableOrgMixinUniqueName, BaseConfig):
             "These values are used during validation and when a variable is "
             "not provided by the device, group, or organization."
         ),
-        load_kwargs={"object_pairs_hook": OrderedDict},
-        dump_kwargs={"indent": 4},
+        encoder=DjangoJSONEncoder,
     )
     __template__ = True
 

openwisp_controller/config/migrations/0001_squashed_0002_config_settings_uuid.py

@@ -1,13 +1,11 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.10.5 on 2017-05-03 17:54
 
-import collections
 import re
 import uuid
 
 import django.core.validators
 import django.utils.timezone
-import jsonfield.fields
 import model_utils.fields
 from django.conf import settings
 from django.db import migrations, models
@@ -58,12 +56,10 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "config",
-                    jsonfield.fields.JSONField(
+                    models.JSONField(
                         blank=True,
                         default=dict,
-                        dump_kwargs={"ensure_ascii": False, "indent": 4},
                         help_text="configuration in NetJSON DeviceConfiguration format",
-                        load_kwargs={"object_pairs_hook": collections.OrderedDict},
                         verbose_name="configuration",
                     ),
                 ),
@@ -250,12 +246,10 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "config",
-                    jsonfield.fields.JSONField(
+                    models.JSONField(
                         blank=True,
                         default=dict,
-                        dump_kwargs={"ensure_ascii": False, "indent": 4},
                         help_text="configuration in NetJSON DeviceConfiguration format",
-                        load_kwargs={"object_pairs_hook": collections.OrderedDict},
                         verbose_name="configuration",
                     ),
                 ),
@@ -347,11 +341,9 @@ class Migration(migrations.Migration):
                 ("name", models.CharField(max_length=64, unique=True)),
                 (
                     "config",
-                    jsonfield.fields.JSONField(
+                    models.JSONField(
                         default=dict,
-                        dump_kwargs={"ensure_ascii": False, "indent": 4},
                         help_text="configuration in NetJSON DeviceConfiguration format",
-                        load_kwargs={"object_pairs_hook": collections.OrderedDict},
                         verbose_name="configuration",
                     ),
                 ),

openwisp_controller/config/migrations/0018_config_context.py

@@ -1,9 +1,7 @@
 # Generated by Django 2.1.4 on 2019-01-09 01:52
 
-import collections
 
-import jsonfield.fields
-from django.db import migrations
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
@@ -13,15 +11,13 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name="config",
             name="context",
-            field=jsonfield.fields.JSONField(
+            field=models.JSONField(
                 blank=True,
-                dump_kwargs={"indent": 4},
                 help_text=(
                     'Additional <a href="http://netjsonconfig.openwisp.org'
                     '/en/stable/general/basics.html#context" target="_blank">context '
                     "(configuration variables)</a> in JSON format"
                 ),
-                load_kwargs={"object_pairs_hook": collections.OrderedDict},
                 null=True,
             ),
         )

openwisp_controller/config/migrations/0023_update_context.py

@@ -1,9 +1,7 @@
 # Generated by Django 3.0.3 on 2020-02-26 19:58
 
-import collections
 
-import jsonfield.fields
-from django.db import migrations
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
@@ -13,17 +11,15 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name="config",
             name="context",
-            field=jsonfield.fields.JSONField(
+            field=models.JSONField(
                 blank=True,
                 default=dict,
-                dump_kwargs={"ensure_ascii": False, "indent": 4},
                 help_text=(
                     "allows overriding "
                     '<a href="https://openwisp.io/docs/stable/controller/user/variables.html'  # noqa: E501
                     '" target="_blank">'
                     "configuration variables</a>"
                 ),
-                load_kwargs={"object_pairs_hook": collections.OrderedDict},
             ),
         )
     ]

openwisp_controller/config/migrations/0028_template_default_values.py

@@ -1,9 +1,7 @@
 # Generated by Django 3.0.3 on 2020-06-29 23:54
 
-import collections
 
-import jsonfield.fields
-from django.db import migrations
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
@@ -13,16 +11,14 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name="template",
             name="default_values",
-            field=jsonfield.fields.JSONField(
+            field=models.JSONField(
                 blank=True,
                 default=dict,
-                dump_kwargs={"ensure_ascii": False, "indent": 4},
                 help_text=(
                     "Define default values for the variables used in this template. "
                     "These values are used during validation and when a variable is "
                     "not provided by the device, group, or organization."
                 ),
-                load_kwargs={"object_pairs_hook": collections.OrderedDict},
                 verbose_name="Default Values",
             ),
         )