mirror of
https://github.com/vacp2p/status-benchmarks.git
synced 2026-01-08 15:13:59 -05:00
RPC & Signal clients (#8)
* Add RPC client * Add signal client * Add missing typing to SignalClient * Add missing typing to RpcClient * Remove skip validation from verify_is_valid_json_rpc_response * TODOS for delta_count * Rename pattern to string
This commit is contained in:
Alberto Soutullo
79
src/rpc_client.py
Normal file
79
src/rpc_client.py
Normal file
@@ -0,0 +1,79 @@
|
||||
# Python Imports
|
||||
import json
|
||||
import logging
|
||||
import requests
|
||||
from typing import List
|
||||
from requests import Session, Response
|
||||
from tenacity import retry, stop_after_delay, wait_fixed
|
||||
from json import JSONDecodeError
|
||||
|
||||
# Project Imports
|
||||
|
||||
|
||||
class RpcClient:
|
||||
|
||||
def __init__(self, rpc_url: str, client: Session = requests.Session()):
|
||||
self.client = client
|
||||
self.rpc_url = rpc_url
|
||||
self.request_counter = 0
|
||||
|
||||
def _check_decode_and_key_errors_in_response(self, response: Response, key: str) -> str:
|
||||
try:
|
||||
return response.json()[key]
|
||||
except json.JSONDecodeError:
|
||||
raise AssertionError(f"Invalid JSON in response: {response.content}")
|
||||
except KeyError:
|
||||
raise AssertionError(f"Key '{key}' not found in the JSON response: {response.content}")
|
||||
|
||||
def verify_is_valid_json_rpc_response(self, response: Response, _id: str = None) -> Response:
|
||||
assert response.status_code == 200, f"Got response {response.content}, status code {response.status_code}"
|
||||
assert response.content
|
||||
self._check_decode_and_key_errors_in_response(response, "result")
|
||||
|
||||
if _id:
|
||||
try:
|
||||
if _id != response.json()["id"]:
|
||||
raise AssertionError(f"got id: {response.json()['id']} instead of expected id: {_id}")
|
||||
except KeyError:
|
||||
raise AssertionError(f"no id in response {response.json()}")
|
||||
return response
|
||||
|
||||
def verify_is_json_rpc_error(self, response: Response):
|
||||
assert response.status_code == 200
|
||||
assert response.content
|
||||
self._check_decode_and_key_errors_in_response(response, "error")
|
||||
|
||||
@retry(stop=stop_after_delay(10), wait=wait_fixed(0.5), reraise=True)
|
||||
def rpc_request(self, method: str, params: List = None, request_id: str = None, url: str = None,
|
||||
enable_logging: bool = True) -> Response:
|
||||
if not request_id:
|
||||
request_id = self.request_counter
|
||||
self.request_counter += 1
|
||||
if params is None:
|
||||
params = []
|
||||
url = url if url else self.rpc_url
|
||||
data = {"jsonrpc": "2.0", "method": method, "id": request_id}
|
||||
if params:
|
||||
data["params"] = params
|
||||
if enable_logging:
|
||||
logging.debug(f"Sending POST request to url {url} with data: {json.dumps(data, sort_keys=True)}")
|
||||
response = self.client.post(url, json=data)
|
||||
try:
|
||||
resp_json = response.json()
|
||||
if enable_logging:
|
||||
logging.debug(f"Got response: {json.dumps(resp_json, sort_keys=True)}")
|
||||
if resp_json.get("error"):
|
||||
assert "JSON-RPC client is unavailable" != resp_json["error"]
|
||||
except JSONDecodeError:
|
||||
if enable_logging:
|
||||
logging.debug(f"Got response: {response.content}")
|
||||
return response
|
||||
|
||||
def rpc_valid_request(self, method: str, params: List = None, _id: str = None, url: str = None,
|
||||
skip_validation: bool = False, enable_logging: bool = True) -> Response:
|
||||
response = self.rpc_request(method, params, _id, url, enable_logging=enable_logging)
|
||||
|
||||
if not skip_validation:
|
||||
self.verify_is_valid_json_rpc_response(response, _id)
|
||||
|
||||
return response
|
||||
146
src/signal_client.py
Normal file
146
src/signal_client.py
Normal file
@@ -0,0 +1,146 @@
|
||||
# Python Imports
|
||||
import json
|
||||
import logging
|
||||
import time
|
||||
import websocket
|
||||
import os
|
||||
from typing import List, Any, Dict, Optional
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
from websocket import WebSocketApp
|
||||
|
||||
from src.enums import SignalType
|
||||
|
||||
LOG_SIGNALS_TO_FILE = False
|
||||
SIGNALS_DIR = os.path.dirname(os.path.abspath(__file__))
|
||||
|
||||
|
||||
class SignalType(Enum):
|
||||
MESSAGES_NEW = "messages.new"
|
||||
MESSAGE_DELIVERED = "message.delivered"
|
||||
NODE_READY = "node.ready"
|
||||
NODE_STARTED = "node.started"
|
||||
NODE_LOGIN = "node.login"
|
||||
NODE_LOGOUT = "node.stopped"
|
||||
|
||||
|
||||
|
||||
class SignalClient:
|
||||
def __init__(self, ws_url: str, await_signals: List[str]):
|
||||
self.url = f"{ws_url}/signals"
|
||||
|
||||
self.await_signals = await_signals
|
||||
# TODO: Improve delta_count explanation
|
||||
self.received_signals = {
|
||||
# For each signal type, store:
|
||||
# - list of received signals
|
||||
# - expected received event delta count (resets to 1 after each wait_for_event call)
|
||||
# - expected received event count
|
||||
# - a function that takes the received signal as an argument and returns True if the signal is accepted (counted) or discarded
|
||||
signal: {
|
||||
"received": [],
|
||||
"delta_count": 1,
|
||||
"expected_count": 1,
|
||||
"accept_fn": None,
|
||||
}
|
||||
for signal in self.await_signals
|
||||
}
|
||||
if LOG_SIGNALS_TO_FILE:
|
||||
self.signal_file_path = os.path.join(
|
||||
SIGNALS_DIR,
|
||||
f"signal_{ws_url.split(':')[-1]}_{datetime.now().strftime('%H%M%S')}.log",
|
||||
)
|
||||
Path(SIGNALS_DIR).mkdir(parents=True, exist_ok=True)
|
||||
|
||||
def on_message(self, ws: WebSocketApp, signal: str):
|
||||
signal_data = json.loads(signal)
|
||||
if LOG_SIGNALS_TO_FILE:
|
||||
self.write_signal_to_file(signal_data)
|
||||
|
||||
signal_type = signal_data.get("type")
|
||||
if signal_type in self.await_signals:
|
||||
accept_fn = self.received_signals[signal_type]["accept_fn"]
|
||||
if not accept_fn or accept_fn(signal_data):
|
||||
self.received_signals[signal_type]["received"].append(signal_data)
|
||||
|
||||
def check_signal_type(self, signal_type: str):
|
||||
if signal_type not in self.await_signals:
|
||||
raise ValueError(f"Signal type {signal_type} is not in the list of awaited signals")
|
||||
|
||||
# Used to set up how many instances of a signal to wait for, before triggering the actions
|
||||
# that cause them to be emitted.
|
||||
def prepare_wait_for_signal(self, signal_type: str, delta_count: int, accept_fn=None):
|
||||
self.check_signal_type(signal_type)
|
||||
|
||||
if delta_count < 1:
|
||||
raise ValueError("delta_count must be greater than 0")
|
||||
self.received_signals[signal_type]["delta_count"] = delta_count
|
||||
self.received_signals[signal_type]["expected_count"] = len(self.received_signals[signal_type]["received"]) + delta_count
|
||||
self.received_signals[signal_type]["accept_fn"] = accept_fn
|
||||
|
||||
def wait_for_signal(self, signal_type: str, timeout: int = 20) -> Dict | List[Dict]:
|
||||
self.check_signal_type(signal_type)
|
||||
|
||||
start_time = time.time()
|
||||
received_signals = self.received_signals.get(signal_type)
|
||||
while (not received_signals) or len(received_signals["received"]) < received_signals["expected_count"]:
|
||||
if time.time() - start_time >= timeout:
|
||||
raise TimeoutError(f"Signal {signal_type} is not received in {timeout} seconds")
|
||||
time.sleep(0.2)
|
||||
logging.debug(f"Signal {signal_type} is received in {round(time.time() - start_time)} seconds")
|
||||
# TODO: Improve delta_count explanation
|
||||
delta_count = received_signals["delta_count"]
|
||||
self.prepare_wait_for_signal(signal_type, 1)
|
||||
if delta_count == 1:
|
||||
return self.received_signals[signal_type]["received"][-1]
|
||||
return self.received_signals[signal_type]["received"][-delta_count:]
|
||||
|
||||
def wait_for_login(self) -> Dict:
|
||||
signal = self.wait_for_signal(SignalType.NODE_LOGIN.value)
|
||||
if "error" in signal["event"]:
|
||||
error_details = signal["event"]["error"]
|
||||
assert not error_details, f"Unexpected error during login: {error_details}"
|
||||
self.node_login_event = signal
|
||||
return signal
|
||||
|
||||
def wait_for_logout(self) -> Dict:
|
||||
signal = self.wait_for_signal(SignalType.NODE_LOGOUT.value)
|
||||
return signal
|
||||
|
||||
def find_signal_containing_string(self, signal_type: str, event_string: str, timeout=20) -> Optional[Dict]:
|
||||
start_time = time.time()
|
||||
while True:
|
||||
if time.time() - start_time >= timeout:
|
||||
raise TimeoutError(f"Signal {signal_type} containing {event_string} is not received in {timeout} seconds")
|
||||
if not self.received_signals.get(signal_type):
|
||||
time.sleep(0.2)
|
||||
continue
|
||||
for event in self.received_signals[signal_type]["received"]:
|
||||
if event_string in json.dumps(event):
|
||||
logging.info(f"Signal {signal_type} containing {event_string} is received in {round(time.time() - start_time)} seconds")
|
||||
return event
|
||||
time.sleep(0.2)
|
||||
|
||||
def _on_error(self, ws: WebSocketApp, error: Any):
|
||||
logging.error(f"Error: {error}")
|
||||
|
||||
def _on_close(self, ws: WebSocketApp, close_status_code: Any, close_msg: Any):
|
||||
logging.info(f"Connection closed: {close_status_code}, {close_msg}")
|
||||
|
||||
def _on_open(self, ws: WebSocketApp):
|
||||
logging.info("Connection opened")
|
||||
|
||||
def _connect(self):
|
||||
ws = websocket.WebSocketApp(
|
||||
self.url,
|
||||
on_message=self.on_message,
|
||||
on_error=self._on_error,
|
||||
on_close=self._on_close,
|
||||
)
|
||||
ws.on_open = self._on_open
|
||||
ws.run_forever()
|
||||
|
||||
def write_signal_to_file(self, signal_data: Dict):
|
||||
with open(self.signal_file_path, "a+") as file:
|
||||
json.dump(signal_data, file)
|
||||
file.write("\n")
|
||||
Reference in New Issue
Block a user