diff --git a/.github/workflows/pr_tests.yml b/.github/workflows/pr_tests.yml index 3e719de73..d9948c8e3 100644 --- a/.github/workflows/pr_tests.yml +++ b/.github/workflows/pr_tests.yml @@ -159,35 +159,45 @@ jobs: --reruns 2 \ --junit-xml=wrapper-results-basic.xml - - name: Run wrapper tests - send e2e part 1 + - name: Run wrapper tests - send handle and subscription continue-on-error: true env: PYTHONPATH: ${{ github.workspace }}/vendor/logos-delivery-python-bindings/waku run: | - pytest tests/wrappers_tests/test_send_e2e_part1.py \ + pytest tests/wrappers_tests/test_send_handle_and_subscription.py \ -m "not docker_required" \ --reruns 2 \ - --junit-xml=wrapper-results-send-part1.xml + --junit-xml=wrapper-results-send-handle-and-subscription.xml - - name: Run wrapper tests - send e2e part 2 + - name: Run wrapper tests - send relay propagation continue-on-error: true env: PYTHONPATH: ${{ github.workspace }}/vendor/logos-delivery-python-bindings/waku run: | - pytest tests/wrappers_tests/test_send_e2e_part2.py \ + pytest tests/wrappers_tests/test_send_relay_propagation.py \ -m "not docker_required" \ --reruns 2 \ - --junit-xml=wrapper-results-send-part2.xml + --junit-xml=wrapper-results-send-relay-propagation.xml - - name: Run wrapper tests - send e2e part 3 + - name: Run wrapper tests - send lightpush and edge continue-on-error: true env: PYTHONPATH: ${{ github.workspace }}/vendor/logos-delivery-python-bindings/waku run: | - pytest tests/wrappers_tests/test_send_e2e_part3.py \ + pytest tests/wrappers_tests/test_send_lightpush_and_edge.py \ -m "not docker_required" \ --reruns 2 \ - --junit-xml=wrapper-results-send-part3.xml + --junit-xml=wrapper-results-send-lightpush-and-edge.xml + + - name: Run wrapper tests - send errors and concurrency + continue-on-error: true + env: + PYTHONPATH: ${{ github.workspace }}/vendor/logos-delivery-python-bindings/waku + run: | + pytest tests/wrappers_tests/test_send_errors_and_concurrency.py \ + -m "not docker_required" \ + --reruns 2 \ + --junit-xml=wrapper-results-send-errors-and-concurrency.xml - name: Test Report if: always() diff --git a/tests/wrappers_tests/test_send_errors_and_concurrency.py b/tests/wrappers_tests/test_send_errors_and_concurrency.py new file mode 100644 index 000000000..eaa895a60 --- /dev/null +++ b/tests/wrappers_tests/test_send_errors_and_concurrency.py @@ -0,0 +1,445 @@ +from concurrent.futures import ThreadPoolExecutor + +import pytest +from src.env_vars import NODE_2 +from src.steps.common import StepsCommon +from src.steps.store import StepsStore +from src.libs.common import delay, to_base64 +from src.libs.custom_logger import get_custom_logger +from src.node.waku_node import WakuNode +from src.node.wrappers_manager import WrapperManager +from src.node.wrapper_helpers import ( + EventCollector, + assert_event_invariants, + create_message_bindings, + get_node_multiaddr, + wait_for_propagated, + wait_for_sent, + wait_for_error, +) + +logger = get_custom_logger(__name__) + +PROPAGATED_TIMEOUT_S = 30.0 +RECOVERY_TIMEOUT_S = 45.0 + +# MaxTimeInCache from send_service.nim. +MAX_TIME_IN_CACHE_S = 60.0 +# Extra slack to cover the background retry loop tick after the window expires. +CACHE_EXPIRY_SLACK_S = 10.0 +ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S = MAX_TIME_IN_CACHE_S + CACHE_EXPIRY_SLACK_S +RETRY_WINDOW_EXPIRED_MSG = "Unable to send within retry time window" + +# S30: concurrent sends on the same content topic during initial auto-subscribe. +S30_CONCURRENT_SENDS = 5 +S30_CONTENT_TOPIC = "/test/1/s30-concurrent/proto" + +# S31: concurrent sends across mixed topics during peer churn. +S31_BURST_SIZE = 8 +S31_CONTENT_TOPICS = [ + "/test/1/s31-topic-a/proto", + "/test/1/s31-topic-b/proto", + "/test/1/s31-topic-c/proto", + "/test/1/s31-topic-d/proto", + "/test/1/s31-topic-e/proto", + "/test/1/s31-topic-f/proto", + "/test/1/s31-topic-g/proto", + "/test/1/s31-topic-h/proto", +] + + +class TestS12IsolatedSenderNoPeers(StepsCommon): + """ + S12 — Isolated sender, no peers. + Sender has relay enabled but zero relay peers and zero lightpush peers. + Expected: send() returns Ok(RequestId), but eventually a message_error + event arrives (no route to propagate). + """ + + def test_s12_send_with_no_peers_produces_error(self, node_config): + sender_collector = EventCollector() + + node_config.update( + { + "relay": True, + "store": False, + "lightpush": False, + "filter": False, + "discv5Discovery": False, + "numShardsInNetwork": 1, + } + ) + + sender_result = WrapperManager.create_and_start( + config=node_config, + event_cb=sender_collector.event_callback, + ) + assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" + + with sender_result.ok_value as sender: + message = create_message_bindings( + payload=to_base64("S12 isolated sender payload"), + contentTopic="/test/1/s12-isolated/proto", + ) + + send_result = sender.send_message(message=message) + assert send_result.is_ok(), f"send() must return Ok(RequestId) even with no peers, got: {send_result.err()}" + + request_id = send_result.ok_value + assert request_id, "send() returned an empty RequestId" + + error = wait_for_error( + collector=sender_collector, + request_id=request_id, + timeout_s=ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S, + ) + assert error is not None, ( + f"No message_error event within {ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S}s " + f"(MaxTimeInCache={MAX_TIME_IN_CACHE_S}s + slack) for isolated sender. " + f"Collected events: {sender_collector.events}" + ) + assert error["requestId"] == request_id + + propagated = wait_for_propagated(sender_collector, request_id, timeout_s=0) + assert propagated is None, f"Unexpected message_propagated event for isolated sender: {propagated}" + + +class TestS21ErrorWhenRetryWindowExpires(StepsCommon): + """ + S21: delivery retry window expires before any valid path recovers. + """ + + def test_s21_error_when_retry_window_expires(self, node_config): + sender_collector = EventCollector() + + node_config.update( + { + "relay": True, + "store": False, + "lightpush": False, + "filter": False, + "discv5Discovery": False, + "numShardsInNetwork": 1, + } + ) + + sender_result = WrapperManager.create_and_start( + config=node_config, + event_cb=sender_collector.event_callback, + ) + assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" + + with sender_result.ok_value as sender_node: + message = create_message_bindings() + send_result = sender_node.send_message(message=message) + assert send_result.is_ok(), f"send() must return Ok(RequestId) even with no peers, got: {send_result.err()}" + + request_id = send_result.ok_value + assert request_id, "send() returned an empty RequestId" + + # No peer + error_event = wait_for_error( + collector=sender_collector, + request_id=request_id, + timeout_s=ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S, + ) + assert error_event is not None, ( + f"No MessageErrorEvent received within {ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S}s " + f"(MaxTimeInCache={MAX_TIME_IN_CACHE_S}s + slack). " + f"Collected events: {sender_collector.events}" + ) + logger.info(f"S21 received error event: {error_event}") + + assert error_event.get("error") == RETRY_WINDOW_EXPIRED_MSG, ( + f"Unexpected error message in message_error event.\n" + f"Expected: {RETRY_WINDOW_EXPIRED_MSG!r}\n" + f"Got: {error_event.get('error')!r}\n" + f"Full event: {error_event}" + ) + + assert_event_invariants(sender_collector, request_id) + + +class TestS30ConcurrentSendsDuringAutoSubscribe(StepsCommon): + """ + S30: concurrent sends on the same content topic during initial auto-subscribe. + - Sender starts unsubscribed to the target topic. + - Several send() calls are issued at nearly the same time. + - Each call must return Ok(RequestId) with a unique id. + - Each request id must get its own propagated event, + with no dropped or cross-associated events. + """ + + def test_s30_concurrent_sends_during_auto_subscribe(self, node_config): + sender_collector = EventCollector() + + node_config.update( + { + "relay": True, + "store": False, + "discv5Discovery": False, + "numShardsInNetwork": 1, + } + ) + + sender_result = WrapperManager.create_and_start( + config=node_config, + event_cb=sender_collector.event_callback, + ) + assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" + + with sender_result.ok_value as sender_node: + # Relay peer so the sender has a propagation path. + relay_config = { + **node_config, + "staticnodes": [get_node_multiaddr(sender_node)], + "portsShift": 1, + } + + relay_result = WrapperManager.create_and_start(config=relay_config) + assert relay_result.is_ok(), f"Failed to start relay peer: {relay_result.err()}" + + with relay_result.ok_value: + # Build one message per send, with distinct payloads so we can + # detect any cross-association between request ids and events. + messages = [ + create_message_bindings( + contentTopic=S30_CONTENT_TOPIC, + payload=to_base64(f"s30-concurrent-{i}"), + ) + for i in range(S30_CONCURRENT_SENDS) + ] + + # Fire all sends concurrently. The sender is not yet subscribed + # to S30_CONTENT_TOPIC, so this exercises the auto-subscribe path + # under contention. + with ThreadPoolExecutor(max_workers=S30_CONCURRENT_SENDS) as pool: + send_results = list(pool.map(sender_node.send_message, messages)) + + # Every send must return Ok(RequestId). + request_ids = [] + for i, send_result in enumerate(send_results): + assert send_result.is_ok(), f"Concurrent send #{i} failed: {send_result.err()}" + request_id = send_result.ok_value + assert request_id, f"Concurrent send #{i} returned an empty RequestId" + request_ids.append(request_id) + + # Request ids must be unique across concurrent sends. + assert len(set(request_ids)) == len(request_ids), f"Duplicate RequestIds returned by concurrent sends: {request_ids}" + + # Each request id must get its own propagated event and no error. + for request_id in request_ids: + propagated_event = wait_for_propagated( + collector=sender_collector, + request_id=request_id, + timeout_s=PROPAGATED_TIMEOUT_S, + ) + assert propagated_event is not None, ( + f"No MessagePropagatedEvent for request_id={request_id} " + f"within {PROPAGATED_TIMEOUT_S}s. " + f"Collected events: {sender_collector.events}" + ) + + error_event = wait_for_error( + collector=sender_collector, + request_id=request_id, + timeout_s=0, + ) + assert error_event is None, f"Unexpected message_error for request_id={request_id}: {error_event}" + + # Cross-association guard: every event with a requestId must + # belong to exactly one of the request ids we issued. + issued = set(request_ids) + for event in sender_collector.snapshot(): + event_request_id = event.get("requestId") + if event_request_id is None: + continue + assert event_request_id in issued, ( + f"Event carries an unknown requestId={event_request_id!r}, " f"not in issued set {issued}. Event: {event}" + ) + + # Per-request invariants apply to every concurrent send + # (correct requestId, no duplicate terminal events, + # Sent never before Propagated). + for request_id in request_ids: + assert_event_invariants(sender_collector, request_id) + + +class TestS31ConcurrentSendsMixedTopicsDuringChurn(StepsStore): + """ + S31: concurrent sends across mixed content topics during peer churn. + """ + + @pytest.mark.docker_required + def test_s31_concurrent_sends_mixed_topics_during_churn(self, node_config): + sender_collector = EventCollector() + + relay_peer = WakuNode(NODE_2, f"s31_relay_peer_{self.test_id}") + relay_peer.start(relay="true", discv5_discovery="false") + relay_peer.set_relay_subscriptions([self.test_pubsub_topic]) + + lightpush_peer = WakuNode(NODE_2, f"s31_lightpush_peer_{self.test_id}") + lightpush_peer.start(relay="true", lightpush="true", discv5_discovery="false") + lightpush_peer.set_relay_subscriptions([self.test_pubsub_topic]) + + store_peer = WakuNode(NODE_2, f"s31_store_peer_{self.test_id}") + store_peer.start(relay="true", store="true", discv5_discovery="false") + store_peer.set_relay_subscriptions([self.test_pubsub_topic]) + + churn_peers = [relay_peer, lightpush_peer, store_peer] + + # Mesh docker peers so a lightpushed message can fan out to the store peer. + peer_multiaddrs = [p.get_multiaddr_with_id() for p in churn_peers] + for peer in churn_peers: + others = [a for a in peer_multiaddrs if a != peer.get_multiaddr_with_id()] + peer.add_peers(others) + + node_config.update( + { + "mode": "Edge", + "relay": True, + "lightpush": True, + "store": False, + "discv5Discovery": False, + "numShardsInNetwork": 1, + "lightpushnode": lightpush_peer.get_multiaddr_with_id(), + } + ) + + sender_result = WrapperManager.create_and_start( + config=node_config, + event_cb=sender_collector.event_callback, + ) + assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" + + with sender_result.ok_value as sender_node: + sender_multiaddr = get_node_multiaddr(sender_node) + for peer in churn_peers: + peer.add_peers([sender_multiaddr]) + delay(3) # let docker peers connect to the sender + + all_request_ids: list[str] = [] + phase1_ids = self._s31_fire_burst(sender_node, phase_label="phase1") + all_request_ids.extend(phase1_ids) + + for peer in churn_peers: + peer.restart() + delay(1) # small window so the restart is actually in-flight + phase2_ids = self._s31_fire_burst(sender_node, phase_label="phase2") + all_request_ids.extend(phase2_ids) + + # Wait for all peers to be ready again and re-attach the sender. + for peer in churn_peers: + peer.ensure_ready(timeout_duration=20) + peer.add_peers([sender_multiaddr]) + + peer_multiaddrs = [p.get_multiaddr_with_id() for p in churn_peers] + for peer in churn_peers: + others = [a for a in peer_multiaddrs if a != peer.get_multiaddr_with_id()] + peer.add_peers(others) + delay(3) + + phase3_ids = self._s31_fire_burst(sender_node, phase_label="phase3") + all_request_ids.extend(phase3_ids) + + assert len(set(all_request_ids)) == len(all_request_ids), f"Duplicate RequestIds across bursts: {all_request_ids}" + + # Phase 1 ran before any churn, so the mesh was stable — standard timeout. + # Phase 3 ran right after restart + re-attach, so the mesh needed to + # re-stabilize — use the recovery timeout to avoid CI flakiness. + phase_timeouts = [ + (phase1_ids, PROPAGATED_TIMEOUT_S), + (phase3_ids, RECOVERY_TIMEOUT_S), + ] + for request_ids, timeout_s in phase_timeouts: + for request_id in request_ids: + propagated_event = wait_for_propagated( + collector=sender_collector, + request_id=request_id, + timeout_s=timeout_s, + ) + assert propagated_event is not None, ( + f"No MessagePropagatedEvent for stable-phase " + f"request_id={request_id} within {timeout_s}s. " + f"Collected events: {sender_collector.events}" + ) + + error_event = wait_for_error( + collector=sender_collector, + request_id=request_id, + timeout_s=0, + ) + assert error_event is None, f"Unexpected message_error event for stable-phase " f"request_id={request_id}: {error_event}" + + for request_id in phase2_ids: + error_event = wait_for_error( + collector=sender_collector, + request_id=request_id, + timeout_s=0, + ) + assert error_event is None, f"Unexpected terminal message_error for phase-2 " f"request_id={request_id} after recovery: {error_event}" + + issued = set(all_request_ids) + for event in sender_collector.snapshot(): + event_request_id = event.get("requestId") + if event_request_id is None: + continue + assert event_request_id in issued, ( + f"Event carries an unknown requestId={event_request_id!r}, " f"not in issued set {issued}. Event: {event}" + ) + + # Use the hash the wrapper emitted on message_sent so the store + # lookup matches the exact bytes that were actually published. + phase3_hashes = [] + for request_id in phase3_ids: + sent_event = wait_for_sent( + collector=sender_collector, + request_id=request_id, + timeout_s=RECOVERY_TIMEOUT_S, + ) + assert sent_event is not None, ( + f"No message_sent event for phase-3 request_id={request_id} " + f"within {RECOVERY_TIMEOUT_S}s. Collected events: {sender_collector.events}" + ) + msg_hash = sent_event.get("messageHash") + assert msg_hash, f"message_sent event missing messageHash: {sent_event}" + phase3_hashes.append(msg_hash) + + # 3 phases × S31_BURST_SIZE messages, so the page must fit them all, + # otherwise phase-3 hashes (which sort last in ascending order) get cut off. + self.check_sent_message_is_stored( + expected_hashes=phase3_hashes, + store_node=store_peer, + pubsub_topic=self.test_pubsub_topic, + page_size=S31_BURST_SIZE * 3, + ascending="true", + ) + + # Per-request invariants apply across all phases, including the + # retry-path bursts (phase 2). If retries ever emit duplicate + # Propagated events or reorder Sent before Propagated, this catches it. + for request_id in all_request_ids: + assert_event_invariants(sender_collector, request_id) + + def _s31_fire_burst(self, sender_node, *, phase_label: str) -> list[str]: + """Fire S31_BURST_SIZE concurrent sends, one per topic in S31_CONTENT_TOPICS. + Returns the list of RequestIds. Asserts every send returned Ok.""" + messages = [ + self.create_message( + contentTopic=S31_CONTENT_TOPICS[i], + payload=to_base64(f"s31-{phase_label}-{i}"), + ) + for i in range(S31_BURST_SIZE) + ] + + with ThreadPoolExecutor(max_workers=S31_BURST_SIZE) as pool: + send_results = list(pool.map(sender_node.send_message, messages)) + + request_ids = [] + for i, send_result in enumerate(send_results): + assert send_result.is_ok(), f"{phase_label}: concurrent send #{i} failed: {send_result.err()}" + request_id = send_result.ok_value + assert request_id, f"{phase_label}: concurrent send #{i} returned an empty RequestId" + request_ids.append(request_id) + + return request_ids diff --git a/tests/wrappers_tests/test_send_e2e_part3.py b/tests/wrappers_tests/test_send_handle_and_subscription.py similarity index 78% rename from tests/wrappers_tests/test_send_e2e_part3.py rename to tests/wrappers_tests/test_send_handle_and_subscription.py index 71620bfdc..2f467e052 100644 --- a/tests/wrappers_tests/test_send_e2e_part3.py +++ b/tests/wrappers_tests/test_send_handle_and_subscription.py @@ -4,8 +4,7 @@ import sys import pytest from src.steps.common import StepsCommon from src.libs.common import to_base64 -from src.env_vars import NODE_1 -from src.node.waku_node import WakuNode +from src.libs.custom_logger import get_custom_logger from src.node.wrappers_manager import WrapperManager from src.node.wrapper_helpers import ( EventCollector, @@ -17,16 +16,10 @@ from src.node.wrapper_helpers import ( wait_for_sent, wait_for_error, ) -from src.test_data import DEFAULT_CLUSTER_ID -from tests.wrappers_tests.conftest import build_node_config + +logger = get_custom_logger(__name__) PROPAGATED_TIMEOUT_S = 30.0 -SENT_AFTER_STORE_TIMEOUT_S = 60.0 - -# Default-cluster shard-0 pubsub topic; used to subscribe the S11 docker store -# peer so it joins the same relay mesh as the wrapper nodes (wrapper config -# uses numShardsInNetwork=1 => shard 0). -STORE_PEER_PUBSUB_TOPIC = f"/waku/2/rs/{DEFAULT_CLUSTER_ID}/0" S01_EXPECTED_ERROR_FRAGMENT = "not initialized" # Destroyed-handle path fails synchronously in the C layer (no callback), @@ -37,6 +30,8 @@ S01_RESULT_MARKER = "__S01_RESULT__" SEND_AFTER_DESTROY_RESULT_MARKER = "__SEND_AFTER_DESTROY_RESULT__" SEND_AFTER_DESTROY_SUBPROCESS_TIMEOUT_S = 60 +S01_INVALID_HANDLE_HELPER = "tests.wrappers_tests.helpers.send_invalid_handle" + # S05: malformed content topics break shard resolution inside # SubscriptionManager.subscribe(), forcing the auto-subscribe step to fail. # Each case targets a distinct validator branch. @@ -57,8 +52,6 @@ S05_MALFORMED_CONTENT_TOPICS = [ ("/app//name/proto", "empty-middle-segment"), ] -S01_INVALID_HANDLE_HELPER = "tests.wrappers_tests.helpers.send_invalid_handle" - class TestS01NilOrUninitializedHandle(StepsCommon): """S01 — send() on a nil/destroyed handle must Err, no events, no crash.""" @@ -119,6 +112,72 @@ class TestS01NilOrUninitializedHandle(StepsCommon): assert result["events_after_send"] == [], f"expected no events after send(), got: {result['events_after_send']}" +class TestS02AutoSubscribeOnFirstSend(StepsCommon): + """ + S02 — Auto-subscribe on first send. + Sender never calls subscribe_content_topic() before send(). + The send API must auto-subscribe to the content topic used in the message. + Expected: send() returns Ok(RequestId), message_propagated arrives. + """ + + def test_s02_send_without_explicit_subscribe(self, node_config): + sender_collector = EventCollector() + + node_config.update( + { + "relay": True, + "store": False, + "lightpush": False, + "filter": False, + "discv5Discovery": False, + "numShardsInNetwork": 1, + } + ) + + sender_result = WrapperManager.create_and_start( + config=node_config, + event_cb=sender_collector.event_callback, + ) + assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" + + with sender_result.ok_value as sender: + peer_config = { + **node_config, + "staticnodes": [get_node_multiaddr(sender)], + "portsShift": 1, + } + + peer_result = WrapperManager.create_and_start(config=peer_config) + assert peer_result.is_ok(), f"Failed to start relay peer: {peer_result.err()}" + + with peer_result.ok_value: + assert wait_for_connected(sender_collector) is not None, "Sender did not reach Connected/PartiallyConnected state" + + message = create_message_bindings( + payload=to_base64("S02 auto-subscribe test payload"), + contentTopic="/test/1/s02-auto-subscribe/proto", + ) + + send_result = sender.send_message(message=message) + assert send_result.is_ok(), f"send() failed: {send_result.err()}" + + request_id = send_result.ok_value + assert request_id, "send() returned an empty RequestId" + + propagated = wait_for_propagated( + collector=sender_collector, + request_id=request_id, + timeout_s=PROPAGATED_TIMEOUT_S, + ) + assert propagated is not None, ( + f"No message_propagated event within {PROPAGATED_TIMEOUT_S}s. " f"Collected events: {sender_collector.events}" + ) + assert propagated["requestId"] == request_id + + error = wait_for_error(sender_collector, request_id, timeout_s=0) + assert error is None, f"Unexpected message_error event: {error}" + + class TestS03SendOnAlreadySubscribedTopic(StepsCommon): """ S03 — Send on already-subscribed content topic. @@ -340,108 +399,3 @@ class TestS05AutoSubscribeFailureBeforeTaskCreation(StepsCommon): assert sender_collector.events == [] or all( event.get("eventType") == "connection_status_change" for event in sender_collector.events ), f"Unexpected events after a pre-task-creation failure: {sender_collector.events}" - - -class TestS11EdgeSenderLightpushAndStore(StepsCommon): - """ - S11 — Edge sender with lightpush path and store validation. - Edge sender has no local relay; it publishes via a wrapper lightpush peer - and validates delivery via a docker store peer. Reliability enabled. - Topology: - [LightpushPeer] wrapper, relay=True, lightpush=True, store=False - [StorePeer] docker WakuNode, relay=true, store=true, - dials the lightpush peer via add_peers and subscribes - to the same shard-0 pubsub topic so it joins the - relay mesh and archives propagated messages. - [Edge] wrapper, mode="Edge", - staticnodes=[lightpush_peer], - storenode=store_peer, - reliabilityEnabled=True - Expected: send() returns Ok(RequestId), Propagated arrives, then Sent - (store validation succeeds), no Error. - Purpose: edge-mode fully validated success path against a real docker - store node (cross-implementation check). - """ - - def test_s11_edge_lightpush_with_store_validation(self, node_config): - sender_collector = EventCollector() - - common = { - "filter": False, - "discv5Discovery": True, - "numShardsInNetwork": 1, - } - - lightpush_config = build_node_config( - relay=True, - lightpush=True, - store=False, - **common, - ) - - lightpush_result = WrapperManager.create_and_start(config=lightpush_config) - assert lightpush_result.is_ok(), f"Failed to start lightpush peer: {lightpush_result.err()}" - - with lightpush_result.ok_value as lightpush_peer: - lightpush_multiaddr = get_node_multiaddr(lightpush_peer) - - # Docker store peer — real nwaku node running as the store backend. - # Dial the lightpush peer via add_peers and subscribe to the same - # shard-0 pubsub topic so it joins the relay mesh and archives - # messages propagated by the lightpush peer. - store_peer = WakuNode(NODE_1, f"s11_store_{self.test_id}") - store_peer.start(relay="true", store="true") - self.add_node_peer(store_peer, [lightpush_multiaddr]) - store_peer.set_relay_subscriptions([STORE_PEER_PUBSUB_TOPIC]) - store_multiaddr = store_peer.get_multiaddr_with_id() - - edge_config = build_node_config( - mode="Edge", - # assuming disc5v already happened - staticnodes=[lightpush_multiaddr, store_multiaddr], - reliabilityEnabled=True, - **common, - ) - - edge_result = WrapperManager.create_and_start( - config=edge_config, - event_cb=sender_collector.event_callback, - ) - assert edge_result.is_ok(), f"Failed to start edge sender: {edge_result.err()}" - - with edge_result.ok_value as edge_sender: - message = create_message_bindings( - payload=to_base64("S11 edge lightpush + store test payload"), - contentTopic="/test/1/s11-edge-lightpush-store/proto", - ) - - send_result = edge_sender.send_message(message=message) - assert send_result.is_ok(), f"send() failed: {send_result.err()}" - - request_id = send_result.ok_value - assert request_id, "send() returned an empty RequestId" - - propagated = wait_for_propagated( - collector=sender_collector, - request_id=request_id, - timeout_s=PROPAGATED_TIMEOUT_S, - ) - assert propagated is not None, ( - f"No message_propagated event within {PROPAGATED_TIMEOUT_S}s. " f"Collected events: {sender_collector.events}" - ) - assert propagated["requestId"] == request_id - - sent = wait_for_sent( - collector=sender_collector, - request_id=request_id, - timeout_s=SENT_AFTER_STORE_TIMEOUT_S, - ) - assert sent is not None, ( - f"No message_sent event within {SENT_AFTER_STORE_TIMEOUT_S}s " f"after propagation. Collected events: {sender_collector.events}" - ) - assert sent["requestId"] == request_id - - error = wait_for_error(sender_collector, request_id, timeout_s=0) - assert error is None, f"Unexpected message_error event: {error}" - - assert_event_invariants(sender_collector, request_id) diff --git a/tests/wrappers_tests/test_send_e2e_part2.py b/tests/wrappers_tests/test_send_lightpush_and_edge.py similarity index 66% rename from tests/wrappers_tests/test_send_e2e_part2.py rename to tests/wrappers_tests/test_send_lightpush_and_edge.py index f94a89829..917ecd918 100644 --- a/tests/wrappers_tests/test_send_e2e_part2.py +++ b/tests/wrappers_tests/test_send_lightpush_and_edge.py @@ -1,253 +1,36 @@ import base64 import pytest +from src.env_vars import NODE_1 from src.steps.common import StepsCommon from src.libs.common import delay, to_base64 from src.libs.custom_logger import get_custom_logger +from src.node.waku_node import WakuNode from src.node.wrappers_manager import WrapperManager from src.node.wrapper_helpers import ( EventCollector, assert_event_invariants, create_message_bindings, get_node_multiaddr, - wait_for_connected, wait_for_propagated, wait_for_sent, wait_for_error, ) -from tests.wrappers_tests.conftest import build_node_config +from src.test_data import DEFAULT_CLUSTER_ID +from tests.wrappers_tests.conftest import build_node_config, free_port logger = get_custom_logger(__name__) PROPAGATED_TIMEOUT_S = 30.0 -SENT_TIMEOUT_S = 10.0 NO_SENT_OBSERVATION_S = 5.0 SENT_AFTER_STORE_TIMEOUT_S = 60.0 OVERSIZED_PAYLOAD_BYTES = 200 * 1024 RECOVERY_TIMEOUT_S = 45.0 SERVICE_DOWN_SETTLE_S = 3.0 -# MaxTimeInCache from send_service.nim. -MAX_TIME_IN_CACHE_S = 60.0 -# Extra slack to cover the background retry loop tick after the window expires. -CACHE_EXPIRY_SLACK_S = 10.0 -ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S = MAX_TIME_IN_CACHE_S + CACHE_EXPIRY_SLACK_S -RETRY_WINDOW_EXPIRED_MSG = "Unable to send within retry time window" - - -class TestS02AutoSubscribeOnFirstSend(StepsCommon): - """ - S02 — Auto-subscribe on first send. - Sender never calls subscribe_content_topic() before send(). - The send API must auto-subscribe to the content topic used in the message. - Expected: send() returns Ok(RequestId), message_propagated arrives. - """ - - def test_s02_send_without_explicit_subscribe(self, node_config): - sender_collector = EventCollector() - - node_config.update( - { - "relay": True, - "store": False, - "lightpush": False, - "filter": False, - "discv5Discovery": False, - "numShardsInNetwork": 1, - } - ) - - sender_result = WrapperManager.create_and_start( - config=node_config, - event_cb=sender_collector.event_callback, - ) - assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" - - with sender_result.ok_value as sender: - peer_config = { - **node_config, - "staticnodes": [get_node_multiaddr(sender)], - "portsShift": 1, - } - - peer_result = WrapperManager.create_and_start(config=peer_config) - assert peer_result.is_ok(), f"Failed to start relay peer: {peer_result.err()}" - - with peer_result.ok_value: - assert wait_for_connected(sender_collector) is not None, "Sender did not reach Connected/PartiallyConnected state" - - message = create_message_bindings( - payload=to_base64("S02 auto-subscribe test payload"), - contentTopic="/test/1/s02-auto-subscribe/proto", - ) - - send_result = sender.send_message(message=message) - assert send_result.is_ok(), f"send() failed: {send_result.err()}" - - request_id = send_result.ok_value - assert request_id, "send() returned an empty RequestId" - - propagated = wait_for_propagated( - collector=sender_collector, - request_id=request_id, - timeout_s=PROPAGATED_TIMEOUT_S, - ) - assert propagated is not None, ( - f"No message_propagated event within {PROPAGATED_TIMEOUT_S}s. " f"Collected events: {sender_collector.events}" - ) - assert propagated["requestId"] == request_id - - error = wait_for_error(sender_collector, request_id, timeout_s=0) - assert error is None, f"Unexpected message_error event: {error}" - - -class TestS06CoreSenderRelayOnly(StepsCommon): - """ - S06 — Core sender with relay peers only, no store. - Sender has local relay enabled and is connected to one relay peer. - Expected: send() returns Ok(RequestId), message_propagated event arrives, - no message_sent (store disabled), no message_error. - """ - - def test_s06_relay_propagation_without_store(self, node_config): - sender_collector = EventCollector() - - node_config.update( - { - "relay": True, - "store": False, - "lightpush": False, - "filter": False, - "discv5Discovery": False, - "numShardsInNetwork": 1, - "reliabilityEnabled": True, - } - ) - - sender_result = WrapperManager.create_and_start( - config=node_config, - event_cb=sender_collector.event_callback, - ) - assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" - - with sender_result.ok_value as sender: - peer_config = { - **node_config, - "staticnodes": [get_node_multiaddr(sender)], - "portsShift": 1, - } - - peer_result = WrapperManager.create_and_start(config=peer_config) - assert peer_result.is_ok(), f"Failed to start relay peer: {peer_result.err()}" - - with peer_result.ok_value: - assert wait_for_connected(sender_collector) is not None, "Sender did not reach Connected/PartiallyConnected state" - - message = create_message_bindings( - payload=to_base64("S06 relay-only test payload"), - contentTopic="/test/1/s06-relay-only/proto", - ) - - send_result = sender.send_message(message=message) - assert send_result.is_ok(), f"send() failed: {send_result.err()}" - - request_id = send_result.ok_value - assert request_id, "send() returned an empty RequestId" - - propagated = wait_for_propagated( - collector=sender_collector, - request_id=request_id, - timeout_s=PROPAGATED_TIMEOUT_S, - ) - assert propagated is not None, ( - f"No message_propagated event within {PROPAGATED_TIMEOUT_S}s. " f"Collected events: {sender_collector.events}" - ) - assert propagated["requestId"] == request_id - - error = wait_for_error(sender_collector, request_id, timeout_s=0) - assert error is None, f"Unexpected message_error event: {error}" - - sent = wait_for_sent(sender_collector, request_id, timeout_s=0) - assert sent is None, f"Unexpected message_sent event (store is disabled): {sent}" - - assert_event_invariants(sender_collector, request_id) - - -class TestS07CoreSenderRelayAndStore(StepsCommon): - """ - S07 — Core sender with relay peers and store peer, reliability enabled. - Sender relays message to a store-capable peer; delivery service validates - the message reached the store via p2p reliability check. - Expected: Propagated, then Sent. - """ - - def test_s07_relay_propagation_with_store_validation(self, node_config): - sender_collector = EventCollector() - - node_config.update( - { - "relay": True, - "store": False, - "lightpush": False, - "filter": False, - "discv5Discovery": False, - "numShardsInNetwork": 1, - "reliabilityEnabled": True, - } - ) - - sender_result = WrapperManager.create_and_start( - config=node_config, - event_cb=sender_collector.event_callback, - ) - assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" - - with sender_result.ok_value as sender: - peer_config = { - **node_config, - "staticnodes": [get_node_multiaddr(sender)], - "portsShift": 1, - "store": True, - } - - peer_result = WrapperManager.create_and_start(config=peer_config) - assert peer_result.is_ok(), f"Failed to start store peer: {peer_result.err()}" - - with peer_result.ok_value: - message = create_message_bindings( - payload=to_base64("S07 relay+store test payload"), - contentTopic="/test/1/s07-relay-store/proto", - ) - - send_result = sender.send_message(message=message) - assert send_result.is_ok(), f"send() failed: {send_result.err()}" - - request_id = send_result.ok_value - assert request_id, "send() returned an empty RequestId" - - propagated = wait_for_propagated( - collector=sender_collector, - request_id=request_id, - timeout_s=PROPAGATED_TIMEOUT_S, - ) - assert propagated is not None, ( - f"No message_propagated event within {PROPAGATED_TIMEOUT_S}s. " f"Collected events: {sender_collector.events}" - ) - assert propagated["requestId"] == request_id - - sent = wait_for_sent( - collector=sender_collector, - request_id=request_id, - timeout_s=SENT_TIMEOUT_S, - ) - assert sent is not None, ( - f"No message_sent event within {SENT_TIMEOUT_S}s after propagation. " f"Collected events: {sender_collector.events}" - ) - assert sent["requestId"] == request_id - - error = wait_for_error(sender_collector, request_id, timeout_s=0) - assert error is None, f"Unexpected message_error event: {error}" - - assert_event_invariants(sender_collector, request_id) +# Default-cluster shard-0 pubsub topic; used to subscribe the S11 docker store +# peer so it joins the same relay mesh as the wrapper nodes (wrapper config +# uses numShardsInNetwork=1 => shard 0). +STORE_PEER_PUBSUB_TOPIC = f"/waku/2/rs/{DEFAULT_CLUSTER_ID}/0" class TestRelayToLightpushFallback(StepsCommon): @@ -417,7 +200,7 @@ class TestS10EdgeSenderLightpushOnly(StepsCommon): """ @pytest.mark.xfail(reason="lightpush peer discovery via staticnodes is broken, see https://github.com/logos-messaging/logos-delivery/issues/3847") - def test_s10_edge_lightpush_propagation(self, node_config): + def test_s10_edge_lightpush_propagation(self): sender_collector = EventCollector() common = { @@ -488,60 +271,109 @@ class TestS10EdgeSenderLightpushOnly(StepsCommon): assert_event_invariants(sender_collector, request_id) -class TestS12IsolatedSenderNoPeers(StepsCommon): +class TestS11EdgeSenderLightpushAndStore(StepsCommon): """ - S12 — Isolated sender, no peers. - Sender has relay enabled but zero relay peers and zero lightpush peers. - Expected: send() returns Ok(RequestId), but eventually a message_error - event arrives (no route to propagate). + S11 — Edge sender with lightpush path and store validation. + Edge sender has no local relay; it publishes via a wrapper lightpush peer + and validates delivery via a docker store peer. Reliability enabled. + Topology: + [LightpushPeer] wrapper, relay=True, lightpush=True, store=False + [StorePeer] docker WakuNode, relay=true, store=true, + dials the lightpush peer via add_peers and subscribes + to the same shard-0 pubsub topic so it joins the + relay mesh and archives propagated messages. + [Edge] wrapper, mode="Edge", + staticnodes=[lightpush_peer], + storenode=store_peer, + reliabilityEnabled=True + Expected: send() returns Ok(RequestId), Propagated arrives, then Sent + (store validation succeeds), no Error. + Purpose: edge-mode fully validated success path against a real docker + store node (cross-implementation check). """ - def test_s12_send_with_no_peers_produces_error(self, node_config): + def test_s11_edge_lightpush_with_store_validation(self): sender_collector = EventCollector() - node_config.update( - { - "relay": True, - "store": False, - "lightpush": False, - "filter": False, - "discv5Discovery": False, - "numShardsInNetwork": 1, - } + common = { + "filter": False, + "discv5Discovery": True, + "numShardsInNetwork": 1, + } + + lightpush_config = build_node_config( + relay=True, + lightpush=True, + store=False, + **common, ) - sender_result = WrapperManager.create_and_start( - config=node_config, - event_cb=sender_collector.event_callback, - ) - assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" + lightpush_result = WrapperManager.create_and_start(config=lightpush_config) + assert lightpush_result.is_ok(), f"Failed to start lightpush peer: {lightpush_result.err()}" - with sender_result.ok_value as sender: - message = create_message_bindings( - payload=to_base64("S12 isolated sender payload"), - contentTopic="/test/1/s12-isolated/proto", + with lightpush_result.ok_value as lightpush_peer: + lightpush_multiaddr = get_node_multiaddr(lightpush_peer) + + # Docker store peer — real nwaku node running as the store backend. + # Dial the lightpush peer via add_peers and subscribe to the same + # shard-0 pubsub topic so it joins the relay mesh and archives + # messages propagated by the lightpush peer. + store_peer = WakuNode(NODE_1, f"s11_store_{self.test_id}") + store_peer.start(relay="true", store="true") + self.add_node_peer(store_peer, [lightpush_multiaddr]) + store_peer.set_relay_subscriptions([STORE_PEER_PUBSUB_TOPIC]) + store_multiaddr = store_peer.get_multiaddr_with_id() + + edge_config = build_node_config( + mode="Edge", + # assuming disc5v already happened + staticnodes=[lightpush_multiaddr, store_multiaddr], + reliabilityEnabled=True, + **common, ) - send_result = sender.send_message(message=message) - assert send_result.is_ok(), f"send() must return Ok(RequestId) even with no peers, got: {send_result.err()}" - - request_id = send_result.ok_value - assert request_id, "send() returned an empty RequestId" - - error = wait_for_error( - collector=sender_collector, - request_id=request_id, - timeout_s=ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S, + edge_result = WrapperManager.create_and_start( + config=edge_config, + event_cb=sender_collector.event_callback, ) - assert error is not None, ( - f"No message_error event within {ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S}s " - f"(MaxTimeInCache={MAX_TIME_IN_CACHE_S}s + slack) for isolated sender. " - f"Collected events: {sender_collector.events}" - ) - assert error["requestId"] == request_id + assert edge_result.is_ok(), f"Failed to start edge sender: {edge_result.err()}" - propagated = wait_for_propagated(sender_collector, request_id, timeout_s=0) - assert propagated is None, f"Unexpected message_propagated event for isolated sender: {propagated}" + with edge_result.ok_value as edge_sender: + message = create_message_bindings( + payload=to_base64("S11 edge lightpush + store test payload"), + contentTopic="/test/1/s11-edge-lightpush-store/proto", + ) + + send_result = edge_sender.send_message(message=message) + assert send_result.is_ok(), f"send() failed: {send_result.err()}" + + request_id = send_result.ok_value + assert request_id, "send() returned an empty RequestId" + + propagated = wait_for_propagated( + collector=sender_collector, + request_id=request_id, + timeout_s=PROPAGATED_TIMEOUT_S, + ) + assert propagated is not None, ( + f"No message_propagated event within {PROPAGATED_TIMEOUT_S}s. " f"Collected events: {sender_collector.events}" + ) + assert propagated["requestId"] == request_id + + sent = wait_for_sent( + collector=sender_collector, + request_id=request_id, + timeout_s=SENT_AFTER_STORE_TIMEOUT_S, + ) + assert sent is not None, ( + f"No message_sent event within {SENT_AFTER_STORE_TIMEOUT_S}s " f"after propagation. Collected events: {sender_collector.events}" + ) + assert sent["requestId"] == request_id + + error = wait_for_error(sender_collector, request_id, timeout_s=0) + assert error is None, f"Unexpected message_error event: {error}" + + assert_event_invariants(sender_collector, request_id) class TestS14LightpushNonRetryableError(StepsCommon): @@ -698,3 +530,122 @@ class TestS15LightpushRetryableErrorRecovery(StepsCommon): assert error is None, f"Unexpected message_error after recovery: {error}" assert_event_invariants(sender_collector, request_id) + + +class TestS26LightpushPeerChurn(StepsCommon): + """ + S26: multiple lightpush peers, the selected one disappears, + an alternate remains. + + Topology (3 peers + sender): + - peer1: relay + lightpush. The lightpush server initially selected + by the sender. Stopped mid-test to simulate churn. + - relay_peer: relay-only. Kept alive throughout the test as a + stable gossipsub mesh neighbour, so that after peer1 disappears + peer2 still has a relay path to propagate the message. + - peer2: relay + lightpush. The surviving lightpush server that + must take over once peer1 is gone. + - sender: edge node with peer1 and peer2 as static lightpush peers. + """ + + def test_s26_lightpush_peer_churn_alternate_remains(self, node_config): + sender_collector = EventCollector() + peer1_config = { + **node_config, + "relay": True, + "lightpush": True, + "store": False, + "filter": False, + "discv5Discovery": True, + "numShardsInNetwork": 1, + "portsShift": 1, + "discv5UdpPort": free_port(), + } + peer1_result = WrapperManager.create_and_start(config=peer1_config) + assert peer1_result.is_ok(), f"Failed to start lightpush peer1: {peer1_result.err()}" + peer1 = peer1_result.ok_value + + relay_config = { + **node_config, + "relay": True, + "lightpush": False, + "store": False, + "filter": False, + "discv5Discovery": False, + "numShardsInNetwork": 1, + "portsShift": 4, + } + + relay_result = WrapperManager.create_and_start(config=relay_config) + assert relay_result.is_ok(), f"Failed to start relay peer: {relay_result.err()}" + + with relay_result.ok_value as relay_peer: + peer2_config = { + **peer1_config, + "staticnodes": [ + get_node_multiaddr(peer1), + get_node_multiaddr(relay_peer), + ], + "portsShift": 2, + "discv5UdpPort": free_port(), + } + + peer2_result = WrapperManager.create_and_start(config=peer2_config) + assert peer2_result.is_ok(), f"Failed to start lightpush peer2: {peer2_result.err()}" + + with peer2_result.ok_value as peer2: + sender_config = { + **node_config, + "mode": "Edge", + "relay": True, + "lightpush": True, + "store": False, + "filter": False, + "discv5Discovery": False, + "numShardsInNetwork": 1, + "portsShift": 3, + "staticnodes": [ + get_node_multiaddr(peer1), + get_node_multiaddr(peer2), + ], + } + + sender_result = WrapperManager.create_and_start( + config=sender_config, + event_cb=sender_collector.event_callback, + ) + assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" + + with sender_result.ok_value as sender_node: + delay(2) + stop_result = peer1.stop_and_destroy() + assert stop_result.is_ok(), f"Failed to stop peer1: {stop_result.err()}" + delay(2) + + message = create_message_bindings() + send_result = sender_node.send_message(message=message) + assert send_result.is_ok(), f"send() must return Ok(RequestId) during peer churn, got: {send_result.err()}" + + request_id = send_result.ok_value + assert request_id, "send() returned an empty RequestId" + + # Expect Propagated via the surviving lightpush peer (peer2). + propagated_event = wait_for_propagated( + collector=sender_collector, + request_id=request_id, + timeout_s=PROPAGATED_TIMEOUT_S, + ) + assert propagated_event is not None, ( + f"No MessagePropagatedEvent within {PROPAGATED_TIMEOUT_S}s " + f"after the selected lightpush peer disappeared. " + f"Collected events: {sender_collector.events}" + ) + + error_event = wait_for_error( + collector=sender_collector, + request_id=request_id, + timeout_s=0, + ) + assert error_event is None, f"Unexpected message_error event during peer churn: {error_event}" + + assert_event_invariants(sender_collector, request_id) diff --git a/tests/wrappers_tests/test_send_e2e_part1.py b/tests/wrappers_tests/test_send_relay_propagation.py similarity index 52% rename from tests/wrappers_tests/test_send_e2e_part1.py rename to tests/wrappers_tests/test_send_relay_propagation.py index 6a94adf81..a1cfce07c 100644 --- a/tests/wrappers_tests/test_send_e2e_part1.py +++ b/tests/wrappers_tests/test_send_relay_propagation.py @@ -1,8 +1,7 @@ -from concurrent.futures import ThreadPoolExecutor - import pytest from src.env_vars import NODE_2 from src.steps.common import StepsCommon +from src.steps.store import StepsStore from src.libs.common import delay, to_base64 from src.libs.custom_logger import get_custom_logger from src.node.waku_node import WakuNode @@ -17,55 +16,179 @@ from src.node.wrapper_helpers import ( wait_for_sent, wait_for_error, ) -from src.steps.store import StepsStore from tests.wrappers_tests.conftest import free_port logger = get_custom_logger(__name__) -## max time to wait after sending the message PROPAGATED_TIMEOUT_S = 30.0 SENT_TIMEOUT_S = 10.0 NO_SENT_OBSERVATION_S = 5.0 SENT_AFTER_STORE_TIMEOUT_S = 60.0 NO_STORE_OBSERVATION_S = 60.0 -RECOVERY_TIMEOUT_S = 45.0 # S20 stabilization delays for gossipsub mesh formation. MESH_STABILIZATION_S = 10 STORE_JOIN_STABILIZATION_S = 10 -# MaxTimeInCache from send_service.nim. -MAX_TIME_IN_CACHE_S = 60.0 -# Extra slack to cover the background retry loop tick after the window expires. -CACHE_EXPIRY_SLACK_S = 10.0 -ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S = MAX_TIME_IN_CACHE_S + CACHE_EXPIRY_SLACK_S -RETRY_WINDOW_EXPIRED_MSG = "Unable to send within retry time window" -# S30: concurrent sends on the same content topic during initial auto-subscribe. -S30_CONCURRENT_SENDS = 5 -S30_CONTENT_TOPIC = "/test/1/s30-concurrent/proto" +class TestS06CoreSenderRelayOnly(StepsCommon): + """ + S06 — Core sender with relay peers only, no store. + Sender has local relay enabled and is connected to one relay peer. + Expected: send() returns Ok(RequestId), message_propagated event arrives, + no message_sent (store disabled), no message_error. + """ -# S31: concurrent sends across mixed topics during peer churn. -S31_BURST_SIZE = 8 -S31_CONTENT_TOPICS = [ - "/test/1/s31-topic-a/proto", - "/test/1/s31-topic-b/proto", - "/test/1/s31-topic-c/proto", - "/test/1/s31-topic-d/proto", - "/test/1/s31-topic-e/proto", - "/test/1/s31-topic-f/proto", - "/test/1/s31-topic-g/proto", - "/test/1/s31-topic-h/proto", -] + def test_s06_relay_propagation_without_store(self, node_config): + sender_collector = EventCollector() + + node_config.update( + { + "relay": True, + "store": False, + "lightpush": False, + "filter": False, + "discv5Discovery": False, + "numShardsInNetwork": 1, + "reliabilityEnabled": True, + } + ) + + sender_result = WrapperManager.create_and_start( + config=node_config, + event_cb=sender_collector.event_callback, + ) + assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" + + with sender_result.ok_value as sender: + peer_config = { + **node_config, + "staticnodes": [get_node_multiaddr(sender)], + "portsShift": 1, + } + + peer_result = WrapperManager.create_and_start(config=peer_config) + assert peer_result.is_ok(), f"Failed to start relay peer: {peer_result.err()}" + + with peer_result.ok_value: + assert wait_for_connected(sender_collector) is not None, "Sender did not reach Connected/PartiallyConnected state" + + message = create_message_bindings( + payload=to_base64("S06 relay-only test payload"), + contentTopic="/test/1/s06-relay-only/proto", + ) + + send_result = sender.send_message(message=message) + assert send_result.is_ok(), f"send() failed: {send_result.err()}" + + request_id = send_result.ok_value + assert request_id, "send() returned an empty RequestId" + + propagated = wait_for_propagated( + collector=sender_collector, + request_id=request_id, + timeout_s=PROPAGATED_TIMEOUT_S, + ) + assert propagated is not None, ( + f"No message_propagated event within {PROPAGATED_TIMEOUT_S}s. " f"Collected events: {sender_collector.events}" + ) + assert propagated["requestId"] == request_id + + error = wait_for_error(sender_collector, request_id, timeout_s=0) + assert error is None, f"Unexpected message_error event: {error}" + + sent = wait_for_sent(sender_collector, request_id, timeout_s=0) + assert sent is None, f"Unexpected message_sent event (store is disabled): {sent}" + + assert_event_invariants(sender_collector, request_id) -class TestSendBeforeRelay(StepsStore): +class TestS07CoreSenderRelayAndStore(StepsCommon): + """ + S07 — Core sender with relay peers and store peer, reliability enabled. + Sender relays message to a store-capable peer; delivery service validates + the message reached the store via p2p reliability check. + Expected: Propagated, then Sent. + """ + + def test_s07_relay_propagation_with_store_validation(self, node_config): + sender_collector = EventCollector() + + node_config.update( + { + "relay": True, + "store": False, + "lightpush": False, + "filter": False, + "discv5Discovery": False, + "numShardsInNetwork": 1, + "reliabilityEnabled": True, + } + ) + + sender_result = WrapperManager.create_and_start( + config=node_config, + event_cb=sender_collector.event_callback, + ) + assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" + + with sender_result.ok_value as sender: + peer_config = { + **node_config, + "staticnodes": [get_node_multiaddr(sender)], + "portsShift": 1, + "store": True, + } + + peer_result = WrapperManager.create_and_start(config=peer_config) + assert peer_result.is_ok(), f"Failed to start store peer: {peer_result.err()}" + + with peer_result.ok_value: + message = create_message_bindings( + payload=to_base64("S07 relay+store test payload"), + contentTopic="/test/1/s07-relay-store/proto", + ) + + send_result = sender.send_message(message=message) + assert send_result.is_ok(), f"send() failed: {send_result.err()}" + + request_id = send_result.ok_value + assert request_id, "send() returned an empty RequestId" + + propagated = wait_for_propagated( + collector=sender_collector, + request_id=request_id, + timeout_s=PROPAGATED_TIMEOUT_S, + ) + assert propagated is not None, ( + f"No message_propagated event within {PROPAGATED_TIMEOUT_S}s. " f"Collected events: {sender_collector.events}" + ) + assert propagated["requestId"] == request_id + + sent = wait_for_sent( + collector=sender_collector, + request_id=request_id, + timeout_s=SENT_TIMEOUT_S, + ) + assert sent is not None, ( + f"No message_sent event within {SENT_TIMEOUT_S}s after propagation. " f"Collected events: {sender_collector.events}" + ) + assert sent["requestId"] == request_id + + error = wait_for_error(sender_collector, request_id, timeout_s=0) + assert error is None, f"Unexpected message_error event: {error}" + + assert_event_invariants(sender_collector, request_id) + + +class TestS17SendBeforeRelayPeersJoin(StepsCommon): + """ + S17: sender starts isolated, calls send() + - send() returns Ok(RequestId) immediately + - Propagated event eventually arrives after a relay peer joins + """ + def test_s17_send_before_relay_peers_joins(self, node_config): - """ - S17: sender starts isolated, calls send() - - send() returns Ok(RequestId) immediately - - Propagated event eventually arrives - """ sender_collector = EventCollector() node_config.update( @@ -132,15 +255,18 @@ class TestSendBeforeRelay(StepsStore): assert_event_invariants(sender_collector, request_id) + +class TestS19StorePeerAppearsAfterPropagation(StepsStore): + """ + S19: a store peer comes online later. + - send() returns Ok(RequestId) immediately + - Propagated --- relay peer + - Sent when store peer is reachable + """ + @pytest.mark.docker_required @pytest.mark.xfail(reason="fails to republish after store peer joins mesh see https://github.com/logos-messaging/logos-delivery/issues/3848") def test_s19_store_peer_appears_after_propagation(self, node_config): - """ - S19: a store peer comes online later. - - send() returns Ok(RequestId) immediately - - Propagated --- relay peer - - Sent when store peer is reachable - """ sender_collector = EventCollector() node_config.update({"relay": True, "store": False, "discv5Discovery": False, "numShardsInNetwork": 1, "reliabilityEnabled": True}) @@ -228,20 +354,22 @@ class TestSendBeforeRelay(StepsStore): assert_event_invariants(sender_collector, request_id) + +class TestS20StoreMissesInitiallyThenRetrySucceeds(StepsStore): + """ + S20: relay propagation succeeds, the first store query misses + (the store peer is reachable but does not yet have the message), + a later retry republishes through the relay mesh, and the store + peer then archives it. + + Covers state flow: + SuccessfullyPropagated -> NextRoundRetry + -> SuccessfullyPropagated -> SuccessfullyValidated + """ + @pytest.mark.docker_required @pytest.mark.skip(reason="Forcing the miss store round not possible") def test_s20_store_misses_initially_then_retry_succeeds(self, node_config): - """ - S20: relay propagation succeeds, the first store query misses - (the store peer is reachable but does not yet have the message), - a later retry republishes through the relay mesh, and the store - peer then archives it. - - Covers state flow: - SuccessfullyPropagated -> NextRoundRetry - -> SuccessfullyPropagated -> SuccessfullyValidated - - """ sender_collector = EventCollector() store_node = WakuNode(NODE_2, f"s20_store_node_{self.test_id}") store_node.start( @@ -350,66 +478,16 @@ class TestSendBeforeRelay(StepsStore): assert_event_invariants(sender_collector, request_id) - def test_s21_error_when_retry_window_expires(self, node_config): - """ - S21: delivery retry window expires before any valid path recovers. - """ - sender_collector = EventCollector() - node_config.update( - { - "relay": True, - "store": False, - "lightpush": False, - "filter": False, - "discv5Discovery": False, - "numShardsInNetwork": 1, - } - ) - - sender_result = WrapperManager.create_and_start( - config=node_config, - event_cb=sender_collector.event_callback, - ) - assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" - - with sender_result.ok_value as sender_node: - message = create_message_bindings() - send_result = sender_node.send_message(message=message) - assert send_result.is_ok(), f"send() must return Ok(RequestId) even with no peers, got: {send_result.err()}" - - request_id = send_result.ok_value - assert request_id, "send() returned an empty RequestId" - - # No peer - error_event = wait_for_error( - collector=sender_collector, - request_id=request_id, - timeout_s=ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S, - ) - assert error_event is not None, ( - f"No MessageErrorEvent received within {ERROR_AFTER_CACHE_EXPIRY_TIMEOUT_S}s " - f"(MaxTimeInCache={MAX_TIME_IN_CACHE_S}s + slack). " - f"Collected events: {sender_collector.events}" - ) - logger.info(f"S21 received error event: {error_event}") - - assert error_event.get("error") == RETRY_WINDOW_EXPIRED_MSG, ( - f"Unexpected error message in message_error event.\n" - f"Expected: {RETRY_WINDOW_EXPIRED_MSG!r}\n" - f"Got: {error_event.get('error')!r}\n" - f"Full event: {error_event}" - ) - - assert_event_invariants(sender_collector, request_id) +class TestS22NonEphemeralWithReliabilityDisabled(StepsCommon): + """ + S22: non-ephemeral message with reliabilityEnabled disabled. + - propagation path exists ,reliabilityEnabled = false. + - Expected: Ok(RequestId), Propagated event only, no Sent event. + Note: S17 already covers the positive path of this test with reliabilityEnabled=True. + """ def test_s22_non_ephemeral_message_with_reliability_disabled(self, node_config): - """ - S22: non-ephemeral message with reliabilityEnabled disabled. - - propagation path exists ,reliabilityEnabled = false. - - Expected: Ok(RequestId), Propagated event only, no Sent event. - Note: S17 already covers the positive path of this test with reliabilityEnabled=True. - """ sender_collector = EventCollector() node_config.update( @@ -476,11 +554,14 @@ class TestSendBeforeRelay(StepsStore): assert_event_invariants(sender_collector, request_id) + +class TestS23NoSentEventWhenRelayHasNoStore(StepsCommon): + """ + S23: non-ephemeral message, reliability enabled, no store peer ever reachable. + - Expected: Ok(RequestId), Propagated event only, no Sent and no terminal error. + """ + def test_s23_no_sent_event_when_relay_has_no_store(self, node_config): - """ - S23: non-ephemeral message, reliability enabled, no store peer ever reachable. - - Expected: Ok(RequestId), Propagated event only, no Sent and no terminal error. - """ sender_collector = EventCollector() node_config.update( @@ -557,13 +638,15 @@ class TestSendBeforeRelay(StepsStore): assert_event_invariants(sender_collector, request_id) - def test_s24_ephemeral_message_with_reachable_store(self, node_config): - """ - S24: ephemeral message, reliability enabled, reachable store peer. - - Setup: propagation path exists, relay peer has store=True (reachable), - - Expected: Ok(RequestId), Propagated event only, no Sent event. - """ +class TestS24EphemeralMessageWithReachableStore(StepsCommon): + """ + S24: ephemeral message, reliability enabled, reachable store peer. + - Setup: propagation path exists, relay peer has store=True (reachable), + - Expected: Ok(RequestId), Propagated event only, no Sent event. + """ + + def test_s24_ephemeral_message_with_reachable_store(self, node_config): sender_collector = EventCollector() node_config.update( @@ -623,398 +706,3 @@ class TestSendBeforeRelay(StepsStore): ) assert_event_invariants(sender_collector, request_id) - - def test_s26_lightpush_peer_churn_alternate_remains(self, node_config): - """ - S26: multiple lightpush peers, the selected one disappears, - an alternate remains. - - Topology (3 peers + sender): - - peer1: relay + lightpush. The lightpush server initially selected - by the sender. Stopped mid-test to simulate churn. - - relay_peer: relay-only. Kept alive throughout the test as a - stable gossipsub mesh neighbour, so that after peer1 disappears - peer2 still has a relay path to propagate the message. - - peer2: relay + lightpush. The surviving lightpush server that - must take over once peer1 is gone. - - sender: edge node with peer1 and peer2 as static lightpush peers. - """ - sender_collector = EventCollector() - peer1_config = { - **node_config, - "relay": True, - "lightpush": True, - "store": False, - "filter": False, - "discv5Discovery": True, - "numShardsInNetwork": 1, - "portsShift": 1, - "discv5UdpPort": free_port(), - } - peer1_result = WrapperManager.create_and_start(config=peer1_config) - assert peer1_result.is_ok(), f"Failed to start lightpush peer1: {peer1_result.err()}" - peer1 = peer1_result.ok_value - - relay_config = { - **node_config, - "relay": True, - "lightpush": False, - "store": False, - "filter": False, - "discv5Discovery": False, - "numShardsInNetwork": 1, - "portsShift": 4, - } - - relay_result = WrapperManager.create_and_start(config=relay_config) - assert relay_result.is_ok(), f"Failed to start relay peer: {relay_result.err()}" - - with relay_result.ok_value as relay_peer: - peer2_config = { - **peer1_config, - "staticnodes": [ - get_node_multiaddr(peer1), - get_node_multiaddr(relay_peer), - ], - "portsShift": 2, - "discv5UdpPort": free_port(), - } - - peer2_result = WrapperManager.create_and_start(config=peer2_config) - assert peer2_result.is_ok(), f"Failed to start lightpush peer2: {peer2_result.err()}" - - with peer2_result.ok_value as peer2: - sender_config = { - **node_config, - "mode": "Edge", - "relay": True, - "lightpush": True, - "store": False, - "filter": False, - "discv5Discovery": False, - "numShardsInNetwork": 1, - "portsShift": 3, - "staticnodes": [ - get_node_multiaddr(peer1), - get_node_multiaddr(peer2), - ], - } - - sender_result = WrapperManager.create_and_start( - config=sender_config, - event_cb=sender_collector.event_callback, - ) - assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" - - with sender_result.ok_value as sender_node: - delay(2) - stop_result = peer1.stop_and_destroy() - assert stop_result.is_ok(), f"Failed to stop peer1: {stop_result.err()}" - delay(2) - - message = create_message_bindings() - send_result = sender_node.send_message(message=message) - assert send_result.is_ok(), f"send() must return Ok(RequestId) during peer churn, got: {send_result.err()}" - - request_id = send_result.ok_value - assert request_id, "send() returned an empty RequestId" - - # Expect Propagated via the surviving lightpush peer (peer2). - propagated_event = wait_for_propagated( - collector=sender_collector, - request_id=request_id, - timeout_s=PROPAGATED_TIMEOUT_S, - ) - assert propagated_event is not None, ( - f"No MessagePropagatedEvent within {PROPAGATED_TIMEOUT_S}s " - f"after the selected lightpush peer disappeared. " - f"Collected events: {sender_collector.events}" - ) - - error_event = wait_for_error( - collector=sender_collector, - request_id=request_id, - timeout_s=0, - ) - assert error_event is None, f"Unexpected message_error event during peer churn: {error_event}" - - assert_event_invariants(sender_collector, request_id) - - def test_s30_concurrent_sends_during_auto_subscribe(self, node_config): - """ - S30: concurrent sends on the same content topic during initial auto-subscribe. - - Sender starts unsubscribed to the target topic. - - Several send() calls are issued at nearly the same time. - - Each call must return Ok(RequestId) with a unique id. - - Each request id must get its own propagated event, - with no dropped or cross-associated events. - """ - sender_collector = EventCollector() - - node_config.update( - { - "relay": True, - "store": False, - "discv5Discovery": False, - "numShardsInNetwork": 1, - } - ) - - sender_result = WrapperManager.create_and_start( - config=node_config, - event_cb=sender_collector.event_callback, - ) - assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" - - with sender_result.ok_value as sender_node: - # Relay peer so the sender has a propagation path. - relay_config = { - **node_config, - "staticnodes": [get_node_multiaddr(sender_node)], - "portsShift": 1, - } - - relay_result = WrapperManager.create_and_start(config=relay_config) - assert relay_result.is_ok(), f"Failed to start relay peer: {relay_result.err()}" - - with relay_result.ok_value: - # Build one message per send, with distinct payloads so we can - # detect any cross-association between request ids and events. - messages = [ - create_message_bindings( - contentTopic=S30_CONTENT_TOPIC, - payload=to_base64(f"s30-concurrent-{i}"), - ) - for i in range(S30_CONCURRENT_SENDS) - ] - - # Fire all sends concurrently. The sender is not yet subscribed - # to S30_CONTENT_TOPIC, so this exercises the auto-subscribe path - # under contention. - with ThreadPoolExecutor(max_workers=S30_CONCURRENT_SENDS) as pool: - send_results = list(pool.map(sender_node.send_message, messages)) - - # Every send must return Ok(RequestId). - request_ids = [] - for i, send_result in enumerate(send_results): - assert send_result.is_ok(), f"Concurrent send #{i} failed: {send_result.err()}" - request_id = send_result.ok_value - assert request_id, f"Concurrent send #{i} returned an empty RequestId" - request_ids.append(request_id) - - # Request ids must be unique across concurrent sends. - assert len(set(request_ids)) == len(request_ids), f"Duplicate RequestIds returned by concurrent sends: {request_ids}" - - # Each request id must get its own propagated event and no error. - for request_id in request_ids: - propagated_event = wait_for_propagated( - collector=sender_collector, - request_id=request_id, - timeout_s=PROPAGATED_TIMEOUT_S, - ) - assert propagated_event is not None, ( - f"No MessagePropagatedEvent for request_id={request_id} " - f"within {PROPAGATED_TIMEOUT_S}s. " - f"Collected events: {sender_collector.events}" - ) - - error_event = wait_for_error( - collector=sender_collector, - request_id=request_id, - timeout_s=0, - ) - assert error_event is None, f"Unexpected message_error for request_id={request_id}: {error_event}" - - # Cross-association guard: every event with a requestId must - # belong to exactly one of the request ids we issued. - issued = set(request_ids) - for event in sender_collector.snapshot(): - event_request_id = event.get("requestId") - if event_request_id is None: - continue - assert event_request_id in issued, ( - f"Event carries an unknown requestId={event_request_id!r}, " f"not in issued set {issued}. Event: {event}" - ) - - # Per-request invariants apply to every concurrent send - # (correct requestId, no duplicate terminal events, - # Sent never before Propagated). - for request_id in request_ids: - assert_event_invariants(sender_collector, request_id) - - @pytest.mark.docker_required - def test_s31_concurrent_sends_mixed_topics_during_churn(self, node_config): - """ - S31: concurrent sends across mixed content topics during peer churn. - """ - sender_collector = EventCollector() - - relay_peer = WakuNode(NODE_2, f"s31_relay_peer_{self.test_id}") - relay_peer.start(relay="true", discv5_discovery="false") - relay_peer.set_relay_subscriptions([self.test_pubsub_topic]) - - lightpush_peer = WakuNode(NODE_2, f"s31_lightpush_peer_{self.test_id}") - lightpush_peer.start(relay="true", lightpush="true", discv5_discovery="false") - lightpush_peer.set_relay_subscriptions([self.test_pubsub_topic]) - - store_peer = WakuNode(NODE_2, f"s31_store_peer_{self.test_id}") - store_peer.start(relay="true", store="true", discv5_discovery="false") - store_peer.set_relay_subscriptions([self.test_pubsub_topic]) - - churn_peers = [relay_peer, lightpush_peer, store_peer] - - # Mesh docker peers so a lightpushed message can fan out to the store peer. - peer_multiaddrs = [p.get_multiaddr_with_id() for p in churn_peers] - for peer in churn_peers: - others = [a for a in peer_multiaddrs if a != peer.get_multiaddr_with_id()] - peer.add_peers(others) - - node_config.update( - { - "mode": "Edge", - "relay": True, - "lightpush": True, - "store": False, - "discv5Discovery": False, - "numShardsInNetwork": 1, - "lightpushnode": lightpush_peer.get_multiaddr_with_id(), - } - ) - - sender_result = WrapperManager.create_and_start( - config=node_config, - event_cb=sender_collector.event_callback, - ) - assert sender_result.is_ok(), f"Failed to start sender: {sender_result.err()}" - - with sender_result.ok_value as sender_node: - sender_multiaddr = get_node_multiaddr(sender_node) - for peer in churn_peers: - peer.add_peers([sender_multiaddr]) - delay(3) # let docker peers connect to the sender - - all_request_ids: list[str] = [] - phase1_ids = self._s31_fire_burst(sender_node, phase_label="phase1") - all_request_ids.extend(phase1_ids) - - for peer in churn_peers: - peer.restart() - delay(1) # small window so the restart is actually in-flight - phase2_ids = self._s31_fire_burst(sender_node, phase_label="phase2") - all_request_ids.extend(phase2_ids) - - # Wait for all peers to be ready again and re-attach the sender. - for peer in churn_peers: - peer.ensure_ready(timeout_duration=20) - peer.add_peers([sender_multiaddr]) - - peer_multiaddrs = [p.get_multiaddr_with_id() for p in churn_peers] - for peer in churn_peers: - others = [a for a in peer_multiaddrs if a != peer.get_multiaddr_with_id()] - peer.add_peers(others) - delay(3) - - phase3_ids = self._s31_fire_burst(sender_node, phase_label="phase3") - all_request_ids.extend(phase3_ids) - - assert len(set(all_request_ids)) == len(all_request_ids), f"Duplicate RequestIds across bursts: {all_request_ids}" - - # Phase 1 ran before any churn, so the mesh was stable — standard timeout. - # Phase 3 ran right after restart + re-attach, so the mesh needed to - # re-stabilize — use the recovery timeout to avoid CI flakiness. - phase_timeouts = [ - (phase1_ids, PROPAGATED_TIMEOUT_S), - (phase3_ids, RECOVERY_TIMEOUT_S), - ] - for request_ids, timeout_s in phase_timeouts: - for request_id in request_ids: - propagated_event = wait_for_propagated( - collector=sender_collector, - request_id=request_id, - timeout_s=timeout_s, - ) - assert propagated_event is not None, ( - f"No MessagePropagatedEvent for stable-phase " - f"request_id={request_id} within {timeout_s}s. " - f"Collected events: {sender_collector.events}" - ) - - error_event = wait_for_error( - collector=sender_collector, - request_id=request_id, - timeout_s=0, - ) - assert error_event is None, f"Unexpected message_error event for stable-phase " f"request_id={request_id}: {error_event}" - - for request_id in phase2_ids: - error_event = wait_for_error( - collector=sender_collector, - request_id=request_id, - timeout_s=0, - ) - assert error_event is None, f"Unexpected terminal message_error for phase-2 " f"request_id={request_id} after recovery: {error_event}" - - issued = set(all_request_ids) - for event in sender_collector.snapshot(): - event_request_id = event.get("requestId") - if event_request_id is None: - continue - assert event_request_id in issued, ( - f"Event carries an unknown requestId={event_request_id!r}, " f"not in issued set {issued}. Event: {event}" - ) - - # Use the hash the wrapper emitted on message_sent so the store - # lookup matches the exact bytes that were actually published. - phase3_hashes = [] - for request_id in phase3_ids: - sent_event = wait_for_sent( - collector=sender_collector, - request_id=request_id, - timeout_s=RECOVERY_TIMEOUT_S, - ) - assert sent_event is not None, ( - f"No message_sent event for phase-3 request_id={request_id} " - f"within {RECOVERY_TIMEOUT_S}s. Collected events: {sender_collector.events}" - ) - msg_hash = sent_event.get("messageHash") - assert msg_hash, f"message_sent event missing messageHash: {sent_event}" - phase3_hashes.append(msg_hash) - - # 3 phases × S31_BURST_SIZE messages, so the page must fit them all, - # otherwise phase-3 hashes (which sort last in ascending order) get cut off. - self.check_sent_message_is_stored( - expected_hashes=phase3_hashes, - store_node=store_peer, - pubsub_topic=self.test_pubsub_topic, - page_size=S31_BURST_SIZE * 3, - ascending="true", - ) - - # Per-request invariants apply across all phases, including the - # retry-path bursts (phase 2). If retries ever emit duplicate - # Propagated events or reorder Sent before Propagated, this catches it. - for request_id in all_request_ids: - assert_event_invariants(sender_collector, request_id) - - def _s31_fire_burst(self, sender_node, *, phase_label: str) -> list[str]: - """Fire S31_BURST_SIZE concurrent sends, one per topic in S31_CONTENT_TOPICS. - Returns the list of RequestIds. Asserts every send returned Ok.""" - messages = [ - self.create_message( - contentTopic=S31_CONTENT_TOPICS[i], - payload=to_base64(f"s31-{phase_label}-{i}"), - ) - for i in range(S31_BURST_SIZE) - ] - - with ThreadPoolExecutor(max_workers=S31_BURST_SIZE) as pool: - send_results = list(pool.map(sender_node.send_message, messages)) - - request_ids = [] - for i, send_result in enumerate(send_results): - assert send_result.is_ok(), f"{phase_label}: concurrent send #{i} failed: {send_result.err()}" - request_id = send_result.ok_value - assert request_id, f"{phase_label}: concurrent send #{i} returned an empty RequestId" - request_ids.append(request_id) - - return request_ids