test: use last_commit_burn_height counter to address flakiness in miner_forking

Author: kantai

testnet/stacks-node/src/nakamoto_node/relayer.rs

@@ -1229,8 +1229,10 @@ impl RelayerThread {
         // update local state
         last_committed.set_txid(&txid);
         self.last_commits.insert(txid);
+        self.globals
+            .counters
+            .bump_naka_submitted_commits(last_committed.burn_tip.block_height);
         self.last_committed = Some(last_committed);
-        self.globals.counters.bump_naka_submitted_commits();
 
         Ok(())
     }

testnet/stacks-node/src/run_loop/neon.rs

@@ -106,6 +106,8 @@ pub struct Counters {
 
     pub naka_submitted_vrfs: RunLoopCounter,
     pub naka_submitted_commits: RunLoopCounter,
+    /// the burn block height when the last commit was submitted
+    pub naka_submitted_commit_last_burn_height: RunLoopCounter,
     pub naka_mined_blocks: RunLoopCounter,
     pub naka_rejected_blocks: RunLoopCounter,
     pub naka_proposed_blocks: RunLoopCounter,
@@ -161,8 +163,12 @@ impl Counters {
         Counters::inc(&self.naka_submitted_vrfs);
     }
 
-    pub fn bump_naka_submitted_commits(&self) {
+    pub fn bump_naka_submitted_commits(&self, committed_height: u64) {
         Counters::inc(&self.naka_submitted_commits);
+        Counters::set(
+            &self.naka_submitted_commit_last_burn_height,
+            committed_height,
+        );
     }
 
     pub fn bump_naka_mined_blocks(&self) {

testnet/stacks-node/src/tests/signer/mod.rs

@@ -88,6 +88,7 @@ pub struct RunningNodes {
     pub run_loop_stopper: Arc<AtomicBool>,
     pub vrfs_submitted: RunLoopCounter,
     pub commits_submitted: RunLoopCounter,
+    pub last_commit_burn_height: RunLoopCounter,
     pub blocks_processed: RunLoopCounter,
     pub nakamoto_blocks_proposed: RunLoopCounter,
     pub nakamoto_blocks_mined: RunLoopCounter,
@@ -902,6 +903,7 @@ fn setup_stx_btc_node<G: FnMut(&mut NeonConfig)>(
         blocks_processed,
         naka_submitted_vrfs: vrfs_submitted,
         naka_submitted_commits: commits_submitted,
+        naka_submitted_commit_last_burn_height: last_commit_burn_height,
         naka_proposed_blocks: naka_blocks_proposed,
         naka_mined_blocks: naka_blocks_mined,
         naka_rejected_blocks: naka_blocks_rejected,
@@ -936,6 +938,7 @@ fn setup_stx_btc_node<G: FnMut(&mut NeonConfig)>(
         run_loop_stopper,
         vrfs_submitted,
         commits_submitted,
+        last_commit_burn_height,
         blocks_processed,
         nakamoto_blocks_proposed: naka_blocks_proposed,
         nakamoto_blocks_mined: naka_blocks_mined,

testnet/stacks-node/src/tests/signer/v0.rs

@@ -1882,6 +1882,7 @@ fn miner_forking() {
     let Counters {
         naka_skip_commit_op: skip_commit_op_rl2,
         naka_submitted_commits: commits_submitted_rl2,
+        naka_submitted_commit_last_burn_height: commits_submitted_rl2_last_burn_height,
         ..
     } = run_loop_2.counters();
     let _run_loop_2_thread = thread::Builder::new()
@@ -1903,6 +1904,8 @@ fn miner_forking() {
     .expect("Timed out waiting for boostrapped node to catch up to the miner");
 
     let commits_submitted_rl1 = signer_test.running_nodes.commits_submitted.clone();
+    let commits_submitted_rl1_last_burn_height =
+        signer_test.running_nodes.last_commit_burn_height.clone();
     let skip_commit_op_rl1 = signer_test
         .running_nodes
         .nakamoto_test_skip_commit_op
@@ -1947,13 +1950,18 @@ fn miner_forking() {
     info!("Pausing stacks block proposal to force an empty tenure commit from RL2");
     TEST_BROADCAST_STALL.lock().unwrap().replace(true);
     let rl1_commits_before = commits_submitted_rl1.load(Ordering::SeqCst);
+    let burn_height_before = get_burn_height();
 
     info!("Unpausing commits from RL1");
     skip_commit_op_rl1.set(false);
 
     info!("Waiting for commits from RL1");
     wait_for(30, || {
-        Ok(commits_submitted_rl1.load(Ordering::SeqCst) > rl1_commits_before)
+        Ok(
+            commits_submitted_rl1.load(Ordering::SeqCst) > rl1_commits_before
+                && commits_submitted_rl1_last_burn_height.load(Ordering::SeqCst)
+                    >= burn_height_before,
+        )
     })
     .expect("Timed out waiting for miner 1 to submit a commit op");
 
@@ -1984,13 +1992,17 @@ fn miner_forking() {
         "------------------------- RL2 Wins Sortition With Outdated View -------------------------"
     );
     let rl2_commits_before = commits_submitted_rl2.load(Ordering::SeqCst);
+    let burn_height = get_burn_height();
 
     info!("Unpausing commits from RL2");
     skip_commit_op_rl2.set(false);
 
     info!("Waiting for commits from RL2");
     wait_for(30, || {
-        Ok(commits_submitted_rl2.load(Ordering::SeqCst) > rl2_commits_before)
+        Ok(
+            commits_submitted_rl2.load(Ordering::SeqCst) > rl2_commits_before
+                && commits_submitted_rl2_last_burn_height.load(Ordering::SeqCst) >= burn_height,
+        )
     })
     .expect("Timed out waiting for miner 1 to submit a commit op");