refactor(nns): Make cast_vote_and_cascade_follow async (#2670)

This gets us closer into the position where we can scale the voting
calculations across multiple messages.

[Prev](#2600) |
[Next](#2697)

rs/nns/governance/benches/scale.rs

@@ -135,6 +135,8 @@ fn make_and_process_proposal(gov: &mut Governance) {
             ..Default::default()
         },
     )
+    .now_or_never()
+    .unwrap()
     .unwrap();
     gov.run_periodic_tasks().now_or_never();
 }

rs/nns/governance/src/governance.rs

@@ -5387,7 +5387,7 @@ impl Governance {
             .collect()
     }
 
-    pub fn make_proposal(
+    pub async fn make_proposal(
         &mut self,
         proposer_id: &NeuronId,
         caller: &PrincipalId,
@@ -5592,7 +5592,8 @@ impl Governance {
         );
         self.heap_data.proposals.insert(proposal_num, proposal_data);
 
-        self.cast_vote_and_cascade_follow(proposal_id, *proposer_id, Vote::Yes, topic);
+        self.cast_vote_and_cascade_follow(proposal_id, *proposer_id, Vote::Yes, topic)
+            .await;
 
         self.process_proposal(proposal_num);
 
@@ -5744,7 +5745,7 @@ impl Governance {
         }
     }
 
-    fn register_vote(
+    async fn register_vote(
         &mut self,
         neuron_id: &NeuronId,
         caller: &PrincipalId,
@@ -5816,7 +5817,8 @@ impl Governance {
             *neuron_id,
             vote,
             topic,
-        );
+        )
+        .await;
 
         self.process_proposal(proposal_id.id);
 
@@ -6328,7 +6330,7 @@ impl Governance {
                 .follow(&id, caller, f)
                 .map(|_| ManageNeuronResponse::follow_response()),
             Some(Command::MakeProposal(p)) => {
-                self.make_proposal(&id, caller, p).map(|proposal_id| {
+                self.make_proposal(&id, caller, p).await.map(|proposal_id| {
                     ManageNeuronResponse::make_proposal_response(
                         proposal_id,
                         "The proposal has been created successfully.".to_string(),
@@ -6337,6 +6339,7 @@ impl Governance {
             }
             Some(Command::RegisterVote(v)) => self
                 .register_vote(&id, caller, v)
+                .await
                 .map(|_| ManageNeuronResponse::register_vote_response()),
             Some(Command::ClaimOrRefresh(_)) => {
                 panic!("This should have already returned")

rs/nns/governance/src/governance/benches.rs

@@ -13,6 +13,7 @@ use crate::{
     test_utils::{MockEnvironment, StubCMC, StubIcpLedger},
 };
 use canbench_rs::{bench, bench_fn, BenchResult};
+use futures::FutureExt;
 use ic_base_types::PrincipalId;
 use ic_nns_common::{
     pb::v1::{NeuronId as NeuronIdProto, ProposalId},
@@ -325,12 +326,10 @@ fn cast_vote_cascade_helper(strategy: SetUpStrategy, topic: Topic) -> BenchResul
 
     let proposal_id = ProposalId { id: 1 };
     bench_fn(|| {
-        governance.cast_vote_and_cascade_follow(proposal_id, neuron_id.into(), Vote::Yes, topic);
-        // let yes_votes = ballots
-        //     .iter()
-        //     .filter(|(id, ballot)| ballot.vote == Vote::Yes as i32)
-        //     .count();
-        // panic!("Number of cascaded votes: {}, {}", ballots.len(), yes_votes)
+        governance
+            .cast_vote_and_cascade_follow(proposal_id, neuron_id.into(), Vote::Yes, topic)
+            .now_or_never()
+            .unwrap();
     })
 }
 

rs/nns/governance/src/governance/tests/mod.rs

@@ -1141,6 +1141,7 @@ mod cast_vote_and_cascade_follow {
         pb::v1::{neuron::Followees, Ballot, ProposalData, Topic, Vote},
         test_utils::{MockEnvironment, StubCMC, StubIcpLedger},
     };
+    use futures::FutureExt;
     use ic_base_types::PrincipalId;
     use ic_nns_common::pb::v1::{NeuronId, ProposalId};
     use icp_ledger::Subaccount;
@@ -1251,12 +1252,15 @@ mod cast_vote_and_cascade_follow {
             Box::new(StubCMC {}),
         );
 
-        governance.cast_vote_and_cascade_follow(
-            ProposalId { id: 1 },
-            NeuronId { id: 1 },
-            Vote::Yes,
-            topic,
-        );
+        governance
+            .cast_vote_and_cascade_follow(
+                ProposalId { id: 1 },
+                NeuronId { id: 1 },
+                Vote::Yes,
+                topic,
+            )
+            .now_or_never()
+            .unwrap();
 
         let deciding_voting_power = |neuron_id| {
             governance
@@ -1338,12 +1342,15 @@ mod cast_vote_and_cascade_follow {
             Box::new(StubCMC {}),
         );
 
-        governance.cast_vote_and_cascade_follow(
-            ProposalId { id: 1 },
-            NeuronId { id: 1 },
-            Vote::Yes,
-            topic,
-        );
+        governance
+            .cast_vote_and_cascade_follow(
+                ProposalId { id: 1 },
+                NeuronId { id: 1 },
+                Vote::Yes,
+                topic,
+            )
+            .now_or_never()
+            .unwrap();
 
         let deciding_voting_power = |neuron_id| {
             governance

rs/nns/governance/src/voting.rs

@@ -13,7 +13,7 @@ thread_local! {
     static VOTING_STATE_MACHINES: RefCell<VotingStateMachines> = RefCell::new(VotingStateMachines::new());
 }
 impl Governance {
-    pub fn cast_vote_and_cascade_follow(
+    pub async fn cast_vote_and_cascade_follow(
         &mut self,
         proposal_id: ProposalId,
         voting_neuron_id: NeuronId,
@@ -166,7 +166,7 @@ impl ProposalVotingStateMachine {
             self.add_followers_to_check(neuron_store, neuron_id, self.topic);
         }
 
-        // Optimization, will not cause tests to fail if removed
+        // Memory optimization, will not cause tests to fail if removed
         retain_neurons_with_castable_ballots(&mut self.followers_to_check, ballots);
 
         while let Some(follower) = self.followers_to_check.pop_first() {

rs/nns/governance/tests/degraded_mode.rs

@@ -173,7 +173,7 @@ async fn test_cannot_submit_motion_in_degraded_mode() {
             })),
             ..Default::default()
         },
-    ),
+    ).await,
     Err(e) if e.error_type == ErrorType::ResourceExhausted as i32);
 }
 
@@ -199,7 +199,8 @@ async fn test_can_submit_nns_canister_upgrade_in_degraded_mode() {
                 })),
                 ..Default::default()
             },
-        ),
+        )
+        .await,
         Ok(_)
     );
 }

rs/nns/governance/tests/fake.rs

@@ -655,6 +655,8 @@ impl ProposalNeuronBehavior {
                     ..Default::default()
                 },
             )
+            .now_or_never()
+            .unwrap()
             .unwrap();
         // Vote
         for (voter, vote) in &self.votes {

rs/nns/governance/tests/fixtures/mod.rs

@@ -633,6 +633,8 @@ impl ProposalNeuronBehavior {
                     ..Default::default()
                 },
             )
+            .now_or_never()
+            .unwrap()
             .unwrap();
         // Vote
         for (voter, vote) in &self.votes {
@@ -816,6 +818,8 @@ impl NNS {
                     ..Default::default()
                 },
             )
+            .now_or_never()
+            .unwrap()
             .unwrap()
     }