Use an explicit is_child key instead of an internal subkey

Author: puddly

.gitignore

@@ -63,6 +63,7 @@ target/
 
 # virtualenv
 .venv/
+.venv*/
 venv/
 ENV/
 

tests/tools/test_network_backup_restore.py

@@ -54,7 +54,6 @@ def backup_json():
             "internal": {
                 "creation_time": "2021-02-16T22:29:28+00:00",
                 "zstack": {"version": 3.3},
-                "children": ["000b57fffe38b212"],
             },
             "source": "[email protected]",
             "version": 1,
@@ -73,7 +72,12 @@ def backup_json():
             "sequence_number": 1,
         },
         "devices": [
-            {"ieee_address": "000b57fffe36b9a0", "nwk_address": "f319"},  # No key
+            {
+                # No key
+                "ieee_address": "000b57fffe36b9a0",
+                "nwk_address": "f319",
+                "is_child": True,
+            },
             {
                 "ieee_address": "000b57fffe38b212",
                 "link_key": {
@@ -82,6 +86,7 @@ def backup_json():
                     "tx_counter": 456,
                 },
                 "nwk_address": "9672",
+                "is_child": True,
             },
             {
                 "ieee_address": "aabbccddeeff0011",
@@ -91,6 +96,7 @@ def backup_json():
                     "tx_counter": 445566,
                 },
                 "nwk_address": "abcd",
+                "is_child": False,
             },
         ],
     }

zigpy_znp/api.py

@@ -387,7 +387,25 @@ async def write_network_info(
             )
 
         for key in network_info.key_table or []:
-            devices[key.partner_ieee] = devices[key.partner_ieee].replace(
+            device = devices.get(key.partner_ieee)
+
+            if device is None:
+                nwk = None
+
+                # The key table doesn't save a device's NWK address so we pick one
+                for test_nwk in range(0x0001, 0xFFFE + 1):
+                    if all(n.nwk != test_nwk for n in network_info.neighbor_table):
+                        nwk = test_nwk
+                        break
+
+                assert nwk is not None
+
+                device = security.StoredDevice(
+                    nwk=nwk,
+                    ieee=key.partner_ieee,
+                )
+
+            devices[key.partner_ieee] = device.replace(
                 aps_link_key=key.key,
                 tx_counter=key.tx_counter,
                 rx_counter=key.rx_counter,

zigpy_znp/tools/common.py

@@ -36,10 +36,6 @@
                     "type": "object",
                     "properties": {
                         "tclk_seed": {"type": "string", "pattern": "[a-fA-F0-9]{32}"},
-                        "children": {
-                            "type": "array",
-                            "items": {"type": "string", "pattern": "[a-fA-F0-9]{16}"},
-                        },
                     },
                 }
             },
@@ -74,6 +70,7 @@
                 "properties": {
                     "nwk_address": {"type": "string", "pattern": "[a-fA-F0-9]{4}"},
                     "ieee_address": {"type": "string", "pattern": "[a-fA-F0-9]{16}"},
+                    "is_child": {"type": "boolean"},
                     "link_key": {
                         "type": "object",
                         "properties": {

zigpy_znp/tools/network_backup.py

@@ -28,6 +28,9 @@ async def backup_network(znp: ZNP) -> t.JSONType:
         obj = {
             "nwk_address": device.nwk.serialize()[::-1].hex(),
             "ieee_address": device.ieee.serialize()[::-1].hex(),
+            "is_child": any(
+                device.ieee == nbr.ieee for nbr in znp.network_info.neighbor_table
+            ),
         }
 
         if device.aps_link_key:
@@ -53,10 +56,6 @@ async def backup_network(znp: ZNP) -> t.JSONType:
                 "zstack": {
                     "version": znp.version,
                 },
-                "children": [
-                    neighbor.ieee.serialize()[::-1].hex()
-                    for neighbor in znp.network_info.neighbor_table
-                ],
             },
         },
         "coordinator_ieee": znp.node_info.ieee.serialize()[::-1].hex(),

zigpy_znp/tools/network_restore.py

@@ -51,15 +51,14 @@ def json_backup_to_zigpy_state(
     network_info.key_table = []
     network_info.neighbor_table = []
 
-    children = backup["stack_specific"].get("zstack", {}).get("children")
-
     for obj in backup["devices"]:
         node = zigpy.state.NodeInfo()
         node.nwk, _ = t.NWK.deserialize(bytes.fromhex(obj["nwk_address"])[::-1])
         node.ieee, _ = t.EUI64.deserialize(bytes.fromhex(obj["ieee_address"])[::-1])
         node.logical_type = None
 
-        if children is None or obj["ieee_address"] in children:
+        # The `is_child` key is optional. If it is missing, preserve the old behavior
+        if obj["is_child"] if "is_child" in obj else ("link_key" not in obj):
             network_info.neighbor_table.append(node)
 
         if "link_key" in obj: