refactor(controller_base): change listen_changes to async

xaviml · Jun 24, 2021 · b86e45d · b86e45d
1 parent 213012c
commit b86e45d
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 23 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -10,9 +10,9 @@ PRERELEASE_NOTE
 ## :pencil2: Features
 -->
 
-<!--
 ## :hammer: Fixes
--->
+
+- Clean action handle when there is an error. This will help for error logging.
 
 <!--
 ## :clock2: Performance

diff --git a/apps/controllerx/cx_core/controller.py b/apps/controllerx/cx_core/controller.py
@@ -169,7 +169,7 @@ async def init(self) -> None:
 
         # Listen for device changes
         for controller_id in controllers_ids:
-            self.integration.listen_changes(controller_id)
+            await self.integration.listen_changes(controller_id)
 
     def filter_actions(
         self,

diff --git a/apps/controllerx/cx_core/integration/__init__.py b/apps/controllerx/cx_core/integration/__init__.py
@@ -27,7 +27,7 @@ def get_default_actions_mapping(self) -> Optional[DefaultActionsMapping]:
         raise NotImplementedError
 
     @abc.abstractmethod
-    def listen_changes(self, controller_id: str) -> None:
+    async def listen_changes(self, controller_id: str) -> None:
         raise NotImplementedError
 
 

diff --git a/apps/controllerx/cx_core/integration/deconz.py b/apps/controllerx/cx_core/integration/deconz.py
@@ -11,8 +11,8 @@ class DeCONZIntegration(Integration):
     def get_default_actions_mapping(self) -> Optional[DefaultActionsMapping]:
         return self.controller.get_deconz_actions_mapping()
 
-    def listen_changes(self, controller_id: str) -> None:
-        Hass.listen_event(
+    async def listen_changes(self, controller_id: str) -> None:
+        await Hass.listen_event(
             self.controller, self.event_callback, "deconz_event", id=controller_id
         )
 

diff --git a/apps/controllerx/cx_core/integration/lutron_caseta.py b/apps/controllerx/cx_core/integration/lutron_caseta.py
@@ -11,8 +11,8 @@ class LutronIntegration(Integration):
     def get_default_actions_mapping(self) -> Optional[DefaultActionsMapping]:
         return self.controller.get_lutron_caseta_actions_mapping()
 
-    def listen_changes(self, controller_id: str) -> None:
-        Hass.listen_event(
+    async def listen_changes(self, controller_id: str) -> None:
+        await Hass.listen_event(
             self.controller,
             self.callback,
             "lutron_caseta_button_event",

diff --git a/apps/controllerx/cx_core/integration/mqtt.py b/apps/controllerx/cx_core/integration/mqtt.py
@@ -11,8 +11,8 @@ class MQTTIntegration(Integration):
     def get_default_actions_mapping(self) -> Optional[DefaultActionsMapping]:
         return self.controller.get_z2m_actions_mapping()
 
-    def listen_changes(self, controller_id: str) -> None:
-        Mqtt.listen_event(
+    async def listen_changes(self, controller_id: str) -> None:
+        await Mqtt.listen_event(
             self.controller, self.event_callback, topic=controller_id, namespace="mqtt"
         )
 

diff --git a/apps/controllerx/cx_core/integration/state.py b/apps/controllerx/cx_core/integration/state.py
@@ -11,9 +11,9 @@ class StateIntegration(Integration):
     def get_default_actions_mapping(self) -> Optional[DefaultActionsMapping]:
         return self.controller.get_z2m_actions_mapping()
 
-    def listen_changes(self, controller_id: str) -> None:
+    async def listen_changes(self, controller_id: str) -> None:
         attribute = self.kwargs.get("attribute", None)
-        Hass.listen_state(
+        await Hass.listen_state(
             self.controller, self.state_callback, controller_id, attribute=attribute
         )
 

diff --git a/apps/controllerx/cx_core/integration/z2m.py b/apps/controllerx/cx_core/integration/z2m.py
@@ -16,13 +16,13 @@ class Z2MIntegration(Integration):
     def get_default_actions_mapping(self) -> Optional[DefaultActionsMapping]:
         return self.controller.get_z2m_actions_mapping()
 
-    def listen_changes(self, controller_id: str) -> None:
+    async def listen_changes(self, controller_id: str) -> None:
         listens_to = self.kwargs.get("listen_to", LISTENS_TO_HA)
         if listens_to == LISTENS_TO_HA:
-            Hass.listen_state(self.controller, self.state_callback, controller_id)
+            await Hass.listen_state(self.controller, self.state_callback, controller_id)
         elif listens_to == LISTENS_TO_MQTT:
             topic_prefix = self.kwargs.get("topic_prefix", "zigbee2mqtt")
-            Mqtt.listen_event(
+            await Mqtt.listen_event(
                 self.controller,
                 self.event_callback,
                 topic=f"{topic_prefix}/{controller_id}",

diff --git a/apps/controllerx/cx_core/integration/zha.py b/apps/controllerx/cx_core/integration/zha.py
@@ -11,8 +11,8 @@ class ZHAIntegration(Integration):
     def get_default_actions_mapping(self) -> Optional[DefaultActionsMapping]:
         return self.controller.get_zha_actions_mapping()
 
-    def listen_changes(self, controller_id: str) -> None:
-        Hass.listen_event(
+    async def listen_changes(self, controller_id: str) -> None:
+        await Hass.listen_event(
             self.controller, self.callback, "zha_event", device_ieee=controller_id
         )
 

diff --git a/tests/conftest.py b/tests/conftest.py
@@ -28,9 +28,9 @@ def hass_mock(monkeypatch: MonkeyPatch):
     """
 
     monkeypatch.setattr(hass.Hass, "__init__", fake_fn())
-    monkeypatch.setattr(hass.Hass, "listen_event", fake_fn())
-    monkeypatch.setattr(mqtt.Mqtt, "listen_event", fake_fn())
-    monkeypatch.setattr(hass.Hass, "listen_state", fake_fn())
+    monkeypatch.setattr(hass.Hass, "listen_event", fake_fn(async_=True))
+    monkeypatch.setattr(mqtt.Mqtt, "listen_event", fake_fn(async_=True))
+    monkeypatch.setattr(hass.Hass, "listen_state", fake_fn(async_=True))
     monkeypatch.setattr(hass.Hass, "log", fake_fn())
     monkeypatch.setattr(hass.Hass, "call_service", fake_fn(async_=True))
     monkeypatch.setattr(hass.Hass, "get_ad_version", fake_fn(to_return="4.0.0"))

diff --git a/tests/test_utils.py b/tests/test_utils.py
@@ -20,7 +20,10 @@ def __init__(self, name: str, controller: "Controller", mocker: MockerFixture):
         self.get_default_actions_mapping = MagicMock(
             name="get_default_actions_mapping", return_value={}
         )
-        self.listen_changes = mocker.stub(name="listen_changes")
+        self.listen_changes_stub = mocker.stub(name="listen_changes")
+
+    async def listen_changes(self, controller_id: str) -> None:
+        self.listen_changes_stub(controller_id)
 
 
 def fake_fn(to_return=None, async_: bool = False) -> Callable:

diff --git a/tests/unit_tests/cx_core/controller_test.py b/tests/unit_tests/cx_core/controller_test.py
@@ -171,8 +171,8 @@ async def test_initialize(
     if not error_expected:
         get_default_actions_mapping.assert_called_once()
         for controller_id in controller_input:
-            integration_mock.listen_changes.assert_any_call(controller_id)
-        assert integration_mock.listen_changes.call_count == len(controller_input)
+            integration_mock.listen_changes_stub.assert_any_call(controller_id)
+        assert integration_mock.listen_changes_stub.call_count == len(controller_input)
         assert list(sut_before_init.actions_mapping.keys()) == actions_output