fix: stop OON policies churning as ghost deletions on UniFi 10.x (#154) (#155)

Author: sirkirby

custom_components/unifi_network_rules/coordination/entity_manager.py

@@ -352,23 +352,12 @@ def check_for_deleted_rules(self, new_data: dict[str, list[Any]]) -> None:
 
         current_known_ids = set(self.coordinator.known_unique_ids)  # Take a snapshot
 
-        # Gather ALL unique IDs present in the new data
+        # Gather ALL unique IDs present in the new data. Mirrors the discovery
+        # map so any rule type the discovery side creates entities for is also
+        # checked here — otherwise entries in known_unique_ids for missing
+        # types get flagged as ghost deletions every cycle (issue #154).
         all_current_unique_ids = set()
-        all_rule_sources_types = [
-            "port_forwards",
-            "traffic_routes",
-            "static_routes",
-            "nat_rules",
-            "firewall_policies",
-            "traffic_rules",
-            "legacy_firewall_rules",
-            "qos_rules",
-            "wlans",
-            "vpn_clients",
-            "vpn_servers",
-            "port_profiles",
-            "networks",
-        ]
+        all_rule_sources_types = [rule_type for rule_type, _ in self._rule_type_entity_map]
 
         for rule_type in all_rule_sources_types:
             rules = new_data.get(rule_type, [])

custom_components/unifi_network_rules/coordination/state_manager.py

@@ -68,6 +68,7 @@ def data_has_changes(self, previous_data: dict[str, list[Any]], new_data: dict[s
             "port_profiles",
             "networks",
             "nat_rules",
+            "oon_policies",
         ]:
             prev_count = len(previous_data.get(rule_type, []))
             new_count = len(new_data.get(rule_type, []))
@@ -87,6 +88,7 @@ def data_has_changes(self, previous_data: dict[str, list[Any]], new_data: dict[s
             "wlans",
             "qos_rules",
             "nat_rules",
+            "oon_policies",
         ]:
             prev_rules = previous_data.get(rule_type, [])
             new_rules = new_data.get(rule_type, [])
@@ -286,6 +288,7 @@ def validate_data_and_handle_errors(self, data: dict[str, list[Any]], previous_d
                 "networks",
                 "devices",
                 "nat_rules",
+                "oon_policies",
             ]
         )
 

custom_components/unifi_network_rules/manifest.json

@@ -12,7 +12,7 @@
     "quality_scale": "custom",
     "requirements": [
         "aiohttp",
-        "aiounifi>=87.0.0",
+        "aiounifi>=91",
         "orjson>=3.8.0"
     ],
     "version": "4.4.5"

requirements.txt

@@ -3,7 +3,7 @@ asyncio
 aiofiles
 aiohttp
 argparse
-aiounifi>=87.0.0
+aiounifi>=91
 pytest
 pytest-asyncio
 pytest-aiohttp

tests/test_oon_policy.py

@@ -273,3 +273,28 @@ def test_change_detector_mapping(self):
         detector = UnifiedChangeDetector(Mock(), Mock())
         assert "oon_policies" in detector._rule_type_mapping
         assert detector._rule_type_mapping["oon_policies"] == "oon_policy"
+
+    def test_deletion_check_does_not_orphan_oon_policies(self, oon_policy_payload):
+        """Regression for #154: OON policies present in current data must not
+        be flagged as deletions every cycle. The deletion-check iteration list
+        previously omitted "oon_policies", causing every OON ID in
+        known_unique_ids to be treated as a ghost deletion on every poll."""
+        from custom_components.unifi_network_rules.coordination.entity_manager import (
+            CoordinatorEntityManager,
+        )
+        from custom_components.unifi_network_rules.helpers.rule import get_rule_id
+
+        policy = OONPolicy(oon_policy_payload)
+        oon_unique_id = get_rule_id(policy)
+        assert oon_unique_id and oon_unique_id.startswith("unr_oon_")
+
+        coordinator = Mock()
+        coordinator._initial_update_done = True
+        coordinator.known_unique_ids = {oon_unique_id}
+
+        manager = CoordinatorEntityManager(Mock(), coordinator)
+        manager._process_deleted_rules = Mock()
+
+        manager.check_for_deleted_rules({"oon_policies": [policy]})
+
+        manager._process_deleted_rules.assert_not_called()