retry cases where the error is an rpc timeout (#15)

* retry cases where the error is an rpc timeout

* use forked version of eth-brownie, update python version to 3.9.16

* increment minor version

Author: Jamchello

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.0
+current_version = 0.2.0
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<stage>[^.]*)\.(?P<devnum>\d+))?

.python-version

@@ -1 +1 @@
-3.9.0
+3.9.16

requirements-dev.txt

@@ -1,7 +1,7 @@
 black == 22.10.0
 bumpversion == 0.6.0
 isort == 5.10.1
-eth-brownie == 1.19.2
+eth-brownie @ git+https://github.com/stakefish/brownie.git@v1.19.3-forked
 pytest-asyncio == 0.20.3
 pytest-mock == 3.10.0
 twine == 4.0.2

requirements.txt

@@ -1,2 +1,2 @@
-web3==5.31.1
+web3==5.31.3
 tenacity==8.1.0

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = stakefish-web3-utils
-version = 0.1.0
+version = 0.2.0
 description = Stakefish’s web3 utils for Python
 author = Michal Baranowski <[email protected]>, Mateusz Sokola <[email protected]>
 url = https://github.com/stakefish/web3-utils

tests/test_retryable_eth_module.py

@@ -10,6 +10,7 @@
 from web3.eth import Eth
 from web3.exceptions import BlockNotFound, TransactionNotFound
 from web3.main import get_default_modules, Web3
+from web3.types import RPCError
 
 from web3_utils.retryable_eth_module import get_retryable_eth_module
 
@@ -141,3 +142,15 @@ def test_stop_retry_on_shutdown(mocker: MockerFixture, event_loop):
         web3.eth.get_block(123)
 
     mocked_fn.assert_called()
+
+
+def test_rpc_timeout_error_retry(mocker):
+    rpc_timeout_error = RPCError(code=-32603, message="request failed or timed out")
+    mocked_fn: MagicMock = mocker.patch(
+        "web3.module.retrieve_blocking_method_call_fn",
+        return_value=trigger_fake_error(error_to_raise=ValueError(rpc_timeout_error)),
+    )
+
+    web3 = retryable_web3()
+    web3.eth.get_block(123)
+    mocked_fn.assert_called()

web3_utils/retryable_eth_module.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 import asyncio
+from http import HTTPStatus
 import logging
 import time
 from typing import Type
@@ -50,6 +51,20 @@ def before(retry_state: "RetryCallState"):
     retry_state.start_time = time.monotonic()
 
 
+def is_retryable_http_error(e) -> bool:
+    """Check for retryable HTTP status codes"""
+    return isinstance(e, HTTPError) and e.response.status_code in [
+        HTTPStatus.TOO_MANY_REQUESTS,
+        HTTPStatus.BAD_GATEWAY,
+        HTTPStatus.GATEWAY_TIMEOUT,
+    ]
+
+
+def is_timeout_value_error(e) -> bool:
+    """Check if a ValueError is due to an rpc request timeout."""
+    return isinstance(e, ValueError) and "request failed or timed out" in str(e)
+
+
 def get_retryable_eth_module(base: Type[Eth] | Type[AsyncEth], logger: logging.Logger, retry_stop: typing.Callable or None = None):
     class RetryableModule(base):
         def __getattribute__(self, name):
@@ -63,7 +78,8 @@ def __getattribute__(self, name):
                         retry_if_exception_type(
                             (BlockNotFound, TransactionNotFound, ConnectionError, ClientConnectorError, asyncio.TimeoutError)
                         ),
-                        retry_if_exception(lambda e: isinstance(e, HTTPError) and e.response.status_code in [429, 502, 504]),
+                        retry_if_exception(is_retryable_http_error),
+                        retry_if_exception(is_timeout_value_error),
                     ),
                     wait=wait_fixed(5),
                     reraise=True,