Force bag changes in relevant benchmarks (targets #9507)

Cargo.toml

@@ -129,7 +129,6 @@ members = [
 	"frame/utility",
 	"frame/vesting",
 	"frame/bags-list",
-	"frame/bags-list/generate-bags",
 	"primitives/api",
 	"primitives/api/proc-macro",
 	"primitives/api/test",
@@ -201,6 +200,8 @@ members = [
 	"utils/frame/try-runtime/cli",
 	"utils/frame/rpc/support",
 	"utils/frame/rpc/system",
+	"utils/frame/generate-bags",
+	"utils/frame/generate-bags/node-runtime",
 	"utils/prometheus",
 	"utils/wasm-builder",
 ]

frame/bags-list/Cargo.toml

@@ -35,12 +35,6 @@ sp-core = { version = "4.0.0-dev", path = "../../primitives/core", optional = tr
 sp-io = { version = "4.0.0-dev", path = "../../primitives/io", optional = true, default-features = false }
 sp-tracing = { version = "4.0.0-dev", path = "../../primitives/tracing", optional = true, default-features = false }
 
-# optional imports for making voter bags lists
-chrono = { version = "0.4.19", optional = true }
-git2 = { version = "0.13.20", default-features = false, optional = true }
-num-format = { version = "0.4.0", optional = true }
-pallet-staking = { version = "4.0.0-dev", path = "../staking", optional = true }
-
 [dev-dependencies]
 sp-core = { version = "4.0.0-dev", path = "../../primitives/core"}
 sp-io = { version = "4.0.0-dev", path = "../../primitives/io"}
@@ -66,11 +60,6 @@ runtime-benchmarks = [
 	"sp-io",
 	"pallet-balances",
 	"sp-tracing",
+  "frame-election-provider-support/runtime-benchmarks",
 ]
-generate-bags = [
-	"chrono",
-	"git2",
-	"num-format",
-	"std",
-	"pallet-staking"
-]
+

frame/bags-list/src/lib.rs

@@ -56,8 +56,6 @@ use sp_std::prelude::*;
 #[cfg(any(feature = "runtime-benchmarks", test))]
 mod benchmarks;
 
-#[cfg(feature = "generate-bags")]
-pub mod generate_bags;
 mod list;
 #[cfg(test)]
 mod mock;
@@ -267,4 +265,40 @@ impl<T: Config> SortedListProvider<T::AccountId> for Pallet<T> {
 	fn clear() {
 		List::<T>::clear()
 	}
+
+	/// `id` is in a position in the list that corresponds to `weight`
+	#[cfg(feature = "runtime-benchmarks")]
+	fn is_in_pos(id: &T::AccountId, weight: VoteWeight, _: bool) -> bool {
+		list::Bag::<T>::get(list::notional_bag_for::<T>(weight)).unwrap().contains(id)
+	}
+
+	#[cfg(feature = "runtime-benchmarks")]
+	fn is_bag_head(id: &T::AccountId, weight: VoteWeight, _: bool) -> bool {
+		list::Bag::<T>::get(list::notional_bag_for::<T>(weight)).unwrap().head_id() == Some(id)
+	}
+
+	/// If `who`'s bond becomes the returned value they are guaranteed to change bags in terms of
+	/// the worst case
+	#[cfg(feature = "runtime-benchmarks")]
+	fn weight_update_worst_case(who: &T::AccountId, is_increase: bool) -> VoteWeight {
+		use frame_support::traits::Get as _;
+		let thresholds = T::BagThresholds::get();
+		let node = list::Node::<T>::get(who).unwrap();
+		let current_bag_idx = thresholds
+			.iter()
+			.chain(std::iter::once(&VoteWeight::MAX))
+			.position(|w| w == &node.bag_upper)
+			.unwrap();
+
+		if is_increase {
+			// +2 helps in some edge cases to ensure threshold are far enough apart
+			let next_threshold_idx = current_bag_idx + 2;
+			assert!(thresholds.len() > next_threshold_idx);
+			thresholds[next_threshold_idx]
+		} else {
+			assert!(current_bag_idx != 0);
+			let prev_threshold_idx = current_bag_idx - 1;
+			thresholds[prev_threshold_idx]
+		}
+	}
 }

frame/bags-list/src/list/mod.rs

@@ -52,7 +52,7 @@ mod tests;
 ///
 /// Note that even if the thresholds list does not have `VoteWeight::MAX` as its final member, this
 /// function behaves as if it does.
-fn notional_bag_for<T: Config>(weight: VoteWeight) -> VoteWeight {
+pub(crate) fn notional_bag_for<T: Config>(weight: VoteWeight) -> VoteWeight {
 	let thresholds = T::BagThresholds::get();
 	let idx = thresholds.partition_point(|&threshold| weight > threshold);
 	thresholds.get(idx).copied().unwrap_or(VoteWeight::MAX)
@@ -586,6 +586,16 @@ impl<T: Config> Bag<T> {
 
 		Ok(())
 	}
+
+	#[cfg(feature = "runtime-benchmarks")]
+	pub(crate) fn contains(&self, id: &T::AccountId) -> bool {
+		self.iter().any(|n| n.id() == id)
+	}
+
+	#[cfg(feature = "runtime-benchmarks")]
+	pub(crate) fn head_id(&self) -> Option<&T::AccountId> {
+		self.head.as_ref()
+	}
 }
 
 /// A Node is the fundamental element comprising the doubly-linked list described by `Bag`.
@@ -596,7 +606,7 @@ pub struct Node<T: Config> {
 	id: T::AccountId,
 	prev: Option<T::AccountId>,
 	next: Option<T::AccountId>,
-	bag_upper: VoteWeight,
+	pub(crate) bag_upper: VoteWeight,
 }
 
 impl<T: Config> Node<T> {

frame/bags-list/src/list/tests.rs

@@ -136,8 +136,8 @@ fn migrate_works() {
 					(15, vec![710]), // nodes in range 11 ..= 15 move from bag 20 to bag 15
 					(20, vec![711]),
 					(1000, vec![2, 3, 4]),
-					(10_000, vec![712]), /* nodes in range 1_001 ..= 2_000 move from bag 2_000
-					                      * to bag 10_000 */
+					// nodes in range 1_001 ..= 2_000 move from bag 2_000 to bag 10_000
+					(10_000, vec![712]),
 				]
 			);
 		});

frame/election-provider-support/src/lib.rs

@@ -333,6 +333,32 @@ pub trait SortedListProvider<AccountId> {
 	fn clear();
 	/// Sanity check internal state of list. Only meant for debug compilation.
 	fn sanity_check() -> Result<(), &'static str>;
+
+	/// `id` is in a position in the list that corresponds to `weight`
+	#[cfg(any(feature = "runtime-benchmarks", test))]
+	fn is_in_pos(_id: &AccountId, _weight: VoteWeight, mock: bool) -> bool {
+		mock
+	}
+
+	/// Wether the voter is the head of the notional bag for the given weight. Only relevant for
+	/// implementations that use bags.
+	///
+	/// `mock` parameter is for implementations where this method is not relevant.
+	#[cfg(any(feature = "runtime-benchmarks", test))]
+	fn is_bag_head(_: &AccountId, _: VoteWeight, mock: bool) -> bool {
+		mock
+	}
+
+	/// If `who` changes by the returned amount they are guaranteed to have a worst case change
+	/// in their list position.
+	#[cfg(any(feature = "runtime-benchmarks", test))]
+	fn weight_update_worst_case(_who: &AccountId, is_increase: bool) -> VoteWeight {
+		if is_increase {
+			VoteWeight::MAX
+		} else {
+			1
+		}
+	}
 }
 
 /// Something that can provide the `VoteWeight` of an account. Similar to [`ElectionProvider`] and

frame/session/benchmarking/src/lib.rs

@@ -126,7 +126,7 @@ fn check_membership_proof_setup<T: Config>(
 	pallet_staking::ValidatorCount::<T>::put(n);
 
 	// create validators and set random session keys
-	for (n, who) in create_validators::<T>(n, 1000).unwrap().into_iter().enumerate() {
+	for (n, who) in create_validators::<T>(n, 1000, 0).unwrap().into_iter().enumerate() {
 		use rand::{RngCore, SeedableRng};
 
 		let validator = T::Lookup::lookup(who).unwrap();

frame/staking/Cargo.toml

@@ -39,11 +39,7 @@ log = { version = "0.4.14", default-features = false }
 # Optional imports for benchmarking
 frame-benchmarking = { version = "4.0.0-dev", default-features = false, path = "../benchmarking", optional = true }
 rand_chacha = { version = "0.2", default-features = false, optional = true }
-
-# Optional imports for making voter bags lists
-chrono = { version = "0.4.19", optional = true }
-git2 = { version = "0.13.20", default-features = false, optional = true }
-num-format = { version = "0.4.0", optional = true }
+pallet-bags-list = { version = "4.0.0-dev",  path = "../bags-list", optional = true }
 
 [dev-dependencies]
 sp-tracing = { version = "4.0.0-dev", path = "../../primitives/tracing" }
@@ -52,7 +48,7 @@ sp-npos-elections = { version = "4.0.0-dev", path = "../../primitives/npos-elect
 pallet-balances = { version = "4.0.0-dev", path = "../balances" }
 pallet-timestamp = { version = "4.0.0-dev", path = "../timestamp" }
 pallet-staking-reward-curve = { version = "4.0.0-dev",  path = "../staking/reward-curve" }
-pallet-bags-list = { version = "4.0.0-dev",  path = "../bags-list" }
+pallet-bags-list = { version = "4.0.0-dev", features = ["runtime-benchmarks"], path = "../bags-list" }
 substrate-test-utils = { version = "4.0.0-dev", path = "../../test-utils" }
 frame-benchmarking = { version = "4.0.0-dev", path = "../benchmarking" }
 frame-election-provider-support = { version = "4.0.0-dev", path = "../election-provider-support" }
@@ -79,16 +75,6 @@ runtime-benchmarks = [
 	"frame-benchmarking",
 	"frame-election-provider-support/runtime-benchmarks",
 	"rand_chacha",
+  "pallet-bags-list/runtime-benchmarks",
 ]
 try-runtime = ["frame-support/try-runtime"]
-generate-bags = [
-	"chrono",
-	"git2",
-	"num-format",
-	"pallet-staking-reward-curve",
-	"pallet-balances",
-	"pallet-timestamp",
-	"sp-core",
-	"sp-tracing",
-	"std",
-]