mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-30 22:11:02 +00:00
Basic tests for sync loop (#182)
* basic sync loop tests * cargo ftm --all * SyncLoopTestParams * move sync loop tests to sync_loop_tests.rs * cargo fmt --all
This commit is contained in:
committed by
Bastian Köcher
parent
ae8c82f0e7
commit
83a3fca5cf
@@ -204,6 +204,7 @@ pub fn run(params: EthereumSyncParams) -> Result<(), RpcError> {
|
|||||||
target,
|
target,
|
||||||
SUBSTRATE_TICK_INTERVAL,
|
SUBSTRATE_TICK_INTERVAL,
|
||||||
params.sync_params,
|
params.sync_params,
|
||||||
|
futures::future::pending(),
|
||||||
);
|
);
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ mod substrate_sync_loop;
|
|||||||
mod substrate_types;
|
mod substrate_types;
|
||||||
mod sync;
|
mod sync;
|
||||||
mod sync_loop;
|
mod sync_loop;
|
||||||
|
mod sync_loop_tests;
|
||||||
mod sync_types;
|
mod sync_types;
|
||||||
mod utils;
|
mod utils;
|
||||||
|
|
||||||
|
|||||||
@@ -209,6 +209,7 @@ pub fn run(params: SubstrateSyncParams) -> Result<(), RpcError> {
|
|||||||
target,
|
target,
|
||||||
ETHEREUM_TICK_INTERVAL,
|
ETHEREUM_TICK_INTERVAL,
|
||||||
params.sync_params,
|
params.sync_params,
|
||||||
|
futures::future::pending(),
|
||||||
);
|
);
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
|
|
||||||
use crate::headers::QueuedHeaders;
|
use crate::headers::QueuedHeaders;
|
||||||
use crate::sync_types::{HeaderId, HeaderStatus, HeadersSyncPipeline, QueuedHeader};
|
use crate::sync_types::{HeaderId, HeaderStatus, HeadersSyncPipeline, QueuedHeader};
|
||||||
use num_traits::{One, Saturating};
|
use num_traits::{One, Saturating, Zero};
|
||||||
|
|
||||||
/// Common sync params.
|
/// Common sync params.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
@@ -112,12 +112,19 @@ impl<P: HeadersSyncPipeline> HeadersSync<P> {
|
|||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// if queue is empty and best header on target is > than best header on source,
|
||||||
|
// then we shoud reorg
|
||||||
|
let best_queued_number = self.headers.best_queued_number();
|
||||||
|
if best_queued_number.is_zero() && source_best_number < target_best_header.0 {
|
||||||
|
return Some(source_best_number);
|
||||||
|
}
|
||||||
|
|
||||||
// we assume that there were no reorgs if we have already downloaded best header
|
// we assume that there were no reorgs if we have already downloaded best header
|
||||||
let best_downloaded_number = std::cmp::max(
|
let best_downloaded_number = std::cmp::max(
|
||||||
std::cmp::max(self.headers.best_queued_number(), self.headers.best_synced_number()),
|
std::cmp::max(best_queued_number, self.headers.best_synced_number()),
|
||||||
target_best_header.0,
|
target_best_header.0,
|
||||||
);
|
);
|
||||||
if best_downloaded_number == source_best_number {
|
if best_downloaded_number >= source_best_number {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -125,6 +132,21 @@ impl<P: HeadersSyncPipeline> HeadersSync<P> {
|
|||||||
Some(best_downloaded_number + One::one())
|
Some(best_downloaded_number + One::one())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Selech orphan header to downoload.
|
||||||
|
pub fn select_orphan_header_to_download(&self) -> Option<&QueuedHeader<P>> {
|
||||||
|
let orphan_header = self.headers.header(HeaderStatus::Orphan)?;
|
||||||
|
|
||||||
|
// we consider header orphan until we'll find it ancestor that is known to the target node
|
||||||
|
// => we may get orphan header while we ask target node whether it knows its parent
|
||||||
|
// => let's avoid fetching duplicate headers
|
||||||
|
let parent_id = orphan_header.parent_id();
|
||||||
|
if self.headers.status(&parent_id) != HeaderStatus::Unknown {
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
|
||||||
|
Some(orphan_header)
|
||||||
|
}
|
||||||
|
|
||||||
/// Select headers that need to be submitted to the target node.
|
/// Select headers that need to be submitted to the target node.
|
||||||
pub fn select_headers_to_submit(&self, stalled: bool) -> Option<Vec<&QueuedHeader<P>>> {
|
pub fn select_headers_to_submit(&self, stalled: bool) -> Option<Vec<&QueuedHeader<P>>> {
|
||||||
// if we operate in backup mode, we only submit headers when sync has stalled
|
// if we operate in backup mode, we only submit headers when sync has stalled
|
||||||
@@ -208,7 +230,7 @@ impl<P: HeadersSyncPipeline> HeadersSync<P> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
pub mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
use crate::ethereum_types::{EthereumHeadersSyncPipeline, H256};
|
use crate::ethereum_types::{EthereumHeadersSyncPipeline, H256};
|
||||||
use crate::headers::tests::{header, id};
|
use crate::headers::tests::{header, id};
|
||||||
@@ -218,7 +240,7 @@ mod tests {
|
|||||||
H256::from_low_u64_le(1000 + number)
|
H256::from_low_u64_le(1000 + number)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn default_sync_params() -> HeadersSyncParams {
|
pub fn default_sync_params() -> HeadersSyncParams {
|
||||||
HeadersSyncParams {
|
HeadersSyncParams {
|
||||||
max_future_headers_to_download: 128,
|
max_future_headers_to_download: 128,
|
||||||
max_headers_in_submitted_status: 128,
|
max_headers_in_submitted_status: 128,
|
||||||
@@ -253,6 +275,11 @@ mod tests {
|
|||||||
eth_sync.source_best_number = Some(101);
|
eth_sync.source_best_number = Some(101);
|
||||||
assert_eq!(eth_sync.select_new_header_to_download(), Some(101));
|
assert_eq!(eth_sync.select_new_header_to_download(), Some(101));
|
||||||
|
|
||||||
|
// when we have to reorganize to longer fork
|
||||||
|
eth_sync.source_best_number = Some(100);
|
||||||
|
eth_sync.target_best_header = Some(HeaderId(200, Default::default()));
|
||||||
|
assert_eq!(eth_sync.select_new_header_to_download(), Some(100));
|
||||||
|
|
||||||
// when there are too many headers scheduled for submitting
|
// when there are too many headers scheduled for submitting
|
||||||
for i in 1..1000 {
|
for i in 1..1000 {
|
||||||
eth_sync.headers.header_response(header(i).header().clone());
|
eth_sync.headers.header_response(header(i).header().clone());
|
||||||
@@ -356,6 +383,11 @@ mod tests {
|
|||||||
assert_eq!(eth_sync.headers.header(HeaderStatus::Orphan), Some(&header(101)));
|
assert_eq!(eth_sync.headers.header(HeaderStatus::Orphan), Some(&header(101)));
|
||||||
eth_sync.headers.header_response(header(100).header().clone());
|
eth_sync.headers.header_response(header(100).header().clone());
|
||||||
|
|
||||||
|
// #101 is now Orphan and #100 is MaybeOrphan => we do not want to retrieve
|
||||||
|
// header #100 again
|
||||||
|
assert_eq!(eth_sync.headers.header(HeaderStatus::Orphan), Some(&header(101)));
|
||||||
|
assert_eq!(eth_sync.select_orphan_header_to_download(), None);
|
||||||
|
|
||||||
// we can't submit header #100, because its parent status is unknown
|
// we can't submit header #100, because its parent status is unknown
|
||||||
assert_eq!(eth_sync.select_headers_to_submit(false), None);
|
assert_eq!(eth_sync.select_headers_to_submit(false), None);
|
||||||
|
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ use futures::{future::FutureExt, stream::StreamExt};
|
|||||||
use num_traits::{Saturating, Zero};
|
use num_traits::{Saturating, Zero};
|
||||||
use std::{
|
use std::{
|
||||||
collections::HashSet,
|
collections::HashSet,
|
||||||
|
future::Future,
|
||||||
time::{Duration, Instant},
|
time::{Duration, Instant},
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -123,6 +124,7 @@ pub fn run<P: HeadersSyncPipeline, TC: TargetClient<P>>(
|
|||||||
target_client: TC,
|
target_client: TC,
|
||||||
target_tick: Duration,
|
target_tick: Duration,
|
||||||
sync_params: HeadersSyncParams,
|
sync_params: HeadersSyncParams,
|
||||||
|
exit_signal: impl Future<Output = ()>,
|
||||||
) {
|
) {
|
||||||
let mut local_pool = futures::executor::LocalPool::new();
|
let mut local_pool = futures::executor::LocalPool::new();
|
||||||
let mut progress_context = (Instant::now(), None, None);
|
let mut progress_context = (Instant::now(), None, None);
|
||||||
@@ -156,6 +158,8 @@ pub fn run<P: HeadersSyncPipeline, TC: TargetClient<P>>(
|
|||||||
let target_go_offline_future = futures::future::Fuse::terminated();
|
let target_go_offline_future = futures::future::Fuse::terminated();
|
||||||
let target_tick_stream = interval(target_tick).fuse();
|
let target_tick_stream = interval(target_tick).fuse();
|
||||||
|
|
||||||
|
let exit_signal = exit_signal.fuse();
|
||||||
|
|
||||||
futures::pin_mut!(
|
futures::pin_mut!(
|
||||||
source_best_block_number_future,
|
source_best_block_number_future,
|
||||||
source_new_header_future,
|
source_new_header_future,
|
||||||
@@ -171,7 +175,8 @@ pub fn run<P: HeadersSyncPipeline, TC: TargetClient<P>>(
|
|||||||
target_submit_header_future,
|
target_submit_header_future,
|
||||||
target_complete_header_future,
|
target_complete_header_future,
|
||||||
target_go_offline_future,
|
target_go_offline_future,
|
||||||
target_tick_stream
|
target_tick_stream,
|
||||||
|
exit_signal
|
||||||
);
|
);
|
||||||
|
|
||||||
loop {
|
loop {
|
||||||
@@ -350,6 +355,10 @@ pub fn run<P: HeadersSyncPipeline, TC: TargetClient<P>>(
|
|||||||
target_best_block_required = true;
|
target_best_block_required = true;
|
||||||
target_incomplete_headers_required = true;
|
target_incomplete_headers_required = true;
|
||||||
},
|
},
|
||||||
|
|
||||||
|
_ = exit_signal => {
|
||||||
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// print progress
|
// print progress
|
||||||
@@ -491,7 +500,7 @@ pub fn run<P: HeadersSyncPipeline, TC: TargetClient<P>>(
|
|||||||
id,
|
id,
|
||||||
);
|
);
|
||||||
source_extra_future.set(source_client.header_extra(id, header.clone()).fuse());
|
source_extra_future.set(source_client.header_extra(id, header.clone()).fuse());
|
||||||
} else if let Some(header) = sync.headers().header(HeaderStatus::Orphan) {
|
} else if let Some(header) = sync.select_orphan_header_to_download() {
|
||||||
// for Orphan we actually ask for parent' header
|
// for Orphan we actually ask for parent' header
|
||||||
let parent_id = header.parent_id();
|
let parent_id = header.parent_id();
|
||||||
|
|
||||||
@@ -540,7 +549,7 @@ fn interval(timeout: Duration) -> impl futures::Stream<Item = ()> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Exponential backoff for connection-unrelated errors retries.
|
/// Exponential backoff for connection-unrelated errors retries.
|
||||||
fn retry_backoff() -> ExponentialBackoff {
|
pub(crate) fn retry_backoff() -> ExponentialBackoff {
|
||||||
let mut backoff = ExponentialBackoff::default();
|
let mut backoff = ExponentialBackoff::default();
|
||||||
// we do not want relayer to stop
|
// we do not want relayer to stop
|
||||||
backoff.max_elapsed_time = None;
|
backoff.max_elapsed_time = None;
|
||||||
@@ -553,7 +562,7 @@ fn retry_backoff() -> ExponentialBackoff {
|
|||||||
/// Returns whether or not the client we're interacting with is online. In this context
|
/// Returns whether or not the client we're interacting with is online. In this context
|
||||||
/// what online means is that the client is currently not handling any other requests
|
/// what online means is that the client is currently not handling any other requests
|
||||||
/// that we've previously sent.
|
/// that we've previously sent.
|
||||||
fn process_future_result<TResult, TError, TGoOfflineFuture>(
|
pub(crate) fn process_future_result<TResult, TError, TGoOfflineFuture>(
|
||||||
result: Result<TResult, TError>,
|
result: Result<TResult, TError>,
|
||||||
retry_backoff: &mut ExponentialBackoff,
|
retry_backoff: &mut ExponentialBackoff,
|
||||||
on_success: impl FnOnce(TResult),
|
on_success: impl FnOnce(TResult),
|
||||||
@@ -624,62 +633,3 @@ fn print_sync_progress<P: HeadersSyncPipeline>(
|
|||||||
);
|
);
|
||||||
(now_time, now_best_header.clone().map(|id| id.0), *now_target_header)
|
(now_time, now_best_header.clone().map(|id| id.0), *now_target_header)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
struct TestError(bool);
|
|
||||||
|
|
||||||
impl MaybeConnectionError for TestError {
|
|
||||||
fn is_connection_error(&self) -> bool {
|
|
||||||
self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn run_backoff_test(result: Result<(), TestError>) -> (Duration, Duration) {
|
|
||||||
let mut backoff = retry_backoff();
|
|
||||||
|
|
||||||
// no randomness in tests (otherwise intervals may overlap => asserts are failing)
|
|
||||||
backoff.randomization_factor = 0f64;
|
|
||||||
|
|
||||||
// increase backoff's current interval
|
|
||||||
let interval1 = backoff.next_backoff().unwrap();
|
|
||||||
let interval2 = backoff.next_backoff().unwrap();
|
|
||||||
assert!(interval2 > interval1);
|
|
||||||
|
|
||||||
// successful future result leads to backoff's reset
|
|
||||||
let go_offline_future = futures::future::Fuse::terminated();
|
|
||||||
futures::pin_mut!(go_offline_future);
|
|
||||||
|
|
||||||
process_future_result(
|
|
||||||
result,
|
|
||||||
&mut backoff,
|
|
||||||
|_| {},
|
|
||||||
&mut go_offline_future,
|
|
||||||
|delay| async_std::task::sleep(delay),
|
|
||||||
|| "Test error".into(),
|
|
||||||
);
|
|
||||||
|
|
||||||
(interval2, backoff.next_backoff().unwrap())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn process_future_result_resets_backoff_on_success() {
|
|
||||||
let (interval2, interval_after_reset) = run_backoff_test(Ok(()));
|
|
||||||
assert!(interval2 > interval_after_reset);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn process_future_result_resets_backoff_on_connection_error() {
|
|
||||||
let (interval2, interval_after_reset) = run_backoff_test(Err(TestError(true)));
|
|
||||||
assert!(interval2 > interval_after_reset);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn process_future_result_does_not_reset_backoff_on_non_connection_error() {
|
|
||||||
let (interval2, interval_after_reset) = run_backoff_test(Err(TestError(false)));
|
|
||||||
assert!(interval2 < interval_after_reset);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -0,0 +1,573 @@
|
|||||||
|
// Copyright 2019-2020 Parity Technologies (UK) Ltd.
|
||||||
|
// This file is part of Parity Bridges Common.
|
||||||
|
|
||||||
|
// Parity Bridges Common 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.
|
||||||
|
|
||||||
|
// Parity Bridges Common 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 Parity Bridges Common. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
#![cfg(test)]
|
||||||
|
|
||||||
|
use crate::sync_loop::{process_future_result, retry_backoff, run, SourceClient, TargetClient};
|
||||||
|
use crate::sync_types::{
|
||||||
|
HeaderId, HeadersSyncPipeline, MaybeConnectionError, QueuedHeader, SourceHeader, SubmittedHeaders,
|
||||||
|
};
|
||||||
|
|
||||||
|
use async_trait::async_trait;
|
||||||
|
use backoff::backoff::Backoff;
|
||||||
|
use futures::{future::FutureExt, stream::StreamExt};
|
||||||
|
use parking_lot::Mutex;
|
||||||
|
use std::{
|
||||||
|
collections::{HashMap, HashSet},
|
||||||
|
sync::Arc,
|
||||||
|
time::Duration,
|
||||||
|
};
|
||||||
|
|
||||||
|
type TestNumber = u64;
|
||||||
|
type TestHash = u64;
|
||||||
|
type TestExtra = u64;
|
||||||
|
type TestCompletion = u64;
|
||||||
|
type TestHeaderId = HeaderId<TestHash, TestNumber>;
|
||||||
|
type TestQueuedHeader = QueuedHeader<TestHeadersSyncPipeline>;
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq)]
|
||||||
|
struct TestHeader {
|
||||||
|
hash: TestHash,
|
||||||
|
number: TestNumber,
|
||||||
|
parent_hash: TestHash,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl SourceHeader<TestHash, TestNumber> for TestHeader {
|
||||||
|
fn id(&self) -> TestHeaderId {
|
||||||
|
HeaderId(self.number, self.hash)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parent_id(&self) -> TestHeaderId {
|
||||||
|
HeaderId(self.number - 1, self.parent_hash)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
struct TestError(bool);
|
||||||
|
|
||||||
|
impl MaybeConnectionError for TestError {
|
||||||
|
fn is_connection_error(&self) -> bool {
|
||||||
|
self.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy)]
|
||||||
|
struct TestHeadersSyncPipeline;
|
||||||
|
|
||||||
|
impl HeadersSyncPipeline for TestHeadersSyncPipeline {
|
||||||
|
const SOURCE_NAME: &'static str = "Source";
|
||||||
|
const TARGET_NAME: &'static str = "Target";
|
||||||
|
|
||||||
|
type Hash = TestHash;
|
||||||
|
type Number = TestNumber;
|
||||||
|
type Header = TestHeader;
|
||||||
|
type Extra = TestExtra;
|
||||||
|
type Completion = TestCompletion;
|
||||||
|
|
||||||
|
fn estimate_size(_: &TestQueuedHeader) -> usize {
|
||||||
|
0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
enum SourceMethod {
|
||||||
|
BestBlockNumber,
|
||||||
|
HeaderByHash(TestHash),
|
||||||
|
HeaderByNumber(TestNumber),
|
||||||
|
HeaderCompletion(TestHeaderId),
|
||||||
|
HeaderExtra(TestHeaderId, TestQueuedHeader),
|
||||||
|
}
|
||||||
|
|
||||||
|
struct Source {
|
||||||
|
data: Mutex<SourceData>,
|
||||||
|
on_method_call: Arc<dyn Fn(SourceMethod, &mut SourceData) + Send + Sync>,
|
||||||
|
}
|
||||||
|
|
||||||
|
struct SourceData {
|
||||||
|
best_block_number: Result<TestNumber, TestError>,
|
||||||
|
header_by_hash: HashMap<TestHash, TestHeader>,
|
||||||
|
header_by_number: HashMap<TestNumber, TestHeader>,
|
||||||
|
provides_completion: bool,
|
||||||
|
provides_extra: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Source {
|
||||||
|
pub fn new(
|
||||||
|
best_block_id: TestHeaderId,
|
||||||
|
headers: Vec<(bool, TestHeader)>,
|
||||||
|
on_method_call: impl Fn(SourceMethod, &mut SourceData) + Send + Sync + 'static,
|
||||||
|
) -> Self {
|
||||||
|
Source {
|
||||||
|
data: Mutex::new(SourceData {
|
||||||
|
best_block_number: Ok(best_block_id.0),
|
||||||
|
header_by_hash: headers
|
||||||
|
.iter()
|
||||||
|
.map(|(_, header)| (header.hash, header.clone()))
|
||||||
|
.collect(),
|
||||||
|
header_by_number: headers
|
||||||
|
.iter()
|
||||||
|
.filter_map(|(is_canonical, header)| {
|
||||||
|
if *is_canonical {
|
||||||
|
Some((header.hash, header.clone()))
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.collect(),
|
||||||
|
provides_completion: true,
|
||||||
|
provides_extra: true,
|
||||||
|
}),
|
||||||
|
on_method_call: Arc::new(on_method_call),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
impl SourceClient<TestHeadersSyncPipeline> for Source {
|
||||||
|
type Error = TestError;
|
||||||
|
|
||||||
|
async fn best_block_number(&self) -> Result<TestNumber, Self::Error> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(SourceMethod::BestBlockNumber, &mut *data);
|
||||||
|
data.best_block_number.clone()
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn header_by_hash(&self, hash: TestHash) -> Result<TestHeader, Self::Error> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(SourceMethod::HeaderByHash(hash), &mut *data);
|
||||||
|
data.header_by_hash.get(&hash).cloned().ok_or(TestError(false))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn header_by_number(&self, number: TestNumber) -> Result<TestHeader, Self::Error> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(SourceMethod::HeaderByNumber(number), &mut *data);
|
||||||
|
data.header_by_number.get(&number).cloned().ok_or(TestError(false))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn header_completion(&self, id: TestHeaderId) -> Result<(TestHeaderId, Option<TestCompletion>), Self::Error> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(SourceMethod::HeaderCompletion(id), &mut *data);
|
||||||
|
if data.provides_completion {
|
||||||
|
Ok((id, Some(test_completion(id))))
|
||||||
|
} else {
|
||||||
|
Ok((id, None))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn header_extra(
|
||||||
|
&self,
|
||||||
|
id: TestHeaderId,
|
||||||
|
header: TestQueuedHeader,
|
||||||
|
) -> Result<(TestHeaderId, TestExtra), Self::Error> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(SourceMethod::HeaderExtra(id, header), &mut *data);
|
||||||
|
if data.provides_extra {
|
||||||
|
Ok((id, test_extra(id)))
|
||||||
|
} else {
|
||||||
|
Err(TestError(false))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
enum TargetMethod {
|
||||||
|
BestHeaderId,
|
||||||
|
IsKnownHeader(TestHeaderId),
|
||||||
|
SubmitHeaders(Vec<TestQueuedHeader>),
|
||||||
|
IncompleteHeadersIds,
|
||||||
|
CompleteHeader(TestHeaderId, TestCompletion),
|
||||||
|
RequiresExtra(TestQueuedHeader),
|
||||||
|
}
|
||||||
|
|
||||||
|
struct Target {
|
||||||
|
data: Mutex<TargetData>,
|
||||||
|
on_method_call: Arc<dyn Fn(TargetMethod, &mut TargetData) + Send + Sync>,
|
||||||
|
}
|
||||||
|
|
||||||
|
struct TargetData {
|
||||||
|
best_header_id: Result<TestHeaderId, TestError>,
|
||||||
|
is_known_header_by_hash: HashMap<TestHash, bool>,
|
||||||
|
submitted_headers: HashMap<TestHash, TestQueuedHeader>,
|
||||||
|
submit_headers_result: Option<SubmittedHeaders<TestHeaderId, TestError>>,
|
||||||
|
completed_headers: HashMap<TestHash, TestCompletion>,
|
||||||
|
requires_completion: bool,
|
||||||
|
requires_extra: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Target {
|
||||||
|
pub fn new(
|
||||||
|
best_header_id: TestHeaderId,
|
||||||
|
headers: Vec<TestHeaderId>,
|
||||||
|
on_method_call: impl Fn(TargetMethod, &mut TargetData) + Send + Sync + 'static,
|
||||||
|
) -> Self {
|
||||||
|
Target {
|
||||||
|
data: Mutex::new(TargetData {
|
||||||
|
best_header_id: Ok(best_header_id),
|
||||||
|
is_known_header_by_hash: headers.iter().map(|header| (header.1, true)).collect(),
|
||||||
|
submitted_headers: HashMap::new(),
|
||||||
|
submit_headers_result: None,
|
||||||
|
completed_headers: HashMap::new(),
|
||||||
|
requires_completion: false,
|
||||||
|
requires_extra: false,
|
||||||
|
}),
|
||||||
|
on_method_call: Arc::new(on_method_call),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
impl TargetClient<TestHeadersSyncPipeline> for Target {
|
||||||
|
type Error = TestError;
|
||||||
|
|
||||||
|
async fn best_header_id(&self) -> Result<TestHeaderId, TestError> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(TargetMethod::BestHeaderId, &mut *data);
|
||||||
|
data.best_header_id.clone()
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn is_known_header(&self, id: TestHeaderId) -> Result<(TestHeaderId, bool), TestError> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(TargetMethod::IsKnownHeader(id), &mut *data);
|
||||||
|
data.is_known_header_by_hash
|
||||||
|
.get(&id.1)
|
||||||
|
.cloned()
|
||||||
|
.map(|is_known_header| Ok((id, is_known_header)))
|
||||||
|
.unwrap_or(Ok((id, false)))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn submit_headers(&self, headers: Vec<TestQueuedHeader>) -> SubmittedHeaders<TestHeaderId, TestError> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(TargetMethod::SubmitHeaders(headers.clone()), &mut *data);
|
||||||
|
data.submitted_headers
|
||||||
|
.extend(headers.iter().map(|header| (header.id().1, header.clone())));
|
||||||
|
data.submit_headers_result.take().expect("test must accept headers")
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn incomplete_headers_ids(&self) -> Result<HashSet<TestHeaderId>, TestError> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(TargetMethod::IncompleteHeadersIds, &mut *data);
|
||||||
|
if data.requires_completion {
|
||||||
|
Ok(data
|
||||||
|
.submitted_headers
|
||||||
|
.iter()
|
||||||
|
.filter(|(hash, _)| !data.completed_headers.contains_key(hash))
|
||||||
|
.map(|(_, header)| header.id())
|
||||||
|
.collect())
|
||||||
|
} else {
|
||||||
|
Ok(HashSet::new())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn complete_header(&self, id: TestHeaderId, completion: TestCompletion) -> Result<TestHeaderId, TestError> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(TargetMethod::CompleteHeader(id, completion), &mut *data);
|
||||||
|
data.completed_headers.insert(id.1, completion);
|
||||||
|
Ok(id)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn requires_extra(&self, header: TestQueuedHeader) -> Result<(TestHeaderId, bool), TestError> {
|
||||||
|
let mut data = self.data.lock();
|
||||||
|
(self.on_method_call)(TargetMethod::RequiresExtra(header.clone()), &mut *data);
|
||||||
|
if data.requires_extra {
|
||||||
|
Ok((header.id(), true))
|
||||||
|
} else {
|
||||||
|
Ok((header.id(), false))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_tick() -> Duration {
|
||||||
|
// in ideal world that should have been Duration::from_millis(0), because we do not want
|
||||||
|
// to sleep in tests at all, but that could lead to `select! {}` always waking on tick
|
||||||
|
// => not doing actual job
|
||||||
|
Duration::from_millis(10)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_id(number: TestNumber) -> TestHeaderId {
|
||||||
|
HeaderId(number, number)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_header(number: TestNumber) -> TestHeader {
|
||||||
|
let id = test_id(number);
|
||||||
|
TestHeader {
|
||||||
|
hash: id.1,
|
||||||
|
number: id.0,
|
||||||
|
parent_hash: if number == 0 {
|
||||||
|
TestHash::default()
|
||||||
|
} else {
|
||||||
|
test_id(number - 1).1
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_forked_id(number: TestNumber, forked_from: TestNumber) -> TestHeaderId {
|
||||||
|
const FORK_OFFSET: TestNumber = 1000;
|
||||||
|
|
||||||
|
if number == forked_from {
|
||||||
|
HeaderId(number, number)
|
||||||
|
} else {
|
||||||
|
HeaderId(number, FORK_OFFSET + number)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_forked_header(number: TestNumber, forked_from: TestNumber) -> TestHeader {
|
||||||
|
let id = test_forked_id(number, forked_from);
|
||||||
|
TestHeader {
|
||||||
|
hash: id.1,
|
||||||
|
number: id.0,
|
||||||
|
parent_hash: if number == 0 {
|
||||||
|
TestHash::default()
|
||||||
|
} else {
|
||||||
|
test_forked_id(number - 1, forked_from).1
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_completion(id: TestHeaderId) -> TestCompletion {
|
||||||
|
id.0
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_extra(id: TestHeaderId) -> TestExtra {
|
||||||
|
id.0
|
||||||
|
}
|
||||||
|
|
||||||
|
fn source_reject_completion(method: &SourceMethod) {
|
||||||
|
if let SourceMethod::HeaderCompletion(_) = method {
|
||||||
|
unreachable!("HeaderCompletion request is not expected")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn source_reject_extra(method: &SourceMethod) {
|
||||||
|
if let SourceMethod::HeaderExtra(_, _) = method {
|
||||||
|
unreachable!("HeaderExtra request is not expected")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn target_accept_all_headers(method: &TargetMethod, data: &mut TargetData, requires_extra: bool) {
|
||||||
|
if let TargetMethod::SubmitHeaders(ref submitted) = method {
|
||||||
|
assert_eq!(submitted.iter().all(|header| header.extra().is_some()), requires_extra,);
|
||||||
|
|
||||||
|
let mut submitted_headers = SubmittedHeaders::default();
|
||||||
|
submitted_headers.submitted = submitted.iter().map(|header| header.id()).collect();
|
||||||
|
data.submit_headers_result = Some(submitted_headers);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn target_signal_exit_when_header_submitted(
|
||||||
|
method: &TargetMethod,
|
||||||
|
header_id: TestHeaderId,
|
||||||
|
exit_signal: &futures::channel::mpsc::UnboundedSender<()>,
|
||||||
|
) {
|
||||||
|
if let TargetMethod::SubmitHeaders(ref submitted) = method {
|
||||||
|
if submitted.iter().any(|header| header.id() == header_id) {
|
||||||
|
exit_signal.unbounded_send(()).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn target_signal_exit_when_header_completed(
|
||||||
|
method: &TargetMethod,
|
||||||
|
header_id: TestHeaderId,
|
||||||
|
exit_signal: &futures::channel::mpsc::UnboundedSender<()>,
|
||||||
|
) {
|
||||||
|
if let TargetMethod::CompleteHeader(completed_id, _) = method {
|
||||||
|
if *completed_id == header_id {
|
||||||
|
exit_signal.unbounded_send(()).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn run_backoff_test(result: Result<(), TestError>) -> (Duration, Duration) {
|
||||||
|
let mut backoff = retry_backoff();
|
||||||
|
|
||||||
|
// no randomness in tests (otherwise intervals may overlap => asserts are failing)
|
||||||
|
backoff.randomization_factor = 0f64;
|
||||||
|
|
||||||
|
// increase backoff's current interval
|
||||||
|
let interval1 = backoff.next_backoff().unwrap();
|
||||||
|
let interval2 = backoff.next_backoff().unwrap();
|
||||||
|
assert!(interval2 > interval1);
|
||||||
|
|
||||||
|
// successful future result leads to backoff's reset
|
||||||
|
let go_offline_future = futures::future::Fuse::terminated();
|
||||||
|
futures::pin_mut!(go_offline_future);
|
||||||
|
|
||||||
|
process_future_result(
|
||||||
|
result,
|
||||||
|
&mut backoff,
|
||||||
|
|_| {},
|
||||||
|
&mut go_offline_future,
|
||||||
|
|delay| async_std::task::sleep(delay),
|
||||||
|
|| "Test error".into(),
|
||||||
|
);
|
||||||
|
|
||||||
|
(interval2, backoff.next_backoff().unwrap())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn process_future_result_resets_backoff_on_success() {
|
||||||
|
let (interval2, interval_after_reset) = run_backoff_test(Ok(()));
|
||||||
|
assert!(interval2 > interval_after_reset);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn process_future_result_resets_backoff_on_connection_error() {
|
||||||
|
let (interval2, interval_after_reset) = run_backoff_test(Err(TestError(true)));
|
||||||
|
assert!(interval2 > interval_after_reset);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn process_future_result_does_not_reset_backoff_on_non_connection_error() {
|
||||||
|
let (interval2, interval_after_reset) = run_backoff_test(Err(TestError(false)));
|
||||||
|
assert!(interval2 < interval_after_reset);
|
||||||
|
}
|
||||||
|
|
||||||
|
struct SyncLoopTestParams {
|
||||||
|
best_source_header: TestHeader,
|
||||||
|
headers_on_source: Vec<(bool, TestHeader)>,
|
||||||
|
best_target_header: TestHeader,
|
||||||
|
headers_on_target: Vec<TestHeader>,
|
||||||
|
target_requires_extra: bool,
|
||||||
|
target_requires_completion: bool,
|
||||||
|
stop_at: TestHeaderId,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn run_sync_loop_test(params: SyncLoopTestParams) {
|
||||||
|
let (exit_sender, exit_receiver) = futures::channel::mpsc::unbounded();
|
||||||
|
let target_requires_extra = params.target_requires_extra;
|
||||||
|
let target_requires_completion = params.target_requires_completion;
|
||||||
|
let stop_at = params.stop_at;
|
||||||
|
let source = Source::new(
|
||||||
|
params.best_source_header.id(),
|
||||||
|
params.headers_on_source,
|
||||||
|
move |method, _| {
|
||||||
|
if !target_requires_extra {
|
||||||
|
source_reject_extra(&method);
|
||||||
|
}
|
||||||
|
if !target_requires_completion {
|
||||||
|
source_reject_completion(&method);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
let target = Target::new(
|
||||||
|
params.best_target_header.id(),
|
||||||
|
params.headers_on_target.into_iter().map(|header| header.id()).collect(),
|
||||||
|
move |method, data| {
|
||||||
|
target_accept_all_headers(&method, data, target_requires_extra);
|
||||||
|
if target_requires_completion {
|
||||||
|
target_signal_exit_when_header_completed(&method, stop_at, &exit_sender);
|
||||||
|
} else {
|
||||||
|
target_signal_exit_when_header_submitted(&method, stop_at, &exit_sender);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
target.data.lock().requires_extra = target_requires_extra;
|
||||||
|
target.data.lock().requires_completion = target_requires_completion;
|
||||||
|
|
||||||
|
run(
|
||||||
|
source,
|
||||||
|
test_tick(),
|
||||||
|
target,
|
||||||
|
test_tick(),
|
||||||
|
crate::sync::tests::default_sync_params(),
|
||||||
|
exit_receiver.into_future().map(|(_, _)| ()),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sync_loop_is_able_to_synchronize_single_header() {
|
||||||
|
run_sync_loop_test(SyncLoopTestParams {
|
||||||
|
best_source_header: test_header(1),
|
||||||
|
headers_on_source: vec![(true, test_header(1))],
|
||||||
|
best_target_header: test_header(0),
|
||||||
|
headers_on_target: vec![test_header(0)],
|
||||||
|
target_requires_extra: false,
|
||||||
|
target_requires_completion: false,
|
||||||
|
stop_at: test_id(1),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sync_loop_is_able_to_synchronize_single_header_with_extra() {
|
||||||
|
run_sync_loop_test(SyncLoopTestParams {
|
||||||
|
best_source_header: test_header(1),
|
||||||
|
headers_on_source: vec![(true, test_header(1))],
|
||||||
|
best_target_header: test_header(0),
|
||||||
|
headers_on_target: vec![test_header(0)],
|
||||||
|
target_requires_extra: true,
|
||||||
|
target_requires_completion: false,
|
||||||
|
stop_at: test_id(1),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sync_loop_is_able_to_synchronize_single_header_with_completion() {
|
||||||
|
run_sync_loop_test(SyncLoopTestParams {
|
||||||
|
best_source_header: test_header(1),
|
||||||
|
headers_on_source: vec![(true, test_header(1))],
|
||||||
|
best_target_header: test_header(0),
|
||||||
|
headers_on_target: vec![test_header(0)],
|
||||||
|
target_requires_extra: false,
|
||||||
|
target_requires_completion: true,
|
||||||
|
stop_at: test_id(1),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sync_loop_is_able_to_reorganize_from_shorter_fork() {
|
||||||
|
run_sync_loop_test(SyncLoopTestParams {
|
||||||
|
best_source_header: test_header(3),
|
||||||
|
headers_on_source: vec![
|
||||||
|
(true, test_header(1)),
|
||||||
|
(true, test_header(2)),
|
||||||
|
(true, test_header(3)),
|
||||||
|
(false, test_forked_header(1, 0)),
|
||||||
|
(false, test_forked_header(2, 0)),
|
||||||
|
],
|
||||||
|
best_target_header: test_forked_header(2, 0),
|
||||||
|
headers_on_target: vec![test_header(0), test_forked_header(1, 0), test_forked_header(2, 0)],
|
||||||
|
target_requires_extra: false,
|
||||||
|
target_requires_completion: false,
|
||||||
|
stop_at: test_id(3),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sync_loop_is_able_to_reorganize_from_longer_fork() {
|
||||||
|
run_sync_loop_test(SyncLoopTestParams {
|
||||||
|
best_source_header: test_header(3),
|
||||||
|
headers_on_source: vec![
|
||||||
|
(true, test_header(1)),
|
||||||
|
(true, test_header(2)),
|
||||||
|
(true, test_header(3)),
|
||||||
|
(false, test_forked_header(1, 0)),
|
||||||
|
(false, test_forked_header(2, 0)),
|
||||||
|
(false, test_forked_header(3, 0)),
|
||||||
|
(false, test_forked_header(4, 0)),
|
||||||
|
(false, test_forked_header(5, 0)),
|
||||||
|
],
|
||||||
|
best_target_header: test_forked_header(5, 0),
|
||||||
|
headers_on_target: vec![
|
||||||
|
test_header(0),
|
||||||
|
test_forked_header(1, 0),
|
||||||
|
test_forked_header(2, 0),
|
||||||
|
test_forked_header(3, 0),
|
||||||
|
test_forked_header(4, 0),
|
||||||
|
test_forked_header(5, 0),
|
||||||
|
],
|
||||||
|
target_requires_extra: false,
|
||||||
|
target_requires_completion: false,
|
||||||
|
stop_at: test_id(3),
|
||||||
|
});
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user