address some comments

- catch more requests errors
- add request information to logs for connection errors
- made `get_tx_hashes_by_block` return None in case of connection error
- add logger to base test class, removed logger from sub classes
- add debug info for checked hashes

Author: fhenneke

src/apis/orderbookapi.py

@@ -51,9 +51,9 @@ def get_solver_competition_data(self, tx_hash: str) -> Optional[dict[str, Any]]:
                     solver_competition_data = json.loads(barn_competition_data.text)
                 else:
                     return None
-        except requests.exceptions.ConnectionError as err:
+        except requests.RequestException as err:
             self.logger.warning(
-                f"Connection error while fetching competition data: {err}"
+                f"Connection error while fetching competition data. Hash: {tx_hash}, error: {err}"
             )
             return None
         return solver_competition_data
@@ -97,8 +97,10 @@ def get_quote(self, trade: Trade) -> Optional[Trade]:
                 json=request_dict,
                 timeout=REQUEST_TIMEOUT,
             )
-        except ValueError as err:
-            self.logger.warning(f"Fee quote failed with error {err}")
+        except requests.RequestException as err:
+            self.logger.warning(
+                f"Fee quote failed. Request: {request_dict}, error: {err}"
+            )
             return None
 
         if quote_response.status_code != SUCCESS_CODE:

src/apis/web3api.py

@@ -42,7 +42,9 @@ def get_current_block_number(self) -> Optional[int]:
             self.logger.warning(f"Error while fetching block number: {err}")
             return None
 
-    def get_tx_hashes_by_block(self, start_block: int, end_block: int) -> list[str]:
+    def get_tx_hashes_by_block(
+        self, start_block: int, end_block: int
+    ) -> Optional[list[str]]:
         """
         Function filters hashes by contract address, and block ranges
         """
@@ -60,7 +62,7 @@ def get_tx_hashes_by_block(self, start_block: int, end_block: int) -> list[str]:
             log_receipts = self.web_3.eth.filter(filter_criteria).get_all_entries()  # type: ignore
         except ValueError as err:
             self.logger.warning(f"ValueError while fetching hashes: {err}")
-            log_receipts = []
+            return None
 
         settlement_hashes_list = list(
             {log_receipt["transactionHash"].hex() for log_receipt in log_receipts}

src/daemon.py

@@ -7,6 +7,7 @@
 # pylint: disable=logging-fstring-interpolation
 
 import time
+from typing import Optional
 from src.apis.web3api import Web3API
 from src.monitoring_tests.solver_competition_surplus_test import (
     SolverCompetitionSurplusTest,
@@ -33,24 +34,28 @@ def main() -> None:
         PartialFillCostCoverageTest(),
     ]
 
-    start_block = web3_api.get_current_block_number()
-    if start_block is None:
-        return
+    start_block: Optional[int] = None
 
     web3_api.logger.debug("Start infinite loop")
     while True:
         time.sleep(SLEEP_TIME_IN_SEC)
+        if start_block is None:
+            start_block = web3_api.get_current_block_number()
+            continue
         end_block = web3_api.get_current_block_number()
         if end_block is None:
             continue
+
         tx_hashes = web3_api.get_tx_hashes_by_block(start_block, end_block)
+        if tx_hashes is None:
+            continue
 
         web3_api.logger.debug(f"{len(tx_hashes)} hashes found: {tx_hashes}")
         for test in tests:
             test.add_hashes_to_queue(tx_hashes)
             web3_api.logger.debug(f"Running test ({test}) for hashes {test.tx_hashes}.")
             test.run_queue()
-            web3_api.logger.debug("Test completed.")
+            web3_api.logger.debug(f"Test ({test}) completed.")
 
         start_block = end_block + 1
 

src/monitoring_tests/base_test.py

@@ -2,7 +2,10 @@
 In this file, we introduce the BaseTest class, whose purpose is to be used as the basis
 for all tests developed.
 """
+# pylint: disable=logging-fstring-interpolation
+
 from abc import ABC, abstractmethod
+from src.helper_functions import get_logger
 
 
 class BaseTest(ABC):
@@ -14,6 +17,7 @@ class BaseTest(ABC):
 
     def __init__(self) -> None:
         self.tx_hashes: list[str] = []
+        self.logger = get_logger()
 
     @abstractmethod
     def run(self, tx_hash: str) -> bool:
@@ -32,6 +36,13 @@ def run_queue(self) -> None:
             success = self.run(tx_hash)
             if not success:
                 tx_hashes_fails.append(tx_hash)
+        tx_hashes_success = [
+            tx_hash for tx_hash in self.tx_hashes if tx_hash not in tx_hashes_fails
+        ]
+        self.logger.debug(
+            f"Test ran successefully for hashes {tx_hashes_success} and"
+            f"needs to be rerun for hashes {tx_hashes_fails}."
+        )
         self.tx_hashes = tx_hashes_fails
 
     def add_hashes_to_queue(self, tx_hashes: list[str]) -> None:
@@ -40,9 +51,9 @@ def add_hashes_to_queue(self, tx_hashes: list[str]) -> None:
         """
         self.tx_hashes += tx_hashes
 
-    @abstractmethod
     def alert(self, msg: str) -> None:
         """
         This function is called to create an alert for a failed test.
         It must be implemented by all subclasses.
         """
+        self.logger.error(msg)

src/monitoring_tests/partially_fillable_cost_coverage_test.py

@@ -7,7 +7,6 @@
 from src.monitoring_tests.base_test import BaseTest
 from src.apis.web3api import Web3API
 from src.apis.orderbookapi import OrderbookAPI
-from src.helper_functions import get_logger
 from src.models import find_partially_fillable
 from src.constants import (
     COST_COVERAGE_ABSOLUTE_DEVIATION_ETH,
@@ -24,7 +23,6 @@ def __init__(self):
         super().__init__()
         self.web3_api = Web3API()
         self.orderbook_api = OrderbookAPI()
-        self.logger = get_logger()
 
     def run(self, tx_hash) -> bool:
         """
@@ -56,9 +54,6 @@ def run(self, tx_hash) -> bool:
 
         return True
 
-    def alert(self, msg: str):
-        self.logger.error(msg)
-
     def run_cost_coverage_test(self, transaction: TxData, receipt: TxReceipt) -> bool:
         """
         Test if the cost of a batch are close to the fees collected in that batch.

src/monitoring_tests/partially_fillable_fee_quote_test.py

@@ -8,7 +8,6 @@
 from src.monitoring_tests.base_test import BaseTest
 from src.apis.web3api import Web3API
 from src.apis.orderbookapi import OrderbookAPI
-from src.helper_functions import get_logger
 from src.models import Trade, find_partially_fillable
 from src.constants import (
     FEE_ABSOLUTE_DEVIATION_ETH_FLAG,
@@ -25,7 +24,6 @@ def __init__(self):
         super().__init__()
         self.web3_api = Web3API()
         self.orderbook_api = OrderbookAPI()
-        self.logger = get_logger()
 
     def run(self, tx_hash) -> bool:
         """
@@ -55,9 +53,6 @@ def run(self, tx_hash) -> bool:
 
         return True
 
-    def alert(self, msg: str):
-        self.logger.error(msg)
-
     def run_quote_test(self, trade: Trade, transaction: TxData) -> bool:
         """
         Check if the fee proposed by a solver is close to the fee proposed by our quoting system.

src/monitoring_tests/solver_competition_surplus_test.py

@@ -8,7 +8,6 @@
 from src.monitoring_tests.base_test import BaseTest
 from src.apis.web3api import Web3API
 from src.apis.orderbookapi import OrderbookAPI
-from src.helper_functions import get_logger
 from src.models import Trade
 from src.constants import ABSOLUTE_ETH_FLAG_AMOUNT, REL_DEVIATION_FLAG_PERCENT
 
@@ -23,7 +22,6 @@ def __init__(self):
         super().__init__()
         self.web3_api = Web3API()
         self.orderbook_api = OrderbookAPI()
-        self.logger = get_logger()
 
     def compare_orders_surplus(self, competition_data: dict[str, Any]) -> bool:
         """
@@ -129,6 +127,3 @@ def run(self, tx_hash) -> bool:
         success = self.compare_orders_surplus(solver_competition_data)
 
         return success
-
-    def alert(self, msg: str) -> None:
-        self.logger.error(msg)