mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-14 19:11:04 +00:00
NetworkBridge: validator (authorities) discovery api (#1699)
* stupid, but it compiles * redo * cleanup * add ValidatorDiscovery to msgs * sketch network bridge code * ConnectToAuthorities instead of validators * more stuff * cleanup * more stuff * complete ConnectToAuthoritiesState * Update node/network/bridge/src/lib.rs Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com> * Collator protocol subsystem (#1659) * WIP * The initial implementation of the collator side. * Improve comments * Multiple collation requests * Add more tests and comments to validator side * Add comments, remove dead code * Apply suggestions from code review Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com> * Fix build after suggested changes * Also connect to the next validator group * Remove a Future impl and move TimeoutExt to util * Minor nits * Fix build * Change FetchCollations back to FetchCollation * Try this * Final fixes * Fix build Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com> * handle multiple in-flight connection requests * handle cancelled requests * Update node/core/runtime-api/src/lib.rs Co-authored-by: Bernhard Schuster <bernhard@ahoi.io> * redo it again * more stuff * redo it again * update comments * workaround Future is not Send * fix trailing spaces * clarify comments * bridge: fix compilation in tests * update more comments * small fixes * port collator protocol to new validator discovery api * collator tests compile * collator tests pass * do not revoke a request when the stream receiver is closed * make revoking opt-in * fix is_fulfilled * handle request revokation in collator * tests * wait for validator connections asyncronously * fix compilation * relabel my todos * apply Fedor's patch * resolve reconnection TODO * resolve revoking TODO * resolve channel capacity TODO * resolve peer cloning TODO * resolve peer disconnected TODO * resolve PeerSet TODO * wip tests * more tests * resolve Arc TODO * rename pending to non_revoked * one more test * extract utility function into util crate * fix compilation in tests * Apply suggestions from code review Co-authored-by: Fedor Sakharov <fedor.sakharov@gmail.com> * revert pin_project removal * fix while let loop * Revert "revert pin_project removal" This reverts commit ae7f529d8de982ef66c3007dd1ff74c6ddce80d2. * fix compilation * Update node/subsystem/src/messages.rs * docs on pub items * guide updates * remove a TODO * small guide update * fix a typo * link to the issue * validator discovery: on_request docs Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com> Co-authored-by: Fedor Sakharov <fedor.sakharov@gmail.com> Co-authored-by: Bernhard Schuster <bernhard@ahoi.io>
This commit is contained in:
@@ -20,7 +20,7 @@ use parity_scale_codec::{Encode, Decode};
|
||||
use futures::prelude::*;
|
||||
use futures::future::BoxFuture;
|
||||
use futures::stream::BoxStream;
|
||||
use futures::channel::oneshot;
|
||||
use futures::channel::{mpsc, oneshot};
|
||||
|
||||
use sc_network::Event as NetworkEvent;
|
||||
use sp_runtime::ConsensusEngineId;
|
||||
@@ -34,16 +34,19 @@ use polkadot_subsystem::messages::{
|
||||
BitfieldDistributionMessage, PoVDistributionMessage, StatementDistributionMessage,
|
||||
CollatorProtocolMessage,
|
||||
};
|
||||
use polkadot_primitives::v1::{Block, Hash, ValidatorId};
|
||||
use polkadot_primitives::v1::{AuthorityDiscoveryId, Block, Hash};
|
||||
use polkadot_node_network_protocol::{
|
||||
ObservedRole, ReputationChange, PeerId, PeerSet, View, NetworkBridgeEvent, v1 as protocol_v1
|
||||
};
|
||||
|
||||
use std::collections::hash_map::{HashMap, Entry as HEntry};
|
||||
use std::collections::{HashMap, hash_map};
|
||||
use std::iter::ExactSizeIterator;
|
||||
use std::pin::Pin;
|
||||
use std::sync::Arc;
|
||||
|
||||
|
||||
mod validator_discovery;
|
||||
|
||||
/// The maximum amount of heads a peer is allowed to have in their view at any time.
|
||||
///
|
||||
/// We use the same limit to compute the view sent to peers locally.
|
||||
@@ -188,29 +191,41 @@ impl Network for Arc<sc_network::NetworkService<Block, Hash>> {
|
||||
}
|
||||
|
||||
/// The network bridge subsystem.
|
||||
pub struct NetworkBridge<N>(N);
|
||||
pub struct NetworkBridge<N, AD> {
|
||||
network_service: N,
|
||||
authority_discovery_service: AD,
|
||||
}
|
||||
|
||||
impl<N> NetworkBridge<N> {
|
||||
/// Create a new network bridge subsystem with underlying network service.
|
||||
impl<N, AD> NetworkBridge<N, AD> {
|
||||
/// Create a new network bridge subsystem with underlying network service and authority discovery service.
|
||||
///
|
||||
/// This assumes that the network service has had the notifications protocol for the network
|
||||
/// bridge already registered. See [`notifications_protocol_info`](notifications_protocol_info).
|
||||
pub fn new(net_service: N) -> Self {
|
||||
NetworkBridge(net_service)
|
||||
pub fn new(network_service: N, authority_discovery_service: AD) -> Self {
|
||||
NetworkBridge {
|
||||
network_service,
|
||||
authority_discovery_service,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<Net, Context> Subsystem<Context> for NetworkBridge<Net>
|
||||
impl<Net, AD, Context> Subsystem<Context> for NetworkBridge<Net, AD>
|
||||
where
|
||||
Net: Network,
|
||||
Net: Network + validator_discovery::Network,
|
||||
AD: validator_discovery::AuthorityDiscovery,
|
||||
Context: SubsystemContext<Message=NetworkBridgeMessage>,
|
||||
{
|
||||
fn start(self, ctx: Context) -> SpawnedSubsystem {
|
||||
// Swallow error because failure is fatal to the node and we log with more precision
|
||||
// within `run_network`.
|
||||
let Self { network_service, authority_discovery_service } = self;
|
||||
SpawnedSubsystem {
|
||||
name: "network-bridge-subsystem",
|
||||
future: run_network(self.0, ctx).map(|_| ()).boxed(),
|
||||
future: run_network(
|
||||
network_service,
|
||||
authority_discovery_service,
|
||||
ctx,
|
||||
).map(|_| ()).boxed(),
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -224,7 +239,11 @@ struct PeerData {
|
||||
enum Action {
|
||||
SendValidationMessage(Vec<PeerId>, protocol_v1::ValidationProtocol),
|
||||
SendCollationMessage(Vec<PeerId>, protocol_v1::CollationProtocol),
|
||||
ConnectToValidators(PeerSet, Vec<ValidatorId>, oneshot::Sender<Vec<(ValidatorId, PeerId)>>),
|
||||
ConnectToValidators {
|
||||
validator_ids: Vec<AuthorityDiscoveryId>,
|
||||
connected: mpsc::Sender<(AuthorityDiscoveryId, PeerId)>,
|
||||
revoke: oneshot::Receiver<()>,
|
||||
},
|
||||
ReportPeer(PeerId, ReputationChange),
|
||||
|
||||
ActiveLeaves(ActiveLeavesUpdate),
|
||||
@@ -254,8 +273,11 @@ fn action_from_overseer_message(
|
||||
=> Action::SendValidationMessage(peers, msg),
|
||||
NetworkBridgeMessage::SendCollationMessage(peers, msg)
|
||||
=> Action::SendCollationMessage(peers, msg),
|
||||
NetworkBridgeMessage::ConnectToValidators(peer_set, validators, res)
|
||||
=> Action::ConnectToValidators(peer_set, validators, res),
|
||||
NetworkBridgeMessage::ConnectToValidators {
|
||||
validator_ids,
|
||||
connected,
|
||||
revoke,
|
||||
} => Action::ConnectToValidators { validator_ids, connected, revoke },
|
||||
},
|
||||
Ok(FromOverseer::Signal(OverseerSignal::BlockFinalized(_)))
|
||||
=> Action::Nop,
|
||||
@@ -538,11 +560,16 @@ async fn dispatch_collation_events_to_all<I>(
|
||||
ctx.send_messages(events.into_iter().flat_map(messages_for)).await
|
||||
}
|
||||
|
||||
async fn run_network<N: Network>(
|
||||
mut net: N,
|
||||
async fn run_network<N, AD>(
|
||||
mut network_service: N,
|
||||
mut authority_discovery_service: AD,
|
||||
mut ctx: impl SubsystemContext<Message=NetworkBridgeMessage>,
|
||||
) -> SubsystemResult<()> {
|
||||
let mut event_stream = net.event_stream().fuse();
|
||||
) -> SubsystemResult<()>
|
||||
where
|
||||
N: Network + validator_discovery::Network,
|
||||
AD: validator_discovery::AuthorityDiscovery,
|
||||
{
|
||||
let mut event_stream = network_service.event_stream().fuse();
|
||||
|
||||
// Most recent heads are at the back.
|
||||
let mut live_heads: Vec<Hash> = Vec::with_capacity(MAX_VIEW_HEADS);
|
||||
@@ -551,7 +578,10 @@ async fn run_network<N: Network>(
|
||||
let mut validation_peers: HashMap<PeerId, PeerData> = HashMap::new();
|
||||
let mut collation_peers: HashMap<PeerId, PeerData> = HashMap::new();
|
||||
|
||||
let mut validator_discovery = validator_discovery::Service::<N, AD>::new();
|
||||
|
||||
loop {
|
||||
|
||||
let action = {
|
||||
let subsystem_next = ctx.recv().fuse();
|
||||
let mut net_event_next = event_stream.next().fuse();
|
||||
@@ -568,31 +598,43 @@ async fn run_network<N: Network>(
|
||||
Action::Abort => return Ok(()),
|
||||
|
||||
Action::SendValidationMessage(peers, msg) => send_message(
|
||||
&mut net,
|
||||
&mut network_service,
|
||||
peers,
|
||||
PeerSet::Validation,
|
||||
WireMessage::ProtocolMessage(msg),
|
||||
).await?,
|
||||
|
||||
Action::SendCollationMessage(peers, msg) => send_message(
|
||||
&mut net,
|
||||
&mut network_service,
|
||||
peers,
|
||||
PeerSet::Collation,
|
||||
WireMessage::ProtocolMessage(msg),
|
||||
).await?,
|
||||
|
||||
Action::ConnectToValidators(_peer_set, _validators, _res) => {
|
||||
// TODO: https://github.com/paritytech/polkadot/issues/1461
|
||||
}
|
||||
Action::ConnectToValidators {
|
||||
validator_ids,
|
||||
connected,
|
||||
revoke,
|
||||
} => {
|
||||
let (ns, ads) = validator_discovery.on_request(
|
||||
validator_ids,
|
||||
connected,
|
||||
revoke,
|
||||
network_service,
|
||||
authority_discovery_service,
|
||||
).await;
|
||||
network_service = ns;
|
||||
authority_discovery_service = ads;
|
||||
},
|
||||
|
||||
Action::ReportPeer(peer, rep) => net.report_peer(peer, rep).await?,
|
||||
Action::ReportPeer(peer, rep) => network_service.report_peer(peer, rep).await?,
|
||||
|
||||
Action::ActiveLeaves(ActiveLeavesUpdate { activated, deactivated }) => {
|
||||
live_heads.extend(activated);
|
||||
live_heads.retain(|h| !deactivated.contains(h));
|
||||
|
||||
update_view(
|
||||
&mut net,
|
||||
&mut network_service,
|
||||
&mut ctx,
|
||||
&live_heads,
|
||||
&mut local_view,
|
||||
@@ -607,9 +649,11 @@ async fn run_network<N: Network>(
|
||||
PeerSet::Collation => &mut collation_peers,
|
||||
};
|
||||
|
||||
validator_discovery.on_peer_connected(&peer, &mut authority_discovery_service).await;
|
||||
|
||||
match peer_map.entry(peer.clone()) {
|
||||
HEntry::Occupied(_) => continue,
|
||||
HEntry::Vacant(vacant) => {
|
||||
hash_map::Entry::Occupied(_) => continue,
|
||||
hash_map::Entry::Vacant(vacant) => {
|
||||
vacant.insert(PeerData {
|
||||
view: View(Vec::new()),
|
||||
});
|
||||
@@ -650,6 +694,8 @@ async fn run_network<N: Network>(
|
||||
PeerSet::Collation => &mut collation_peers,
|
||||
};
|
||||
|
||||
validator_discovery.on_peer_disconnected(&peer, &mut authority_discovery_service).await;
|
||||
|
||||
if peer_map.remove(&peer).is_some() {
|
||||
let res = match peer_set {
|
||||
PeerSet::Validation => dispatch_validation_event_to_all(
|
||||
@@ -677,7 +723,7 @@ async fn run_network<N: Network>(
|
||||
peer.clone(),
|
||||
&mut validation_peers,
|
||||
v_messages,
|
||||
&mut net,
|
||||
&mut network_service,
|
||||
).await?;
|
||||
|
||||
if let Err(e) = dispatch_validation_events_to_all(
|
||||
@@ -697,7 +743,7 @@ async fn run_network<N: Network>(
|
||||
peer.clone(),
|
||||
&mut collation_peers,
|
||||
c_messages,
|
||||
&mut net,
|
||||
&mut network_service,
|
||||
).await?;
|
||||
|
||||
if let Err(e) = dispatch_collation_events_to_all(
|
||||
@@ -716,6 +762,7 @@ async fn run_network<N: Network>(
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
@@ -723,6 +770,8 @@ mod tests {
|
||||
use futures::executor;
|
||||
|
||||
use std::sync::Arc;
|
||||
use std::collections::HashSet;
|
||||
use async_trait::async_trait;
|
||||
use parking_lot::Mutex;
|
||||
use assert_matches::assert_matches;
|
||||
|
||||
@@ -730,6 +779,7 @@ mod tests {
|
||||
use polkadot_node_subsystem_test_helpers::{
|
||||
SingleItemSink, SingleItemStream, TestSubsystemContextHandle,
|
||||
};
|
||||
use sc_network::Multiaddr;
|
||||
use sp_keyring::Sr25519Keyring;
|
||||
|
||||
// The subsystem's view of the network - only supports a single call to `event_stream`.
|
||||
@@ -738,6 +788,8 @@ mod tests {
|
||||
action_tx: mpsc::UnboundedSender<NetworkAction>,
|
||||
}
|
||||
|
||||
struct TestAuthorityDiscovery;
|
||||
|
||||
// The test's view of the network. This receives updates from the subsystem in the form
|
||||
// of `NetworkAction`s.
|
||||
struct TestNetworkHandle {
|
||||
@@ -748,6 +800,7 @@ mod tests {
|
||||
fn new_test_network() -> (
|
||||
TestNetwork,
|
||||
TestNetworkHandle,
|
||||
TestAuthorityDiscovery,
|
||||
) {
|
||||
let (net_tx, net_rx) = polkadot_node_subsystem_test_helpers::single_item_sink();
|
||||
let (action_tx, action_rx) = mpsc::unbounded();
|
||||
@@ -761,6 +814,7 @@ mod tests {
|
||||
action_rx,
|
||||
net_tx,
|
||||
},
|
||||
TestAuthorityDiscovery,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -786,6 +840,23 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
impl validator_discovery::Network for TestNetwork {
|
||||
fn set_priority_group(&self, _group_id: String, _multiaddresses: HashSet<Multiaddr>) -> Result<(), String> {
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl validator_discovery::AuthorityDiscovery for TestAuthorityDiscovery {
|
||||
async fn get_addresses_by_authority_id(&mut self, _authority: AuthorityDiscoveryId) -> Option<Vec<Multiaddr>> {
|
||||
None
|
||||
}
|
||||
|
||||
async fn get_authority_id_by_peer_id(&mut self, _peer_id: PeerId) -> Option<AuthorityDiscoveryId> {
|
||||
None
|
||||
}
|
||||
}
|
||||
|
||||
impl TestNetworkHandle {
|
||||
// Get the next network action.
|
||||
async fn next_network_action(&mut self) -> NetworkAction {
|
||||
@@ -842,11 +913,12 @@ mod tests {
|
||||
|
||||
fn test_harness<T: Future<Output=()>>(test: impl FnOnce(TestHarness) -> T) {
|
||||
let pool = sp_core::testing::TaskExecutor::new();
|
||||
let (network, network_handle) = new_test_network();
|
||||
let (network, network_handle, discovery) = new_test_network();
|
||||
let (context, virtual_overseer) = polkadot_node_subsystem_test_helpers::make_subsystem_context(pool);
|
||||
|
||||
let network_bridge = run_network(
|
||||
network,
|
||||
discovery,
|
||||
context,
|
||||
)
|
||||
.map_err(|_| panic!("subsystem execution failed"))
|
||||
|
||||
@@ -0,0 +1,594 @@
|
||||
// Copyright 2020 Parity Technologies (UK) Ltd.
|
||||
// This file is part of Polkadot.
|
||||
|
||||
// Polkadot 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.
|
||||
|
||||
// Polkadot 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 Polkadot. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
//! A validator discovery service for the Network Bridge.
|
||||
|
||||
use core::marker::PhantomData;
|
||||
use std::collections::{HashSet, HashMap, hash_map};
|
||||
use std::sync::Arc;
|
||||
|
||||
use async_trait::async_trait;
|
||||
use futures::channel::{mpsc, oneshot};
|
||||
|
||||
use sc_network::Multiaddr;
|
||||
use sc_authority_discovery::Service as AuthorityDiscoveryService;
|
||||
use polkadot_node_network_protocol::PeerId;
|
||||
use polkadot_primitives::v1::{AuthorityDiscoveryId, Block, Hash};
|
||||
|
||||
const PRIORITY_GROUP: &'static str = "parachain_validators";
|
||||
|
||||
/// An abstraction over networking for the purposes of validator discovery service.
|
||||
pub trait Network: Send + 'static {
|
||||
/// Ask the network to connect to these nodes and not disconnect from them until removed from the priority group.
|
||||
fn set_priority_group(&self, group_id: String, multiaddresses: HashSet<Multiaddr>) -> Result<(), String>;
|
||||
// TODO (ordian): we might want to add `add_to_priority_group` and `remove_from_priority_group`
|
||||
// https://github.com/paritytech/polkadot/issues/1763
|
||||
}
|
||||
|
||||
/// An abstraction over the authority discovery service.
|
||||
#[async_trait]
|
||||
pub trait AuthorityDiscovery: Send + 'static {
|
||||
/// Get the addresses for the given [`AuthorityId`] from the local address cache.
|
||||
async fn get_addresses_by_authority_id(&mut self, authority: AuthorityDiscoveryId) -> Option<Vec<Multiaddr>>;
|
||||
/// Get the [`AuthorityId`] for the given [`PeerId`] from the local address cache.
|
||||
async fn get_authority_id_by_peer_id(&mut self, peer_id: PeerId) -> Option<AuthorityDiscoveryId>;
|
||||
}
|
||||
|
||||
impl Network for Arc<sc_network::NetworkService<Block, Hash>> {
|
||||
fn set_priority_group(&self, group_id: String, multiaddresses: HashSet<Multiaddr>) -> Result<(), String> {
|
||||
sc_network::NetworkService::set_priority_group(&**self, group_id, multiaddresses)
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl AuthorityDiscovery for AuthorityDiscoveryService {
|
||||
async fn get_addresses_by_authority_id(&mut self, authority: AuthorityDiscoveryId) -> Option<Vec<Multiaddr>> {
|
||||
AuthorityDiscoveryService::get_addresses_by_authority_id(self, authority).await
|
||||
}
|
||||
|
||||
async fn get_authority_id_by_peer_id(&mut self, peer_id: PeerId) -> Option<AuthorityDiscoveryId> {
|
||||
AuthorityDiscoveryService::get_authority_id_by_peer_id(self, peer_id).await
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// This struct tracks the state for one `ConnectToValidators` request.
|
||||
struct NonRevokedConnectionRequestState {
|
||||
requested: Vec<AuthorityDiscoveryId>,
|
||||
pending: HashSet<AuthorityDiscoveryId>,
|
||||
sender: mpsc::Sender<(AuthorityDiscoveryId, PeerId)>,
|
||||
revoke: oneshot::Receiver<()>,
|
||||
}
|
||||
|
||||
impl NonRevokedConnectionRequestState {
|
||||
/// Create a new instance of `ConnectToValidatorsState`.
|
||||
pub fn new(
|
||||
requested: Vec<AuthorityDiscoveryId>,
|
||||
pending: HashSet<AuthorityDiscoveryId>,
|
||||
sender: mpsc::Sender<(AuthorityDiscoveryId, PeerId)>,
|
||||
revoke: oneshot::Receiver<()>,
|
||||
) -> Self {
|
||||
Self {
|
||||
requested,
|
||||
pending,
|
||||
sender,
|
||||
revoke,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn on_authority_connected(&mut self, authority: &AuthorityDiscoveryId, peer_id: &PeerId) {
|
||||
if self.pending.remove(authority) {
|
||||
// an error may happen if the request was revoked or
|
||||
// the channel's buffer is full, ignoring it is fine
|
||||
let _ = self.sender.try_send((authority.clone(), peer_id.clone()));
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns `true` if the request is revoked.
|
||||
pub fn is_revoked(&mut self) -> bool {
|
||||
self.revoke
|
||||
.try_recv()
|
||||
.map_or(true, |r| r.is_some())
|
||||
}
|
||||
|
||||
pub fn requested(&self) -> &[AuthorityDiscoveryId] {
|
||||
self.requested.as_ref()
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
pub(super) struct Service<N, AD> {
|
||||
// we assume one PeerId per AuthorityId is enough
|
||||
connected_validators: HashMap<AuthorityDiscoveryId, PeerId>,
|
||||
// the `u64` counts the number of pending non-revoked requests for this validator
|
||||
// note: the validators in this map are not necessarily present
|
||||
// in the `connected_validators` map.
|
||||
// Invariant: the value > 0 for non-revoked requests.
|
||||
requested_validators: HashMap<AuthorityDiscoveryId, u64>,
|
||||
// keep for the network priority_group updates
|
||||
validator_multiaddresses: HashSet<Multiaddr>,
|
||||
non_revoked_discovery_requests: Vec<NonRevokedConnectionRequestState>,
|
||||
// PhantomData used to make the struct generic instead of having generic methods
|
||||
network: PhantomData<N>,
|
||||
authority_discovery: PhantomData<AD>,
|
||||
}
|
||||
|
||||
impl<N: Network, AD: AuthorityDiscovery> Service<N, AD> {
|
||||
pub fn new() -> Self {
|
||||
Self {
|
||||
connected_validators: HashMap::new(),
|
||||
requested_validators: HashMap::new(),
|
||||
validator_multiaddresses: HashSet::new(),
|
||||
non_revoked_discovery_requests: Vec::new(),
|
||||
network: PhantomData,
|
||||
authority_discovery: PhantomData,
|
||||
}
|
||||
}
|
||||
|
||||
/// On a new connection request, a priority group update will be issued.
|
||||
/// It will ask the network to connect to the validators and not disconnect
|
||||
/// from them at least until all the pending requests containing them are revoked.
|
||||
///
|
||||
/// This method will also clean up all previously revoked requests.
|
||||
// it takes `network_service` and `authority_discovery_service` by value
|
||||
// and returns them as a workaround for the Future: Send requirement imposed by async fn impl.
|
||||
pub async fn on_request(
|
||||
&mut self,
|
||||
validator_ids: Vec<AuthorityDiscoveryId>,
|
||||
mut connected: mpsc::Sender<(AuthorityDiscoveryId, PeerId)>,
|
||||
revoke: oneshot::Receiver<()>,
|
||||
network_service: N,
|
||||
mut authority_discovery_service: AD,
|
||||
) -> (N, AD) {
|
||||
const MAX_ADDR_PER_PEER: usize = 3;
|
||||
|
||||
let already_connected = validator_ids.iter()
|
||||
.cloned()
|
||||
.filter_map(|id| {
|
||||
let counter = self.requested_validators.entry(id.clone()).or_default();
|
||||
// if the counter overflows, there is something really wrong going on
|
||||
*counter += 1;
|
||||
|
||||
self.connected_validators
|
||||
.get(&id)
|
||||
.map(|peer| (id, peer.clone()))
|
||||
});
|
||||
|
||||
|
||||
let on_revoke = |map: &mut HashMap<AuthorityDiscoveryId, u64>, id: AuthorityDiscoveryId| -> Option<AuthorityDiscoveryId> {
|
||||
match map.entry(id) {
|
||||
hash_map::Entry::Occupied(mut entry) => {
|
||||
*entry.get_mut() -= 1;
|
||||
if *entry.get() == 0 {
|
||||
return Some(entry.remove_entry().0);
|
||||
}
|
||||
}
|
||||
hash_map::Entry::Vacant(_) => {
|
||||
// should be unreachable
|
||||
}
|
||||
}
|
||||
None
|
||||
};
|
||||
|
||||
// try to send already connected peers
|
||||
for (id, peer) in already_connected {
|
||||
match connected.try_send((id, peer)) {
|
||||
Err(e) if e.is_disconnected() => {
|
||||
// the request is already revoked
|
||||
for peer_id in validator_ids {
|
||||
on_revoke(&mut self.requested_validators, peer_id);
|
||||
}
|
||||
return (network_service, authority_discovery_service);
|
||||
}
|
||||
Err(_) => {
|
||||
// the channel's buffer is full
|
||||
// ignore the error, the receiver will miss out some peers
|
||||
// but that's fine
|
||||
break;
|
||||
}
|
||||
Ok(()) => continue,
|
||||
}
|
||||
}
|
||||
|
||||
// collect multiaddress of validators
|
||||
for authority in validator_ids.iter().cloned() {
|
||||
let result = authority_discovery_service.get_addresses_by_authority_id(authority).await;
|
||||
if let Some(addresses) = result {
|
||||
// We might have several `PeerId`s per `AuthorityId`
|
||||
// depending on the number of sentry nodes,
|
||||
// so we limit the max number of sentries per node to connect to.
|
||||
// They are going to be removed soon though:
|
||||
// https://github.com/paritytech/substrate/issues/6845
|
||||
for addr in addresses.into_iter().take(MAX_ADDR_PER_PEER) {
|
||||
self.validator_multiaddresses.insert(addr);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// clean up revoked requests
|
||||
let mut revoked_indices = Vec::new();
|
||||
let mut revoked_validators = Vec::new();
|
||||
for (i, maybe_revoked) in self.non_revoked_discovery_requests.iter_mut().enumerate() {
|
||||
if maybe_revoked.is_revoked() {
|
||||
for id in maybe_revoked.requested() {
|
||||
if let Some(id) = on_revoke(&mut self.requested_validators, id.clone()) {
|
||||
revoked_validators.push(id);
|
||||
}
|
||||
}
|
||||
revoked_indices.push(i);
|
||||
}
|
||||
}
|
||||
|
||||
// clean up revoked requests states
|
||||
for to_revoke in revoked_indices.into_iter().rev() {
|
||||
drop(self.non_revoked_discovery_requests.swap_remove(to_revoke));
|
||||
}
|
||||
|
||||
// multiaddresses to remove
|
||||
for id in revoked_validators.into_iter() {
|
||||
let result = authority_discovery_service.get_addresses_by_authority_id(id).await;
|
||||
if let Some(addresses) = result {
|
||||
for addr in addresses.into_iter().take(MAX_ADDR_PER_PEER) {
|
||||
self.validator_multiaddresses.remove(&addr);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ask the network to connect to these nodes and not disconnect
|
||||
// from them until removed from the priority group
|
||||
// TODO (ordian): this clones the whole set of multaddresses
|
||||
// TODO (ordian): use add_to_priority_group for incremental updates?
|
||||
if let Err(e) = network_service.set_priority_group(
|
||||
PRIORITY_GROUP.to_owned(),
|
||||
self.validator_multiaddresses.clone(),
|
||||
) {
|
||||
log::warn!(target: super::TARGET, "AuthorityDiscoveryService returned an invalid multiaddress: {}", e);
|
||||
}
|
||||
|
||||
let pending = validator_ids.iter()
|
||||
.cloned()
|
||||
.filter(|id| !self.connected_validators.contains_key(id))
|
||||
.collect::<HashSet<_>>();
|
||||
|
||||
self.non_revoked_discovery_requests.push(NonRevokedConnectionRequestState::new(
|
||||
validator_ids,
|
||||
pending,
|
||||
connected,
|
||||
revoke,
|
||||
));
|
||||
|
||||
(network_service, authority_discovery_service)
|
||||
}
|
||||
|
||||
pub async fn on_peer_connected(&mut self, peer_id: &PeerId, authority_discovery_service: &mut AD) {
|
||||
// check if it's an authority we've been waiting for
|
||||
let maybe_authority = authority_discovery_service.get_authority_id_by_peer_id(peer_id.clone()).await;
|
||||
if let Some(authority) = maybe_authority {
|
||||
for request in self.non_revoked_discovery_requests.iter_mut() {
|
||||
request.on_authority_connected(&authority, peer_id);
|
||||
}
|
||||
self.connected_validators.insert(authority, peer_id.clone());
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn on_peer_disconnected(&mut self, peer_id: &PeerId, authority_discovery_service: &mut AD) {
|
||||
let maybe_authority = authority_discovery_service.get_authority_id_by_peer_id(peer_id.clone()).await;
|
||||
if let Some(authority) = maybe_authority {
|
||||
self.connected_validators.remove(&authority);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
use futures::stream::StreamExt as _;
|
||||
|
||||
use sp_keyring::Sr25519Keyring;
|
||||
|
||||
|
||||
fn new_service() -> Service<TestNetwork, TestAuthorityDiscovery> {
|
||||
Service::new()
|
||||
}
|
||||
|
||||
fn new_network() -> (TestNetwork, TestAuthorityDiscovery) {
|
||||
(TestNetwork::default(), TestAuthorityDiscovery::new())
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct TestNetwork {
|
||||
// Mutex is used because of &self signature of set_priority_group
|
||||
priority_group: std::sync::Mutex<HashSet<Multiaddr>>,
|
||||
}
|
||||
|
||||
struct TestAuthorityDiscovery {
|
||||
by_authority_id: HashMap<AuthorityDiscoveryId, Multiaddr>,
|
||||
by_peer_id: HashMap<PeerId, AuthorityDiscoveryId>,
|
||||
}
|
||||
|
||||
impl TestAuthorityDiscovery {
|
||||
fn new() -> Self {
|
||||
let peer_ids = known_peer_ids();
|
||||
let authorities = known_authorities();
|
||||
let multiaddr = known_multiaddr();
|
||||
Self {
|
||||
by_authority_id: authorities.iter()
|
||||
.cloned()
|
||||
.zip(multiaddr.into_iter())
|
||||
.collect(),
|
||||
by_peer_id: peer_ids.into_iter()
|
||||
.zip(authorities.into_iter())
|
||||
.collect(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Network for TestNetwork {
|
||||
fn set_priority_group(&self, _group_id: String, multiaddresses: HashSet<Multiaddr>) -> Result<(), String> {
|
||||
let mut group = self.priority_group.lock().unwrap();
|
||||
*group = multiaddresses;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl AuthorityDiscovery for TestAuthorityDiscovery {
|
||||
async fn get_addresses_by_authority_id(&mut self, authority: AuthorityDiscoveryId) -> Option<Vec<Multiaddr>> {
|
||||
self.by_authority_id.get(&authority).cloned().map(|addr| vec![addr])
|
||||
}
|
||||
|
||||
async fn get_authority_id_by_peer_id(&mut self, peer_id: PeerId) -> Option<AuthorityDiscoveryId> {
|
||||
self.by_peer_id.get(&peer_id).cloned()
|
||||
}
|
||||
}
|
||||
|
||||
fn known_authorities() -> Vec<AuthorityDiscoveryId> {
|
||||
[
|
||||
Sr25519Keyring::Alice,
|
||||
Sr25519Keyring::Bob,
|
||||
Sr25519Keyring::Charlie,
|
||||
].iter().map(|k| k.public().into()).collect()
|
||||
}
|
||||
|
||||
fn known_peer_ids() -> Vec<PeerId> {
|
||||
(0..3).map(|_| PeerId::random()).collect()
|
||||
}
|
||||
|
||||
fn known_multiaddr() -> Vec<Multiaddr> {
|
||||
vec![
|
||||
"/ip4/127.0.0.1/tcp/1234".parse().unwrap(),
|
||||
"/ip4/127.0.0.1/tcp/1235".parse().unwrap(),
|
||||
"/ip4/127.0.0.1/tcp/1236".parse().unwrap(),
|
||||
]
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn request_is_revoked_on_send() {
|
||||
let (revoke_tx, revoke_rx) = oneshot::channel();
|
||||
let (sender, _receiver) = mpsc::channel(0);
|
||||
|
||||
let mut request = NonRevokedConnectionRequestState::new(
|
||||
Vec::new(),
|
||||
HashSet::new(),
|
||||
sender,
|
||||
revoke_rx,
|
||||
);
|
||||
|
||||
assert!(!request.is_revoked());
|
||||
|
||||
revoke_tx.send(()).unwrap();
|
||||
|
||||
assert!(request.is_revoked());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn request_is_revoked_when_the_sender_is_dropped() {
|
||||
let (revoke_tx, revoke_rx) = oneshot::channel();
|
||||
let (sender, _receiver) = mpsc::channel(0);
|
||||
|
||||
let mut request = NonRevokedConnectionRequestState::new(
|
||||
Vec::new(),
|
||||
HashSet::new(),
|
||||
sender,
|
||||
revoke_rx,
|
||||
);
|
||||
|
||||
assert!(!request.is_revoked());
|
||||
|
||||
drop(revoke_tx);
|
||||
|
||||
assert!(request.is_revoked());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn requests_are_fulfilled_immediately_for_already_connected_peers() {
|
||||
let mut service = new_service();
|
||||
|
||||
let (ns, mut ads) = new_network();
|
||||
|
||||
let peer_ids: Vec<_> = ads.by_peer_id.keys().cloned().collect();
|
||||
let authority_ids: Vec<_> = ads.by_peer_id.values().cloned().collect();
|
||||
|
||||
futures::executor::block_on(async move {
|
||||
let req1 = vec![authority_ids[0].clone(), authority_ids[1].clone()];
|
||||
let (sender, mut receiver) = mpsc::channel(2);
|
||||
let (_revoke_tx, revoke_rx) = oneshot::channel();
|
||||
|
||||
service.on_peer_connected(&peer_ids[0], &mut ads).await;
|
||||
|
||||
let _ = service.on_request(
|
||||
req1,
|
||||
sender,
|
||||
revoke_rx,
|
||||
ns,
|
||||
ads,
|
||||
).await;
|
||||
|
||||
|
||||
// the results should be immediately available
|
||||
let reply1 = receiver.next().await.unwrap();
|
||||
assert_eq!(reply1.0, authority_ids[0]);
|
||||
assert_eq!(reply1.1, peer_ids[0]);
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn requests_are_fulfilled_on_peer_connection() {
|
||||
let mut service = new_service();
|
||||
|
||||
let (ns, ads) = new_network();
|
||||
|
||||
let peer_ids: Vec<_> = ads.by_peer_id.keys().cloned().collect();
|
||||
let authority_ids: Vec<_> = ads.by_peer_id.values().cloned().collect();
|
||||
|
||||
futures::executor::block_on(async move {
|
||||
let req1 = vec![authority_ids[0].clone(), authority_ids[1].clone()];
|
||||
let (sender, mut receiver) = mpsc::channel(2);
|
||||
let (_revoke_tx, revoke_rx) = oneshot::channel();
|
||||
|
||||
let (_, mut ads) = service.on_request(
|
||||
req1,
|
||||
sender,
|
||||
revoke_rx,
|
||||
ns,
|
||||
ads,
|
||||
).await;
|
||||
|
||||
|
||||
service.on_peer_connected(&peer_ids[0], &mut ads).await;
|
||||
let reply1 = receiver.next().await.unwrap();
|
||||
assert_eq!(reply1.0, authority_ids[0]);
|
||||
assert_eq!(reply1.1, peer_ids[0]);
|
||||
|
||||
service.on_peer_connected(&peer_ids[1], &mut ads).await;
|
||||
let reply2 = receiver.next().await.unwrap();
|
||||
assert_eq!(reply2.0, authority_ids[1]);
|
||||
assert_eq!(reply2.1, peer_ids[1]);
|
||||
});
|
||||
}
|
||||
|
||||
// Test cleanup works.
|
||||
#[test]
|
||||
fn requests_are_removed_on_revoke() {
|
||||
let mut service = new_service();
|
||||
|
||||
let (ns, mut ads) = new_network();
|
||||
|
||||
let peer_ids: Vec<_> = ads.by_peer_id.keys().cloned().collect();
|
||||
let authority_ids: Vec<_> = ads.by_peer_id.values().cloned().collect();
|
||||
|
||||
futures::executor::block_on(async move {
|
||||
let (sender, mut receiver) = mpsc::channel(1);
|
||||
let (revoke_tx, revoke_rx) = oneshot::channel();
|
||||
|
||||
service.on_peer_connected(&peer_ids[0], &mut ads).await;
|
||||
service.on_peer_connected(&peer_ids[1], &mut ads).await;
|
||||
|
||||
let (ns, ads) = service.on_request(
|
||||
vec![authority_ids[0].clone()],
|
||||
sender,
|
||||
revoke_rx,
|
||||
ns,
|
||||
ads,
|
||||
).await;
|
||||
|
||||
let _ = receiver.next().await.unwrap();
|
||||
// revoke the request
|
||||
revoke_tx.send(()).unwrap();
|
||||
|
||||
let (sender, mut receiver) = mpsc::channel(1);
|
||||
let (_revoke_tx, revoke_rx) = oneshot::channel();
|
||||
|
||||
let _ = service.on_request(
|
||||
vec![authority_ids[1].clone()],
|
||||
sender,
|
||||
revoke_rx,
|
||||
ns,
|
||||
ads,
|
||||
).await;
|
||||
|
||||
let reply = receiver.next().await.unwrap();
|
||||
assert_eq!(reply.0, authority_ids[1]);
|
||||
assert_eq!(reply.1, peer_ids[1]);
|
||||
assert_eq!(service.non_revoked_discovery_requests.len(), 1);
|
||||
});
|
||||
}
|
||||
|
||||
// More complex test with overlapping revoked requests
|
||||
#[test]
|
||||
fn revoking_requests_with_overlapping_validator_sets() {
|
||||
let mut service = new_service();
|
||||
|
||||
let (ns, mut ads) = new_network();
|
||||
|
||||
let peer_ids: Vec<_> = ads.by_peer_id.keys().cloned().collect();
|
||||
let authority_ids: Vec<_> = ads.by_peer_id.values().cloned().collect();
|
||||
|
||||
futures::executor::block_on(async move {
|
||||
let (sender, mut receiver) = mpsc::channel(1);
|
||||
let (revoke_tx, revoke_rx) = oneshot::channel();
|
||||
|
||||
service.on_peer_connected(&peer_ids[0], &mut ads).await;
|
||||
service.on_peer_connected(&peer_ids[1], &mut ads).await;
|
||||
|
||||
let (ns, ads) = service.on_request(
|
||||
vec![authority_ids[0].clone(), authority_ids[2].clone()],
|
||||
sender,
|
||||
revoke_rx,
|
||||
ns,
|
||||
ads,
|
||||
).await;
|
||||
|
||||
let _ = receiver.next().await.unwrap();
|
||||
// revoke the first request
|
||||
revoke_tx.send(()).unwrap();
|
||||
|
||||
let (sender, mut receiver) = mpsc::channel(1);
|
||||
let (revoke_tx, revoke_rx) = oneshot::channel();
|
||||
|
||||
let (ns, ads) = service.on_request(
|
||||
vec![authority_ids[0].clone(), authority_ids[1].clone()],
|
||||
sender,
|
||||
revoke_rx,
|
||||
ns,
|
||||
ads,
|
||||
).await;
|
||||
|
||||
let _ = receiver.next().await.unwrap();
|
||||
assert_eq!(service.non_revoked_discovery_requests.len(), 1);
|
||||
assert_eq!(ns.priority_group.lock().unwrap().len(), 2);
|
||||
|
||||
// revoke the second request
|
||||
revoke_tx.send(()).unwrap();
|
||||
|
||||
let (sender, mut receiver) = mpsc::channel(1);
|
||||
let (_revoke_tx, revoke_rx) = oneshot::channel();
|
||||
|
||||
let (ns, _) = service.on_request(
|
||||
vec![authority_ids[0].clone()],
|
||||
sender,
|
||||
revoke_rx,
|
||||
ns,
|
||||
ads,
|
||||
).await;
|
||||
|
||||
let _ = receiver.next().await.unwrap();
|
||||
assert_eq!(service.non_revoked_discovery_requests.len(), 1);
|
||||
assert_eq!(ns.priority_group.lock().unwrap().len(), 1);
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user