bug fixes and other improvements

Author: tmunzer-AIDE

src/mistapi/device_utils/__tools/shell.py

@@ -127,6 +127,7 @@ def _build_sslopt(self) -> dict:
         session = self._mist_session._session
         if session.verify is False:
             sslopt["cert_reqs"] = ssl.CERT_NONE
+            sslopt["check_hostname"] = False
         elif isinstance(session.verify, str):
             sslopt["ca_certs"] = session.verify
         if session.cert:
@@ -143,15 +144,21 @@ def _build_sslopt(self) -> dict:
 
     def connect(self) -> None:
         """Open the WebSocket connection."""
+        if self._ws is not None and self._ws.connected:
+            raise RuntimeError("Already connected; call disconnect() first")
         LOGGER.info("Connecting to shell WebSocket: %s", self._ws_url)
         self._ws = websocket.create_connection(
             self._ws_url,
             header=self._get_headers(),
             cookie=self._get_cookie(),
             sslopt=self._build_sslopt(),
         )
-        self._ws.settimeout(0.1)
-        self.resize(self._rows, self._cols)
+        try:
+            self._ws.settimeout(0.1)
+            self.resize(self._rows, self._cols)
+        except Exception:
+            self.disconnect()
+            raise
         LOGGER.info("Shell WebSocket connected")
 
     def disconnect(self) -> None:
@@ -210,8 +217,16 @@ def recv(self, timeout: float = 0.1) -> bytes | None:
         finally:
             try:
                 ws.settimeout(old_timeout)
-            except Exception:
-                pass
+            except (
+                websocket.WebSocketConnectionClosedException,
+                ConnectionError,
+                OSError,
+            ) as exc:
+                LOGGER.debug(
+                    "ShellSession.recv: failed to restore websocket timeout "
+                    "(socket may be closed): %s",
+                    exc,
+                )
 
     def resize(self, rows: int, cols: int) -> None:
         """Send a terminal resize message to the device."""

src/mistapi/websockets/__ws_client.py

@@ -49,6 +49,11 @@ def __init__(
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
     ) -> None:
+        if max_reconnect_attempts < 0:
+            raise ValueError("max_reconnect_attempts must be >= 0")
+        if reconnect_backoff <= 0:
+            raise ValueError("reconnect_backoff must be > 0")
+
         self._mist_session = mist_session
         self._channels = channels
         self._ping_interval = ping_interval
@@ -75,7 +80,7 @@ def __init__(
     # Auth / URL helpers
 
     def _build_ws_url(self) -> str:
-        return f"wss://{self._mist_session._cloud_uri.replace('api.', 'api-ws.')}/api-ws/v1/stream"
+        return f"wss://{self._mist_session._cloud_uri.replace('api.', 'api-ws.', 1)}/api-ws/v1/stream"
 
     def _get_headers(self) -> dict:
         if self._mist_session._apitoken:
@@ -109,6 +114,7 @@ def _build_sslopt(self) -> dict:
         session = self._mist_session._session
         if session.verify is False:
             sslopt["cert_reqs"] = ssl.CERT_NONE
+            sslopt["check_hostname"] = False
         elif isinstance(session.verify, str):
             sslopt["ca_certs"] = session.verify
         if session.cert:
@@ -146,6 +152,8 @@ def _handle_open(self, ws: websocket.WebSocketApp) -> None:
         for channel in self._channels:
             ws.send(json.dumps({"subscribe": channel}))
         self._reconnect_attempts = 0
+        self._last_close_code = None
+        self._last_close_msg = None
         self._connected.set()
         if self._on_open_cb:
             self._on_open_cb()
@@ -200,6 +208,8 @@ def connect(self, run_in_background: bool = True) -> None:
             If True, runs the WebSocket loop in a daemon thread (non-blocking).
             If False, blocks the calling thread until disconnected.
         """
+        if self._thread is not None and self._thread.is_alive():
+            raise RuntimeError("Already connected; call disconnect() first")
         self._user_disconnect.clear()
         self._reconnect_attempts = 0
         # Drain stale sentinel from previous connection

src/mistapi/websockets/location.py

@@ -34,7 +34,7 @@ class BleAssetsEvents(_MistWebsocket):
     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.
+        Automatically reconnect on unexpected disconnections using exponential backoff.
     max_reconnect_attempts : int, default 5
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
@@ -45,22 +45,22 @@ class BleAssetsEvents(_MistWebsocket):
     -----------
     Callback style (background thread)::
 
-        ws = LocationBleAssetsEvents(session, site_id="abc123", map_id="def456")
+        ws = BleAssetsEvents(session, site_id="abc123", map_id="def456")
         ws.on_message(lambda data: print(data))
         ws.connect()  # non-blocking, runs in background thread
         input("Press Enter to stop")
         ws.disconnect()
 
     Generator style (background thread)::
 
-        ws = LocationBleAssetsEvents(session, site_id="abc123", map_id="def456")
+        ws = BleAssetsEvents(session, site_id="abc123", map_id="def456")
         ws.connect(run_in_background=True)
         for msg in ws.receive():
             process(msg)
 
     Context manager::
 
-        with LocationBleAssetsEvents(session, site_id="abc123", map_id="def456") as ws:
+        with BleAssetsEvents(session, site_id="abc123", map_id="def456") as ws:
             ws.on_message(my_handler)
             ws.connect()  # non-blocking, runs in background thread
             time.sleep(60)
@@ -107,27 +107,33 @@ class ConnectedClientsEvents(_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 unexpected disconnections 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
     -----------
     Callback style (background thread)::
 
-        ws = LocationConnectedClientsEvents(session, site_id="abc123", map_id="def456")
+        ws = ConnectedClientsEvents(session, site_id="abc123", map_id="def456")
         ws.on_message(lambda data: print(data))
         ws.connect()  # non-blocking, runs in background thread
         input("Press Enter to stop")
         ws.disconnect()
 
     Generator style (background thread)::
 
-        ws = LocationConnectedClientsEvents(session, site_id="abc123", map_id="def456")
+        ws = ConnectedClientsEvents(session, site_id="abc123", map_id="def456")
         ws.connect(run_in_background=True)
         for msg in ws.receive():
             process(msg)
 
     Context manager::
 
-        with LocationConnectedClientsEvents(session, site_id="abc123", map_id="def456") as ws:
+        with ConnectedClientsEvents(session, site_id="abc123", map_id="def456") as ws:
             ws.on_message(my_handler)
             ws.connect()  # non-blocking, runs in background thread
             time.sleep(60)
@@ -174,27 +180,33 @@ class SdkClientsEvents(_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 unexpected disconnections 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
     -----------
     Callback style (background thread)::
 
-        ws = LocationSdkClientsEvents(session, site_id="abc123", map_id="def456")
+        ws = SdkClientsEvents(session, site_id="abc123", map_id="def456")
         ws.on_message(lambda data: print(data))
         ws.connect()  # non-blocking, runs in background thread
         input("Press Enter to stop")
         ws.disconnect()
 
     Generator style (background thread)::
 
-        ws = LocationSdkClientsEvents(session, site_id="abc123", map_id="def456")
+        ws = SdkClientsEvents(session, site_id="abc123", map_id="def456")
         ws.connect(run_in_background=True)
         for msg in ws.receive():
             process(msg)
 
     Context manager::
 
-        with LocationSdkClientsEvents(session, site_id="abc123", map_id="def456") as ws:
+        with SdkClientsEvents(session, site_id="abc123", map_id="def456") as ws:
             ws.on_message(my_handler)
             ws.connect()  # non-blocking, runs in background thread
             time.sleep(60)
@@ -241,27 +253,33 @@ class UnconnectedClientsEvents(_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 unexpected disconnections 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
     -----------
     Callback style (background thread)::
 
-        ws = LocationUnconnectedClientsEvents(session, site_id="abc123", map_id="def456")
+        ws = UnconnectedClientsEvents(session, site_id="abc123", map_id="def456")
         ws.on_message(lambda data: print(data))
         ws.connect()  # non-blocking, runs in background thread
         input("Press Enter to stop")
         ws.disconnect()
 
     Generator style (background thread)::
 
-        ws = LocationUnconnectedClientsEvents(session, site_id="abc123", map_id="def456")
+        ws = UnconnectedClientsEvents(session, site_id="abc123", map_id="def456")
         ws.connect(run_in_background=True)
         for msg in ws.receive():
             process(msg)
 
     Context manager::
 
-        with LocationUnconnectedClientsEvents(session, site_id="abc123", map_id="def456") as ws:
+        with UnconnectedClientsEvents(session, site_id="abc123", map_id="def456") as ws:
             ws.on_message(my_handler)
             ws.connect()  # non-blocking, runs in background thread
             time.sleep(60)
@@ -310,27 +328,33 @@ class DiscoveredBleAssetsEvents(_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 unexpected disconnections 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
     -----------
     Callback style (background thread)::
 
-        ws = LocationDiscoveredBleAssetsEvents(session, site_id="abc123", map_id="def456")
+        ws = DiscoveredBleAssetsEvents(session, site_id="abc123", map_id="def456")
         ws.on_message(lambda data: print(data))
         ws.connect()  # non-blocking, runs in background thread
         input("Press Enter to stop")
         ws.disconnect()
 
     Generator style (background thread)::
 
-        ws = LocationDiscoveredBleAssetsEvents(session, site_id="abc123", map_id="def456")
+        ws = DiscoveredBleAssetsEvents(session, site_id="abc123", map_id="def456")
         ws.connect(run_in_background=True)
         for msg in ws.receive():
             process(msg)
 
     Context manager::
 
-        with LocationDiscoveredBleAssetsEvents(session, site_id="abc123", map_id="def456") as ws:
+        with DiscoveredBleAssetsEvents(session, site_id="abc123", map_id="def456") as ws:
             ws.on_message(my_handler)
             ws.connect()  # non-blocking, runs in background thread
             time.sleep(60)

src/mistapi/websockets/orgs.py

@@ -32,7 +32,7 @@ class InsightsEvents(_MistWebsocket):
     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.
+        Automatically reconnect on unexpected disconnections using exponential backoff.
     max_reconnect_attempts : int, default 5
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
@@ -42,22 +42,22 @@ class InsightsEvents(_MistWebsocket):
     -----------
     Callback style (background thread)::
 
-        ws = OrgInsightsEvents(session, org_id="abc123")
+        ws = InsightsEvents(session, org_id="abc123")
         ws.on_message(lambda data: print(data))
         ws.connect()  # non-blocking, runs in background thread
         input("Press Enter to stop")
         ws.disconnect()
 
     Generator style::
 
-        ws = OrgInsightsEvents(session, org_id="abc123")
+        ws = InsightsEvents(session, org_id="abc123")
         ws.connect(run_in_background=True)
         for msg in ws.receive():
             process(msg)
 
     Context manager::
 
-        with OrgInsightsEvents(session, org_id="abc123") as ws:
+        with InsightsEvents(session, org_id="abc123") as ws:
             ws.on_message(my_handler)
             ws.connect()  # non-blocking, runs in background thread
             time.sleep(60)
@@ -101,7 +101,7 @@ class MxEdgesStatsEvents(_MistWebsocket):
     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.
+        Automatically reconnect on unexpected disconnections using exponential backoff.
     max_reconnect_attempts : int, default 5
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
@@ -111,22 +111,22 @@ class MxEdgesStatsEvents(_MistWebsocket):
     -----------
     Callback style (background thread)::
 
-        ws = OrgMxEdgesStatsEvents(session, org_id="abc123")
+        ws = MxEdgesStatsEvents(session, org_id="abc123")
         ws.on_message(lambda data: print(data))
         ws.connect()  # non-blocking, runs in background thread
         input("Press Enter to stop")
         ws.disconnect()
 
     Generator style::
 
-        ws = OrgMxEdgesStatsEvents(session, org_id="abc123")
+        ws = MxEdgesStatsEvents(session, org_id="abc123")
         ws.connect(run_in_background=True)
         for msg in ws.receive():
             process(msg)
 
     Context manager::
 
-        with OrgMxEdgesStatsEvents(session, org_id="abc123") as ws:
+        with MxEdgesStatsEvents(session, org_id="abc123") as ws:
             ws.on_message(my_handler)
             ws.connect()  # non-blocking, runs in background thread
             time.sleep(60)
@@ -170,7 +170,7 @@ class MxEdgesEvents(_MistWebsocket):
     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.
+        Automatically reconnect on unexpected disconnections using exponential backoff.
     max_reconnect_attempts : int, default 5
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0

src/mistapi/websockets/session.py

@@ -33,7 +33,7 @@ class SessionWithUrl(_MistWebsocket):
     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.
+        Automatically reconnect on unexpected disconnections using exponential backoff.
     max_reconnect_attempts : int, default 5
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
@@ -43,22 +43,22 @@ class SessionWithUrl(_MistWebsocket):
     -----------
     Callback style (background thread)::
 
-        ws = sessionWithUrl(session, url="wss://example.com/channel")
+        ws = SessionWithUrl(session, url="wss://example.com/channel")
         ws.on_message(lambda data: print(data))
         ws.connect()  # non-blocking, runs in background thread
         input("Press Enter to stop")
         ws.disconnect()
 
     Generator style::
 
-        ws = sessionWithUrl(session, url="wss://example.com/channel")
+        ws = SessionWithUrl(session, url="wss://example.com/channel")
         ws.connect(run_in_background=True)
         for msg in ws.receive():
             process(msg)
 
     Context manager::
 
-        with sessionWithUrl(session, url="wss://example.com/channel") as ws:
+        with SessionWithUrl(session, url="wss://example.com/channel") as ws:
             ws.on_message(my_handler)
             ws.connect()  # non-blocking, runs in background thread
             time.sleep(60)