pyobs-core 2.0.0.dev30__tar.gz → 2.0.0.dev32__tar.gz

{pyobs_core-2.0.0.dev30 → pyobs_core-2.0.0.dev32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyobs-core
-Version: 2.0.0.dev30
+Version: 2.0.0.dev32
 Summary: robotic telescope software
 Author-email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT

{pyobs_core-2.0.0.dev30 → pyobs_core-2.0.0.dev32}/pyobs/comm/xmpp/xmppclient.py

@@ -15,7 +15,14 @@ log = logging.getLogger(__name__)
 class XmppClient(slixmpp.ClientXMPP):
     """XMPP client for pyobs."""
 
-    def __init__(self, jid: str, password: str, **kwargs: Any):
+    def __init__(
+        self,
+        jid: str,
+        password: str,
+        ping_interval: float = 300.0,
+        ping_timeout: float = 30.0,
+        **kwargs: Any,
+    ):
         """Create a new XMPP client.
 
         An XmppClient handles the actual XMPP communication for the XmppComm module.
@@ -23,6 +30,12 @@ class XmppClient(slixmpp.ClientXMPP):
         Args:
             jid: Connect to the XMPP server with the given JID.
             password: Password to use for connection.
+            ping_interval: Seconds between XEP-0199 keepalive pings.
+            ping_timeout: Seconds to wait for a ping reply before treating the connection as
+                dead and reconnecting. If the server-side shaper can delay an IQ reply by more
+                than this, keepalive pings misfire as false disconnects -- raise this to be more
+                tolerant of a throttled/slow server instead of only tolerating a genuinely dead
+                connection.
         """
 
         slixmpp.ClientXMPP.__init__(self, jid, password, **kwargs)
@@ -51,7 +64,7 @@ class XmppClient(slixmpp.ClientXMPP):
         self.register_plugin("xep_0199")  # XMPP Ping
 
         # enable keep alive pings
-        self.plugin["xep_0199"].enable_keepalive()
+        self.plugin["xep_0199"].enable_keepalive(interval=ping_interval, timeout=ping_timeout)
 
         # handle session_start and message events
         self.add_event_handler("session_start", self.session_start)

{pyobs_core-2.0.0.dev30 → pyobs_core-2.0.0.dev32}/pyobs/comm/xmpp/xmppcomm.py

@@ -95,6 +95,16 @@ class XmppComm(Comm):
     Finally, always make sure that ``use_tls`` is set according to the server's settings, i.e. if it uses TLS, this
     parameter must be True, and False otherwise. Cryptic error messages will follow, if one does not set this properly.
 
+    ``ping_interval``/``ping_timeout`` control the XEP-0199 keepalive ping that detects a dead connection.
+    ``ping_timeout`` in particular may need raising above its 30s default on a server whose shaper can delay an IQ
+    reply that long under load -- otherwise a merely-slow reply is indistinguishable from a dead connection and
+    triggers a reconnect that didn't need to happen::
+
+        comm:
+            class: pyobs.comm.xmpp.XmppComm
+            jid: someuser@example.com/pyobs
+            ping_timeout: 60
+
     """
 
     __module__ = "pyobs.comm.xmpp"
@@ -109,6 +119,8 @@ class XmppComm(Comm):
         server: str | None = None,
         use_tls: bool = False,
         ignore_cert_errors: bool = False,
+        ping_interval: float = 300.0,
+        ping_timeout: float = 30.0,
         *args: Any,
         **kwargs: Any,
     ):
@@ -124,6 +136,8 @@ class XmppComm(Comm):
             password: Password for given JID.
             server: Server to connect to. If not given, domain from JID is used.
             use_tls: Whether to use TLS.
+            ping_interval: Seconds between XEP-0199 keepalive pings.
+            ping_timeout: Seconds to wait for a ping reply before reconnecting.
         """
         Comm.__init__(self, *args, **kwargs)
 
@@ -140,6 +154,8 @@ class XmppComm(Comm):
         self._server = server
         self._use_tls = use_tls
         self._ignore_cert_errors = ignore_cert_errors
+        self._ping_interval = ping_interval
+        self._ping_timeout = ping_timeout
         self._loop = asyncio.get_event_loop()
         self._safe_send_attempts = 5
         self._safe_send_wait = 1
@@ -217,7 +233,9 @@ class XmppComm(Comm):
             self._xmpp.abort()
 
         # create client
-        self._xmpp = XmppClient(self._jid, self._password)
+        self._xmpp = XmppClient(
+            self._jid, self._password, ping_interval=self._ping_interval, ping_timeout=self._ping_timeout
+        )
 
         # presence gating (see mark_ready()) only applies to a comm with an actual Module
         # attached that hasn't finished starting yet -- a module-less XmppComm (a GUI, an
@@ -1019,7 +1037,7 @@ class XmppComm(Comm):
             try:
                 await self._safe_send(self.client.plugin["xep_0060"].subscribe, self._pubsub_service, node)
                 break
-            except slixmpp.exceptions.IqError:
+            except (slixmpp.exceptions.IqError, slixmpp.exceptions.IqTimeout):
                 await asyncio.sleep(1)
         else:
             log.warning("Could not subscribe to state node %s after 30 attempts", node)

{pyobs_core-2.0.0.dev30 → pyobs_core-2.0.0.dev32}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyobs-core"
-version = "2.0.0.dev30"
+version = "2.0.0.dev32"
 description = "robotic telescope software"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
 requires-python = ">=3.11"