Attempting fixing connection stability: add internal feature flag for disabling server heartbeat check (#146)

Author: vrslev

packages/stompman/stompman/client.py

@@ -44,6 +44,7 @@ class Client:
     connection_confirmation_timeout: int = 2
     disconnect_confirmation_timeout: int = 2
     check_server_alive_interval_factor: int = 3
+    _ff_disable_server_heartbeat_check: bool = False
     """Client will check if server alive `server heartbeat interval` times `interval factor`"""
 
     connection_class: type[AbstractConnection] = Connection
@@ -74,6 +75,7 @@ def __post_init__(self) -> None:
             read_max_chunk_size=self.read_max_chunk_size,
             write_retry_attempts=self.write_retry_attempts,
             check_server_alive_interval_factor=self.check_server_alive_interval_factor,
+            _ff_disable_server_heartbeat_check=self._ff_disable_server_heartbeat_check,
             ssl=self.ssl,
         )
 

packages/stompman/stompman/connection_manager.py

@@ -50,6 +50,7 @@ class ConnectionManager:
     read_max_chunk_size: int
     write_retry_attempts: int
     check_server_alive_interval_factor: int
+    _ff_disable_server_heartbeat_check: bool
 
     _active_connection_state: ActiveConnectionState | None = field(default=None, init=False)
     _reconnect_lock: asyncio.Lock = field(init=False, default_factory=asyncio.Lock)
@@ -86,8 +87,10 @@ def _restart_heartbeat_tasks(self, server_heartbeat: Heartbeat) -> None:
         self._send_heartbeat_task = self._task_group.create_task(
             self._send_heartbeats_forever(server_heartbeat.want_to_receive_interval_ms)
         )
-        self._check_server_heartbeat_task = self._task_group.create_task(
-            self._check_server_heartbeat_forever(server_heartbeat.will_send_interval_ms)
+        self._check_server_heartbeat_task = (
+            self._task_group.create_task(self._check_server_heartbeat_forever(server_heartbeat.will_send_interval_ms))
+            if not self._ff_disable_server_heartbeat_check
+            else self._task_group.create_task(asyncio.sleep(0))
         )
 
     async def _send_heartbeats_forever(self, send_heartbeat_interval_ms: int) -> None:

packages/stompman/test_stompman/conftest.py

@@ -79,6 +79,7 @@ class EnrichedConnectionManager(ConnectionManager):
     write_retry_attempts: int = 3
     ssl: Literal[True] | SSLContext | None = None
     check_server_alive_interval_factor: int = 3
+    _ff_disable_server_heartbeat_check: bool = False
 
 
 DataclassType = TypeVar("DataclassType")