tari_comms 5.3.0-pre.3

A peer-to-peer messaging system
Documentation 
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

//  Copyright 2020, The Tari Project
//
//  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
//  following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
//  disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//  following disclaimer in the documentation and/or other materials provided with the distribution.
//
//  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
//  products derived from this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
//  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use std::{
    sync::{
        Arc,
        RwLock,
        atomic::{AtomicUsize, Ordering},
    },
    task::{Context, Poll},
};

use bytes::Bytes;
use futures::future;
use tower::{Service, util::BoxService};

use crate::{
    message::MessageExt,
    peer_manager::{PeerFeatures, create_test_peer},
    protocol::{
        ProtocolId,
        rpc::{
            Request,
            Response,
            RpcError,
            RpcStatus,
            body::{Body, ClientStreaming},
            client::RpcClient,
            context::RpcCommsBackend,
            message::RpcMethod,
            server::{NamedProtocolService, RpcServerError},
        },
    },
    test_utils::{
        build_peer_manager,
        mocks::{ConnectivityManagerMockState, create_connectivity_mock},
    },
};

#[derive(Clone, Default)]
pub struct MockRpcService {
    state: MockRpcServiceState,
}

impl NamedProtocolService for MockRpcService {
    const PROTOCOL_NAME: &'static [u8] = b"rpc-mock";
}

impl MockRpcService {
    pub fn new() -> Self {
        Default::default()
    }

    pub fn shared_state(&self) -> MockRpcServiceState {
        self.state.clone()
    }
}

impl Service<ProtocolId> for MockRpcService {
    type Error = RpcServerError;
    type Future = future::Ready<Result<Self::Response, Self::Error>>;
    type Response = BoxService<Request<Bytes>, Response<Body>, RpcStatus>;

    fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Poll::Ready(Ok(()))
    }

    fn call(&mut self, _: ProtocolId) -> Self::Future {
        let state = self.state.clone();
        let my_service = tower::service_fn(move |_: Request<Bytes>| {
            state.inc_call_count();
            future::ready(state.get_response())
        });

        future::ready(Ok(BoxService::new(my_service)))
    }
}

#[derive(Debug, Clone)]
pub struct MockRpcServiceState {
    call_count: Arc<AtomicUsize>,
    response: Arc<RwLock<Result<Response<Bytes>, RpcStatus>>>,
}

impl Default for MockRpcServiceState {
    fn default() -> Self {
        Self {
            call_count: Arc::new(AtomicUsize::new(0)),
            response: Arc::new(RwLock::new(Err(RpcStatus::not_implemented(
                "Mock service not implemented",
            )))),
        }
    }
}

impl MockRpcServiceState {
    fn inc_call_count(&self) -> usize {
        self.call_count.fetch_add(1, Ordering::SeqCst)
    }

    pub fn call_count(&self) -> usize {
        self.call_count.load(Ordering::SeqCst)
    }

    fn get_response(&self) -> Result<Response<Body>, RpcStatus> {
        let lock = &*self.response.read().unwrap();
        lock.as_ref()
            .map(|r| r.clone().map(Body::single))
            .map_err(|err| err.clone())
    }

    pub fn set_response(&self, response: Result<Response<Bytes>, RpcStatus>) {
        *self.response.write().unwrap() = response;
    }

    pub fn set_response_ok<T: prost::Message>(&self, response: &T) {
        self.set_response(Ok(Response::new(response.to_encoded_bytes().into())));
    }

    pub fn set_response_err(&self, err: RpcStatus) {
        self.set_response(Err(err));
    }
}

pub struct MockRpcClient {
    inner: RpcClient,
}

impl NamedProtocolService for MockRpcClient {
    const PROTOCOL_NAME: &'static [u8] = b"rpc-mock";
}

impl MockRpcClient {
    pub async fn request_response<T: prost::Message, R: prost::Message + Default>(
        &mut self,
        request: T,
        method: RpcMethod,
    ) -> Result<R, RpcError> {
        self.inner.request_response(request, method).await
    }

    #[allow(dead_code)]
    pub async fn server_streaming<T: prost::Message, R: prost::Message + Default>(
        &mut self,
        request: T,
        method: RpcMethod,
    ) -> Result<ClientStreaming<R>, RpcError> {
        self.inner.server_streaming(request, method).await
    }
}

impl From<RpcClient> for MockRpcClient {
    fn from(inner: RpcClient) -> Self {
        Self { inner }
    }
}

pub(crate) fn create_mocked_rpc_context() -> (RpcCommsBackend, ConnectivityManagerMockState) {
    let (connectivity, mock) = create_connectivity_mock();
    let mock_state = mock.get_shared_state();
    mock.spawn();
    let peer_manager = build_peer_manager(&create_test_peer(false, PeerFeatures::COMMUNICATION_NODE)).unwrap();

    (RpcCommsBackend::new(peer_manager, connectivity), mock_state)
}