1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
|
import unittest
import os
import asyncio
from unittest.mock import patch
from logging import getLogger
import json
from electrum_aionostr.relay import Manager, Relay
from electrum_aionostr.key import PrivateKey
from electrum_aionostr.event import Event
_logger = getLogger(__name__)
_logger.setLevel('DEBUG')
def get_random_dummy_event() -> Event:
privkey = PrivateKey(os.urandom(32))
event = Event(
pubkey=privkey.public_key.hex(),
content="test"
)
event = event.sign(privkey.hex())
return event
class DummyWebsocket:
def __init__(self):
self.incoming_messages = asyncio.Queue() # data we receive from the relay
self.outgoing_messages = asyncio.Queue() # data we send to the relay
async def receive_str(self):
msg = await self.incoming_messages.get()
_logger.debug(f"DummyWebsocket received message")
return msg
async def send_str(self, message: str):
await self.outgoing_messages.put(message)
_logger.debug(f"DummyWebsocket sent message")
async def close(self):
_logger.debug(f"DummyWebsocket closed")
class DummyClientSession:
def __init__(self):
self.dummy_websocket = DummyWebsocket()
async def ws_connect(self, url, origin, ssl):
_logger.debug(f"DummyClientSession ws connected")
return self.dummy_websocket
async def close(self):
_logger.debug(f"DummyClientSession closed")
class DummyRelay(Relay):
"""Relay without network connections to test the relay manager"""
def __init__(
self,
url: str,
origin:str = '',
private_key:str='',
connect_timeout: float=1.0,
log=None,
ssl_context=None,
proxy=None,
):
Relay.__init__(self, url, origin, private_key, connect_timeout, log, ssl_context, proxy)
# this will make Relay.connect() use the DummyClientSession instead of an aiohttp ClientSession
self.client = DummyClientSession()
def receive_data_from_relay(self, data):
# put the data on the dummy websocket so the Relay instance treats data as it is appearing
# on the websocket connection to the connected relay
self.client.dummy_websocket.incoming_messages.put_nowait(data)
class TestManager(unittest.IsolatedAsyncioTestCase):
async def test_monitor_queues_event_deduplication(self):
"""
Tests if the events returned by multiple relays are
properly deduplicated.
"""
output_queue = asyncio.Queue() # this is what the consumer of the subscription will receive
input_queues = [asyncio.Queue() for _ in range(10)] # these are the relays
dummy_events = [get_random_dummy_event() for _ in range(20)]
for queue in input_queues:
for dummy_event in dummy_events:
queue.put_nowait(dummy_event)
queue.put_nowait(None) # EOSE
# Create a patched version of Queue.put that adds a delay to force context
# switching as it happens with regular usage of monitor_queues
original_put = asyncio.Queue.put
async def slow_put(self, item):
await asyncio.sleep(0.01)
await original_put(self, item)
with patch('asyncio.Queue.put', slow_put):
monitoring_task = asyncio.create_task(Manager.monitor_queues(
input_queues,
output_queue,
set(),
True,
))
# check if the output queue returns some events twice
event_ids = set()
while True:
event = await asyncio.wait_for(output_queue.get(), timeout=10)
if event is None:
assert len(event_ids) == len(dummy_events)
break
assert event.id not in event_ids
event_ids.add(event.id)
monitoring_task.cancel()
async def test_manager_deduplicates_relays(self):
"""
Relay manager should deduplicate relay urls so it doesn't try to open multiple connections
to the same relay if it gets passed slightly different URLS.
This is important as we often have to open connections on-demand with urls parsed from Nostr
event tags which maybe are slightly different to our own config urls.
"""
relay_urls = [
"wss://test.com/",
"wss://test.com/",
"wss://test.com",
"wss://TEST.COM",
"wSS://test.com",
"wss://TEST.com",
"test.com",
"TEST.COM",
]
manager = Manager(
relays=relay_urls,
)
self.assertEqual(len(manager.relays), 1, msg=[r.url for r in manager.relays])
self.assertEqual(manager.relays[0].url, "wss://test.com")
async def test_subscription_gets_closed_on_return(self):
"""Test that get_events properly unsubscribes when exiting its AsyncGenerator"""
private_key = os.urandom(32)
with patch('electrum_aionostr.relay.Relay', DummyRelay):
manager = Manager(
relays=[f"wss://dummy{i}.relay" for i in range(10)],
private_key=private_key.hex(),
log=_logger,
)
await manager.connect()
self.assertTrue(manager.connected)
received_any_event = asyncio.Future()
async def get_some_events():
query = {'kinds': [1]}
async for event in manager.get_events(query, only_stored=False, single_event=False):
received_any_event.set_result(event)
# return after we received any event, the subscription should get closed
return
event_task = asyncio.create_task(get_some_events())
while len(manager.subscriptions) < 1:
# wait until task creates subscription
await asyncio.sleep(0.01)
self.assertEqual(len(manager.subscriptions), 1, msg="manger should have exactly one subscription")
subscription_id = next(iter(manager.subscriptions.keys()))
# now let the relays send us some events for this subscription
for i in range(5):
relay_message = json.dumps(['EVENT', subscription_id, get_random_dummy_event().to_json_object()])
for dummy_relay in manager.relays:
dummy_relay.receive_data_from_relay(relay_message)
await asyncio.wait_for(received_any_event, timeout=0.5)
# now the subscription task returned, leaving the async generator. the subscription should
# get closed and cleaned up
async def wait_for_cleanup():
while subscription_id in manager.subscriptions:
await asyncio.sleep(0.01)
await asyncio.wait_for(wait_for_cleanup(), timeout=0.5)
self.assertTrue(event_task.done())
async def test_subscription_returns_event_stored_only(self):
"""
Test that we don't immediately close the subscription if only_stored=True and any relay returns
EOSE (End of stored events) before another relay got the chance to send us the event we requested.
"""
private_key = os.urandom(32)
with patch('electrum_aionostr.relay.Relay', DummyRelay):
manager = Manager(
relays=[f"wss://dummy{i}.relay" for i in range(10)],
private_key=private_key.hex(),
log=_logger,
)
await manager.connect()
self.assertTrue(manager.connected)
async def get_event():
query = {'kinds': [1]}
got_event = None
async for event in manager.get_events(query, only_stored=True, single_event=False):
got_event = event
self.assertIsNotNone(got_event, msg="Subscription didn't return any event")
event_task = asyncio.create_task(get_event())
while len(manager.subscriptions) < 1:
# wait until task creates subscription
await asyncio.sleep(0.01)
self.assertEqual(len(manager.subscriptions), 1, msg="manger should have exactly one subscription")
# all relays except the last one report they don't have any event stored
subscription_id = next(iter(manager.subscriptions.keys()))
eose_message = json.dumps(['EOSE', subscription_id])
for dummy_relay in manager.relays[:-1]:
dummy_relay.receive_data_from_relay(eose_message)
# the first relay even sends multiple EOSE to us
for _ in range(10):
manager.relays[0].receive_data_from_relay(eose_message)
# the last relay will send one event and then EOSE
last_relay = manager.relays[-1]
event_message = json.dumps(['EVENT', subscription_id, get_random_dummy_event().to_json_object()])
last_relay.receive_data_from_relay(event_message)
last_relay.receive_data_from_relay(eose_message)
# the event task should return once it got the event as we set only_stored True
await asyncio.wait_for(event_task, timeout=1)
event_task.result()
async def test_subscription_doesnt_get_closed(self):
"""
Test that a subscription for future events (only_stored=False) doesn't get closed if all
relays send EOSE.
"""
private_key = os.urandom(32)
with patch('electrum_aionostr.relay.Relay', DummyRelay):
manager = Manager(
relays=[f"wss://dummy{i}.relay" for i in range(10)],
private_key=private_key.hex(),
log=_logger,
)
await manager.connect()
self.assertTrue(manager.connected)
any_event = asyncio.Future()
async def get_event():
query = {'kinds': [1]}
async for event in manager.get_events(query, only_stored=False, single_event=False):
any_event.set_result(event)
self.assertTrue(False, msg="Subscription stopped")
event_task = asyncio.create_task(get_event())
while len(manager.subscriptions) < 1:
# wait until task creates subscription
await asyncio.sleep(0.01)
self.assertEqual(len(manager.subscriptions), 1, msg="manger should have exactly one subscription")
# all relays send EOSE, but the subscription should stay open
subscription_id = next(iter(manager.subscriptions.keys()))
eose_message = json.dumps(['EOSE', subscription_id])
for dummy_relay in manager.relays:
dummy_relay.receive_data_from_relay(eose_message)
# check that the task is still running and that the subscription didn't return anything
await asyncio.sleep(0.1)
self.assertFalse(event_task.done(), msg="Subscription task stopped")
self.assertFalse(any_event.done())
# now send one event to a single relay, it should be set in the future
relay = manager.relays[0]
dummy_event = get_random_dummy_event().to_json_object()
event_message = json.dumps(['EVENT', subscription_id, dummy_event])
relay.receive_data_from_relay(event_message)
await asyncio.wait_for(any_event, timeout=0.5)
self.assertEqual(dummy_event, any_event.result().to_json_object())
await asyncio.sleep(0.1)
self.assertFalse(event_task.done(), msg="The task should still be running")
event_task.cancel()
|