crypto-ws-api 2.0.17__tar.gz → 2.0.18__tar.gz

{crypto_ws_api-2.0.17 → crypto_ws_api-2.0.18}/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.0.18 - 2025-03-10
+### Fix
+* [🔒] fix/ws_session.py: Proper restoration of WebSocket connection during recurring failures
+
+### Update
+* [💻] feat/ws_session.py: Add logging configuration and handlers for debug purpose
+* [🔄] fix/ws_session.py: Update UserWSS class to accept a logger instance
+
 ## 2.0.17 - 2025-02-20
 ### Update
 * Bump dependencies

{crypto_ws_api-2.0.17 → crypto_ws_api-2.0.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: crypto-ws-api
-Version: 2.0.17
+Version: 2.0.18
 Summary: Crypto WS API connector for ASYNC requests
 Author-email: Jerry Fedorenko <jerry.fedorenko@yahoo.com>
 Requires-Python: >=3.8

{crypto_ws_api-2.0.17 → crypto_ws_api-2.0.18}/crypto_ws_api/__init__.py

@@ -13,7 +13,7 @@ __maintainer__ = "Jerry Fedorenko"
 __contact__ = "https://github.com/DogsTailFarmer"
 __email__ = "jerry.fedorenko@yahoo.com"
 __credits__ = ["https://github.com/DanyaSWorlD"]
-__version__ = "2.0.17"
+__version__ = "2.0.18"
 
 from pathlib import Path
 import shutil
@@ -22,6 +22,7 @@ from platformdirs import user_config_path
 VERSION = __version__
 TIMEOUT = 5  # sec timeout for WSS initialization and get response
 DELAY = 0.1  # sec delay in keepalive loop
+DEBUG_LOG = 'debug'  # The name of the exchange for which log files, separated by trade_id with DEBUG level, will be generated
 # Maximum str size for unique query ID
 ID_LEN_LIMIT = {
     "binance": 36,

{crypto_ws_api-2.0.17 → crypto_ws_api-2.0.18}/crypto_ws_api/ws_session.py

@@ -4,7 +4,8 @@ import asyncio
 import gc
 import sys
 import time
-import logging
+import logging.handlers
+from pathlib import Path
 import ujson as json
 from ujson import JSONDecodeError
 import hmac
@@ -19,14 +20,34 @@ from websockets.asyncio.client import connect
 from websockets import ConnectionClosed
 
 from enum import Enum
-from crypto_ws_api import TIMEOUT, ID_LEN_LIMIT, DELAY
+from crypto_ws_api import TIMEOUT, ID_LEN_LIMIT, DELAY, DEBUG_LOG
+
+from exchanges_wrapper import LOG_PATH
 
-logger = logging.getLogger(__name__)
-logger.level = logging.INFO
 sys.tracebacklimit = 0
+
 ALPHABET = string.ascii_letters + string.digits
 CONST_WS_START = "userDataStream.start"
 
+def set_logger(name, log_file, file_level=logging.INFO, propagate=False):
+    formatter = logging.Formatter(fmt="[%(asctime)s: %(levelname)s] %(message)s")
+    #
+    fh = logging.handlers.RotatingFileHandler(log_file, maxBytes=1000000, backupCount=10)
+    fh.setFormatter(formatter)
+    fh.setLevel(file_level)
+    #
+    sh = logging.StreamHandler()
+    sh.setFormatter(formatter)
+    sh.setLevel(logging.INFO)
+    #
+    _logger = logging.getLogger(name)
+    _logger.addHandler(fh)
+    _logger.addHandler(sh)
+    _logger.propagate = propagate
+
+    return _logger
+
+logger = set_logger(__name__, Path(LOG_PATH, 'ws_session.log'))
 
 def generate_signature(exchange: str, secret: str, data: str) -> str:
     digest_func = hashlib.sha384 if exchange == 'bitfinex' else hashlib.sha256
@@ -75,7 +96,6 @@ class UserWSS:
         "endpoint",
         "_api_key",
         "_api_secret",
-        "signed",
         "_passphrase",
         "_ws",
         "_listen_key",
@@ -87,17 +107,17 @@ class UserWSS:
         "in_event",
         "_response_pool",
         "tasks",
-        "ping"
+        "ping",
+        "logger"
     )
 
-    def __init__(self, ws_id, exchange, endpoint, api_key, api_secret, signed, passphrase=None):
+    def __init__(self, ws_id, exchange, endpoint, api_key, api_secret, passphrase=None, trade_id=None):
         self.init = True
         self.exchange = exchange
         self.endpoint = endpoint
         #
         self._api_key = api_key
         self._api_secret = api_secret
-        self.signed = signed
         self._passphrase = passphrase
         self._ws = None
         self._listen_key = None
@@ -111,6 +131,15 @@ class UserWSS:
         self.tasks = set()
         self.ping = 0
 
+        if self.exchange == DEBUG_LOG:
+            if trade_id in logging.root.manager.loggerDict:
+                logger.info(f"Logger {trade_id} already exists")
+                self.logger = logging.root.manager.loggerDict[trade_id]
+            else:
+                self.logger = set_logger(trade_id, Path(LOG_PATH, f"ws_{trade_id}.log"), logging.DEBUG)
+        else:
+            self.logger = logger
+
     def tasks_manage(self, coro, name=None):
         _t = asyncio.create_task(coro, name=name)
         self.tasks.add(_t)
@@ -143,11 +172,13 @@ class UserWSS:
             else:
                 logger.warning(f"UserWSS: {self.ws_id}: {msg}")
                 await self.stop()
+        logger.warning(f"UserWSS: {self.ws_id}: _ws_listener stopped")
+        await self.stop()
 
     async def start_wss(self):
         async for self._ws in connect(
                 self.endpoint,
-                logger=logger,
+                logger=self.logger,
                 ping_interval=None if self.exchange == 'huobi' else 20
         ):
             try:
@@ -160,16 +191,17 @@ class UserWSS:
                     self.operational_status = False
                     [task.cancel() for task in self.tasks if not task.done()]
                     self.tasks.clear()
-                    logger.warning(f"Restart WSS for {self.ws_id}")
+                    logger.warning(f"Restart UserWSS for {self.ws_id}")
                     continue
             except Exception as ex:
-                logger.error(f"WSS start other exception: {ex}")
+                logger.error(f"UserWSS start other exception: {ex}")
 
     async def ws_login(self):
         res = await self.request(CONST_WS_START, send_api_key=True)
         if res is None:
             logger.warning(f"UserWSS: Not 'logged in' for {self.ws_id}")
-            raise ConnectionClosed(None, None)
+            if self._ws:
+                await self._ws.close(code=4000)
         else:
             if self.exchange == 'binance':
                 self._listen_key = res.get('listenKey')
@@ -215,7 +247,6 @@ class UserWSS:
         except asyncio.CancelledError:
             pass  # Task cancellation should not be logged as an error
         else:
-            # logger.info(f"request: {self.ws_id}: {res}")
             return res
 
     async def _response_distributor(self, _id):
@@ -494,20 +525,22 @@ class UserWSSession:
         send_api_key=False,
         _signed=False,
     ):
+
         ws_id = f"{self.exchange}-{trade_id}-{method}"
 
-        user_wss = self.user_wss.setdefault(
-            ws_id,
-            UserWSS(
-                ws_id,
-                self.exchange,
-                self.endpoint,
-                self._api_key,
-                self._api_secret,
-                _signed,
-                self._passphrase
-            )
-        )
+        if ws_id in self.user_wss:
+            user_wss = self.user_wss[ws_id]
+        else:
+            user_wss = UserWSS(
+                    ws_id,
+                    self.exchange,
+                    self.endpoint,
+                    self._api_key,
+                    self._api_secret,
+                    self._passphrase,
+                    trade_id
+                )
+            self.user_wss[ws_id] = user_wss
 
         if user_wss.init:
             user_wss.init = False