Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: enable simple resharding v3 test #12191

Merged
merged 3 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion chain/chain/src/chain.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2347,7 +2347,12 @@ impl Chain {
) -> bool {
let result = epoch_manager.will_shard_layout_change(parent_hash);
let will_shard_layout_change = match result {
Ok(will_shard_layout_change) => will_shard_layout_change,
Ok(_will_shard_layout_change) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: could we add a todo here to enable this later?

// Before state sync is fixed, we don't catch up split shards.
// Assume that all needed shards are tracked already.
// will_shard_layout_change,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a TODO(resharding) here?

cc @marcelo-gonzalez you will likely need fix that as part of state sync & resharding integration

false
}
Err(err) => {
// TODO(resharding) This is a problem, if this happens the node
// will not perform resharding and fall behind the network.
Expand Down
31 changes: 22 additions & 9 deletions integration-tests/src/test_loop/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ pub(crate) struct TestLoopBuilder {
config_modifier: Option<Box<dyn Fn(&mut ClientConfig, usize)>>,
/// Whether to do the warmup or not. See `skip_warmup` for more details.
warmup: bool,
/// Whether all nodes must track all shards.
track_all_shards: bool,
}

impl TestLoopBuilder {
Expand All @@ -91,6 +93,7 @@ impl TestLoopBuilder {
runtime_config_store: None,
config_modifier: None,
warmup: true,
track_all_shards: false,
}
}

Expand Down Expand Up @@ -170,6 +173,11 @@ impl TestLoopBuilder {
self
}

pub fn track_all_shards(mut self) -> Self {
self.track_all_shards = true;
self
}

/// Overrides the tempdir (which contains state dump, etc.) instead
/// of creating a new one.
pub fn test_loop_data_dir(mut self, dir: TempDir) -> Self {
Expand Down Expand Up @@ -270,16 +278,21 @@ impl TestLoopBuilder {
// Configure tracked shards.
// * single shard tracking for validators
// * all shard tracking for non-validators (RPCs and archival)
let epoch_config = epoch_config_store.get_config(genesis.config.protocol_version);
let num_block_producer = epoch_config.num_block_producer_seats;
let num_chunk_producer = epoch_config.validator_selection_config.num_chunk_producer_seats;
let num_chunk_validator = epoch_config.validator_selection_config.num_chunk_validator_seats;
let validator_num =
num_block_producer.max(num_chunk_producer).max(num_chunk_validator) as usize;
if idx < validator_num {
client_config.tracked_shards = Vec::new();
} else {
let not_a_validator = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: It's better to use positive statements ( is_validator ) - it makes it more readable
mini-nit: maybe worth moving to a helper method

let epoch_config = epoch_config_store.get_config(genesis.config.protocol_version);
let num_block_producer = epoch_config.num_block_producer_seats;
let num_chunk_producer =
epoch_config.validator_selection_config.num_chunk_producer_seats;
let num_chunk_validator =
epoch_config.validator_selection_config.num_chunk_validator_seats;
let validator_num =
num_block_producer.max(num_chunk_producer).max(num_chunk_validator) as usize;
idx >= validator_num
};
if self.track_all_shards || not_a_validator {
client_config.tracked_shards = vec![666];
} else {
client_config.tracked_shards = Vec::new();
}

if let Some(config_modifier) = &self.config_modifier {
Expand Down
44 changes: 30 additions & 14 deletions integration-tests/src/test_loop/tests/resharding_v3.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,15 @@ use crate::test_loop::env::TestLoopEnv;
use crate::test_loop::utils::ONE_NEAR;

/// Stub for checking Resharding V3.
/// After uncommenting panics with
/// StorageInconsistentState("Failed to find root node ... in memtrie")
/// TODO(#11881): add the following scenarios:
/// - Shard ids should not be contiguous. For now we reuse existing shard id
/// which is incorrect!!!
/// - Nodes must not track all shards. State sync must succeed.
/// - Set up chunk validator-only nodes. State witness must pass validation.
/// - Tx load must be consistent. Txs and receipts must cross resharding
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be better if test cross shard receipts in a separate test, but yes tx should be consistent

/// boundary. All txs must succeed.
/// - Shard layout can be taken from mainnet.
#[test]
#[ignore]
fn test_resharding_v3() {
if !ProtocolFeature::SimpleNightshadeV4.enabled(PROTOCOL_VERSION) {
return;
Expand All @@ -28,12 +33,12 @@ fn test_resharding_v3() {
let builder = TestLoopBuilder::new();

let initial_balance = 1_000_000 * ONE_NEAR;
let epoch_length = 10;
let epoch_length = 6;
let accounts =
(0..8).map(|i| format!("account{}", i).parse().unwrap()).collect::<Vec<AccountId>>();
let clients = accounts.iter().cloned().collect_vec();
let block_and_chunk_producers = (0..8).map(|idx| accounts[idx].as_str()).collect_vec();
// TODO: set up chunk validator-only nodes.
let clients = vec![accounts[0].clone(), accounts[3].clone(), accounts[6].clone()];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you only pick a few accounts here? Can you add a comment?

let block_and_chunk_producers =
clients.iter().map(|account: &AccountId| account.as_str()).collect_vec();

// Prepare shard split configuration.
let base_epoch_config_store = EpochConfigStore::for_chain_id("mainnet").unwrap();
Expand All @@ -42,6 +47,10 @@ fn test_resharding_v3() {
base_epoch_config_store.get_config(base_protocol_version).as_ref().clone();
base_epoch_config.validator_selection_config.shuffle_shard_assignment_for_chunk_producers =
false;
base_epoch_config.block_producer_kickout_threshold = 0;
base_epoch_config.chunk_producer_kickout_threshold = 0;
base_epoch_config.chunk_validator_only_kickout_threshold = 0;
Comment on lines +55 to +57
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why no kickouts? Is it temporary until all is implemented? If so can you add a todo?

base_epoch_config.shard_layout = ShardLayout::v1(vec!["account3".parse().unwrap()], None, 3);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should test also the case where we go from ShardLayout::v2 to ShardLayout::v2. Maybe in following PRs we can have a common setup method

let base_shard_layout = base_epoch_config.shard_layout.clone();
let mut epoch_config = base_epoch_config.clone();
let mut boundary_accounts = base_shard_layout.boundary_accounts().clone();
Expand All @@ -50,9 +59,12 @@ fn test_resharding_v3() {
let last_shard_id = shard_ids.pop().unwrap();
let mut shards_split_map: BTreeMap<ShardId, Vec<ShardId>> =
shard_ids.iter().map(|shard_id| (*shard_id, vec![*shard_id])).collect();
shard_ids.extend([max_shard_id + 1, max_shard_id + 2]);
shards_split_map.insert(last_shard_id, vec![max_shard_id + 1, max_shard_id + 2]);
boundary_accounts.push(AccountId::try_from("x.near".to_string()).unwrap());
// Keep this way until non-contiguous shard ids are supported.
// let new_shards = vec![max_shard_id + 1, max_shard_id + 2];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: add todo?

let new_shards = vec![max_shard_id, max_shard_id + 1];
shard_ids.extend(new_shards.clone());
shards_split_map.insert(last_shard_id, new_shards);
boundary_accounts.push(AccountId::try_from("xyz.near".to_string()).unwrap());
epoch_config.shard_layout =
ShardLayout::v2(boundary_accounts, shard_ids, Some(shards_split_map));
let expected_num_shards = epoch_config.shard_layout.shard_ids().count();
Expand All @@ -73,8 +85,12 @@ fn test_resharding_v3() {
}
let (genesis, _) = genesis_builder.build();

let TestLoopEnv { mut test_loop, datas: node_datas, tempdir } =
builder.genesis(genesis).epoch_config_store(epoch_config_store).clients(clients).build();
let TestLoopEnv { mut test_loop, datas: node_datas, tempdir } = builder
.genesis(genesis)
.epoch_config_store(epoch_config_store)
.clients(clients)
.track_all_shards()
.build();

let client_handle = node_datas[0].client_sender.actor_handle();
let success_condition = |test_loop_data: &mut TestLoopData| -> bool {
Expand All @@ -89,8 +105,8 @@ fn test_resharding_v3() {

test_loop.run_until(
success_condition,
// Timeout at producing 5 epochs, approximately.
Duration::seconds((5 * epoch_length) as i64),
// Give enough time to produce ~6 epochs.
Duration::seconds((6 * epoch_length) as i64),
);

TestLoopEnv { test_loop, datas: node_datas, tempdir }
Expand Down
Loading