openmodule 16.1.1__tar.gz → 17.0.0__tar.gz

{openmodule-16.1.1 → openmodule-17.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openmodule
-Version: 16.1.1
+Version: 17.0.0
 Summary: Libraries for developing the arivo openmodule
 Home-page: https://gitlab.com/arivo-public/device-python/openmodule.git
 Author: ARIVO
@@ -13,18 +13,18 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown; charset=UTF-8
 License-File: LICENSE
-Requires-Dist: pydantic~=2.0
+Requires-Dist: pydantic~=2.12.0
 Requires-Dist: sentry-sdk~=2.19.0
-Requires-Dist: orjson<4,>=3.4.7
+Requires-Dist: orjson~=3.11
 Requires-Dist: pyzmq~=26.2
 Requires-Dist: pyyaml<7,>=5.0
-Requires-Dist: editdistance>=0.8.1
+Requires-Dist: editdistance~=0.8.1
 Requires-Dist: sqlalchemy~=2.0.0
 Requires-Dist: alembic<2,>=1.5.4
 Requires-Dist: requests<3,>=2.22
-Requires-Dist: python-dateutil>=2.7.2
-Requires-Dist: python-dotenv~=0.15
-Requires-Dist: arivo-settings_models~=2.5.2
+Requires-Dist: python-dateutil~=2.9
+Requires-Dist: python-dotenv~=1.2.0
+Requires-Dist: arivo-settings_models~=2.6.0
 Provides-Extra: test
 Requires-Dist: openmodule_test; extra == "test"
 Provides-Extra: commands

{openmodule-16.1.1 → openmodule-17.0.0}/openmodule/alert.py

@@ -78,7 +78,7 @@ class AlertHandler(object):
             self._alerts.append(alert)
             return alert["id"]
 
-    def send_with_alert_id(self, alert_id: int, status: AlertStatus, meta: dict, value: float | None = None):
+    def send_with_alert_id(self, alert_id: int, status: AlertStatus, meta: dict | None, value: float | None = None):
         """ Send a status message on the given alert with the corresponding meta/kwarg arguments
             Returns True if alert was send else False"""
         assert status in [AlertStatus.error, AlertStatus.ok, AlertStatus.offline]

{openmodule-16.1.1 → openmodule-17.0.0}/openmodule/core.py

@@ -3,6 +3,7 @@ import os
 import shutil
 import signal
 import threading
+import time
 import warnings
 from concurrent.futures.thread import ThreadPoolExecutor
 
@@ -17,6 +18,7 @@ from openmodule.logging import init_logging
 from openmodule.messaging import _internal_get_pub_socket, get_sub_socket, receive_message_from_socket, \
     wait_for_connection
 from openmodule.models.base import ZMQMessage
+from openmodule.models.settings import SettingsGetRequest, SettingsGetResponse
 from openmodule.sentry import init_sentry, should_activate_sentry, deinit_sentry
 from openmodule.threading import get_thread_wrapper
 from openmodule.connection_status import ConnectionStatusListener
@@ -134,6 +136,22 @@ def print_environment(core: OpenModuleCore):
         )
 
 
+def wait_for_misc(core: OpenModuleCore, timeout: float = 120, retry_time: float = 3.0):
+    """
+    Checks if service misc is answering by calling a "settings" "get" request for "common/garage_settings"
+    """
+    from openmodule.rpc import RPCClient
+    start = time.time()
+    while time.time() - start < timeout:
+        try:
+            core.rpc_client.rpc("settings", "get", SettingsGetRequest(key="common/garage_settings", scope=""),
+                                SettingsGetResponse, retry_time)
+            return
+        except RPCClient.Exception as e:
+            core.log.warning(f"Misc did not answer correctly because of {str(e) or repr(e)}. Retry in 3 seconds")
+    raise TimeoutError("Could not get any settings in time")
+
+
 def init_openmodule(config, *, dsn: str = None, sentry=None, logging=True, dsgvo=True,
                     health_handler: HealthHandlerType | None = None,
                     context=None, database=False, catch_sigterm=True,

{openmodule-16.1.1 → openmodule-17.0.0}/openmodule/dispatcher.py

@@ -20,6 +20,9 @@ from openmodule.config import settings
 from openmodule.models.base import ZMQMessage
 
 
+DispatcherFilterType = dict | Callable[[dict], bool] | None
+
+
 class DummyExecutor(Executor):
     def __init__(self):
         self._shutdown = False
@@ -41,9 +44,9 @@ class DummyExecutor(Executor):
 
 
 class Listener:
-    def __init__(self, message_class: type[ZMQMessage], type: str | None, filter: Callable | None,
+    def __init__(self, message_class: type[ZMQMessage], type: str | None, filter_: DispatcherFilterType,
                  handler: Callable):
-        self.filter = filter
+        self.filter_ = filter_
         self.handler = sentry.trace(f"message_handler.{qualname_from_function(handler)}")(handler)
         self.type = type
         self.message_class = message_class
@@ -52,8 +55,9 @@ class Listener:
         if self.type and message.get("type") != self.type:
             return False
 
-        if self.filter:
-            return self.filter(message)
+        if self.filter_:
+            # this is expected to fail if a non-empty dict is passed as 'filter_' parameter
+            return self.filter_(message)  # type: ignore
         else:
             return True
 
@@ -144,15 +148,15 @@ class MessageDispatcher:
     def register_handler(self, topic: str,
                          message_class: type[ZMQMessageSub],
                          handler: Callable[[ZMQMessageSub], None], *,
-                         filter: dict | Callable[[dict], bool] | None = None,
+                         filter_: DispatcherFilterType = None,
                          match_type=True):
         """
         registers a message handler. without any filters all messages from the topic are
         sent to the message handler.
-        :param filter: a dictionary of values which must match in order for the message to
+        :param filter_: a dictionary of values which must match in order for the message to
                        be further processed
         :param match_type: if set to true the message_class's type field is used as a filter.
-                           equivalent to setting filter={"type": message_class.fields["type"].default}
+                           equivalent to setting filter_={"type": message_class.fields["type"].default}
         """
 
         assert isinstance(topic, str), "topic must be a string"
@@ -169,7 +173,7 @@ class MessageDispatcher:
         else:
             type_ = None
 
-        listener = Listener(message_class, type_, filter, handler)
+        listener = Listener(message_class, type_, filter_, handler)
         self.listeners[topic].append(listener)
 
         if settings.TESTING and hasattr(handler, "__global__") and "/tests/" not in handler.__globals__['__file__']:
@@ -231,12 +235,12 @@ class SubscribingMessageDispatcher(MessageDispatcher):
     def register_handler(self, topic: str,
                          message_class: type[ZMQMessageSub],
                          handler: Callable[[ZMQMessageSub], None], *,
-                         filter: dict | None = None,
+                         filter_: DispatcherFilterType = None,
                          match_type=True):
         assert isinstance(topic, str), "channel must be a string"
 
         self.subscribe(topic)
-        return super().register_handler(topic, message_class, handler, filter=filter, match_type=match_type)
+        return super().register_handler(topic, message_class, handler, filter_=filter_, match_type=match_type)
 
     def unregister_handler(self, listener: Listener):
         super().unregister_handler(listener)

{openmodule-16.1.1 → openmodule-17.0.0}/openmodule/health.py

@@ -145,6 +145,7 @@ class Healthz:
             description=description,
             state=HealthCheckState.no_data
         )
+        self.checks = dict(sorted(self.checks.items(), key=lambda x: x[0]))
 
     def remove_check(self, check_id, *, parent: bool | None = False, package: str | None = None):
         key = self._check_id(check_id, parent, package)
@@ -185,6 +186,7 @@ class Healthz:
             description=description,
             labels=list(labels),
         )
+        self.metrics = dict(sorted(self.metrics.items(), key=lambda x: x[0]))
 
     def remove_metric(self, metric_id: str, *, parent: bool | None = False, package: str | None = None):
         key = self._check_id(metric_id, parent, package)

{openmodule-16.1.1 → openmodule-17.0.0}/openmodule/utils/schedule.py

@@ -61,6 +61,8 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 """
 
+# VERSION: 1.2.2 (May 25, 2024)
+
 from collections.abc import Hashable
 import datetime
 import functools

{openmodule-16.1.1 → openmodule-17.0.0}/openmodule/utils/settings.py

@@ -6,7 +6,7 @@ from typing import Any, TypeVar, Literal, overload
 from settings_models.serialization import parse_setting_from_obj
 from settings_models.settings.common import GarageName, Gates, Rates, ParkingAreas, Parksettings, PrivacySettings, \
     CostGroups, GarageSettings, Location, BillingSettings, SupportSettings, Urls
-from settings_models.settings.device_keys import PairingKey, Certificate, Otp
+from settings_models.settings.device_keys import PairingKey
 from settings_models.settings.enforcement import EnforcementSettings
 from settings_models.settings.gate_control import GateMode, DayMode
 from settings_models.settings.intercom import IntercomSettings
@@ -186,14 +186,6 @@ class SettingsProvider:
     def get(self, key: Literal["device_keys/pairing"]) -> PairingKey:  # pragma: no cover
         ...
 
-    @overload
-    def get(self, key: Literal["device_keys/cert"]) -> Certificate:  # pragma: no cover
-        ...
-
-    @overload
-    def get(self, key: Literal["device_keys/otp"]) -> Otp:  # pragma: no cover
-        ...
-
     @overload
     def get(self, key: Literal["feature_flags"]) -> dict:  # pragma: no cover
         ...

{openmodule-16.1.1 → openmodule-17.0.0}/openmodule.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openmodule
-Version: 16.1.1
+Version: 17.0.0
 Summary: Libraries for developing the arivo openmodule
 Home-page: https://gitlab.com/arivo-public/device-python/openmodule.git
 Author: ARIVO
@@ -13,18 +13,18 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown; charset=UTF-8
 License-File: LICENSE
-Requires-Dist: pydantic~=2.0
+Requires-Dist: pydantic~=2.12.0
 Requires-Dist: sentry-sdk~=2.19.0
-Requires-Dist: orjson<4,>=3.4.7
+Requires-Dist: orjson~=3.11
 Requires-Dist: pyzmq~=26.2
 Requires-Dist: pyyaml<7,>=5.0
-Requires-Dist: editdistance>=0.8.1
+Requires-Dist: editdistance~=0.8.1
 Requires-Dist: sqlalchemy~=2.0.0
 Requires-Dist: alembic<2,>=1.5.4
 Requires-Dist: requests<3,>=2.22
-Requires-Dist: python-dateutil>=2.7.2
-Requires-Dist: python-dotenv~=0.15
-Requires-Dist: arivo-settings_models~=2.5.2
+Requires-Dist: python-dateutil~=2.9
+Requires-Dist: python-dotenv~=1.2.0
+Requires-Dist: arivo-settings_models~=2.6.0
 Provides-Extra: test
 Requires-Dist: openmodule_test; extra == "test"
 Provides-Extra: commands

{openmodule-16.1.1 → openmodule-17.0.0}/openmodule.egg-info/requires.txt

@@ -1,15 +1,15 @@
-pydantic~=2.0
+pydantic~=2.12.0
 sentry-sdk~=2.19.0
-orjson<4,>=3.4.7
+orjson~=3.11
 pyzmq~=26.2
 pyyaml<7,>=5.0
-editdistance>=0.8.1
+editdistance~=0.8.1
 sqlalchemy~=2.0.0
 alembic<2,>=1.5.4
 requests<3,>=2.22
-python-dateutil>=2.7.2
-python-dotenv~=0.15
-arivo-settings_models~=2.5.2
+python-dateutil~=2.9
+python-dotenv~=1.2.0
+arivo-settings_models~=2.6.0
 
 [commands]
 openmodule_commands

{openmodule-16.1.1 → openmodule-17.0.0}/tests/test_core.py

@@ -1,12 +1,17 @@
 import threading
+import time
 from unittest import mock
 
 from openmodule.alert import AlertHandleType
 from openmodule.config import override_settings
-from openmodule.core import core, init_openmodule, shutdown_openmodule
+from openmodule.core import core, init_openmodule, shutdown_openmodule, wait_for_misc
 from openmodule.models.base import ZMQMessage
+from openmodule.models.settings import SettingsGetResponse
+from openmodule.rpc import RPCClient
 from openmodule_test.alert import AlertTestMixin
+from openmodule_test.core import OpenModuleCoreTestMixin
 from openmodule_test.health import HealthTestMixin
+from openmodule_test.rpc import MockRPCClient
 from openmodule_test.sentry import SentryTestMixin
 
 
@@ -95,3 +100,28 @@ class OpenModuleCoreTest(AlertTestMixin, HealthTestMixin, SentryTestMixin):
         self.assertTrue(dispatch_done.wait(timeout=3))
         self.assertFalse(handler.called)
         self.assertEqual(error, "")
+
+
+class WaitForMiscTest(OpenModuleCoreTestMixin):
+    def test_wait_for_misc(self):
+        with self.assertRaises(TimeoutError):
+            wait_for_misc(self.core, 3, 1)
+
+        def raise_error(*args, **kwargs):
+            time.sleep(1)
+            raise RPCClient.RPCServerError("Bad request")
+
+        self.core.rpc_client = MockRPCClient(immediate_callbacks={("settings", "get"): raise_error})
+        with self.assertRaises(TimeoutError):
+            wait_for_misc(self.core, 3, 1)
+
+        def set_rpc_client():
+            time.sleep(2.0)
+            self.core.rpc_client = MockRPCClient(responses={("settings", "get"): SettingsGetResponse(success=True)})
+
+        thread = threading.Thread(target=set_rpc_client)
+        thread.start()
+        wait_for_misc(self.core, 3, 1)
+        thread.join()
+
+        wait_for_misc(self.core, 3, 1)

{openmodule-16.1.1 → openmodule-17.0.0}/tests/test_dispatcher.py

@@ -51,7 +51,7 @@ class MessageDispatcherBasicsTestCase(MessageDispatcherBaseTest):
     def test_filter(self):
         self.dispatcher.register_handler("test", ZMQMessage, self._set_true_handler,
                                          match_type=False,
-                                         filter=lambda msg: msg.get("type") == "some-type")
+                                         filter_=lambda msg: msg.get("type") == "some-type")
 
         # filter does not match
         self.dispatcher.dispatch("test", self.dummy_message(type="incorrect"))
@@ -68,10 +68,10 @@ class MessageDispatcherBasicsTestCase(MessageDispatcherBaseTest):
 
         self.dispatcher.register_handler("test", ZMQMessage, partial(self._set_true_handler, var="message1"),
                                          match_type=False,
-                                         filter=lambda msg: msg.get("type") == "some-type")
+                                         filter_=lambda msg: msg.get("type") == "some-type")
         self.dispatcher.register_handler("test", ZMQMessage, partial(self._set_true_handler, var="message2"),
                                          match_type=False,
-                                         filter=lambda msg: msg.get("type") == "some-type")
+                                         filter_=lambda msg: msg.get("type") == "some-type")
 
         # filter does not match
         self.dispatcher.dispatch("test", self.dummy_message(type="incorrect"))
@@ -171,6 +171,10 @@ class MessageDispatcherWithExecutorTestCase(TestCase):
             IoListener(MessageDispatcher(executor=ThreadPoolExecutor(max_workers=2)))
 
 
+def dummy_handler(_: ZMQMessage) -> None:
+    return None
+
+
 class SubscribingMessageDispatcherTestCase(TestCase):
     subscriptions = set()
 
@@ -188,12 +192,12 @@ class SubscribingMessageDispatcherTestCase(TestCase):
         )
 
     def test_subscribe(self):
-        self.dispatcher.register_handler("topic1", ZMQMessage, lambda *x: x, match_type=False)
+        self.dispatcher.register_handler("topic1", ZMQMessage, dummy_handler, match_type=False)
         self.assertEqual({"topic1"}, self.subscriptions)
 
     def test_unsubscribe(self):
-        listener1 = self.dispatcher.register_handler("topic1", ZMQMessage, lambda *x: x, match_type=False)
-        listener2 = self.dispatcher.register_handler("topic1", ZMQMessage, lambda *x: x, match_type=False)
+        listener1 = self.dispatcher.register_handler("topic1", ZMQMessage, dummy_handler, match_type=False)
+        listener2 = self.dispatcher.register_handler("topic1", ZMQMessage, dummy_handler, match_type=False)
 
         self.assertEqual({"topic1"}, self.subscriptions)
 

{openmodule-16.1.1 → openmodule-17.0.0}/tests/test_health.py

@@ -37,6 +37,34 @@ class HealthTestCase(HealthTestMixin, TestCase):
         self.assertEqual(health["pong"]["status"], "error")
         self.assertEqual(health["pong"]["message"], "error")
 
+    def test_checks_ordered(self):
+        self.core.health.add_check("z", "z", "test z")
+        self.core.health.add_check("y", "y", "test y")
+        self.assertListEqual(
+            list(self.core.health.checks.keys()),
+            [("y", "test"), ("z", "test")]
+        )
+        self.core.health.add_check("a", "a", "test a")
+        self.core.health.add_check("f", "f", "test f")
+        self.assertListEqual(
+            list(self.core.health.checks.keys()),
+            [("a", "test"), ("f", "test"), ("y", "test"), ("z", "test")]
+        )
+
+    def test_metrics_sorted(self):
+        self.core.health.add_metric("z", HealthMetricType.count, "Test Z", "test z")
+        self.core.health.add_metric("y", HealthMetricType.count, "Test Y", "test y")
+        self.assertListEqual(
+            list(self.core.health.metrics.keys()),
+            [("y", "test"), ("z", "test")]
+        )
+        self.core.health.add_metric("a", HealthMetricType.count, "Test A", "test a")
+        self.core.health.add_metric("f", HealthMetricType.count, "Test F", "test f")
+        self.assertListEqual(
+            list(self.core.health.metrics.keys()),
+            [("a", "test"), ("f", "test"), ("y", "test"), ("z", "test")]
+        )
+
     def test_metrics(self):
         self.core.health.add_metric("test_counter", HealthMetricType.count, "Test Count", "counter for testing",
                                     labels={"lc1", "lc2"})
@@ -256,9 +284,10 @@ class HealthTestCase(HealthTestMixin, TestCase):
         self.core.health.metric_set("test_int", 123)
         self.core.health.metric_set("test_float", 123.123)
         health = HealthPongMessage.model_validate(self.get_health())
-        self.assertEqual("123", health.metrics[0].values['{"compute_id":"1"}'])
+        # NOTE: metrics and checks are sorted by keys!
+        self.assertEqual(123.123, health.metrics[0].values['{"compute_id":"1"}'])
         self.assertEqual(123, health.metrics[1].values['{"compute_id":"1"}'])
-        self.assertEqual(123.123, health.metrics[2].values['{"compute_id":"1"}'])
+        self.assertEqual("123", health.metrics[2].values['{"compute_id":"1"}'])
 
     def test_metric_clear(self):
         self.core.health.add_metric("test_counter", HealthMetricType.count, "Test Count", "counter for testing",