mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-12 03:01:07 +00:00
Extract warp sync strategy from ChainSync (#2467)
Extract `WarpSync` (and `StateSync` as part of warp sync) from `ChainSync` as independent syncing strategy called by `SyncingEngine`. Introduce `SyncingStrategy` enum as a proxy between `SyncingEngine` and specific syncing strategies. ## Limitations Gap sync is kept in `ChainSync` for now because it shares the same set of peers as block syncing implementation in `ChainSync`. Extraction of a common context responsible for peer management in syncing strategies able to run in parallel is planned for a follow-up PR. ## Further improvements A possibility of conversion of `SyncingStartegy` into a trait should be evaluated. The main stopper for this is that different strategies need to communicate different actions to `SyncingEngine` and respond to different events / provide different APIs (e.g., requesting justifications is only possible via `ChainSync` and not through `WarpSync`; `SendWarpProofRequest` action is only relevant to `WarpSync`, etc.) --------- Co-authored-by: Aaro Altonen <48052676+altonen@users.noreply.github.com>
This commit is contained in:
@@ -0,0 +1,967 @@
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
||||
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
//! Tests of [`ChainSync`].
|
||||
|
||||
use super::*;
|
||||
use futures::executor::block_on;
|
||||
use sc_block_builder::BlockBuilderBuilder;
|
||||
use sc_network_common::sync::message::{BlockAnnounce, BlockData, BlockState, FromBlock};
|
||||
use sp_blockchain::HeaderBackend;
|
||||
use substrate_test_runtime_client::{
|
||||
runtime::{Block, Hash, Header},
|
||||
BlockBuilderExt, ClientBlockImportExt, ClientExt, DefaultTestClientBuilderExt, TestClient,
|
||||
TestClientBuilder, TestClientBuilderExt,
|
||||
};
|
||||
|
||||
#[test]
|
||||
fn processes_empty_response_on_justification_request_for_unknown_block() {
|
||||
// if we ask for a justification for a given block to a peer that doesn't know that block
|
||||
// (different from not having a justification), the peer will reply with an empty response.
|
||||
// internally we should process the response as the justification not being available.
|
||||
|
||||
let client = Arc::new(TestClientBuilder::new().build());
|
||||
let peer_id = PeerId::random();
|
||||
|
||||
let mut sync = ChainSync::new(ChainSyncMode::Full, client.clone(), 1, 64, None).unwrap();
|
||||
|
||||
let (a1_hash, a1_number) = {
|
||||
let a1 = BlockBuilderBuilder::new(&*client)
|
||||
.on_parent_block(client.chain_info().best_hash)
|
||||
.with_parent_block_number(client.chain_info().best_number)
|
||||
.build()
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap()
|
||||
.block;
|
||||
(a1.hash(), *a1.header.number())
|
||||
};
|
||||
|
||||
// add a new peer with the same best block
|
||||
sync.add_peer(peer_id, a1_hash, a1_number);
|
||||
|
||||
// and request a justification for the block
|
||||
sync.request_justification(&a1_hash, a1_number);
|
||||
|
||||
// the justification request should be scheduled to that peer
|
||||
assert!(sync
|
||||
.justification_requests()
|
||||
.iter()
|
||||
.any(|(who, request)| { *who == peer_id && request.from == FromBlock::Hash(a1_hash) }));
|
||||
|
||||
// there are no extra pending requests
|
||||
assert_eq!(sync.extra_justifications.pending_requests().count(), 0);
|
||||
|
||||
// there's one in-flight extra request to the expected peer
|
||||
assert!(sync.extra_justifications.active_requests().any(|(who, (hash, number))| {
|
||||
*who == peer_id && *hash == a1_hash && *number == a1_number
|
||||
}));
|
||||
|
||||
// if the peer replies with an empty response (i.e. it doesn't know the block),
|
||||
// the active request should be cleared.
|
||||
sync.on_block_justification(peer_id, BlockResponse::<Block> { id: 0, blocks: vec![] })
|
||||
.unwrap();
|
||||
|
||||
// there should be no in-flight requests
|
||||
assert_eq!(sync.extra_justifications.active_requests().count(), 0);
|
||||
|
||||
// and the request should now be pending again, waiting for reschedule
|
||||
assert!(sync
|
||||
.extra_justifications
|
||||
.pending_requests()
|
||||
.any(|(hash, number)| { *hash == a1_hash && *number == a1_number }));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn restart_doesnt_affect_peers_downloading_finality_data() {
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
|
||||
let mut sync = ChainSync::new(ChainSyncMode::Full, client.clone(), 1, 64, None).unwrap();
|
||||
|
||||
let peer_id1 = PeerId::random();
|
||||
let peer_id2 = PeerId::random();
|
||||
let peer_id3 = PeerId::random();
|
||||
|
||||
let mut new_blocks = |n| {
|
||||
for _ in 0..n {
|
||||
let block = BlockBuilderBuilder::new(&*client)
|
||||
.on_parent_block(client.chain_info().best_hash)
|
||||
.with_parent_block_number(client.chain_info().best_number)
|
||||
.build()
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap()
|
||||
.block;
|
||||
block_on(client.import(BlockOrigin::Own, block.clone())).unwrap();
|
||||
}
|
||||
|
||||
let info = client.info();
|
||||
(info.best_hash, info.best_number)
|
||||
};
|
||||
|
||||
let (b1_hash, b1_number) = new_blocks(50);
|
||||
|
||||
// add 2 peers at blocks that we don't have locally
|
||||
sync.add_peer(peer_id1, Hash::random(), 42);
|
||||
sync.add_peer(peer_id2, Hash::random(), 10);
|
||||
|
||||
// we wil send block requests to these peers
|
||||
// for these blocks we don't know about
|
||||
assert!(sync
|
||||
.block_requests()
|
||||
.into_iter()
|
||||
.all(|(p, _)| { p == peer_id1 || p == peer_id2 }));
|
||||
|
||||
// add a new peer at a known block
|
||||
sync.add_peer(peer_id3, b1_hash, b1_number);
|
||||
|
||||
// we request a justification for a block we have locally
|
||||
sync.request_justification(&b1_hash, b1_number);
|
||||
|
||||
// the justification request should be scheduled to the
|
||||
// new peer which is at the given block
|
||||
assert!(sync.justification_requests().iter().any(|(p, r)| {
|
||||
*p == peer_id3 &&
|
||||
r.fields == BlockAttributes::JUSTIFICATION &&
|
||||
r.from == FromBlock::Hash(b1_hash)
|
||||
}));
|
||||
|
||||
assert_eq!(
|
||||
sync.peers.get(&peer_id3).unwrap().state,
|
||||
PeerSyncState::DownloadingJustification(b1_hash),
|
||||
);
|
||||
|
||||
// clear old actions
|
||||
let _ = sync.take_actions();
|
||||
|
||||
// we restart the sync state
|
||||
sync.restart();
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
|
||||
// which should make us send out block requests to the first two peers
|
||||
assert_eq!(actions.len(), 2);
|
||||
assert!(actions.iter().all(|action| match action {
|
||||
ChainSyncAction::SendBlockRequest { peer_id, .. } =>
|
||||
peer_id == &peer_id1 || peer_id == &peer_id2,
|
||||
_ => false,
|
||||
}));
|
||||
|
||||
// peer 3 should be unaffected it was downloading finality data
|
||||
assert_eq!(
|
||||
sync.peers.get(&peer_id3).unwrap().state,
|
||||
PeerSyncState::DownloadingJustification(b1_hash),
|
||||
);
|
||||
|
||||
// Set common block to something that we don't have (e.g. failed import)
|
||||
sync.peers.get_mut(&peer_id3).unwrap().common_number = 100;
|
||||
sync.restart();
|
||||
assert_eq!(sync.peers.get(&peer_id3).unwrap().common_number, 50);
|
||||
}
|
||||
|
||||
/// Send a block annoucnement for the given `header`.
|
||||
fn send_block_announce(header: Header, peer_id: PeerId, sync: &mut ChainSync<Block, TestClient>) {
|
||||
let announce = BlockAnnounce {
|
||||
header: header.clone(),
|
||||
state: Some(BlockState::Best),
|
||||
data: Some(Vec::new()),
|
||||
};
|
||||
|
||||
let _ = sync.on_validated_block_announce(true, peer_id, &announce);
|
||||
}
|
||||
|
||||
/// Create a block response from the given `blocks`.
|
||||
fn create_block_response(blocks: Vec<Block>) -> BlockResponse<Block> {
|
||||
BlockResponse::<Block> {
|
||||
id: 0,
|
||||
blocks: blocks
|
||||
.into_iter()
|
||||
.map(|b| BlockData::<Block> {
|
||||
hash: b.hash(),
|
||||
header: Some(b.header().clone()),
|
||||
body: Some(b.deconstruct().1),
|
||||
indexed_body: None,
|
||||
receipt: None,
|
||||
message_queue: None,
|
||||
justification: None,
|
||||
justifications: None,
|
||||
})
|
||||
.collect(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Get a block request from `sync` and check that is matches the expected request.
|
||||
fn get_block_request(
|
||||
sync: &mut ChainSync<Block, TestClient>,
|
||||
from: FromBlock<Hash, u64>,
|
||||
max: u32,
|
||||
peer: &PeerId,
|
||||
) -> BlockRequest<Block> {
|
||||
let requests = sync.block_requests();
|
||||
|
||||
log::trace!(target: LOG_TARGET, "Requests: {requests:?}");
|
||||
|
||||
assert_eq!(1, requests.len());
|
||||
assert_eq!(*peer, requests[0].0);
|
||||
|
||||
let request = requests[0].1.clone();
|
||||
|
||||
assert_eq!(from, request.from);
|
||||
assert_eq!(Some(max), request.max);
|
||||
request
|
||||
}
|
||||
|
||||
/// Build and import a new best block.
|
||||
fn build_block(client: &mut Arc<TestClient>, at: Option<Hash>, fork: bool) -> Block {
|
||||
let at = at.unwrap_or_else(|| client.info().best_hash);
|
||||
|
||||
let mut block_builder = BlockBuilderBuilder::new(&**client)
|
||||
.on_parent_block(at)
|
||||
.fetch_parent_block_number(&**client)
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
if fork {
|
||||
block_builder.push_storage_change(vec![1, 2, 3], Some(vec![4, 5, 6])).unwrap();
|
||||
}
|
||||
|
||||
let block = block_builder.build().unwrap().block;
|
||||
|
||||
block_on(client.import(BlockOrigin::Own, block.clone())).unwrap();
|
||||
block
|
||||
}
|
||||
|
||||
fn unwrap_from_block_number(from: FromBlock<Hash, u64>) -> u64 {
|
||||
if let FromBlock::Number(from) = from {
|
||||
from
|
||||
} else {
|
||||
panic!("Expected a number!");
|
||||
}
|
||||
}
|
||||
|
||||
/// A regression test for a behavior we have seen on a live network.
|
||||
///
|
||||
/// The scenario is that the node is doing a full resync and is connected to some node that is
|
||||
/// doing a major sync as well. This other node that is doing a major sync will finish before
|
||||
/// our node and send a block announcement message, but we don't have seen any block
|
||||
/// announcement from this node in its sync process. Meaning our common number didn't change. It
|
||||
/// is now expected that we start an ancestor search to find the common number.
|
||||
#[test]
|
||||
fn do_ancestor_search_when_common_block_to_best_qeued_gap_is_to_big() {
|
||||
sp_tracing::try_init_simple();
|
||||
|
||||
let blocks = {
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
(0..MAX_DOWNLOAD_AHEAD * 2)
|
||||
.map(|_| build_block(&mut client, None, false))
|
||||
.collect::<Vec<_>>()
|
||||
};
|
||||
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let info = client.info();
|
||||
|
||||
let mut sync = ChainSync::new(ChainSyncMode::Full, client.clone(), 5, 64, None).unwrap();
|
||||
|
||||
let peer_id1 = PeerId::random();
|
||||
let peer_id2 = PeerId::random();
|
||||
|
||||
let best_block = blocks.last().unwrap().clone();
|
||||
let max_blocks_to_request = sync.max_blocks_per_request;
|
||||
// Connect the node we will sync from
|
||||
sync.add_peer(peer_id1, best_block.hash(), *best_block.header().number());
|
||||
sync.add_peer(peer_id2, info.best_hash, 0);
|
||||
|
||||
let mut best_block_num = 0;
|
||||
while best_block_num < MAX_DOWNLOAD_AHEAD {
|
||||
let request = get_block_request(
|
||||
&mut sync,
|
||||
FromBlock::Number(max_blocks_to_request as u64 + best_block_num as u64),
|
||||
max_blocks_to_request as u32,
|
||||
&peer_id1,
|
||||
);
|
||||
|
||||
let from = unwrap_from_block_number(request.from.clone());
|
||||
|
||||
let mut resp_blocks = blocks[best_block_num as usize..from as usize].to_vec();
|
||||
resp_blocks.reverse();
|
||||
|
||||
let response = create_block_response(resp_blocks.clone());
|
||||
|
||||
// Clear old actions to not deal with them
|
||||
let _ = sync.take_actions();
|
||||
|
||||
sync.on_block_data(&peer_id1, Some(request), response).unwrap();
|
||||
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
assert_eq!(actions.len(), 1);
|
||||
assert!(matches!(
|
||||
&actions[0],
|
||||
ChainSyncAction::ImportBlocks{ origin: _, blocks } if blocks.len() == max_blocks_to_request as usize,
|
||||
));
|
||||
|
||||
best_block_num += max_blocks_to_request as u32;
|
||||
|
||||
let _ = sync.on_blocks_processed(
|
||||
max_blocks_to_request as usize,
|
||||
max_blocks_to_request as usize,
|
||||
resp_blocks
|
||||
.iter()
|
||||
.rev()
|
||||
.map(|b| {
|
||||
(
|
||||
Ok(BlockImportStatus::ImportedUnknown(
|
||||
*b.header().number(),
|
||||
Default::default(),
|
||||
Some(peer_id1),
|
||||
)),
|
||||
b.hash(),
|
||||
)
|
||||
})
|
||||
.collect(),
|
||||
);
|
||||
|
||||
resp_blocks
|
||||
.into_iter()
|
||||
.rev()
|
||||
.for_each(|b| block_on(client.import_as_final(BlockOrigin::Own, b)).unwrap());
|
||||
}
|
||||
|
||||
// "Wait" for the queue to clear
|
||||
sync.queue_blocks.clear();
|
||||
|
||||
// Let peer2 announce that it finished syncing
|
||||
send_block_announce(best_block.header().clone(), peer_id2, &mut sync);
|
||||
|
||||
let (peer1_req, peer2_req) =
|
||||
sync.block_requests().into_iter().fold((None, None), |res, req| {
|
||||
if req.0 == peer_id1 {
|
||||
(Some(req.1), res.1)
|
||||
} else if req.0 == peer_id2 {
|
||||
(res.0, Some(req.1))
|
||||
} else {
|
||||
panic!("Unexpected req: {:?}", req)
|
||||
}
|
||||
});
|
||||
|
||||
// We should now do an ancestor search to find the correct common block.
|
||||
let peer2_req = peer2_req.unwrap();
|
||||
assert_eq!(Some(1), peer2_req.max);
|
||||
assert_eq!(FromBlock::Number(best_block_num as u64), peer2_req.from);
|
||||
|
||||
let response = create_block_response(vec![blocks[(best_block_num - 1) as usize].clone()]);
|
||||
|
||||
// Clear old actions to not deal with them
|
||||
let _ = sync.take_actions();
|
||||
|
||||
sync.on_block_data(&peer_id2, Some(peer2_req), response).unwrap();
|
||||
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
assert!(actions.is_empty());
|
||||
|
||||
let peer1_from = unwrap_from_block_number(peer1_req.unwrap().from);
|
||||
|
||||
// As we are on the same chain, we should directly continue with requesting blocks from
|
||||
// peer 2 as well.
|
||||
get_block_request(
|
||||
&mut sync,
|
||||
FromBlock::Number(peer1_from + max_blocks_to_request as u64),
|
||||
max_blocks_to_request as u32,
|
||||
&peer_id2,
|
||||
);
|
||||
}
|
||||
|
||||
/// A test that ensures that we can sync a huge fork.
|
||||
///
|
||||
/// The following scenario:
|
||||
/// A peer connects to us and we both have the common block 512. The last finalized is 2048.
|
||||
/// Our best block is 4096. The peer send us a block announcement with 4097 from a fork.
|
||||
///
|
||||
/// We will first do an ancestor search to find the common block. After that we start to sync
|
||||
/// the fork and finish it ;)
|
||||
#[test]
|
||||
fn can_sync_huge_fork() {
|
||||
sp_tracing::try_init_simple();
|
||||
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let blocks = (0..MAX_BLOCKS_TO_LOOK_BACKWARDS * 4)
|
||||
.map(|_| build_block(&mut client, None, false))
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
let fork_blocks = {
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let fork_blocks = blocks[..MAX_BLOCKS_TO_LOOK_BACKWARDS as usize * 2]
|
||||
.into_iter()
|
||||
.inspect(|b| block_on(client.import(BlockOrigin::Own, (*b).clone())).unwrap())
|
||||
.cloned()
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
fork_blocks
|
||||
.into_iter()
|
||||
.chain(
|
||||
(0..MAX_BLOCKS_TO_LOOK_BACKWARDS * 2 + 1)
|
||||
.map(|_| build_block(&mut client, None, true)),
|
||||
)
|
||||
.collect::<Vec<_>>()
|
||||
};
|
||||
|
||||
let info = client.info();
|
||||
|
||||
let mut sync = ChainSync::new(ChainSyncMode::Full, client.clone(), 5, 64, None).unwrap();
|
||||
|
||||
let finalized_block = blocks[MAX_BLOCKS_TO_LOOK_BACKWARDS as usize * 2 - 1].clone();
|
||||
let just = (*b"TEST", Vec::new());
|
||||
client.finalize_block(finalized_block.hash(), Some(just)).unwrap();
|
||||
sync.update_chain_info(&info.best_hash, info.best_number);
|
||||
|
||||
let peer_id1 = PeerId::random();
|
||||
|
||||
let common_block = blocks[MAX_BLOCKS_TO_LOOK_BACKWARDS as usize / 2].clone();
|
||||
// Connect the node we will sync from
|
||||
sync.add_peer(peer_id1, common_block.hash(), *common_block.header().number());
|
||||
|
||||
send_block_announce(fork_blocks.last().unwrap().header().clone(), peer_id1, &mut sync);
|
||||
|
||||
let mut request =
|
||||
get_block_request(&mut sync, FromBlock::Number(info.best_number), 1, &peer_id1);
|
||||
|
||||
// Discard old actions we are not interested in
|
||||
let _ = sync.take_actions();
|
||||
|
||||
// Do the ancestor search
|
||||
loop {
|
||||
let block = &fork_blocks[unwrap_from_block_number(request.from.clone()) as usize - 1];
|
||||
let response = create_block_response(vec![block.clone()]);
|
||||
|
||||
sync.on_block_data(&peer_id1, Some(request), response).unwrap();
|
||||
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
|
||||
request = if actions.is_empty() {
|
||||
// We found the ancenstor
|
||||
break
|
||||
} else {
|
||||
assert_eq!(actions.len(), 1);
|
||||
match &actions[0] {
|
||||
ChainSyncAction::SendBlockRequest { peer_id: _, request } => request.clone(),
|
||||
action @ _ => panic!("Unexpected action: {action:?}"),
|
||||
}
|
||||
};
|
||||
|
||||
log::trace!(target: LOG_TARGET, "Request: {request:?}");
|
||||
}
|
||||
|
||||
// Now request and import the fork.
|
||||
let mut best_block_num = *finalized_block.header().number() as u32;
|
||||
let max_blocks_to_request = sync.max_blocks_per_request;
|
||||
while best_block_num < *fork_blocks.last().unwrap().header().number() as u32 - 1 {
|
||||
let request = get_block_request(
|
||||
&mut sync,
|
||||
FromBlock::Number(max_blocks_to_request as u64 + best_block_num as u64),
|
||||
max_blocks_to_request as u32,
|
||||
&peer_id1,
|
||||
);
|
||||
|
||||
let from = unwrap_from_block_number(request.from.clone());
|
||||
|
||||
let mut resp_blocks = fork_blocks[best_block_num as usize..from as usize].to_vec();
|
||||
resp_blocks.reverse();
|
||||
|
||||
let response = create_block_response(resp_blocks.clone());
|
||||
|
||||
sync.on_block_data(&peer_id1, Some(request), response).unwrap();
|
||||
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
assert_eq!(actions.len(), 1);
|
||||
assert!(matches!(
|
||||
&actions[0],
|
||||
ChainSyncAction::ImportBlocks{ origin: _, blocks } if blocks.len() == sync.max_blocks_per_request as usize
|
||||
));
|
||||
|
||||
best_block_num += sync.max_blocks_per_request as u32;
|
||||
|
||||
sync.on_blocks_processed(
|
||||
max_blocks_to_request as usize,
|
||||
max_blocks_to_request as usize,
|
||||
resp_blocks
|
||||
.iter()
|
||||
.rev()
|
||||
.map(|b| {
|
||||
(
|
||||
Ok(BlockImportStatus::ImportedUnknown(
|
||||
*b.header().number(),
|
||||
Default::default(),
|
||||
Some(peer_id1),
|
||||
)),
|
||||
b.hash(),
|
||||
)
|
||||
})
|
||||
.collect(),
|
||||
);
|
||||
|
||||
// Discard pending actions
|
||||
let _ = sync.take_actions();
|
||||
|
||||
resp_blocks
|
||||
.into_iter()
|
||||
.rev()
|
||||
.for_each(|b| block_on(client.import(BlockOrigin::Own, b)).unwrap());
|
||||
}
|
||||
|
||||
// Request the tip
|
||||
get_block_request(&mut sync, FromBlock::Hash(fork_blocks.last().unwrap().hash()), 1, &peer_id1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn syncs_fork_without_duplicate_requests() {
|
||||
sp_tracing::try_init_simple();
|
||||
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let blocks = (0..MAX_BLOCKS_TO_LOOK_BACKWARDS * 4)
|
||||
.map(|_| build_block(&mut client, None, false))
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
let fork_blocks = {
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let fork_blocks = blocks[..MAX_BLOCKS_TO_LOOK_BACKWARDS as usize * 2]
|
||||
.into_iter()
|
||||
.inspect(|b| block_on(client.import(BlockOrigin::Own, (*b).clone())).unwrap())
|
||||
.cloned()
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
fork_blocks
|
||||
.into_iter()
|
||||
.chain(
|
||||
(0..MAX_BLOCKS_TO_LOOK_BACKWARDS * 2 + 1)
|
||||
.map(|_| build_block(&mut client, None, true)),
|
||||
)
|
||||
.collect::<Vec<_>>()
|
||||
};
|
||||
|
||||
let info = client.info();
|
||||
|
||||
let mut sync = ChainSync::new(ChainSyncMode::Full, client.clone(), 5, 64, None).unwrap();
|
||||
|
||||
let finalized_block = blocks[MAX_BLOCKS_TO_LOOK_BACKWARDS as usize * 2 - 1].clone();
|
||||
let just = (*b"TEST", Vec::new());
|
||||
client.finalize_block(finalized_block.hash(), Some(just)).unwrap();
|
||||
sync.update_chain_info(&info.best_hash, info.best_number);
|
||||
|
||||
let peer_id1 = PeerId::random();
|
||||
|
||||
let common_block = blocks[MAX_BLOCKS_TO_LOOK_BACKWARDS as usize / 2].clone();
|
||||
// Connect the node we will sync from
|
||||
sync.add_peer(peer_id1, common_block.hash(), *common_block.header().number());
|
||||
|
||||
send_block_announce(fork_blocks.last().unwrap().header().clone(), peer_id1, &mut sync);
|
||||
|
||||
let mut request =
|
||||
get_block_request(&mut sync, FromBlock::Number(info.best_number), 1, &peer_id1);
|
||||
|
||||
// Discard pending actions
|
||||
let _ = sync.take_actions();
|
||||
|
||||
// Do the ancestor search
|
||||
loop {
|
||||
let block = &fork_blocks[unwrap_from_block_number(request.from.clone()) as usize - 1];
|
||||
let response = create_block_response(vec![block.clone()]);
|
||||
|
||||
sync.on_block_data(&peer_id1, Some(request), response).unwrap();
|
||||
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
|
||||
request = if actions.is_empty() {
|
||||
// We found the ancenstor
|
||||
break
|
||||
} else {
|
||||
assert_eq!(actions.len(), 1);
|
||||
match &actions[0] {
|
||||
ChainSyncAction::SendBlockRequest { peer_id: _, request } => request.clone(),
|
||||
action @ _ => panic!("Unexpected action: {action:?}"),
|
||||
}
|
||||
};
|
||||
|
||||
log::trace!(target: LOG_TARGET, "Request: {request:?}");
|
||||
}
|
||||
|
||||
// Now request and import the fork.
|
||||
let mut best_block_num = *finalized_block.header().number() as u32;
|
||||
let max_blocks_to_request = sync.max_blocks_per_request;
|
||||
|
||||
let mut request = get_block_request(
|
||||
&mut sync,
|
||||
FromBlock::Number(max_blocks_to_request as u64 + best_block_num as u64),
|
||||
max_blocks_to_request as u32,
|
||||
&peer_id1,
|
||||
);
|
||||
let last_block_num = *fork_blocks.last().unwrap().header().number() as u32 - 1;
|
||||
while best_block_num < last_block_num {
|
||||
let from = unwrap_from_block_number(request.from.clone());
|
||||
|
||||
let mut resp_blocks = fork_blocks[best_block_num as usize..from as usize].to_vec();
|
||||
resp_blocks.reverse();
|
||||
|
||||
let response = create_block_response(resp_blocks.clone());
|
||||
|
||||
// Discard old actions
|
||||
let _ = sync.take_actions();
|
||||
|
||||
sync.on_block_data(&peer_id1, Some(request.clone()), response).unwrap();
|
||||
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
assert_eq!(actions.len(), 1);
|
||||
assert!(matches!(
|
||||
&actions[0],
|
||||
ChainSyncAction::ImportBlocks{ origin: _, blocks } if blocks.len() == max_blocks_to_request as usize
|
||||
));
|
||||
|
||||
best_block_num += max_blocks_to_request as u32;
|
||||
|
||||
if best_block_num < last_block_num {
|
||||
// make sure we're not getting a duplicate request in the time before the blocks are
|
||||
// processed
|
||||
request = get_block_request(
|
||||
&mut sync,
|
||||
FromBlock::Number(max_blocks_to_request as u64 + best_block_num as u64),
|
||||
max_blocks_to_request as u32,
|
||||
&peer_id1,
|
||||
);
|
||||
}
|
||||
|
||||
let mut notify_imported: Vec<_> = resp_blocks
|
||||
.iter()
|
||||
.rev()
|
||||
.map(|b| {
|
||||
(
|
||||
Ok(BlockImportStatus::ImportedUnknown(
|
||||
*b.header().number(),
|
||||
Default::default(),
|
||||
Some(peer_id1),
|
||||
)),
|
||||
b.hash(),
|
||||
)
|
||||
})
|
||||
.collect();
|
||||
|
||||
// The import queue may send notifications in batches of varying size. So we simulate
|
||||
// this here by splitting the batch into 2 notifications.
|
||||
let max_blocks_to_request = sync.max_blocks_per_request;
|
||||
let second_batch = notify_imported.split_off(notify_imported.len() / 2);
|
||||
let _ = sync.on_blocks_processed(
|
||||
max_blocks_to_request as usize,
|
||||
max_blocks_to_request as usize,
|
||||
notify_imported,
|
||||
);
|
||||
|
||||
let _ = sync.on_blocks_processed(
|
||||
max_blocks_to_request as usize,
|
||||
max_blocks_to_request as usize,
|
||||
second_batch,
|
||||
);
|
||||
|
||||
resp_blocks
|
||||
.into_iter()
|
||||
.rev()
|
||||
.for_each(|b| block_on(client.import(BlockOrigin::Own, b)).unwrap());
|
||||
}
|
||||
|
||||
// Request the tip
|
||||
get_block_request(&mut sync, FromBlock::Hash(fork_blocks.last().unwrap().hash()), 1, &peer_id1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn removes_target_fork_on_disconnect() {
|
||||
sp_tracing::try_init_simple();
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let blocks = (0..3).map(|_| build_block(&mut client, None, false)).collect::<Vec<_>>();
|
||||
|
||||
let mut sync = ChainSync::new(ChainSyncMode::Full, client.clone(), 1, 64, None).unwrap();
|
||||
|
||||
let peer_id1 = PeerId::random();
|
||||
let common_block = blocks[1].clone();
|
||||
// Connect the node we will sync from
|
||||
sync.add_peer(peer_id1, common_block.hash(), *common_block.header().number());
|
||||
|
||||
// Create a "new" header and announce it
|
||||
let mut header = blocks[0].header().clone();
|
||||
header.number = 4;
|
||||
send_block_announce(header, peer_id1, &mut sync);
|
||||
assert!(sync.fork_targets.len() == 1);
|
||||
|
||||
let _ = sync.remove_peer(&peer_id1);
|
||||
assert!(sync.fork_targets.len() == 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn can_import_response_with_missing_blocks() {
|
||||
sp_tracing::try_init_simple();
|
||||
let mut client2 = Arc::new(TestClientBuilder::new().build());
|
||||
let blocks = (0..4).map(|_| build_block(&mut client2, None, false)).collect::<Vec<_>>();
|
||||
|
||||
let empty_client = Arc::new(TestClientBuilder::new().build());
|
||||
|
||||
let mut sync = ChainSync::new(ChainSyncMode::Full, empty_client.clone(), 1, 64, None).unwrap();
|
||||
|
||||
let peer_id1 = PeerId::random();
|
||||
let best_block = blocks[3].clone();
|
||||
sync.add_peer(peer_id1, best_block.hash(), *best_block.header().number());
|
||||
|
||||
sync.peers.get_mut(&peer_id1).unwrap().state = PeerSyncState::Available;
|
||||
sync.peers.get_mut(&peer_id1).unwrap().common_number = 0;
|
||||
|
||||
// Request all missing blocks and respond only with some.
|
||||
let request = get_block_request(&mut sync, FromBlock::Hash(best_block.hash()), 4, &peer_id1);
|
||||
let response =
|
||||
create_block_response(vec![blocks[3].clone(), blocks[2].clone(), blocks[1].clone()]);
|
||||
sync.on_block_data(&peer_id1, Some(request.clone()), response).unwrap();
|
||||
assert_eq!(sync.best_queued_number, 0);
|
||||
|
||||
// Request should only contain the missing block.
|
||||
let request = get_block_request(&mut sync, FromBlock::Number(1), 1, &peer_id1);
|
||||
let response = create_block_response(vec![blocks[0].clone()]);
|
||||
sync.on_block_data(&peer_id1, Some(request), response).unwrap();
|
||||
assert_eq!(sync.best_queued_number, 4);
|
||||
}
|
||||
#[test]
|
||||
fn ancestor_search_repeat() {
|
||||
let state = AncestorSearchState::<Block>::BinarySearch(1, 3);
|
||||
assert!(handle_ancestor_search_state(&state, 2, true).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sync_restart_removes_block_but_not_justification_requests() {
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let mut sync = ChainSync::new(ChainSyncMode::Full, client.clone(), 1, 64, None).unwrap();
|
||||
|
||||
let peers = vec![PeerId::random(), PeerId::random()];
|
||||
|
||||
let mut new_blocks = |n| {
|
||||
for _ in 0..n {
|
||||
let block = BlockBuilderBuilder::new(&*client)
|
||||
.on_parent_block(client.chain_info().best_hash)
|
||||
.with_parent_block_number(client.chain_info().best_number)
|
||||
.build()
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap()
|
||||
.block;
|
||||
block_on(client.import(BlockOrigin::Own, block.clone())).unwrap();
|
||||
}
|
||||
|
||||
let info = client.info();
|
||||
(info.best_hash, info.best_number)
|
||||
};
|
||||
|
||||
let (b1_hash, b1_number) = new_blocks(50);
|
||||
|
||||
// add new peer and request blocks from them
|
||||
sync.add_peer(peers[0], Hash::random(), 42);
|
||||
|
||||
// we don't actually perform any requests, just keep track of peers waiting for a response
|
||||
let mut pending_responses = HashSet::new();
|
||||
|
||||
// we wil send block requests to these peers
|
||||
// for these blocks we don't know about
|
||||
for (peer, _request) in sync.block_requests() {
|
||||
// "send" request
|
||||
pending_responses.insert(peer);
|
||||
}
|
||||
|
||||
// add a new peer at a known block
|
||||
sync.add_peer(peers[1], b1_hash, b1_number);
|
||||
|
||||
// we request a justification for a block we have locally
|
||||
sync.request_justification(&b1_hash, b1_number);
|
||||
|
||||
// the justification request should be scheduled to the
|
||||
// new peer which is at the given block
|
||||
let mut requests = sync.justification_requests();
|
||||
assert_eq!(requests.len(), 1);
|
||||
let (peer, _request) = requests.remove(0);
|
||||
// "send" request
|
||||
assert!(pending_responses.insert(peer));
|
||||
|
||||
assert!(!std::matches!(
|
||||
sync.peers.get(&peers[0]).unwrap().state,
|
||||
PeerSyncState::DownloadingJustification(_),
|
||||
));
|
||||
assert_eq!(
|
||||
sync.peers.get(&peers[1]).unwrap().state,
|
||||
PeerSyncState::DownloadingJustification(b1_hash),
|
||||
);
|
||||
assert_eq!(pending_responses.len(), 2);
|
||||
|
||||
// discard old actions
|
||||
let _ = sync.take_actions();
|
||||
|
||||
// restart sync
|
||||
sync.restart();
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
for action in actions.iter() {
|
||||
match action {
|
||||
ChainSyncAction::CancelBlockRequest { peer_id } => {
|
||||
pending_responses.remove(&peer_id);
|
||||
},
|
||||
ChainSyncAction::SendBlockRequest { peer_id, .. } => {
|
||||
// we drop obsolete response, but don't register a new request, it's checked in
|
||||
// the `assert!` below
|
||||
pending_responses.remove(&peer_id);
|
||||
},
|
||||
action @ _ => panic!("Unexpected action: {action:?}"),
|
||||
}
|
||||
}
|
||||
assert!(actions.iter().any(|action| {
|
||||
match action {
|
||||
ChainSyncAction::SendBlockRequest { peer_id, .. } => peer_id == &peers[0],
|
||||
_ => false,
|
||||
}
|
||||
}));
|
||||
|
||||
assert_eq!(pending_responses.len(), 1);
|
||||
assert!(pending_responses.contains(&peers[1]));
|
||||
assert_eq!(
|
||||
sync.peers.get(&peers[1]).unwrap().state,
|
||||
PeerSyncState::DownloadingJustification(b1_hash),
|
||||
);
|
||||
let _ = sync.remove_peer(&peers[1]);
|
||||
pending_responses.remove(&peers[1]);
|
||||
assert_eq!(pending_responses.len(), 0);
|
||||
}
|
||||
|
||||
/// The test demonstrates https://github.com/paritytech/polkadot-sdk/issues/2094.
|
||||
/// TODO: convert it into desired behavior test once the issue is fixed (see inline comments).
|
||||
/// The issue: we currently rely on block numbers instead of block hash
|
||||
/// to download blocks from peers. As a result, we can end up with blocks
|
||||
/// from different forks as shown by the test.
|
||||
#[test]
|
||||
#[should_panic]
|
||||
fn request_across_forks() {
|
||||
sp_tracing::try_init_simple();
|
||||
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let blocks = (0..100).map(|_| build_block(&mut client, None, false)).collect::<Vec<_>>();
|
||||
|
||||
let fork_a_blocks = {
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let mut fork_blocks = blocks[..]
|
||||
.into_iter()
|
||||
.inspect(|b| {
|
||||
assert!(matches!(client.block(*b.header.parent_hash()), Ok(Some(_))));
|
||||
block_on(client.import(BlockOrigin::Own, (*b).clone())).unwrap()
|
||||
})
|
||||
.cloned()
|
||||
.collect::<Vec<_>>();
|
||||
for _ in 0..10 {
|
||||
fork_blocks.push(build_block(&mut client, None, false));
|
||||
}
|
||||
fork_blocks
|
||||
};
|
||||
|
||||
let fork_b_blocks = {
|
||||
let mut client = Arc::new(TestClientBuilder::new().build());
|
||||
let mut fork_blocks = blocks[..]
|
||||
.into_iter()
|
||||
.inspect(|b| {
|
||||
assert!(matches!(client.block(*b.header.parent_hash()), Ok(Some(_))));
|
||||
block_on(client.import(BlockOrigin::Own, (*b).clone())).unwrap()
|
||||
})
|
||||
.cloned()
|
||||
.collect::<Vec<_>>();
|
||||
for _ in 0..10 {
|
||||
fork_blocks.push(build_block(&mut client, None, true));
|
||||
}
|
||||
fork_blocks
|
||||
};
|
||||
|
||||
let mut sync = ChainSync::new(ChainSyncMode::Full, client.clone(), 5, 64, None).unwrap();
|
||||
|
||||
// Add the peers, all at the common ancestor 100.
|
||||
let common_block = blocks.last().unwrap();
|
||||
let peer_id1 = PeerId::random();
|
||||
sync.add_peer(peer_id1, common_block.hash(), *common_block.header().number());
|
||||
let peer_id2 = PeerId::random();
|
||||
sync.add_peer(peer_id2, common_block.hash(), *common_block.header().number());
|
||||
|
||||
// Peer 1 announces 107 from fork 1, 100-107 get downloaded.
|
||||
{
|
||||
let block = (&fork_a_blocks[106]).clone();
|
||||
let peer = peer_id1;
|
||||
log::trace!(target: LOG_TARGET, "<1> {peer} announces from fork 1");
|
||||
send_block_announce(block.header().clone(), peer, &mut sync);
|
||||
let request = get_block_request(&mut sync, FromBlock::Hash(block.hash()), 7, &peer);
|
||||
let mut resp_blocks = fork_a_blocks[100_usize..107_usize].to_vec();
|
||||
resp_blocks.reverse();
|
||||
let response = create_block_response(resp_blocks.clone());
|
||||
|
||||
// Drop old actions
|
||||
let _ = sync.take_actions();
|
||||
|
||||
sync.on_block_data(&peer, Some(request), response).unwrap();
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
assert_eq!(actions.len(), 1);
|
||||
assert!(matches!(
|
||||
&actions[0],
|
||||
ChainSyncAction::ImportBlocks{ origin: _, blocks } if blocks.len() == 7_usize
|
||||
));
|
||||
assert_eq!(sync.best_queued_number, 107);
|
||||
assert_eq!(sync.best_queued_hash, block.hash());
|
||||
assert!(sync.is_known(&block.header.parent_hash()));
|
||||
}
|
||||
|
||||
// Peer 2 also announces 107 from fork 1.
|
||||
{
|
||||
let prev_best_number = sync.best_queued_number;
|
||||
let prev_best_hash = sync.best_queued_hash;
|
||||
let peer = peer_id2;
|
||||
log::trace!(target: LOG_TARGET, "<2> {peer} announces from fork 1");
|
||||
for i in 100..107 {
|
||||
let block = (&fork_a_blocks[i]).clone();
|
||||
send_block_announce(block.header().clone(), peer, &mut sync);
|
||||
assert!(sync.block_requests().is_empty());
|
||||
}
|
||||
assert_eq!(sync.best_queued_number, prev_best_number);
|
||||
assert_eq!(sync.best_queued_hash, prev_best_hash);
|
||||
}
|
||||
|
||||
// Peer 2 undergoes reorg, announces 108 from fork 2, gets downloaded even though we
|
||||
// don't have the parent from fork 2.
|
||||
{
|
||||
let block = (&fork_b_blocks[107]).clone();
|
||||
let peer = peer_id2;
|
||||
log::trace!(target: LOG_TARGET, "<3> {peer} announces from fork 2");
|
||||
send_block_announce(block.header().clone(), peer, &mut sync);
|
||||
// TODO: when the issue is fixed, this test can be changed to test the
|
||||
// expected behavior instead. The needed changes would be:
|
||||
// 1. Remove the `#[should_panic]` directive
|
||||
// 2. These should be changed to check that sync.block_requests().is_empty(), after the
|
||||
// block is announced.
|
||||
let request = get_block_request(&mut sync, FromBlock::Hash(block.hash()), 1, &peer);
|
||||
let response = create_block_response(vec![block.clone()]);
|
||||
|
||||
// Drop old actions we are not going to check
|
||||
let _ = sync.take_actions();
|
||||
|
||||
sync.on_block_data(&peer, Some(request), response).unwrap();
|
||||
let actions = sync.take_actions().collect::<Vec<_>>();
|
||||
assert_eq!(actions.len(), 1);
|
||||
assert!(matches!(
|
||||
&actions[0],
|
||||
ChainSyncAction::ImportBlocks{ origin: _, blocks } if blocks.len() == 1_usize
|
||||
));
|
||||
assert!(sync.is_known(&block.header.parent_hash()));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user