OctoBot-Trading 2.4.149__tar.gz → 2.4.150__tar.gz

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150}/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.4.150] - 2025-01-27
+### Added
+[Proxy] Proxy related errors and prefixes
+
 ## [2.4.149] - 2025-01-22
 ### Added
 [PersonalData] add get_trade_or_open_order and improve typing

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150/OctoBot_Trading.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OctoBot-Trading
-Version: 2.4.149
+Version: 2.4.150
 Summary: OctoBot project trading package
 Home-page: https://github.com/Drakkar-Software/OctoBot-Trading
 Author: Drakkar-Software
@@ -16,7 +16,7 @@ Classifier: Operating System :: POSIX
 Requires-Python: >=3.8
 License-File: LICENSE
 
-# OctoBot-Trading [2.4.149](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
+# OctoBot-Trading [2.4.150](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/903b6b22bceb4661b608a86fea655f69)](https://app.codacy.com/gh/Drakkar-Software/OctoBot-Trading?utm_source=github.com&utm_medium=referral&utm_content=Drakkar-Software/OctoBot-Trading&utm_campaign=Badge_Grade_Dashboard)
 [![PyPI](https://img.shields.io/pypi/v/OctoBot-Trading.svg)](https://pypi.python.org/pypi/OctoBot-Trading/)
 [![Coverage Status](https://coveralls.io/repos/github/Drakkar-Software/OctoBot-Trading/badge.svg?branch=master)](https://coveralls.io/github/Drakkar-Software/OctoBot-Trading?branch=master)

{OctoBot-Trading-2.4.149/OctoBot_Trading.egg-info → OctoBot-Trading-2.4.150}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OctoBot-Trading
-Version: 2.4.149
+Version: 2.4.150
 Summary: OctoBot project trading package
 Home-page: https://github.com/Drakkar-Software/OctoBot-Trading
 Author: Drakkar-Software
@@ -16,7 +16,7 @@ Classifier: Operating System :: POSIX
 Requires-Python: >=3.8
 License-File: LICENSE
 
-# OctoBot-Trading [2.4.149](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
+# OctoBot-Trading [2.4.150](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/903b6b22bceb4661b608a86fea655f69)](https://app.codacy.com/gh/Drakkar-Software/OctoBot-Trading?utm_source=github.com&utm_medium=referral&utm_content=Drakkar-Software/OctoBot-Trading&utm_campaign=Badge_Grade_Dashboard)
 [![PyPI](https://img.shields.io/pypi/v/OctoBot-Trading.svg)](https://pypi.python.org/pypi/OctoBot-Trading/)
 [![Coverage Status](https://coveralls.io/repos/github/Drakkar-Software/OctoBot-Trading/badge.svg?branch=master)](https://coveralls.io/github/Drakkar-Software/OctoBot-Trading?branch=master)

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150}/README.md

@@ -1,4 +1,4 @@
-# OctoBot-Trading [2.4.149](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
+# OctoBot-Trading [2.4.150](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/903b6b22bceb4661b608a86fea655f69)](https://app.codacy.com/gh/Drakkar-Software/OctoBot-Trading?utm_source=github.com&utm_medium=referral&utm_content=Drakkar-Software/OctoBot-Trading&utm_campaign=Badge_Grade_Dashboard)
 [![PyPI](https://img.shields.io/pypi/v/OctoBot-Trading.svg)](https://pypi.python.org/pypi/OctoBot-Trading/)
 [![Coverage Status](https://coveralls.io/repos/github/Drakkar-Software/OctoBot-Trading/badge.svg?branch=master)](https://coveralls.io/github/Drakkar-Software/OctoBot-Trading?branch=master)

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150}/octobot_trading/__init__.py

@@ -15,4 +15,4 @@
 #  License along with this library.
 
 PROJECT_NAME = "OctoBot-Trading"
-VERSION = "2.4.149"  # major.minor.revision
+VERSION = "2.4.150"  # major.minor.revision

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150}/octobot_trading/errors.py

@@ -33,6 +33,12 @@ class MissingMinimalExchangeTradeVolume(OctoBotExchangeError):
     """
 
 
+class ExchangeProxyError(OctoBotExchangeError):
+    """
+    Raised when an issue related to an exchange proxy is encountered
+    """
+
+
 class TradingModeIncompatibility(Exception):
     """
     Raised when a trading mode is incompatible with the current situation

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150}/octobot_trading/exchanges/config/proxy_config.py

@@ -32,6 +32,8 @@ class ProxyConfig:
     aiohttp_trust_env: bool = octobot_trading.constants.ENABLE_EXCHANGE_HTTP_PROXY_FROM_ENV
     # if set, will be called when exchange stops
     stop_proxy_callback: typing.Optional[typing.Callable] = None
+    # if set, returns the last url given to a callback method that return "True", meaning the last url that used a proxy
+    get_last_proxied_request_url: typing.Optional[typing.Callable] = None
 
     @classmethod
     def default_env_var_config(cls):

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150}/octobot_trading/exchanges/connectors/ccxt/ccxt_client_util.py

@@ -408,3 +408,33 @@ def _use_request_counter(identifier: str, ccxt_client: async_ccxt.Exchange):
 
 def ccxt_exchange_class_factory(exchange_name):
     return getattr(async_ccxt, exchange_name)
+
+def reraise_with_proxy_prefix_if_relevant(ccxt_connector, cause_error: Exception, raised_error: typing.Optional[Exception]):
+    if was_latest_request_proxied(ccxt_connector):
+        raised = raised_error or cause_error
+        raise raised.__class__(f"[Proxied request] {raised}") from cause_error
+
+
+def was_latest_request_proxied(ccxt_connector) -> bool:
+    if not (
+        ccxt_connector.exchange_manager.proxy_config
+        and ccxt_connector.exchange_manager.proxy_config.get_last_proxied_request_url
+    ):
+        return False
+    last_proxied_request_url = ccxt_connector.exchange_manager.proxy_config.get_last_proxied_request_url()
+    last_client_request_url = ccxt_connector.client.last_request_url
+    # if last requests are matching: it was proxied
+    return last_proxied_request_url == last_client_request_url
+
+
+def get_proxy_error_if_any(error: Exception) -> typing.Optional[Exception]:
+    if isinstance(error, (aiohttp.ClientProxyConnectionError, aiohttp.ClientHttpProxyError)):
+        return error
+    max_depth = 10
+    depth = 1
+    cause_error = error
+    while (cause_error := getattr(cause_error, "__cause__", None)) and depth < max_depth:
+        if isinstance(cause_error, (aiohttp.ClientProxyConnectionError, aiohttp.ClientHttpProxyError)):
+            return cause_error
+        depth += 1
+    return None

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150}/octobot_trading/exchanges/connectors/ccxt/ccxt_connector.py

@@ -989,6 +989,21 @@ class CCXTConnector(abstract_exchange.AbstractExchange):
         # 15 pairs, each on 3 time frames
         return 45
 
+    def raise_or_prefix_proxy_error_if_relevant(self, cause_error: Exception, raised_error: typing.Optional[Exception]):
+        """
+        Will raise octobot_trading.errors.ExchangeProxyError when the error is linked to a proxy
+        server of configuration issue.
+        Will re-raise a "[Proxied request] " prefix given error message if relevant, otherwise will just raise the error
+        """
+        if proxy_error := ccxt_client_util.get_proxy_error_if_any(cause_error):
+            raise octobot_trading.errors.ExchangeProxyError(proxy_error) from cause_error
+        # when api key is wrong or proxy is unavailable
+        ccxt_client_util.reraise_with_proxy_prefix_if_relevant(self, cause_error, raised_error)
+        # reraise_with_proxy_prefix_if_relevant did not raise, raise the error as is
+        if raised_error is None:
+            raise cause_error
+        raise raised_error from cause_error
+
     def log_ddos_error(self, error):
         self.logger.error(
             f"DDoSProtection triggered [{html_util.get_html_summary_if_relevant(error)} ({error.__class__.__name__})]. "
@@ -1003,26 +1018,32 @@ class CCXTConnector(abstract_exchange.AbstractExchange):
     def error_describer(self):
         try:
             yield
-        except ccxt.DDoSProtection as e:
+        except ccxt.DDoSProtection as err:
             # raised upon rate limit issues, last response data might have details on what is happening
-            if self.exchange_manager.exchange.should_log_on_ddos_exception(e):
-                self.log_ddos_error(e)
+            if self.exchange_manager.exchange.should_log_on_ddos_exception(err):
+                self.log_ddos_error(err)
             raise
         except ccxt.InvalidNonce as err:
             # use 2 index to get the caller of the context manager
             caller_function_name = inspect.stack()[2].function
             exchanges.log_time_sync_error(self.logger, self.name, err, caller_function_name)
             raise octobot_trading.errors.FailedRequest(html_util.get_html_summary_if_relevant(err)) from err
-        except ccxt.RequestTimeout as e:
+        except ccxt.RequestTimeout as err:
             raise octobot_trading.errors.FailedRequest(
-                f"Request timeout: {html_util.get_html_summary_if_relevant(e)}"
-            ) from e
+                f"Request timeout: {html_util.get_html_summary_if_relevant(err)}"
+            ) from err
         except ccxt.AuthenticationError as err:
-            raise octobot_trading.errors.AuthenticationError(html_util.get_html_summary_if_relevant(err)) from err
+            self.raise_or_prefix_proxy_error_if_relevant(
+                err,
+                octobot_trading.errors.AuthenticationError(html_util.get_html_summary_if_relevant(err))
+            )
         except ccxt.ExchangeNotAvailable as err:
-            raise octobot_trading.errors.FailedRequest(
-                f"Failed to execute request: {err.__class__.__name__}: {html_util.get_html_summary_if_relevant(err)}"
-            ) from err
+            self.raise_or_prefix_proxy_error_if_relevant(
+                err,
+                octobot_trading.errors.FailedRequest(
+                    f"Failed to execute request: {err.__class__.__name__}: {html_util.get_html_summary_if_relevant(err)}"
+                )
+            )
         except ccxt.ExchangeError as err:
             if self.exchange_manager.exchange.is_authentication_error(err):
                 # ensure this is not an unhandled authentication error

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150}/octobot_trading/util/test_tools/exchanges_test_tools.py

@@ -116,13 +116,19 @@ async def add_symbols_details(
 ) -> exchange_data_import.ExchangeData:
 
     await ensure_symbol_markets(exchange_manager, reload=reload_markets, market_filter=market_filter)
-    await asyncio.gather(*(
-        _update_ohlcv(
-            exchange_manager, symbol, time_frame, exchange_data,
+    if len(symbols) == 1:
+        await _update_ohlcv(
+            exchange_manager, next(iter(symbols)), time_frame, exchange_data,
             history_size, start_time, end_time, close_price_only, include_latest_candle
         )
-        for symbol in symbols
-    ))
+    else:
+        await asyncio.gather(*(
+            _update_ohlcv(
+                exchange_manager, symbol, time_frame, exchange_data,
+                history_size, start_time, end_time, close_price_only, include_latest_candle
+            )
+            for symbol in symbols
+        ))
     return exchange_data
 
 
@@ -202,11 +208,13 @@ async def get_open_orders(
     ignore_unsupported_orders: bool = True,
 ) -> list:
     open_orders = []
-
     symbols = symbols or [market.symbol for market in exchange_data.markets]
-    await asyncio.gather(*(
-        _get_open_orders(exchange_manager, symbol, open_orders, ignore_unsupported_orders) for symbol in symbols
-    ))
+    if len(symbols) == 1:
+        await _get_open_orders(exchange_manager, next(iter(symbols)), open_orders, ignore_unsupported_orders)
+    else:
+        await asyncio.gather(*(
+            _get_open_orders(exchange_manager, symbol, open_orders, ignore_unsupported_orders) for symbol in symbols
+        ))
     return open_orders
 
 
@@ -235,10 +243,13 @@ async def get_cancelled_orders(
 ) -> list:
     cancelled_orders = []
     symbols = symbols or [market.symbol for market in exchange_data.markets]
-    await asyncio.gather(*(
-        _get_cancelled_orders(exchange_manager, symbol, cancelled_orders, ignore_unsupported_orders)
-        for symbol in symbols
-    ))
+    if len(symbols) == 1:
+        await _get_cancelled_orders(exchange_manager, next(iter(symbols)), cancelled_orders, ignore_unsupported_orders)
+    else:
+        await asyncio.gather(*(
+            _get_cancelled_orders(exchange_manager, symbol, cancelled_orders, ignore_unsupported_orders)
+            for symbol in symbols
+        ))
     return cancelled_orders
 
 
@@ -257,10 +268,13 @@ async def get_trades(
 ) -> list:
     trades = []
     symbols = symbols or [market.symbol for market in exchange_data.markets]
-    await asyncio.gather(*(
-        _get_trades(exchange_manager, symbol, trades)
-        for symbol in symbols
-    ))
+    if len(symbols) == 1:
+        await _get_trades(exchange_manager, next(iter(symbols)), trades)
+    else:
+        await asyncio.gather(*(
+            _get_trades(exchange_manager, symbol, trades)
+            for symbol in symbols
+        ))
     return trades
 
 
@@ -307,6 +321,10 @@ async def create_orders(
     order_creation_timeout: float,
     price_by_symbol: dict[str, float],
 ) -> list:
+    if len(orders) == 1:
+        return [
+            await _create_order(exchange_manager, next(iter(orders)), order_creation_timeout, price_by_symbol)
+        ]
     return await asyncio.gather(*(
         _create_order(exchange_manager, order_dict, order_creation_timeout, price_by_symbol)
         for order_dict in orders

{OctoBot-Trading-2.4.149 → OctoBot-Trading-2.4.150}/tests/exchanges/connectors/ccxt/test_ccxt_connector.py

@@ -15,12 +15,16 @@
 #  You should have received a copy of the GNU Lesser General Public
 #  License along with this library.
 import decimal
+import ccxt
+import aiohttp
+import aiohttp.client_reqrep
 
 import mock
 from mock import patch
 
 import octobot_trading.exchanges.connectors as exchange_connectors
 import octobot_trading.enums as enums
+import octobot_trading.errors
 import octobot_trading.exchange_data.contracts as contracts
 import octobot_trading.exchanges.connectors.ccxt.ccxt_clients_cache as ccxt_clients_cache
 import pytest
@@ -204,6 +208,78 @@ async def test_get_trade_fee(exchange_manager, future_trader_simulator_with_defa
            _get_fees("taker", "BTC", future_fees_value, decimal.Decimal("0.00018"))
 
 
+async def test_error_describer(ccxt_connector):
+    with pytest.raises(ZeroDivisionError, match="plop"):
+        # random error is just forwarded
+        with ccxt_connector.error_describer():
+            raise ZeroDivisionError("plop")
+    with pytest.raises(ccxt.DDoSProtection):
+        # forwarded ccxt error
+        with ccxt_connector.error_describer():
+            raise ccxt.DDoSProtection("plop")
+    with pytest.raises(octobot_trading.errors.FailedRequest):
+        # transformed ccxt error
+        with ccxt_connector.error_describer():
+            raise ccxt.InvalidNonce("plop")
+    with pytest.raises(octobot_trading.errors.FailedRequest):
+        # transformed ccxt error
+        with ccxt_connector.error_describer():
+            raise ccxt.RequestTimeout("plop")
+    with pytest.raises(ccxt.ExchangeError):
+        # forwarded ccxt error
+        with ccxt_connector.error_describer():
+            raise ccxt.ExchangeError("plop")
+    with mock.patch.object(
+        ccxt_connector.exchange_manager.exchange, "is_authentication_error", mock.Mock(return_value=True)
+    ) as is_authentication_error_mock:
+        with pytest.raises(octobot_trading.errors.AuthenticationError):
+            # transformed ccxt error
+            with ccxt_connector.error_describer():
+                raise ccxt.ExchangeError("plop")
+        is_authentication_error_mock.assert_called_once()
+
+    # proxied errors
+    with pytest.raises(octobot_trading.errors.AuthenticationError):
+        # transformed ccxt error
+        with ccxt_connector.error_describer():
+            raise ccxt.AuthenticationError("plop")
+    with pytest.raises(octobot_trading.errors.FailedRequest):
+        # transformed ccxt error
+        with ccxt_connector.error_describer():
+            raise ccxt.ExchangeNotAvailable("plop")
+    with pytest.raises(octobot_trading.errors.ExchangeProxyError):
+        # proxy connection error
+        with ccxt_connector.error_describer():
+            raise ccxt.AuthenticationError from aiohttp.ClientProxyConnectionError(
+                aiohttp.client_reqrep.ConnectionKey("host", 11, True, True, None, None, None), OSError("plop")
+            )
+    with mock.patch.object(
+        ccxt_connector.exchange_manager.proxy_config, "get_last_proxied_request_url",
+            mock.Mock(return_value="https///plop.com/coucou")
+    ) as get_last_proxied_request_url_mock:
+        with pytest.raises(octobot_trading.errors.AuthenticationError, match="plop"):
+            # not proxied request error
+            with ccxt_connector.error_describer():
+                raise ccxt.AuthenticationError("plop")
+        get_last_proxied_request_url_mock.assert_called_once()
+        get_last_proxied_request_url_mock.reset_mock()
+        with pytest.raises(octobot_trading.errors.AuthenticationError, match="plop"):
+            # not proxied request error
+            ccxt_connector.client.last_request_url = "not_plop"
+            with ccxt_connector.error_describer():
+                raise ccxt.AuthenticationError("plop")
+        get_last_proxied_request_url_mock.assert_called_once()
+        get_last_proxied_request_url_mock.reset_mock()
+        with pytest.raises(octobot_trading.errors.AuthenticationError, match="\[Proxied request\] plop"):
+            # proxied request error: add prefix
+            ccxt_connector.client.last_request_url = "https///plop.com/coucou"
+            with ccxt_connector.error_describer():
+                raise ccxt.AuthenticationError("plop")
+        get_last_proxied_request_url_mock.assert_called_once()
+        get_last_proxied_request_url_mock.reset_mock()
+
+
+
 def _get_fees(type, currency, rate, cost):
     return {
         enums.FeePropertyColumns.TYPE.value: type,