Port notifier to stable futures

This commit is contained in:
pawan
2020-04-21 18:23:07 +05:30
parent d0b478f994
commit 3075b3c61c

View File

@@ -2,13 +2,13 @@ use crate::metrics;
use beacon_chain::{BeaconChain, BeaconChainTypes}; use beacon_chain::{BeaconChain, BeaconChainTypes};
use environment::RuntimeContext; use environment::RuntimeContext;
use eth2_libp2p::NetworkGlobals; use eth2_libp2p::NetworkGlobals;
use futures::{Future, Stream}; use futures::{FutureExt, StreamExt, TryFutureExt};
use parking_lot::Mutex; use parking_lot::Mutex;
use slog::{debug, error, info, warn}; use slog::{debug, error, info, warn};
use slot_clock::SlotClock; use slot_clock::SlotClock;
use std::sync::Arc; use std::sync::Arc;
use std::time::{Duration, Instant}; use std::time::Duration;
use tokio::timer::Interval; use tokio::time::{interval_at, Instant};
use types::{EthSpec, Slot}; use types::{EthSpec, Slot};
/// Create a warning log whenever the peer count is at or below this value. /// Create a warning log whenever the peer count is at or below this value.
@@ -32,9 +32,7 @@ pub fn spawn_notifier<T: BeaconChainTypes>(
network: Arc<NetworkGlobals<T::EthSpec>>, network: Arc<NetworkGlobals<T::EthSpec>>,
milliseconds_per_slot: u64, milliseconds_per_slot: u64,
) -> Result<tokio::sync::oneshot::Sender<()>, String> { ) -> Result<tokio::sync::oneshot::Sender<()>, String> {
let log_1 = context.log.clone(); let log = context.log.clone();
let log_2 = context.log.clone();
let log_3 = context.log.clone();
let slot_duration = Duration::from_millis(milliseconds_per_slot); let slot_duration = Duration::from_millis(milliseconds_per_slot);
let duration_to_next_slot = beacon_chain let duration_to_next_slot = beacon_chain
@@ -50,82 +48,93 @@ pub fn spawn_notifier<T: BeaconChainTypes>(
let speedo = Mutex::new(Speedo::default()); let speedo = Mutex::new(Speedo::default());
let interval_future = Interval::new(start_instant, interval_duration) // Note: `interval_at` panics when interval_duration is 0
.map_err( // TODO: `Return type of closure passed to `for_each` is restricted to `Future<Output = ()>`
move |e| error!(log_1, "Slot notifier timer failed"; "error" => format!("{:?}", e)), // Hence, shifting the .then() error logs into the `for_each` closure.
) // Can be solved with `TryStreamExt::try_for_each` if `Interval` implemented `TryStream`.
.for_each(move |_| { let interval_future = interval_at(start_instant, interval_duration).for_each(|_| {
let log = log_2.clone(); let connected_peer_count = network.connected_peers();
let connected_peer_count = network.connected_peers(); let head_info = match beacon_chain.head_info() {
Ok(head) => head,
let head_info = beacon_chain.head_info() Err(e) => {
.map_err(|e| error!(
log,
"Failed to get beacon chain head info";
"error" => format!("{:?}", e)
))?;
let head_slot = head_info.slot;
let head_epoch = head_slot.epoch(T::EthSpec::slots_per_epoch());
let current_slot = beacon_chain.slot().map_err(|e| {
error!( error!(
log, log,
"Unable to read current slot"; "Notifier failed to notify, Failed to get beacon chain head info";
"error" => format!("{:?}", e) "error" => format!("{:?}", e)
) );
})?; return futures::future::ready(());
let current_epoch = current_slot.epoch(T::EthSpec::slots_per_epoch());
let finalized_epoch = head_info.finalized_checkpoint.epoch;
let finalized_root = head_info.finalized_checkpoint.root;
let head_root = head_info.block_root;
let mut speedo = speedo.lock();
speedo.observe(head_slot, Instant::now());
metrics::set_gauge(&metrics::SYNC_SLOTS_PER_SECOND, speedo.slots_per_second().unwrap_or_else(|| 0_f64) as i64);
// The next two lines take advantage of saturating subtraction on `Slot`.
let head_distance = current_slot - head_slot;
if connected_peer_count <= WARN_PEER_COUNT {
warn!(log, "Low peer count"; "peer_count" => peer_count_pretty(connected_peer_count));
} }
};
debug!( let head_slot = head_info.slot;
log, let head_epoch = head_slot.epoch(T::EthSpec::slots_per_epoch());
"Slot timer"; let current_slot = match beacon_chain.slot() {
"peers" => peer_count_pretty(connected_peer_count), Ok(slot) => slot,
"finalized_root" => format!("{}", finalized_root), Err(e) => {
"finalized_epoch" => finalized_epoch, error!(
"head_block" => format!("{}", head_root), log,
"head_slot" => head_slot, "Notify failed to notify, Unable to read current slot";
"current_slot" => current_slot, "error" => format!("{:?}", e)
);
return futures::future::ready(());
}
};
let current_epoch = current_slot.epoch(T::EthSpec::slots_per_epoch());
let finalized_epoch = head_info.finalized_checkpoint.epoch;
let finalized_root = head_info.finalized_checkpoint.root;
let head_root = head_info.block_root;
let mut speedo = speedo.lock();
speedo.observe(head_slot, Instant::now());
metrics::set_gauge(
&metrics::SYNC_SLOTS_PER_SECOND,
speedo.slots_per_second().unwrap_or_else(|| 0_f64) as i64,
);
// The next two lines take advantage of saturating subtraction on `Slot`.
let head_distance = current_slot - head_slot;
if connected_peer_count <= WARN_PEER_COUNT {
warn!(log, "Low peer count"; "peer_count" => peer_count_pretty(connected_peer_count));
}
debug!(
log,
"Slot timer";
"peers" => peer_count_pretty(connected_peer_count),
"finalized_root" => format!("{}", finalized_root),
"finalized_epoch" => finalized_epoch,
"head_block" => format!("{}", head_root),
"head_slot" => head_slot,
"current_slot" => current_slot,
);
if head_epoch + 1 < current_epoch {
let distance = format!(
"{} slots ({})",
head_distance.as_u64(),
slot_distance_pretty(head_distance, slot_duration)
); );
if head_epoch + 1 < current_epoch { info!(
let distance = format!( log,
"{} slots ({})", "Syncing";
head_distance.as_u64(), "peers" => peer_count_pretty(connected_peer_count),
slot_distance_pretty(head_distance, slot_duration) "distance" => distance,
); "speed" => sync_speed_pretty(speedo.slots_per_second()),
"est_time" => estimated_time_pretty(speedo.estimated_time_till_slot(current_slot)),
);
info!( return futures::future::ready(());
log, };
"Syncing";
"peers" => peer_count_pretty(connected_peer_count),
"distance" => distance,
"speed" => sync_speed_pretty(speedo.slots_per_second()),
"est_time" => estimated_time_pretty(speedo.estimated_time_till_slot(current_slot)),
);
return Ok(()); macro_rules! not_quite_synced_log {
};
macro_rules! not_quite_synced_log {
($message: expr) => { ($message: expr) => {
info!( info!(
log_2, log,
$message; $message;
"peers" => peer_count_pretty(connected_peer_count), "peers" => peer_count_pretty(connected_peer_count),
"finalized_root" => format!("{}", finalized_root), "finalized_root" => format!("{}", finalized_root),
@@ -136,41 +145,31 @@ pub fn spawn_notifier<T: BeaconChainTypes>(
} }
} }
if head_epoch + 1 == current_epoch { if head_epoch + 1 == current_epoch {
not_quite_synced_log!("Synced to previous epoch") not_quite_synced_log!("Synced to previous epoch")
} else if head_slot != current_slot { } else if head_slot != current_slot {
not_quite_synced_log!("Synced to current epoch") not_quite_synced_log!("Synced to current epoch")
} else { } else {
info!( info!(
log_2, log,
"Synced"; "Synced";
"peers" => peer_count_pretty(connected_peer_count), "peers" => peer_count_pretty(connected_peer_count),
"finalized_root" => format!("{}", finalized_root), "finalized_root" => format!("{}", finalized_root),
"finalized_epoch" => finalized_epoch, "finalized_epoch" => finalized_epoch,
"epoch" => current_epoch, "epoch" => current_epoch,
"slot" => current_slot, "slot" => current_slot,
); );
}; };
Ok(()) futures::future::ready(())
}) });
.then(move |result| {
match result {
Ok(()) => Ok(()),
Err(e) => {
error!(
log_3,
"Notifier failed to notify";
"error" => format!("{:?}", e)
);
Ok(())
} } });
let (exit_signal, exit) = tokio::sync::oneshot::channel(); let (exit_signal, exit) = tokio::sync::oneshot::channel();
context let future = futures::future::select(interval_future, exit.map_err(|_| ()).map(|_| ()));
.executor
.spawn(interval_future.select(exit).map(|_| ()).map_err(|_| ())); // TODO: the runtime handle should spawn this future.
tokio::task::spawn(future);
Ok(exit_signal) Ok(exit_signal)
} }