1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

// Copyright (c) The Diem Core Contributors
// SPDX-License-Identifier: Apache-2.0

#![forbid(unsafe_code)]

use async_trait::async_trait;
use diem_config::network_id::PeerNetworkId;
use diem_types::PeerId;
use network::{
    application::{
        interface::{MultiNetworkSender, NetworkInterface},
        storage::{LockingHashMap, PeerMetadataStorage},
    },
    error::NetworkError,
    peer_manager::{ConnectionRequestSender, PeerManagerRequestSender},
    protocols::network::{
        AppConfig, ApplicationNetworkSender, NetworkSender, NewNetworkSender, RpcError,
    },
    ProtocolId,
};
use std::{sync::Arc, time::Duration};
use storage_service_types::{
    StorageServiceError, StorageServiceMessage, StorageServiceRequest, StorageServiceResponse,
};
use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    #[error("DiemNet Rpc error: {0}")]
    RpcError(#[from] RpcError),

    #[error("Error from remote storage service: {0}")]
    StorageServiceError(#[from] StorageServiceError),
}

// TODO(philiphayes): need to expose access to somewhere to store per-peer data?
// is this the right place?
/// The interface for sending Storage Service requests and querying network peer
/// information.
#[derive(Clone, Debug)]
pub struct StorageServiceClient {
    network_sender: StorageServiceMultiSender,
    peer_metadata: Arc<PeerMetadataStorage>,
}

impl StorageServiceClient {
    pub fn new(
        network_sender: StorageServiceMultiSender,
        peer_metadata: Arc<PeerMetadataStorage>,
    ) -> Self {
        Self {
            network_sender,
            peer_metadata,
        }
    }

    pub async fn send_request(
        &self,
        recipient: PeerNetworkId,
        request: StorageServiceRequest,
        timeout: Duration,
    ) -> Result<StorageServiceResponse, Error> {
        let message = self
            .network_sender
            .send_rpc(recipient, StorageServiceMessage::Request(request), timeout)
            .await?;
        match message {
            StorageServiceMessage::Response(Ok(response)) => Ok(response),
            StorageServiceMessage::Response(Err(err)) => Err(Error::StorageServiceError(err)),
            StorageServiceMessage::Request(_) => Err(Error::RpcError(RpcError::InvalidRpcResponse)),
        }
    }
}

// TODO(philiphayes): not clear yet what value this trait is providing
#[async_trait]
impl NetworkInterface<StorageServiceMessage, StorageServiceMultiSender> for StorageServiceClient {
    // TODO(philiphayes): flesh out
    type AppDataKey = ();
    type AppData = ();

    fn peer_metadata_storage(&self) -> &PeerMetadataStorage {
        &self.peer_metadata
    }

    // TODO(philiphayes): kind of awkward? I don't actually want to expose this...
    // sending should just be a part of the interface itself no?
    fn sender(&self) -> StorageServiceMultiSender {
        todo!()
    }

    fn app_data(&self) -> &LockingHashMap<Self::AppDataKey, Self::AppData> {
        todo!()
    }
}

/// A network sender that dispatches across multiple networks.
pub type StorageServiceMultiSender =
    MultiNetworkSender<StorageServiceMessage, StorageServiceNetworkSender>;

pub fn network_endpoint_config() -> AppConfig {
    AppConfig::client([ProtocolId::StorageServiceRpc])
}

// TODO(philiphayes): this is a lot of boilerplate for what is effectively a
// NetworkSender type alias that impls ApplicationNetworkSender... maybe we just
// add ProtocolId to the APIs so we don't need this extra layer?
/// The Storage Service network sender for a single network.
#[derive(Clone, Debug)]
pub struct StorageServiceNetworkSender {
    inner: NetworkSender<StorageServiceMessage>,
}

impl NewNetworkSender for StorageServiceNetworkSender {
    fn new(
        peer_mgr_reqs_tx: PeerManagerRequestSender,
        connection_reqs_tx: ConnectionRequestSender,
    ) -> Self {
        Self {
            inner: NetworkSender::new(peer_mgr_reqs_tx, connection_reqs_tx),
        }
    }
}

#[async_trait]
impl ApplicationNetworkSender<StorageServiceMessage> for StorageServiceNetworkSender {
    fn send_to(
        &self,
        _recipient: PeerId,
        _message: StorageServiceMessage,
    ) -> Result<(), NetworkError> {
        unimplemented!()
    }

    // TODO(philiphayes): a lot of boilerplate just to add `ProtocolId::StorageServiceRpc`
    // by default.
    async fn send_rpc(
        &self,
        recipient: PeerId,
        message: StorageServiceMessage,
        timeout: Duration,
    ) -> Result<StorageServiceMessage, RpcError> {
        self.inner
            .send_rpc(recipient, ProtocolId::StorageServiceRpc, message, timeout)
            .await
    }
}