[change] Replace third-party JSONField with native models.JSONField and optimize indexing

Author: Hafiz

openwisp_monitoring/check/base/models.py

@@ -1,12 +1,9 @@
-from collections import OrderedDict
-
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
 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 openwisp_utils.base import TimeStampedEditableModel
 
@@ -37,13 +34,11 @@ class AbstractCheck(TimeStampedEditableModel):
         db_index=True,
         max_length=128,
     )
-    params = JSONField(
+    params = models.JSONField(
         _("parameters"),
         default=dict,
         blank=True,
         help_text=_("parameters needed to perform the check"),
-        load_kwargs={"object_pairs_hook": OrderedDict},
-        dump_kwargs={"indent": 4},
     )
 
     class Meta:

openwisp_monitoring/check/migrations/0001_initial_squashed_0002_check_unique_together.py

@@ -1,11 +1,9 @@
 # Generated by Django 3.1.2 on 2020-11-18 12:55
 
-import collections
 import uuid
 
 import django.db.models.deletion
 import django.utils.timezone
-import jsonfield.fields
 import model_utils.fields
 import swapper
 from django.db import migrations, models
@@ -67,12 +65,10 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "params",
-                    jsonfield.fields.JSONField(
+                    models.JSONField(
                         blank=True,
                         default=dict,
-                        dump_kwargs={"indent": 4},
                         help_text="parameters needed to perform the check",
-                        load_kwargs={"object_pairs_hook": collections.OrderedDict},
                         verbose_name="parameters",
                     ),
                 ),

openwisp_monitoring/monitoring/base/models.py

@@ -11,12 +11,12 @@
 from django.contrib.auth import get_user_model
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
+from django.contrib.postgres.indexes import GinIndex
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.core.validators import MaxValueValidator
 from django.db import IntegrityError, models
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
-from jsonfield import JSONField
 from openwisp_notifications.signals import notify
 from pytz import timezone as tz
 from pytz import utc
@@ -91,20 +91,16 @@ class AbstractMetric(TimeStampedEditableModel):
     )
     object_id = models.CharField(max_length=36, db_index=True, blank=True, null=True)
     content_object = GenericForeignKey("content_type", "object_id")
-    main_tags = JSONField(
+    main_tags = models.JSONField(
         _("main tags"),
         default=dict,
         blank=True,
-        load_kwargs={"object_pairs_hook": OrderedDict},
-        dump_kwargs={"indent": 4},
         db_index=True,
     )
-    extra_tags = JSONField(
+    extra_tags = models.JSONField(
         _("extra tags"),
         default=dict,
         blank=True,
-        load_kwargs={"object_pairs_hook": OrderedDict},
-        dump_kwargs={"indent": 4},
     )
     # NULL means the health has yet to be assessed
     is_healthy = models.BooleanField(default=None, null=True, blank=True, db_index=True)
@@ -120,6 +116,10 @@ class Meta:
             "object_id",
             "main_tags",
         )
+        indexes = [
+            GinIndex(fields=["main_tags"], name="main_tags_gin_idx"),
+            GinIndex(fields=["extra_tags"], name="extra_tags_gin_idx"),
+        ]
 
     def __str__(self):
         obj = self.content_object

openwisp_monitoring/monitoring/migrations/0004_metric_main_and_extra_tags.py

@@ -1,9 +1,6 @@
 # Generated by Django 3.2.12 on 2022-04-23 17:50
 
-import collections
-
-import jsonfield.fields
-from django.db import migrations
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
@@ -16,23 +13,19 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name="metric",
             name="main_tags",
-            field=jsonfield.fields.JSONField(
+            field=models.JSONField(
                 blank=True,
                 db_index=True,
                 default=dict,
-                dump_kwargs={"indent": 4},
-                load_kwargs={"object_pairs_hook": collections.OrderedDict},
                 verbose_name="main tags",
             ),
         ),
         migrations.AddField(
             model_name="metric",
             name="extra_tags",
-            field=jsonfield.fields.JSONField(
+            field=models.JSONField(
                 blank=True,
                 default=dict,
-                dump_kwargs={"indent": 4},
-                load_kwargs={"object_pairs_hook": collections.OrderedDict},
                 verbose_name="extra tags",
             ),
         ),

openwisp_monitoring/monitoring/migrations/0013_auto_20260224_0730.py

@@ -0,0 +1,25 @@
+from django.db import migrations
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('monitoring', '0012_migrate_signal_metrics'),
+    ]
+
+    operations = [
+        migrations.RunSQL(
+            sql='DROP INDEX IF EXISTS monitoring_metric_main_tags_2d8550ae_like; '
+                'DROP INDEX IF EXISTS monitoring_metric_main_tags_2d8550ae;',
+            reverse_sql=migrations.RunSQL.noop
+        ),
+        migrations.RunSQL(
+            sql='ALTER TABLE monitoring_metric ALTER COLUMN main_tags TYPE jsonb USING main_tags::jsonb; '
+                'ALTER TABLE monitoring_metric ALTER COLUMN extra_tags TYPE jsonb USING extra_tags::jsonb;',
+            reverse_sql='ALTER TABLE monitoring_metric ALTER COLUMN main_tags TYPE text; '
+                        'ALTER TABLE monitoring_metric ALTER COLUMN extra_tags TYPE text;'
+        ),
+        migrations.RunSQL(
+            sql='CREATE INDEX IF NOT EXISTS main_tags_gin_idx ON monitoring_metric USING gin (main_tags); '
+                'CREATE INDEX IF NOT EXISTS extra_tags_gin_idx ON monitoring_metric USING gin (extra_tags);',
+            reverse_sql='DROP INDEX IF EXISTS main_tags_gin_idx; DROP INDEX IF EXISTS extra_tags_gin_idx;'
+        ),
+    ]

tests/openwisp2/sample_check/migrations/0001_initial.py

@@ -1,11 +1,9 @@
 # Generated by Django 3.0.5 on 2020-05-27 03:04
 
-import collections
 import uuid
 
 import django.db.models.deletion
 import django.utils.timezone
-import jsonfield.fields
 import model_utils.fields
 from django.db import migrations, models
 
@@ -74,12 +72,10 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "params",
-                    jsonfield.fields.JSONField(
+                    models.JSONField(
                         blank=True,
                         default=dict,
-                        dump_kwargs={"indent": 4},
                         help_text="parameters needed to perform the check",
-                        load_kwargs={"object_pairs_hook": collections.OrderedDict},
                         verbose_name="parameters",
                     ),
                 ),

tests/openwisp2/sample_monitoring/migrations/0001_initial.py

@@ -1,13 +1,11 @@
 # Generated by Django 3.0.5 on 2020-05-27 03:04
 
-import collections
 import uuid
 
 import django
 import django.core.validators
 import django.db.models.deletion
 import django.utils.timezone
-import jsonfield
 import model_utils.fields
 import swapper
 from django.db import migrations, models
@@ -104,22 +102,18 @@ class Migration(migrations.Migration):
                 ),
                 (
                     "main_tags",
-                    jsonfield.fields.JSONField(
+                    models.JSONField(
                         blank=True,
                         db_index=True,
                         default=dict,
-                        dump_kwargs={"indent": 4},
-                        load_kwargs={"object_pairs_hook": collections.OrderedDict},
                         verbose_name="main tags",
                     ),
                 ),
                 (
                     "extra_tags",
-                    jsonfield.fields.JSONField(
+                    models.JSONField(
                         blank=True,
                         default=dict,
-                        dump_kwargs={"indent": 4},
-                        load_kwargs={"object_pairs_hook": collections.OrderedDict},
                         verbose_name="extra tags",
                     ),
                 ),