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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
#![cfg(not(target_arch = "wasm32"))]
use crate::{
    core::{Invocation, InvocationResponse, WasmCloudEntity},
    Message, RpcError,
};
#[allow(unused_imports)]
use log::{debug, error, trace};
use ring::digest::{Context, Digest, SHA256};
use serde::{de::DeserializeOwned, Serialize};
use serde_json::Value as JsonValue;
use std::{
    convert::{TryFrom, TryInto},
    io::Read,
    ops::Deref,
    sync::Arc,
};

/// Send wasmbus rpc messages
///
/// The primary use of RpcClient is providers sending to actors,
/// however providers don't need to construct this - one is created
/// by HostBridge, which providers create during initialization.
///
/// This class is also used by wash and test tools for sending
/// rpc messages to actors and providers. Note that sending to
/// a provider requires an existing link definition, _and_,
/// the message needs to be signed by a valid cluster key.
///
/// This RpcClient does not subscribe to rpc topics.
/// To subscribe, use the nats client api directly.
///
#[derive(Clone)]
pub struct RpcClient {
    /// sync or async nats client
    client: NatsClientType,
    /// lattice rpc prefix
    lattice_prefix: String,
    /// secrets for signing invocations
    key: Arc<wascap::prelude::KeyPair>,
}

#[derive(Clone)]
pub(crate) enum NatsClientType {
    Sync(nats::Connection),
    Asynk(nats::asynk::Connection),
    Async(Arc<crate::provider::NatsClient>),
}

/// returns rpc topic name for actor or provider target
fn topic_for(entity: &WasmCloudEntity, lattice_prefix: &str) -> String {
    if !entity.link_name.is_empty() {
        // provider target
        format!(
            "wasmbus.rpc.{}.{}.{}",
            lattice_prefix, entity.public_key, entity.link_name
        )
    } else {
        // actor target
        format!("wasmbus.rpc.{}.{}", lattice_prefix, entity.public_key)
    }
}

impl RpcClient {
    /// Constructs a new RpcClient for the async nats connection.
    /// parameters: async nats client, lattice rpc prefix (usually "default"),
    /// and secret key for signing messages
    pub fn new(
        nats: Arc<crate::provider::NatsClient>,
        lattice_prefix: &str,
        key: wascap::prelude::KeyPair,
    ) -> Self {
        RpcClient {
            client: NatsClientType::Async(nats),
            lattice_prefix: lattice_prefix.to_string(),
            key: Arc::new(key),
        }
    }

    /// Constructs a new RpcClient for a nats::asynk connection.
    /// parameters: async nats client, lattice rpc prefix (usually "default"),
    /// and secret key for signing messages
    pub fn new_asynk(
        nats: nats::asynk::Connection,
        lattice_prefix: &str,
        key: wascap::prelude::KeyPair,
    ) -> Self {
        RpcClient {
            client: NatsClientType::Asynk(nats),
            lattice_prefix: lattice_prefix.to_string(),
            key: Arc::new(key),
        }
    }

    /// Constructs a new RpcClient using an async nats connection
    /// parameters: synch nats client connection, lattice rpc prefix (usually "default"),
    /// and secret key for signing messages
    fn new_sync(
        nats: nats::Connection,
        lattice_prefix: &str,
        key: wascap::prelude::KeyPair,
    ) -> Self {
        RpcClient {
            client: NatsClientType::Sync(nats),
            lattice_prefix: lattice_prefix.to_string(),
            key: Arc::new(key),
        }
    }

    // convenience method for returning async client
    // If the client is not the correct type, returns None
    pub fn get_async(&self) -> Option<&ratsio::NatsClient> {
        use std::borrow::Borrow;
        match self.client.borrow() {
            NatsClientType::Async(nats) => Some(nats),
            _ => None,
        }
    }

    // convenience method for returning nats::asynk Connection
    // If the client is not the correct type, returns None
    pub fn get_asynk(&self) -> Option<&nats::asynk::Connection> {
        use std::borrow::Borrow;
        match self.client.borrow() {
            NatsClientType::Asynk(nc) => Some(nc),
            _ => None,
        }
    }

    /// Send an rpc message using json-encoded data
    pub async fn send_json<Target, Arg, Resp>(
        &self,
        origin: WasmCloudEntity,
        target: Target,
        method: &str,
        data: JsonValue,
    ) -> Result<JsonValue, RpcError>
    where
        Arg: DeserializeOwned + Serialize,
        Resp: DeserializeOwned + Serialize,
        Target: Into<WasmCloudEntity>,
    {
        let msg = JsonMessage(method, data).try_into()?;
        let bytes = self.send(origin, target, msg).await?;
        let resp = response_to_json::<Resp>(&bytes)?;
        Ok(resp)
    }

    /// Send an rpc message.
    ///   target may be &str or String for sending to an actor, or a WasmCloudEntity (for actor or provider)
    /// If nats client is sync, this can block the current thread
    pub async fn send<Target>(
        &self,
        origin: WasmCloudEntity,
        target: Target,
        message: Message<'_>,
    ) -> Result<Vec<u8>, RpcError>
    where
        Target: Into<WasmCloudEntity>,
    {
        let target = target.into();
        let origin_url = origin.url();
        let subject = make_uuid();
        let issuer = &self.key.public_key();
        let target_url = format!("{}/{}", target.url(), &message.method);
        debug!("rpc_client sending to {}", &target_url);
        let claims = wascap::prelude::Claims::<wascap::prelude::Invocation>::new(
            issuer.clone(),
            subject,
            &target_url,
            &origin_url,
            &invocation_hash(&target_url, &origin_url, &message.arg),
        );

        let topic = topic_for(&target, &self.lattice_prefix);
        let method = message.method.to_string();
        let invocation = Invocation {
            origin,
            target,
            operation: method.clone(),
            msg: message.arg.into_owned(),
            id: make_uuid(),
            encoded_claims: claims.encode(&self.key).unwrap(),
            host_id: String::new(),
        };
        trace!("rpc send {}", &target_url);

        let nats_body = crate::serialize(&invocation)?;

        // TODO: request with timeout
        let payload = self
            .request(&topic, &nats_body)
            .await
            .map_err(|e| RpcError::Nats(format!("rpc send error: {}: {}", target_url, e)))?;
        let inv_response = crate::deserialize::<InvocationResponse>(&payload)
            .map_err(|e| RpcError::Deser(e.to_string()))?;
        match inv_response.error {
            None => {
                trace!("rpc ok response from {}", &target_url);
                Ok(inv_response.msg)
            }
            Some(err) => {
                // if error is Some(_), we must ignore the msg field
                error!("rpc error response from {}: {}", &target_url, &err);
                Err(RpcError::Rpc(err))
            }
        }
    }

    /// Send nats request wait for response.
    /// If client is sync, this can block the current thread
    pub async fn request(&self, subject: &str, data: &[u8]) -> Result<Vec<u8>, RpcError> {
        use std::borrow::Borrow;

        let bytes = match self.client.borrow() {
            NatsClientType::Async(ref nats) => {
                let resp = nats
                    .request(subject, data)
                    .await
                    .map_err(|e| RpcError::Nats(e.to_string()))?;
                resp.payload
            }
            NatsClientType::Sync(ref connection) => {
                let message = connection
                    .request(subject, data)
                    .map_err(|e| RpcError::Nats(e.to_string()))?;
                message.data
            }
            NatsClientType::Asynk(ref connection) => {
                let message = connection
                    .request(subject, data)
                    .await
                    .map_err(|e| RpcError::Nats(e.to_string()))?;
                message.data
            }
        };
        Ok(bytes)
    }

    /// Send nats message with no reply-to
    pub async fn publish(&self, subject: &str, data: &[u8]) -> Result<(), RpcError> {
        use std::borrow::Borrow;

        match self.client.borrow() {
            NatsClientType::Async(nats) => nats
                .publish(subject, data)
                .await
                .map_err(|e| RpcError::Nats(e.to_string()))?,
            NatsClientType::Sync(connection) => connection
                .publish(subject, data)
                .map_err(|e| RpcError::Nats(e.to_string()))?,
            NatsClientType::Asynk(connection) => connection
                .publish(subject, data)
                .await
                .map_err(|e| RpcError::Nats(e.to_string()))?,
        }
        Ok(())
    }
}

pub(crate) fn invocation_hash(target_url: &str, origin_url: &str, msg: &[u8]) -> String {
    use std::io::Write;
    let mut cleanbytes: Vec<u8> = Vec::new();
    cleanbytes.write_all(origin_url.as_bytes()).unwrap();
    cleanbytes.write_all(target_url.as_bytes()).unwrap();
    cleanbytes.write_all(msg).unwrap();
    let digest = sha256_digest(cleanbytes.as_slice()).unwrap();
    data_encoding::HEXUPPER.encode(digest.as_ref())
}

fn sha256_digest<R: Read>(mut reader: R) -> Result<Digest, Box<dyn std::error::Error>> {
    let mut context = Context::new(&SHA256);
    let mut buffer = [0; 1024];

    loop {
        let count = reader.read(&mut buffer).map_err(|e| format!("{}", e))?;
        if count == 0 {
            break;
        }
        context.update(&buffer[..count]);
    }

    Ok(context.finish())
}

/// Create a new random uuid for invocations
pub fn make_uuid() -> String {
    use uuid::Uuid;
    // TODO: revisit whether this is using the right random
    // all providers should use make_uuid() so we can change generation later if necessary

    Uuid::new_v4()
        .to_simple()
        .encode_lower(&mut Uuid::encode_buffer())
        .to_string()
}

impl Deref for RpcClientSync {
    type Target = RpcClient;

    fn deref(&self) -> &RpcClient {
        &self.inner
    }
}

pub struct RpcClientSync {
    inner: RpcClient,
}

impl RpcClientSync {
    /// Constructs a new synchronous RpcClient
    /// parameters: nats client connection, lattice rpc prefix (usually "default"),
    /// and secret key for signing messages
    pub fn new(
        nats: nats::Connection,
        lattice_prefix: &str,
        key: wascap::prelude::KeyPair,
    ) -> Self {
        RpcClientSync {
            inner: RpcClient::new_sync(nats, lattice_prefix, key),
        }
    }

    /// Send an rpc message using json-encoded data.
    /// Blocks the current thread until response is received.
    pub async fn send_json<Target, Arg, Resp>(
        &self,
        origin: WasmCloudEntity,
        target: Target,
        method: &str,
        data: JsonValue,
    ) -> Result<JsonValue, RpcError>
    where
        Arg: DeserializeOwned + Serialize,
        Resp: DeserializeOwned + Serialize,
        Target: Into<WasmCloudEntity>,
    {
        let msg = JsonMessage(method, data).try_into()?;
        let bytes = self.send(origin, target, msg)?;
        let resp = response_to_json::<Resp>(&bytes)?;
        Ok(resp)
    }

    /// Send an rpc message.
    /// Blocks the current thread until response is received.
    pub fn send<Target>(
        &self,
        origin: WasmCloudEntity,
        target: Target,
        message: Message<'_>,
    ) -> Result<Vec<u8>, RpcError>
    where
        Target: Into<WasmCloudEntity>,
    {
        let this = self.inner.clone();
        let handle = tokio::runtime::Handle::current();
        handle.block_on(async move { this.send(origin, target, message).await })
    }
}

/// A Json message (method, args)
struct JsonMessage<'m>(&'m str, JsonValue);

impl<'m> TryFrom<JsonMessage<'m>> for Message<'m> {
    /// convert json message to rpc message (msgpack)
    fn try_from(jm: JsonMessage<'m>) -> Result<Message<'m>, Self::Error> {
        let arg = json_to_args::<JsonValue>(jm.1)?;
        Ok(Message {
            method: jm.0,
            arg: std::borrow::Cow::Owned(arg),
        })
    }

    type Error = RpcError;
}

/// convert json args to msgpack
fn json_to_args<T>(v: JsonValue) -> Result<Vec<u8>, RpcError>
where
    T: Serialize,
    T: DeserializeOwned,
{
    crate::serialize(
        &serde_json::from_value::<T>(v)
            .map_err(|e| RpcError::Deser(format!("invalid params: {}.", e)))?,
    )
}

/// convert message response to json
fn response_to_json<T>(msg: &[u8]) -> Result<JsonValue, RpcError>
where
    T: Serialize,
    T: DeserializeOwned,
{
    serde_json::to_value(crate::deserialize::<T>(msg)?)
        .map_err(|e| RpcError::Ser(format!("response serialization : {}.", e)))
}