rustymilky 0.1.0

Milky 协议的 Rust SDK
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

use anyhow::anyhow;
use tokio_tungstenite::tungstenite::client::IntoClientRequest;

use crate::{Result, protocol::ApiEndpoint};

pub(crate) fn build_event_url(base_url: &reqwest::Url) -> Result<reqwest::Url> {
  extend_url(base_url, &["event"])
}

pub(crate) fn build_api_url<T: ApiEndpoint>(base_url: &reqwest::Url) -> Result<reqwest::Url> {
  extend_url(base_url, &["api", T::NAME])
}

fn extend_url(base_url: &reqwest::Url, segments: &[&str]) -> Result<reqwest::Url> {
  let mut url = base_url.clone();
  let mut path_segments = url
    .path_segments_mut()
    .map_err(|()| anyhow!("Base URL cannot be used for path joins"))?;
  path_segments.pop_if_empty();

  for segment in segments {
    path_segments.push(segment);
  }

  drop(path_segments);

  Ok(url)
}

pub(crate) fn websocket_url(event_url: &reqwest::Url) -> Result<reqwest::Url> {
  let mut websocket_url = event_url.clone();

  match websocket_url.scheme() {
    "http" => websocket_url
      .set_scheme("ws")
      .map_err(|()| anyhow!("Failed to convert event URL to ws scheme"))?,
    "https" => websocket_url
      .set_scheme("wss")
      .map_err(|()| anyhow!("Failed to convert event URL to wss scheme"))?,
    scheme => {
      return Err(anyhow!(
        "Unsupported URL scheme for WebSocket transport: {scheme}"
      ));
    }
  }

  Ok(websocket_url)
}

pub(crate) fn websocket_request(
  event_url: &reqwest::Url,
  authorization: Option<&reqwest::header::HeaderValue>,
) -> Result<tokio_tungstenite::tungstenite::handshake::client::Request> {
  let websocket_url = websocket_url(event_url)?;
  let mut request = websocket_url.as_str().into_client_request()?;

  if let Some(authorization) = authorization {
    request
      .headers_mut()
      .insert(reqwest::header::AUTHORIZATION, authorization.clone());
  }

  Ok(request)
}

pub(crate) fn build_sse_request(
  client: &reqwest::Client,
  url: reqwest::Url,
  last_event_id: Option<&str>,
) -> reqwest::RequestBuilder {
  let mut request = client.get(url);

  if let Some(last_event_id) = last_event_id {
    request = request.header("last-event-id", last_event_id);
  }

  request
}

#[cfg(test)]
mod tests {
  use super::*;
  use crate::protocol::GetImplInfoInput;

  #[test]
  fn converts_http_event_url_to_ws() {
    let base_url = reqwest::Url::parse("http://127.0.0.1:3100/").unwrap();
    let event_url = build_event_url(&base_url).unwrap();
    let ws_url = websocket_url(&event_url).unwrap();

    assert_eq!(ws_url.as_str(), "ws://127.0.0.1:3100/event");
  }

  #[test]
  fn converts_https_event_url_to_wss() {
    let base_url = reqwest::Url::parse("https://milky.example/").unwrap();
    let event_url = build_event_url(&base_url).unwrap();
    let ws_url = websocket_url(&event_url).unwrap();

    assert_eq!(ws_url.as_str(), "wss://milky.example/event");
  }

  #[test]
  fn rejects_unsupported_websocket_url_schemes() {
    let url = reqwest::Url::parse("ftp://milky.example/event").unwrap();

    let error = websocket_url(&url).unwrap_err();

    assert!(error.to_string().contains("Unsupported URL scheme"));
  }

  #[test]
  fn builds_websocket_handshake_with_authorization_header() {
    let event_url = reqwest::Url::parse("http://127.0.0.1:3100/event").unwrap();
    let authorization = reqwest::header::HeaderValue::from_static("Bearer token");

    let request = websocket_request(&event_url, Some(&authorization)).unwrap();

    assert_eq!(request.uri().to_string(), "ws://127.0.0.1:3100/event");
    assert_eq!(
      request.headers().get(reqwest::header::AUTHORIZATION),
      Some(&authorization)
    );
  }

  #[test]
  fn preserves_base_path_for_api_urls_without_trailing_slash() {
    let base_url = reqwest::Url::parse("https://milky.example/base").unwrap();

    let api_url = build_api_url::<GetImplInfoInput>(&base_url).unwrap();

    assert_eq!(
      api_url.as_str(),
      "https://milky.example/base/api/get_impl_info"
    );
  }

  #[test]
  fn preserves_base_path_for_event_urls_without_trailing_slash() {
    let base_url = reqwest::Url::parse("https://milky.example/base").unwrap();

    let event_url = build_event_url(&base_url).unwrap();

    assert_eq!(event_url.as_str(), "https://milky.example/base/event");
  }
}