[chores:fix] Fixed data migrations breaking due to JSONField change #1061

Historical migration models can expose old JSONField values as strings
or nulls. Several data migrations assumed dict values or live model
properties, which broke upgrades with older controller databases.

Normalized legacy JSON values before mutating configs, skip malformed
nested entries, and compute checksums inside the migration without
depending on the live Config.checksum property.

Also avoid loading stale template relations during VPN client template
population and tolerate VPN rows with missing DH parameters.

Related to #1061

Author: nemesifier

openwisp_controller/config/migrations/0042_multiple_wireguard_tunnels.py

@@ -3,6 +3,7 @@
 from django.db import migrations
 
 from ..migrations import get_swapped_model
+from . import resolve_config
 
 
 def get_wireguard_and_vxlan_wireguard_templates(apps):
@@ -13,11 +14,13 @@ def get_wireguard_and_vxlan_wireguard_templates(apps):
 def allow_multiple_wireguard_tunneling(apps, schema_editor):
     templates = get_wireguard_and_vxlan_wireguard_templates(apps).iterator()
     for template in templates:
-        config = template.config
-        interfaces = config["interfaces"]
+        config = resolve_config(template.config)
+        interfaces = config.get("interfaces", [])
         vpn_id = template.vpn.pk.hex
         changed = False
         for interface in interfaces:
+            if not isinstance(interface, dict):
+                continue
             interface_type = interface.get("type", None)
             private_key = interface.get("private_key", None)
             if interface_type != "wireguard" or not private_key:
@@ -38,11 +41,13 @@ def allow_multiple_wireguard_tunneling(apps, schema_editor):
 def disallow_multiple_wireguard_tunneling(apps, schema_editor):
     templates = get_wireguard_and_vxlan_wireguard_templates(apps).iterator()
     for template in templates:
-        config = template.config
-        interfaces = config["interfaces"]
+        config = resolve_config(template.config)
+        interfaces = config.get("interfaces", [])
         vpn_id = template.vpn.pk.hex
         changed = False
         for interface in interfaces:
+            if not isinstance(interface, dict):
+                continue
             interface_type = interface.get("type", None)
             private_key = interface.get("private_key", None)
             if interface_type != "wireguard" or not private_key:

openwisp_controller/config/migrations/0048_wifi_radio_band_migration.py

@@ -4,6 +4,8 @@
 from django.db import migrations
 from netjsonconfig import channels
 
+from . import resolve_config
+
 
 def hwmode_to_band(radio):
     """
@@ -67,39 +69,44 @@ def band_to_hwmode(radio):
         # 802.11ax and 802.11ad were not supported in OpenWrt < 21.
         # Hence, we ignore "6g" and "60g" values.
         if band == "2g":
-            if radio["protocol"] == "802.11b":
+            if radio.get("protocol") == "802.11b":
                 return "11b"
             else:
                 return "11g"
         elif band == "5g":
             return "11a"
     # Use protocol to infer "hwmode"
-    protocol = radio["protocol"]
+    protocol = radio.get("protocol")
     if protocol in ["802.11a", "802.11b", "802.11g"]:
         # return 11a, 11b or 11g
         return protocol[4:]
     if protocol == "802.11ac":
         return "11a"
     # determine hwmode depending on channel used
-    if radio["channel"] == 0:
+    channel = radio.get("channel")
+    if channel == 0:
         # when using automatic channel selection, we need an
         # additional parameter to determine the frequency band
         return radio.get("hwmode")
-    elif radio["channel"] <= 13:
+    elif channel is not None and channel <= 13:
         return "11g"
-    else:
+    elif channel is not None:
         return "11a"
 
 
 def update_config_for_model(Model, func, field):
     updated_objects = []
     for obj in Model.objects.iterator(chunk_size=100):
         update_obj = False
-        for radio in obj.config.get("radios", []):
+        config = resolve_config(obj.config)
+        for radio in config.get("radios", []):
+            if not isinstance(radio, dict):
+                continue
             if not radio.get(field):
                 radio[field] = func(radio)
                 update_obj = True
         if update_obj:
+            obj.config = config
             updated_objects.append(obj)
         if len(updated_objects) > 100:
             Model.objects.bulk_update(updated_objects, fields=["config"])

openwisp_controller/config/migrations/0057_populate_vpnclient_template.py

@@ -6,13 +6,19 @@
 
 def populate_vpnclient_template(apps, schema_editor):
     VpnClient = apps.get_model("config", "VpnClient")
+    Config = apps.get_model("config", "Config")
+    Template = apps.get_model("config", "Template")
 
     for vpn_client in VpnClient.objects.iterator():
-        if vpn_client.template is None:
+        if vpn_client.template_id is not None:
+            continue
+        try:
             vpn_client.template = vpn_client.config.templates.get(
                 vpn_id=vpn_client.vpn_id
             )
-            vpn_client.save()
+        except (Config.DoesNotExist, Template.DoesNotExist):
+            continue
+        vpn_client.save()
 
 
 class Migration(migrations.Migration):

openwisp_controller/config/migrations/0059_zerotier_templates_ow_zt_to_global.py

@@ -1,17 +1,22 @@
 from django.db import migrations
 
+from . import resolve_config
+
 
 def change_owzt_to_global(apps, schema_editor):
     Template = apps.get_model("config", "Template")
     updated_templates = set()
     for template in Template.objects.filter(
         type="vpn", vpn__backend="openwisp_controller.vpn_backends.ZeroTier"
     ).iterator():
-        if "zerotier" in template.config:
-            for item in template.config.get("zerotier", []):
-                if item.get("name") == "ow_zt":
-                    item["name"] = "global"
-                    updated_templates.add(template)
+        config = resolve_config(template.config)
+        for item in config.get("zerotier", []):
+            if not isinstance(item, dict):
+                continue
+            if item.get("name") == "ow_zt":
+                item["name"] = "global"
+                template.config = config
+                updated_templates.add(template)
     Template.objects.bulk_update(updated_templates, ["config"])