switch-api 0.6.18__tar.gz → 0.6.20__tar.gz

{switch_api-0.6.18 → switch_api-0.6.20}/HISTORY.md

@@ -11,6 +11,7 @@ In the `realtime` module:
 - Preserved new-topic behavior: when no retained message exists and Redis is not configured, the provided dataframe is used and published as the initial retained dataset.
 - Updated `subscribe_with_retained_sync()` to apply the passed timeout to the MQTT connection, check subscribe failures, and log when no retained topics are received within the wait period.
 - Added Redis timeout retry handling with a default maximum of 3 attempts for Redis realtime update operations.
+- Added MQTT publish reconnect/retry handling for transient `MQTT_ERR_NO_CONN` publish failures.
 
 
 #0.6.17

{switch_api-0.6.18 → switch_api-0.6.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.18
+Version: 0.6.20
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License
@@ -69,6 +69,7 @@ In the `realtime` module:
 - Preserved new-topic behavior: when no retained message exists and Redis is not configured, the provided dataframe is used and published as the initial retained dataset.
 - Updated `subscribe_with_retained_sync()` to apply the passed timeout to the MQTT connection, check subscribe failures, and log when no retained topics are received within the wait period.
 - Added Redis timeout retry handling with a default maximum of 3 attempts for Redis realtime update operations.
+- Added MQTT publish reconnect/retry handling for transient `MQTT_ERR_NO_CONN` publish failures.
 
 
 #0.6.17

{switch_api-0.6.18 → switch_api-0.6.20}/setup.py

@@ -16,7 +16,7 @@ setup(
     long_description_content_type='text/markdown',
     license='MIT License',
     name="switch_api",
-    version="0.6.18",
+    version="0.6.20",
     packages=find_packages(include=["switch_api", "switch_api.*"]),
     install_requires=['pandas==1.5.3', 'requests', 'azure-storage-blob', 'pandera[io]==0.7.1', 'azure-servicebus',
                       'msal>=1.11.0', 'paho-mqtt==1.6.1', 'uvicorn==0.22.0', 'fastapi==0.98.0', 'pyodbc==4.0.39', 'cachetools==5.5.0', 

{switch_api-0.6.18 → switch_api-0.6.20}/switch_api/__init__.py

@@ -44,4 +44,4 @@ from . import _guide
 # log.addHandler(_ch)
 # https://dev.to/joaomcteixeira/setting-up-python-logging-for-a-library-app-6ml
 
-__version__ = "0.6.18"
+__version__ = "0.6.20"

{switch_api-0.6.18 → switch_api-0.6.20}/switch_api/realtime/_mqtt.py

@@ -8,10 +8,13 @@ A module containing the SwithRealtime class and associated methods referenced by
 module is not directly referenced by end users.
 """
 import logging
+import ssl
 import sys
 import threading
+import time
 from typing import Iterable
 from urllib.parse import urlparse
+import certifi
 import paho.mqtt.client as mqtt
 from paho.mqtt.client import MQTTMessage
 from .._utils._constants import (WS_MQTT_CONNECTION_TIMEOUT)
@@ -53,7 +56,16 @@ class SwitchRealtime:
 
         self.client_id = client_id
         self.client = mqtt.Client(client_id=client_id, transport='websockets', clean_session=True)
-        self.client.tls_set()
+        # self.client.tls_set()
+
+        # -- adhoc for cds engine server --
+        self.client.tls_set(
+            ca_certs=certifi.where(),
+            cert_reqs=ssl.CERT_REQUIRED,
+            tls_version=ssl.PROTOCOL_TLS_CLIENT,
+        )
+        self.client.tls_insecure_set(False)
+        # -- adhoc for cds engine server --
 
         if username and password:
             self.client.username_pw_set(username, password)
@@ -67,6 +79,7 @@ class SwitchRealtime:
 
         self._connected = False
         self._connect_event = threading.Event()
+        self._loop_started = False
 
         # Store all topic states here
         self.topic_state = {}
@@ -93,8 +106,13 @@ class SwitchRealtime:
         logger.info(f'Attempting connection to MQTT broker with client_id={self.client_id} on host={self.host} port={self.port}')
         logger.info(f'hostname={url.hostname}')
 
-        self.client.connect(host=url.hostname, port=self.port)
-        self.client.loop_start() # Run network loop in background thread
+        if self._loop_started:
+            logger.info("Reconnecting existing MQTT client network loop.")
+            self.client.reconnect()
+        else:
+            self.client.connect(host=url.hostname, port=self.port)
+            self.client.loop_start() # Run network loop in background thread
+            self._loop_started = True
 
         self._connected = self._connect_event.wait(timeout=timeout)
 
@@ -158,19 +176,73 @@ class SwitchRealtime:
         return retained_dataset
 
 
-    def publish(self, topic: str, payload: str, qos: int = 1, retain: bool = True):
+    def publish(
+        self,
+        topic: str,
+        payload: str,
+        qos: int = 1,
+        retain: bool = True,
+        timeout: int = WS_MQTT_CONNECTION_TIMEOUT,
+        max_retries: int = 3,
+    ):
         """
         Publish message to broker.
         Set retain=True to store as last known state.
         """
-        result = self.client.publish(topic, payload, qos=qos, retain=retain)
+        if not isinstance(max_retries, int) or max_retries < 1:
+            raise ValueError("max_retries must be a positive integer.")
+
+        last_error = None
+
+        for attempt in range(1, max_retries + 1):
+            if not self._connected:
+                logger.warning(
+                    f"MQTT client is not connected before publish to {topic}. "
+                    f"Reconnect attempt {attempt}/{max_retries}."
+                )
+                reconnect_error = None
+                try:
+                    connected = self.connect(timeout=timeout)
+                except Exception as e:
+                    connected = False
+                    reconnect_error = f"Could not reconnect to MQTT Broker: {e}"
+                    logger.error(reconnect_error)
+
+                if not connected:
+                    last_error = reconnect_error or "Could not reconnect to MQTT Broker."
+                    logger.error(last_error)
+                    time.sleep(1)
+                    continue
+
+            result = self.client.publish(topic, payload, qos=qos, retain=retain)
+
+            if result.rc == mqtt.MQTT_ERR_SUCCESS:
+                logger.info(
+                    f"MQTT publish accepted for topic={topic}, "
+                    f"mid={result.mid}, attempt={attempt}/{max_retries}"
+                )
+                return result
+
+            last_error = (
+                f"Failed to publish to {topic}. MQTT result code: {result.rc}"
+            )
+            logger.error(last_error)
+
+            if result.rc != mqtt.MQTT_ERR_NO_CONN or attempt >= max_retries:
+                break
+
+            self._connected = False
+            logger.warning(
+                f"MQTT publish failed because client is not connected. "
+                f"Retrying publish to {topic} after reconnect "
+                f"(attempt {attempt + 1}/{max_retries})."
+            )
+            time.sleep(1)
 
-        if result.rc != mqtt.MQTT_ERR_SUCCESS:
-            message = f"Failed to publish to {topic}. MQTT result code: {result.rc}"
-            logger.error(message)
-            raise RuntimeError(message)
+        message = last_error or f"Failed to publish to {topic}."
+        logger.error(message)
+        raise RuntimeError(message)
 
-        return result
 
 
 

{switch_api-0.6.18 → switch_api-0.6.20}/switch_api/realtime/realtime.py

@@ -388,7 +388,7 @@ def submit_realtime_updates(
     # ----------------------------
     try:
         _log_json_value(f"Publishing MQTT payload for topic={topic}", payload_json)
-        _switch_realtime.publish(topic=topic, payload=payload_json)
+        _switch_realtime.publish(topic=topic, payload=payload_json, timeout=timeout)
         logger.info(f"Published merged DataFrame to {topic}")
     except Exception as e:
         logger.error(f"Failed to publish DataFrame: {e}")

{switch_api-0.6.18 → switch_api-0.6.20}/switch_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.18
+Version: 0.6.20
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License
@@ -69,6 +69,7 @@ In the `realtime` module:
 - Preserved new-topic behavior: when no retained message exists and Redis is not configured, the provided dataframe is used and published as the initial retained dataset.
 - Updated `subscribe_with_retained_sync()` to apply the passed timeout to the MQTT connection, check subscribe failures, and log when no retained topics are received within the wait period.
 - Added Redis timeout retry handling with a default maximum of 3 attempts for Redis realtime update operations.
+- Added MQTT publish reconnect/retry handling for transient `MQTT_ERR_NO_CONN` publish failures.
 
 
 #0.6.17