propagate ws reconnect to other classes

Author: tmunzer-AIDE

CHANGELOG.md

@@ -47,8 +47,9 @@ Updated to mist_openapi spec version 2602.1.7.
 ---
 
 ### 3. BUG FIXES
-
 - Fixed `ShellSession.recv()` to gracefully handle socket timeout reset when the connection is already closed
+- Fixed thread-safety (TOCTOU) race conditions in `ShellSession` by capturing WebSocket reference in local variables across `disconnect()`, `connected`, `send()`, `recv()`, and `resize()` methods
+- Fixed thread-safety race condition in `_MistWebsocket.disconnect()` with local variable capture
 
 ---
 

README.md

@@ -579,19 +579,23 @@ The package provides a WebSocket client for real-time event streaming from the M
 
 ### Connection Parameters
 
-All channel classes accept the following optional keyword arguments to control the WebSocket keep-alive behaviour:
+All channel classes accept the following optional keyword arguments:
 
 | Parameter | Type | Default | Description |
 |-----------|------|---------|-------------|
 | `ping_interval` | `int` | `30` | Seconds between automatic ping frames. Set to `0` to disable pings. |
 | `ping_timeout` | `int` | `10` | Seconds to wait for a pong response before treating the connection as dead. |
+| `auto_reconnect` | `bool` | `False` | Automatically reconnect on transient failures using exponential backoff. |
+| `max_reconnect_attempts` | `int` | `5` | Maximum number of reconnect attempts before giving up. |
+| `reconnect_backoff` | `float` | `2.0` | Base backoff delay in seconds. Doubles after each failed attempt (2s, 4s, 8s, ...). Resets on successful reconnection. |
 
 ```python
 ws = mistapi.websockets.sites.DeviceStatsEvents(
     apisession,
     site_ids=["<site_id>"],
-    ping_interval=60,   # ping every 60 s
-    ping_timeout=20,    # wait up to 20 s for pong
+    ping_interval=60,       # ping every 60 s
+    ping_timeout=20,        # wait up to 20 s for pong
+    auto_reconnect=True,    # reconnect on transient failures
 )
 ws.connect()
 ```

src/mistapi/websockets/location.py

@@ -33,6 +33,12 @@ class BleAssetsEvents(_MistWebsocket):
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
         Time in seconds to wait for a ping response before considering the connection dead.
+    auto_reconnect : bool, default False
+        Automatically reconnect on transient failures using exponential backoff.
+    max_reconnect_attempts : int, default 5
+        Maximum number of reconnect attempts before giving up.
+    reconnect_backoff : float, default 2.0
+        Base backoff delay in seconds. Doubles after each failed attempt.
 
 
     EXAMPLE
@@ -67,13 +73,19 @@ def __init__(
         map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
+        auto_reconnect: bool = False,
+        max_reconnect_attempts: int = 5,
+        reconnect_backoff: float = 2.0,
     ) -> None:
         channels = [f"/sites/{site_id}/stats/maps/{mid}/assets" for mid in map_id]
         super().__init__(
             mist_session,
             channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
+            auto_reconnect=auto_reconnect,
+            max_reconnect_attempts=max_reconnect_attempts,
+            reconnect_backoff=reconnect_backoff,
         )
 
 
@@ -128,13 +140,19 @@ def __init__(
         map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
+        auto_reconnect: bool = False,
+        max_reconnect_attempts: int = 5,
+        reconnect_backoff: float = 2.0,
     ) -> None:
         channels = [f"/sites/{site_id}/stats/maps/{mid}/clients" for mid in map_id]
         super().__init__(
             mist_session,
             channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
+            auto_reconnect=auto_reconnect,
+            max_reconnect_attempts=max_reconnect_attempts,
+            reconnect_backoff=reconnect_backoff,
         )
 
 
@@ -189,13 +207,19 @@ def __init__(
         map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
+        auto_reconnect: bool = False,
+        max_reconnect_attempts: int = 5,
+        reconnect_backoff: float = 2.0,
     ) -> None:
         channels = [f"/sites/{site_id}/stats/maps/{mid}/sdkclients" for mid in map_id]
         super().__init__(
             mist_session,
             channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
+            auto_reconnect=auto_reconnect,
+            max_reconnect_attempts=max_reconnect_attempts,
+            reconnect_backoff=reconnect_backoff,
         )
 
 
@@ -250,6 +274,9 @@ def __init__(
         map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
+        auto_reconnect: bool = False,
+        max_reconnect_attempts: int = 5,
+        reconnect_backoff: float = 2.0,
     ) -> None:
         channels = [
             f"/sites/{site_id}/stats/maps/{mid}/unconnected_clients" for mid in map_id
@@ -259,6 +286,9 @@ def __init__(
             channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
+            auto_reconnect=auto_reconnect,
+            max_reconnect_attempts=max_reconnect_attempts,
+            reconnect_backoff=reconnect_backoff,
         )
 
 
@@ -313,6 +343,9 @@ def __init__(
         map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
+        auto_reconnect: bool = False,
+        max_reconnect_attempts: int = 5,
+        reconnect_backoff: float = 2.0,
     ) -> None:
         channels = [
             f"/sites/{site_id}/stats/maps/{mid}/discovered_assets" for mid in map_id
@@ -322,4 +355,7 @@ def __init__(
             channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
+            auto_reconnect=auto_reconnect,
+            max_reconnect_attempts=max_reconnect_attempts,
+            reconnect_backoff=reconnect_backoff,
         )

src/mistapi/websockets/orgs.py

@@ -31,6 +31,12 @@ class InsightsEvents(_MistWebsocket):
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
         Time in seconds to wait for a ping response before considering the connection dead.
+    auto_reconnect : bool, default False
+        Automatically reconnect on transient failures using exponential backoff.
+    max_reconnect_attempts : int, default 5
+        Maximum number of reconnect attempts before giving up.
+    reconnect_backoff : float, default 2.0
+        Base backoff delay in seconds. Doubles after each failed attempt.
 
     EXAMPLE
     -----------
@@ -63,12 +69,18 @@ def __init__(
         org_id: str,
         ping_interval: int = 30,
         ping_timeout: int = 10,
+        auto_reconnect: bool = False,
+        max_reconnect_attempts: int = 5,
+        reconnect_backoff: float = 2.0,
     ) -> None:
         super().__init__(
             mist_session,
             channels=[f"/orgs/{org_id}/insights/summary"],
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
+            auto_reconnect=auto_reconnect,
+            max_reconnect_attempts=max_reconnect_attempts,
+            reconnect_backoff=reconnect_backoff,
         )
 
 
@@ -88,6 +100,12 @@ class MxEdgesStatsEvents(_MistWebsocket):
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
         Time in seconds to wait for a ping response before considering the connection dead.
+    auto_reconnect : bool, default False
+        Automatically reconnect on transient failures using exponential backoff.
+    max_reconnect_attempts : int, default 5
+        Maximum number of reconnect attempts before giving up.
+    reconnect_backoff : float, default 2.0
+        Base backoff delay in seconds. Doubles after each failed attempt.
 
     EXAMPLE
     -----------
@@ -120,12 +138,18 @@ def __init__(
         org_id: str,
         ping_interval: int = 30,
         ping_timeout: int = 10,
+        auto_reconnect: bool = False,
+        max_reconnect_attempts: int = 5,
+        reconnect_backoff: float = 2.0,
     ) -> None:
         super().__init__(
             mist_session,
             channels=[f"/orgs/{org_id}/stats/mxedges"],
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
+            auto_reconnect=auto_reconnect,
+            max_reconnect_attempts=max_reconnect_attempts,
+            reconnect_backoff=reconnect_backoff,
         )
 
 
@@ -145,6 +169,12 @@ class MxEdgesEvents(_MistWebsocket):
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
         Time in seconds to wait for a ping response before considering the connection dead.
+    auto_reconnect : bool, default False
+        Automatically reconnect on transient failures using exponential backoff.
+    max_reconnect_attempts : int, default 5
+        Maximum number of reconnect attempts before giving up.
+    reconnect_backoff : float, default 2.0
+        Base backoff delay in seconds. Doubles after each failed attempt.
 
     EXAMPLE
     -----------
@@ -177,10 +207,16 @@ def __init__(
         org_id: str,
         ping_interval: int = 30,
         ping_timeout: int = 10,
+        auto_reconnect: bool = False,
+        max_reconnect_attempts: int = 5,
+        reconnect_backoff: float = 2.0,
     ) -> None:
         super().__init__(
             mist_session,
             channels=[f"/orgs/{org_id}/mxedges"],
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
+            auto_reconnect=auto_reconnect,
+            max_reconnect_attempts=max_reconnect_attempts,
+            reconnect_backoff=reconnect_backoff,
         )

src/mistapi/websockets/session.py

@@ -32,6 +32,12 @@ class SessionWithUrl(_MistWebsocket):
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
         Time in seconds to wait for a ping response before considering the connection dead.
+    auto_reconnect : bool, default False
+        Automatically reconnect on transient failures using exponential backoff.
+    max_reconnect_attempts : int, default 5
+        Maximum number of reconnect attempts before giving up.
+    reconnect_backoff : float, default 2.0
+        Base backoff delay in seconds. Doubles after each failed attempt.
 
     EXAMPLE
     -----------
@@ -64,13 +70,19 @@ def __init__(
         url: str,
         ping_interval: int = 30,
         ping_timeout: int = 10,
+        auto_reconnect: bool = False,
+        max_reconnect_attempts: int = 5,
+        reconnect_backoff: float = 2.0,
     ) -> None:
         self._url = url
         super().__init__(
             mist_session,
             channels=[],
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
+            auto_reconnect=auto_reconnect,
+            max_reconnect_attempts=max_reconnect_attempts,
+            reconnect_backoff=reconnect_backoff,
         )
 
     def _build_ws_url(self) -> str: