From 2cac9f56ad178e34a96d1a19896c819a2083db63 Mon Sep 17 00:00:00 2001 From: Guy Nir Date: Sun, 8 Dec 2024 15:17:41 +0200 Subject: [PATCH] chore(sequencing): remove ConsensusMessage from stream_handler_test --- .../src/converters/consensus_test.rs | 1 + .../src/converters/test_instances.rs | 5 +-- .../src/stream_handler_test.rs | 35 +++++++++---------- 3 files changed, 21 insertions(+), 20 deletions(-) diff --git a/crates/papyrus_protobuf/src/converters/consensus_test.rs b/crates/papyrus_protobuf/src/converters/consensus_test.rs index 9bb15dd176..fb2822c876 100644 --- a/crates/papyrus_protobuf/src/converters/consensus_test.rs +++ b/crates/papyrus_protobuf/src/converters/consensus_test.rs @@ -66,6 +66,7 @@ fn convert_stream_message_to_vec_u8_and_back() { assert_eq!(stream_message, res_data); } +// TODO(guyn): this can be removed once ConsensusMessage is taken out. #[test] fn convert_consensus_message_to_vec_u8_and_back() { let mut rng = get_rng(); diff --git a/crates/papyrus_protobuf/src/converters/test_instances.rs b/crates/papyrus_protobuf/src/converters/test_instances.rs index 6f0940b316..58a8469c05 100644 --- a/crates/papyrus_protobuf/src/converters/test_instances.rs +++ b/crates/papyrus_protobuf/src/converters/test_instances.rs @@ -5,8 +5,8 @@ use starknet_api::core::ContractAddress; use starknet_api::transaction::{Transaction, TransactionHash}; use crate::consensus::{ - ConsensusMessage, - Proposal, + ConsensusMessage, // TODO: remove this + Proposal, // TODO: remove this ProposalFin, ProposalInit, ProposalPart, @@ -18,6 +18,7 @@ use crate::consensus::{ }; auto_impl_get_test_instance! { + // TODO(guyn): remove this once we integrate ProposalPart everywhere. pub enum ConsensusMessage { Proposal(Proposal) = 0, Vote(Vote) = 1, diff --git a/crates/sequencing/papyrus_consensus/src/stream_handler_test.rs b/crates/sequencing/papyrus_consensus/src/stream_handler_test.rs index 047bf27142..e02a4185fb 100644 --- a/crates/sequencing/papyrus_consensus/src/stream_handler_test.rs +++ b/crates/sequencing/papyrus_consensus/src/stream_handler_test.rs @@ -10,7 +10,7 @@ use papyrus_network::network_manager::test_utils::{ }; use papyrus_network::network_manager::BroadcastTopicChannels; use papyrus_network_types::network_types::BroadcastedMessageMetadata; -use papyrus_protobuf::consensus::{ConsensusMessage, Proposal, StreamMessage, StreamMessageBody}; +use papyrus_protobuf::consensus::{StreamMessage, StreamMessageBody}; use papyrus_test_utils::{get_rng, GetTestInstance}; use super::{MessageId, StreamHandler, StreamId}; @@ -20,16 +20,18 @@ const CHANNEL_SIZE: usize = 100; #[cfg(test)] mod tests { + use papyrus_protobuf::consensus::{ProposalInit, ProposalPart}; + use super::*; fn make_test_message( stream_id: StreamId, message_id: MessageId, fin: bool, - ) -> StreamMessage { + ) -> StreamMessage { let content = match fin { true => StreamMessageBody::Fin, - false => StreamMessageBody::Content(ConsensusMessage::Proposal(Proposal::default())), + false => StreamMessageBody::Content(ProposalPart::Init(ProposalInit::default())), }; StreamMessage { message: content, stream_id, message_id } } @@ -47,24 +49,21 @@ mod tests { } async fn send( - sender: &mut MockBroadcastedMessagesSender>, + sender: &mut MockBroadcastedMessagesSender>, metadata: &BroadcastedMessageMetadata, - msg: StreamMessage, + msg: StreamMessage, ) { sender.send((msg, metadata.clone())).await.unwrap(); } #[allow(clippy::type_complexity)] fn setup_test() -> ( - StreamHandler, - MockBroadcastedMessagesSender>, - mpsc::Receiver>, + StreamHandler, + MockBroadcastedMessagesSender>, + mpsc::Receiver>, BroadcastedMessageMetadata, - mpsc::Sender<(StreamId, mpsc::Receiver)>, - futures::stream::Map< - mpsc::Receiver>, - fn(Vec) -> StreamMessage, - >, + mpsc::Sender<(StreamId, mpsc::Receiver)>, + futures::stream::Map>, fn(Vec) -> StreamMessage>, ) { // The outbound_sender is the network connector for broadcasting messages. // The network_broadcast_receiver is used to catch those messages in the test. @@ -81,7 +80,7 @@ mod tests { // The receiver goes into StreamHandler, sender is used by the test (as mock Consensus). // Note that each new channel comes in a tuple with (stream_id, receiver). let (outbound_channel_sender, outbound_channel_receiver) = - mpsc::channel::<(StreamId, mpsc::Receiver)>(CHANNEL_SIZE); + mpsc::channel::<(StreamId, mpsc::Receiver)>(CHANNEL_SIZE); // The network_sender_to_inbound is the sender of the mock network, that is used by the // test to send messages into the StreamHandler (from the mock network). @@ -99,7 +98,7 @@ mod tests { // each stream. The inbound_channel_receiver is given to the "mock consensus" that // gets new channels and inbounds to them. let (inbound_channel_sender, inbound_channel_receiver) = - mpsc::channel::>(CHANNEL_SIZE); + mpsc::channel::>(CHANNEL_SIZE); // TODO(guyn): We should also give the broadcast_topic_client to the StreamHandler // This will allow reporting to the network things like bad peers. @@ -418,7 +417,7 @@ mod tests { broadcast_channel_sender.send((stream_id1, receiver1)).await.unwrap(); // Send a message on the stream. - let message1 = ConsensusMessage::Proposal(Proposal::default()); + let message1 = ProposalPart::Init(ProposalInit::default()); sender1.send(message1.clone()).await.unwrap(); // Run the loop for a short duration to process the message. @@ -445,7 +444,7 @@ mod tests { assert_eq!(stream_handler.outbound_stream_number[&stream_id1], 1); // Send another message on the same stream. - let message2 = ConsensusMessage::Proposal(Proposal::default()); + let message2 = ProposalPart::Init(ProposalInit::default()); sender1.send(message2.clone()).await.unwrap(); // Run the loop for a short duration to process the message. @@ -470,7 +469,7 @@ mod tests { broadcast_channel_sender.send((stream_id2, receiver2)).await.unwrap(); // Send a message on the stream. - let message3 = ConsensusMessage::Proposal(Proposal::default()); + let message3 = ProposalPart::Init(ProposalInit::default()); sender2.send(message3.clone()).await.unwrap(); // Run the loop for a short duration to process the message.