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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
//! Web utils
use awc::{
    error::{PayloadError, SendRequestError},
    http::{header, HeaderMap, HeaderName, HeaderValue, Method, StatusCode},
    ClientRequest, ClientResponse, SendClientRequest,
};
use bytes::{Buf, Bytes, BytesMut};
use futures::stream::Peekable;
use futures::{Stream, StreamExt, TryStreamExt};
use heck::MixedCase;
use serde::{de::DeserializeOwned, Serialize};
use serde_qs;
use std::cmp::max;
use std::convert::TryFrom;
use std::pin::Pin;
use std::task::{Context, Poll};
use std::{env, rc::Rc, str::FromStr, time::Duration};
use url::{form_urlencoded, Url};

use crate::model::ErrorMessage;
use crate::{Error, Result};

pub const YAGNA_API_URL_ENV_VAR: &str = "YAGNA_API_URL";
pub const DEFAULT_YAGNA_API_URL: &str = "http://127.0.0.1:7465";
const MAX_BODY_SIZE: usize = 10 * 1024 * 1024;

pub fn rest_api_url() -> Url {
    let api_url = env::var(YAGNA_API_URL_ENV_VAR).unwrap_or(DEFAULT_YAGNA_API_URL.into());
    api_url
        .parse()
        .expect(&format!("invalid API URL: {}", api_url))
}

#[derive(Clone, Debug)]
pub enum WebAuth {
    Bearer(String),
}

/// Convenient wrapper for the [`awc::Client`](
/// https://docs.rs/awc/1.0/awc/struct.Client.html) with builder.
#[derive(Clone)]
pub struct WebClient {
    base_url: Rc<Url>,
    awc: awc::Client,
}

pub trait WebInterface {
    const API_URL_ENV_VAR: &'static str;
    const API_SUFFIX: &'static str;

    fn rebase_service_url(base_url: Rc<Url>) -> Result<Rc<Url>> {
        if let Some(url) = std::env::var(Self::API_URL_ENV_VAR).ok() {
            return Ok(Url::from_str(&url)?.into());
        }
        Ok(base_url.join(Self::API_SUFFIX)?.into())
    }

    fn from_client(client: WebClient) -> Self;
}

#[derive(Clone)]
pub struct WebRequestMeta {
    method: Method,
    url: String,
}

impl WebRequestMeta {
    fn new(method: Method, url: String) -> Self {
        WebRequestMeta { method, url }
    }

    fn as_request_err(&self, err: SendRequestError) -> Error {
        Error::from_request(err, self.method.clone(), self.url.clone())
    }

    fn as_response_err(&self, code: StatusCode, msg: String) -> Error {
        Error::from_response(code, msg, self.method.clone(), self.url.clone())
    }
}

pub struct WebRequest<T> {
    inner_request: T,
    meta: WebRequestMeta,
}

impl WebClient {
    pub fn builder() -> WebClientBuilder {
        WebClientBuilder::default()
    }

    pub fn with_token(token: &str) -> WebClient {
        WebClientBuilder::default().auth_token(token).build()
    }

    /// constructs endpoint url in form of `<base_url>/<suffix>`.
    ///
    /// suffix should not have leading slash ie. `offer` not `/offer`
    fn url<T: AsRef<str>>(&self, suffix: T) -> Result<url::Url> {
        Ok(self.base_url.join(suffix.as_ref())?)
    }

    pub fn request(&self, method: Method, url: &str) -> WebRequest<ClientRequest> {
        let url = self.url(url).unwrap().to_string();
        log::debug!("doing {} on {}", method, url);
        WebRequest {
            inner_request: self.awc.request(method.clone(), &url),
            meta: WebRequestMeta::new(method, url),
        }
    }

    pub async fn event_stream(&self, url: &str) -> Result<impl Stream<Item = Result<Event>>> {
        let url = self.url(url).unwrap().to_string();
        log::debug!("event stream at {}", url);
        let method = Method::GET;
        let request = self
            .awc
            .request(method.clone(), &url)
            .set(header::Accept(vec![header::qitem(mime::TEXT_EVENT_STREAM)]));
        let stream = request
            .send()
            .await
            .map_err(|e| Error::from_request(e, method, url))?
            .into_stream()
            .map_err(Error::from)
            .event_stream();
        Ok(stream)
    }

    pub fn get(&self, url: &str) -> WebRequest<ClientRequest> {
        self.request(Method::GET, url)
    }

    pub fn post(&self, url: &str) -> WebRequest<ClientRequest> {
        self.request(Method::POST, url)
    }

    pub fn put(&self, url: &str) -> WebRequest<ClientRequest> {
        self.request(Method::PUT, url)
    }

    pub fn delete(&self, url: &str) -> WebRequest<ClientRequest> {
        self.request(Method::DELETE, url)
    }

    pub fn interface<T: WebInterface>(&self) -> Result<T> {
        self.interface_at(None)
    }

    pub fn interface_at<T: WebInterface>(&self, base_url: impl Into<Option<Url>>) -> Result<T> {
        let base_url = match base_url.into() {
            Some(url) => url.into(),
            None => T::rebase_service_url(self.base_url.clone())?,
        };

        let awc = self.awc.clone();
        Ok(T::from_client(WebClient { base_url, awc }))
    }
}

impl WebRequest<ClientRequest> {
    pub fn send_json<T: Serialize + std::fmt::Debug>(
        self,
        value: &T,
    ) -> WebRequest<SendClientRequest> {
        log::trace!("sending payload: {:?}", value);
        WebRequest {
            inner_request: self.inner_request.send_json(value),
            meta: self.meta,
        }
    }

    pub fn send_bytes(self, bytes: Vec<u8>) -> WebRequest<SendClientRequest> {
        let inner_request = self
            .inner_request
            .content_type("application/octet-stream")
            .send_body(bytes);
        WebRequest {
            inner_request,
            meta: self.meta,
        }
    }

    pub fn send(self) -> WebRequest<SendClientRequest> {
        WebRequest {
            inner_request: self.inner_request.send(),
            meta: self.meta,
        }
    }
}

impl WebRequest<SendClientRequest> {
    async fn request(
        self,
    ) -> Result<ClientResponse<impl Stream<Item = std::result::Result<Bytes, PayloadError>>>> {
        let meta = self.meta.clone();
        let mut response = self
            .inner_request
            .await
            .map_err(|e| meta.as_request_err(e))?;

        log::trace!("{:?}", response.headers());
        if response.status().is_success() {
            Ok(response)
        } else {
            let msg = if response
                .headers()
                .get(header::CONTENT_TYPE)
                .map(|v| v.as_bytes() == b"application/json")
                .unwrap_or_default()
            {
                let err_msg = response.json().await;
                err_msg
                    .map(|e: ErrorMessage| e.message.unwrap_or_default())
                    .unwrap_or_else(|e| format!("error parsing error msg: {}", e))
            } else {
                match response.body().limit(MAX_BODY_SIZE).await {
                    Ok(ref bytes) => String::from_utf8_lossy(&bytes).to_string(),
                    Err(e) => e.to_string(),
                }
            };
            Err(meta.as_response_err(response.status(), msg))
        }
    }

    pub async fn bytes(self) -> Result<Vec<u8>> {
        Ok(self.request().await?.body().await?.to_vec())
    }

    pub async fn json<T: DeserializeOwned>(self) -> Result<T> {
        let meta = self.meta.clone();
        let mut response = self.request().await?;

        // allow empty body and no content (204) to pass smoothly
        if StatusCode::NO_CONTENT == response.status()
            || Some("0")
                == response
                    .headers()
                    .get(header::CONTENT_LENGTH)
                    .and_then(|h| h.to_str().ok())
        {
            return Ok(serde_json::from_value(serde_json::json!(()))?);
        }
        let raw_body = response.body().limit(MAX_BODY_SIZE).await?;
        let body = std::str::from_utf8(&raw_body)?;
        log::debug!(
            "WebRequest.json(). method={} url={}, resp='{}'",
            meta.method,
            meta.url,
            body.split_at(512.min(body.len())).0
        );
        Ok(serde_json::from_str(body)?)
    }
}

// this is used internally to translate from HTTP Timeout into default result
// (empty vec most of the time)
pub(crate) fn default_on_timeout<T: Default>(err: Error) -> Result<T> {
    match err {
        Error::TimeoutError { msg, url, .. } => {
            log::trace!("timeout getting url {}: {}", url, msg);
            Ok(Default::default())
        }
        _ => Err(err),
    }
}

#[derive(Clone, Debug)]
pub struct WebClientBuilder {
    pub(crate) api_url: Option<Url>,
    pub(crate) auth: Option<WebAuth>,
    pub(crate) headers: HeaderMap,
    pub(crate) timeout: Option<Duration>,
}

impl WebClientBuilder {
    pub fn auth_token(mut self, token: &str) -> Self {
        self.auth = Some(WebAuth::Bearer(token.to_string()));
        self
    }

    pub fn api_url(mut self, url: Url) -> Self {
        self.api_url = Some(url);
        self
    }

    pub fn timeout(mut self, timeout: Duration) -> Self {
        self.timeout = Some(timeout);
        self
    }

    pub fn header(mut self, name: String, value: String) -> Result<Self> {
        let name = HeaderName::from_str(name.as_str())?;
        let value = HeaderValue::from_str(value.as_str())?;

        self.headers.insert(name, value);
        Ok(self)
    }

    pub fn build(self) -> WebClient {
        let mut builder = awc::ClientBuilder::new();

        if let Some(timeout) = self.timeout {
            builder = builder.timeout(timeout);
        } else {
            builder = builder.disable_timeout();
        }
        if let Some(auth) = &self.auth {
            builder = match auth {
                WebAuth::Bearer(token) => builder.bearer_auth(token),
            }
        }
        for (key, value) in self.headers.iter() {
            builder = builder.header(key.clone(), value.clone());
        }

        WebClient {
            base_url: Rc::new(self.api_url.unwrap_or_else(|| rest_api_url())),
            awc: builder.finish(),
        }
    }
}

impl Default for WebClientBuilder {
    fn default() -> Self {
        WebClientBuilder {
            api_url: None,
            auth: None,
            headers: HeaderMap::new(),
            timeout: None,
        }
    }
}

/// Builder for the query part of the URLs.
pub struct QueryParamsBuilder<'a> {
    serializer: form_urlencoded::Serializer<'a, String>,
}

impl<'a> QueryParamsBuilder<'a> {
    pub fn new() -> Self {
        let serializer = form_urlencoded::Serializer::new("".into());
        QueryParamsBuilder { serializer }
    }

    pub fn put<N: ToString, V: ToString>(mut self, name: N, value: Option<V>) -> Self {
        if let Some(v) = value {
            self.serializer
                .append_pair(&name.to_string().to_mixed_case(), &v.to_string());
        };
        self
    }

    pub fn build(mut self) -> String {
        self.serializer.finish()
    }
}

#[derive(Debug)]
pub struct Event {
    pub id: Option<u64>,
    pub event: String,
    pub data: String,
}

impl TryFrom<String> for Event {
    type Error = Error;

    fn try_from(string: String) -> Result<Self> {
        let mut id = None;
        let mut event = String::new();
        let mut data = Vec::<String>::new();

        for line in string.split('\n') {
            let split = line.splitn(2, ":").collect::<Vec<_>>();
            if split.len() < 2 {
                continue;
            }

            let value = split[1].trim_start();
            match split[0] {
                "event" => event = value.into(),
                "data" => data.push(value.into()),
                "id" => {
                    id = match value.parse::<u64>() {
                        Ok(id) => Some(id),
                        _ => None,
                    }
                }
                _ => (),
            }
        }
        if event.is_empty() {
            return Err(Error::EventStreamError("Missing event entry".into()));
        }
        let data = data.join("\n");
        Ok(Event { id, event, data })
    }
}

pub trait EventStreamExt<S, E>
where
    S: Stream<Item = std::result::Result<Bytes, E>> + Unpin + 'static,
    E: Into<Error>,
{
    fn event_stream(self) -> EventStream<S, E>;
}

impl<S, E> EventStreamExt<S, E> for S
where
    S: Stream<Item = std::result::Result<Bytes, E>> + Unpin + 'static,
    E: Into<Error>,
{
    fn event_stream(self) -> EventStream<S, E> {
        EventStream::new(self)
    }
}

pub struct EventStream<S, E>
where
    S: Stream<Item = std::result::Result<Bytes, E>> + Unpin + 'static,
{
    inner: Peekable<S>,
    buffer: BytesMut,
}

impl<S, E> EventStream<S, E>
where
    S: Stream<Item = std::result::Result<Bytes, E>> + Unpin + 'static,
    E: Into<Error>,
{
    pub fn new(stream: S) -> Self {
        EventStream {
            inner: stream.peekable(),
            buffer: BytesMut::new(),
        }
    }

    fn next_event(&mut self, start_idx: usize) -> Option<Result<Event>> {
        let idx = max(0, start_idx as i64 - 1) as usize;
        if let Some(idx) = Self::find(self.buffer.bytes(), b"\n\n", idx) {
            let bytes = self.buffer.split_to(idx);
            return String::from_utf8(bytes.to_vec())
                .map(Event::try_from)
                .map_err(Error::from)
                .ok();
        }
        None
    }

    fn find(source: &[u8], find: &[u8], start_idx: usize) -> Option<usize> {
        let mut find_idx = 0;
        for (i, b) in source.iter().enumerate().skip(start_idx) {
            if *b == find[find_idx] {
                find_idx += 1;
                if find_idx == find.len() {
                    return Some(i);
                }
            } else {
                find_idx = 0;
            }
        }
        None
    }
}

impl<S, E> Stream for EventStream<S, E>
where
    S: Stream<Item = std::result::Result<Bytes, E>> + Unpin + 'static,
    E: Into<Error>,
{
    type Item = std::result::Result<Event, Error>;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let this = self.get_mut();
        if let Some(result) = this.next_event(0) {
            return Poll::Ready(Some(result));
        }

        match Pin::new(&mut this.inner).poll_next(cx) {
            Poll::Ready(Some(Ok(bytes))) => {
                let idx = this.buffer.len();
                this.buffer.extend(bytes.into_iter());

                if let Some(result) = this.next_event(idx) {
                    Poll::Ready(Some(result))
                } else {
                    if let Poll::Ready(_) = Pin::new(&mut this.inner).poll_peek(cx) {
                        cx.waker().wake_by_ref();
                    }
                    Poll::Pending
                }
            }
            Poll::Ready(Some(Err(e))) => Poll::Ready(Some(Err(e.into()))),
            Poll::Ready(None) => Poll::Ready(None),
            Poll::Pending => Poll::Pending,
        }
    }
}

/// Macro to facilitate URL formatting for REST API async bindings
macro_rules! url_format {
    {
        $path:expr $(,$var:ident)* $(,#[query] $varq:ident)* $(,)?
    } => {{
        let mut url = format!( $path $(, $var=$var)* );
        let query = crate::web::QueryParamsBuilder::new()
            $( .put( stringify!($varq), $varq ) )*
            .build();
        if query.len() > 1 {
            url = format!("{}?{}", url, query)
        }
        url
    }};
}

pub fn url_format_obj<T>(base: &str, params: &T) -> String
where
    T: Serialize,
{
    let qs = serde_qs::to_string(params).unwrap_or("".to_string());
    if qs.len() > 0 {
        format!("{}?{}", base, qs)
    } else {
        base.to_string()
    }
}

#[cfg(test)]
#[rustfmt::skip]
mod tests {
    use bytes::Bytes;
    use crate::web::EventStream;
    use futures::{StreamExt, FutureExt, Stream};
    use crate::Error;

    #[test]
    fn static_url() {
        assert_eq!(url_format!("foo"), "foo");
    }

    #[test]
    fn single_placeholder_url() {
        let bar = "qux";
        assert_eq!(url_format!("foo/{}", bar), "foo/qux");
    }

    #[test]
    fn single_var_url() {
        let bar = "qux";
        assert_eq!(url_format!("foo/{bar}", bar), "foo/qux");
    }

    // compilation error when wrong var name given
    //    #[test]
    //    fn wrong_single_var_url() {
    //        let bar="qux";
    //        assert_eq!(url_format!("foo/{baz}", bar), "foo/{}");
    //    }

    #[test]
    fn multi_var_url() {
        let bar = "qux";
        let baz = "quz";
        assert_eq!(
            url_format!("foo/{bar}/fuu/{baz}", bar, baz),
            "foo/qux/fuu/quz"
        );
    }

    #[test]
    fn empty_query_url() {
        let bar = Option::<String>::None;
        assert_eq!(url_format!("foo", #[query] bar), "foo");
    }

    #[test]
    #[rustfmt::skip]
    fn single_query_url() {
        let bar= Some("qux");
        assert_eq!(url_format!("foo", #[query] bar), "foo?bar=qux");
    }

    #[test]
    fn mix_query_url() {
        let bar = Option::<String>::None;
        let baz = Some("quz");
        assert_eq!(url_format!("foo", #[query] bar, #[query] baz), "foo?baz=quz");
    }

    #[test]
    fn multi_query_url() {
        let bar = Some("qux");
        let baz = Some("quz");
        assert_eq!(url_format!("foo", #[query] bar, #[query] baz), "foo?bar=qux&baz=quz");
    }

    #[test]
    fn multi_var_and_query_url() {
        let bar = "baara";
        let baz = 0;
        let qar = Some(true);
        let qaz = Some(3);
        assert_eq!(
            url_format!(
                "foo/{bar}/fuu/{baz}",
                bar,
                baz,
                #[query] qar,
                #[query] qaz
            ),
            "foo/baara/fuu/0?qar=true&qaz=3"
        );
    }

    async fn verify_stream<S, F>(f: F) -> anyhow::Result<()>
    where
        S: Stream<Item = std::result::Result<Bytes, Error>> + Unpin + 'static,
        F: Fn(&'static str) -> EventStream<S, Error>,
    {
        let src = r#"
:ping
event: stdout
data: some
data: output
id: 1

:ping

event: stderr
data:
id: 2

event: stdout
data: 0
id

"#;
        let stream = f(src);
        let events = stream.collect::<Vec<_>>().await;

        assert_eq!(events.len(), 4);
        let mut iter = events.into_iter();

        let event = iter.next().unwrap()?;
        assert_eq!(event.event, "stdout".to_string());
        assert_eq!(event.data, "some\noutput".to_string());
        assert_eq!(event.id, Some(1));

        assert!(iter.next().unwrap().is_err());

        let event = iter.next().unwrap()?;
        assert_eq!(event.event, "stderr".to_string());
        assert_eq!(event.data, "".to_string());
        assert_eq!(event.id, Some(2));

        let event = iter.next().unwrap()?;
        assert_eq!(event.event, "stdout".to_string());
        assert_eq!(event.data, "0".to_string());
        assert_eq!(event.id, None);

        Ok(())
    }

    #[actix_rt::test]
    async fn event_stream() {
        verify_stream(|s| {
            let stream = futures::stream::once(async move { Ok::<_, Error>(Bytes::from(s.to_string().into_bytes()))}.boxed_local());
            EventStream::new(stream)
        }).await.unwrap();

        verify_stream(|s| {
            let stream = futures::stream::iter(s.as_bytes()).chunks(5).map(|v| {
                Ok::<_, Error>(Bytes::from(v.iter().map(|b| **b).collect::<Vec<_>>()))
            });
            EventStream::new(stream)
        }).await.unwrap();

        verify_stream(|s| {
            let stream = futures::stream::iter(s.as_bytes()).chunks(1).map(|v| {
                Ok::<_, Error>(Bytes::from(v.iter().map(|b| **b).collect::<Vec<_>>()))
            });
            EventStream::new(stream)
        }).await.unwrap();
    }
}