apollo_consensus: rename proposal cache and stream fields in manager

Author: asmaastarkware

crates/apollo_consensus/src/manager.rs

@@ -178,13 +178,13 @@ struct ConsensusCache<ContextT: ConsensusContext> {
     // Mapping: { Height : Vec<Vote> }
     future_votes: BTreeMap<BlockNumber, Vec<Vote>>,
     // Mapping: { Height : { Round : (Init, Receiver)}}
-    cached_proposals:
+    future_proposals_cache:
         BTreeMap<BlockNumber, BTreeMap<Round, ProposalReceiverTuple<ContextT::ProposalPart>>>,
 }
 
 impl<ContextT: ConsensusContext> ConsensusCache<ContextT> {
     fn new() -> Self {
-        Self { future_votes: BTreeMap::new(), cached_proposals: BTreeMap::new() }
+        Self { future_votes: BTreeMap::new(), future_proposals_cache: BTreeMap::new() }
     }
 
     /// Filters the cached messages:
@@ -214,7 +214,7 @@ impl<ContextT: ConsensusContext> ConsensusCache<ContextT> {
         height: BlockNumber,
     ) -> Vec<(ProposalInit, mpsc::Receiver<ContextT::ProposalPart>)> {
         loop {
-            let Some(entry) = self.cached_proposals.first_entry() else {
+            let Some(entry) = self.future_proposals_cache.first_entry() else {
                 return Vec::new();
             };
             match entry.key().cmp(&height) {
@@ -247,7 +247,7 @@ impl<ContextT: ConsensusContext> ConsensusCache<ContextT> {
         proposal_init: ProposalInit,
         content_receiver: mpsc::Receiver<ContextT::ProposalPart>,
     ) {
-        self.cached_proposals
+        self.future_proposals_cache
             .entry(proposal_init.height)
             .or_default()
             .entry(proposal_init.round)
@@ -256,7 +256,7 @@ impl<ContextT: ConsensusContext> ConsensusCache<ContextT> {
 
     fn report_max_cached_block_number_metric(&self, height: BlockNumber) {
         // If nothing is cached use current height as "max".
-        let max_cached_block_number = self.cached_proposals.keys().max().unwrap_or(&height);
+        let max_cached_block_number = self.future_proposals_cache.keys().max().unwrap_or(&height);
         CONSENSUS_MAX_CACHED_BLOCK_NUMBER.set_lossy(max_cached_block_number.0);
     }
 
@@ -281,7 +281,8 @@ struct MultiHeightManager<ContextT: ConsensusContext> {
     #[allow(dead_code)]
     voted_height_storage: Arc<Mutex<dyn HeightVotedStorageTrait>>,
     // Proposal content streams keyed by (height, round)
-    proposal_streams: BTreeMap<(BlockNumber, Round), mpsc::Receiver<ContextT::ProposalPart>>,
+    current_height_proposals_streams:
+        BTreeMap<(BlockNumber, Round), mpsc::Receiver<ContextT::ProposalPart>>,
     cache: ConsensusCache<ContextT>,
 }
 
@@ -302,7 +303,7 @@ impl<ContextT: ConsensusContext> MultiHeightManager<ContextT> {
             quorum_type,
             last_voted_height_at_initialization,
             voted_height_storage,
-            proposal_streams: BTreeMap::new(),
+            current_height_proposals_streams: BTreeMap::new(),
             cache: ConsensusCache::new(),
         }
     }
@@ -353,7 +354,7 @@ impl<ContextT: ConsensusContext> MultiHeightManager<ContextT> {
         }
 
         // Height completed; clear any content streams associated with current and lower heights.
-        self.proposal_streams.retain(|(h, _), _| *h > height);
+        self.current_height_proposals_streams.retain(|(h, _), _| *h > height);
 
         Ok(res)
     }
@@ -665,7 +666,8 @@ impl<ContextT: ConsensusContext> MultiHeightManager<ContextT> {
         content_receiver: mpsc::Receiver<ContextT::ProposalPart>,
     ) -> Result<ShcReturn, ConsensusError> {
         // Store the stream; requests will reference it by (height, round)
-        self.proposal_streams.insert((height, proposal_init.round), content_receiver);
+        self.current_height_proposals_streams
+            .insert((height, proposal_init.round), content_receiver);
         let leader_fn = make_leader_fn(context, height);
         shc.handle_proposal(&leader_fn, proposal_init)
     }
@@ -792,7 +794,7 @@ impl<ContextT: ConsensusContext> MultiHeightManager<ContextT> {
             SMRequest::StartValidateProposal(init) => {
                 // Look up the stored stream.
                 let key = (height, init.round);
-                if let Some(stream) = self.proposal_streams.remove(&key) {
+                if let Some(stream) = self.current_height_proposals_streams.remove(&key) {
                     let timeout = timeouts.get_proposal_timeout(init.round);
                     let receiver = context.validate_proposal(init, timeout, stream).await;
                     let round = init.round;