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
use std::fmt;

use serde::de::{self, Visitor};
use serde::{Deserialize, Deserializer, Serialize};

use crate::data::DataConnectionIdWrapper;
use crate::error;
use crate::media::MediaConnectionIdWrapper;

/// Identifier for PeerObject.
///
/// To avoid misuse, it is used with Token.
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq, Eq, Ord, Hash)]
pub struct PeerId(pub String);

impl PeerId {
    pub fn as_str(&self) -> &str {
        self.0.as_str()
    }

    pub fn new(peer_id: impl Into<String>) -> Self {
        PeerId(peer_id.into())
    }
}

/// Token to avoid mesuse of Peer.
///
/// It is used with PeerId.
#[derive(Serialize, Debug, Clone, PartialOrd, PartialEq, Eq, Ord, Hash)]
pub struct Token(String);

impl Token {
    pub fn as_str(&self) -> &str {
        self.0.as_str()
    }

    pub fn try_create(token: impl Into<String>) -> Result<Self, error::Error> {
        // peer token's prefix is composed of a UUID and a prefix "pt-".
        let token_string = token.into();
        if !token_string.starts_with("pt-") {
            return Err(error::Error::create_local_error(
                "token str\'s prefix is \"pt-\"",
            ));
        }
        if token_string.len() != 39 {
            // It's length is 39(UUID: 36 + prefix: 3).
            return Err(error::Error::create_local_error(
                "token str's length should be 39",
            ));
        }
        if !token_string.is_ascii() {
            return Err(error::Error::create_local_error(
                "token str should be ascii",
            ));
        }

        Ok(Token(token_string))
    }
}

#[test]
fn create_token_success() {
    let token = Token::try_create("pt-9749250e-d157-4f80-9ee2-359ce8524308").unwrap();
    assert_eq!(token.as_str(), "pt-9749250e-d157-4f80-9ee2-359ce8524308");
}

#[test]
fn create_token_not_start_with_pt() {
    // peer token's prefix is "pt-"
    let token = Token::try_create("vi-9749250e-d157-4f80-9ee2-359ce8524308");
    if let Err(error::Error::LocalError(err)) = token {
        assert_eq!(err.as_str(), "token str\'s prefix is \"pt-\"");
    } else {
        unreachable!();
    }
}

#[test]
fn create_token_not_sufficient_length() {
    // this test is executed with 38 chars
    let token = Token::try_create("pt-9749250e-d157-4f80-9ee2-359ce852430");
    if let Err(error::Error::LocalError(err)) = token {
        assert_eq!(err.as_str(), "token str\'s length should be 39");
    } else {
        unreachable!();
    }
}

#[test]
fn create_token_too_long() {
    // this test is executed with 40 chars
    let token = Token::try_create("pt-9749250e-d157-4f80-9ee2-359ce85243080");
    if let Err(error::Error::LocalError(err)) = token {
        assert_eq!(err.as_str(), "token str\'s length should be 39");
    } else {
        unreachable!();
    }
}

#[test]
fn create_token_not_ascii_str() {
    let token = Token::try_create("pt-9749250e-d157-4f80-9ee2-359ce8524あ");
    if let Err(error::Error::LocalError(err)) = token {
        assert_eq!(err.as_str(), "token str should be ascii");
    } else {
        unreachable!();
    }
}

struct TokenVisitor;

impl<'de> Visitor<'de> for TokenVisitor {
    type Value = Token;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str("a 39 length str")
    }

    fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
    where
        E: de::Error,
    {
        let token = Token::try_create(value);
        if let Err(error::Error::LocalError(err)) = token {
            return Err(E::custom(format!("fail to deserialize Token: {}", err)));
        } else if let Err(_) = token {
            return Err(E::custom(format!("fail to deserialize Token")));
        }

        Ok(token.unwrap())
    }

    fn visit_string<E>(self, value: String) -> Result<Self::Value, E>
    where
        E: de::Error,
    {
        let token = Token::try_create(value);
        if let Err(error::Error::LocalError(err)) = token {
            return Err(E::custom(format!("fail to deserialize Token: {}", err)));
        } else if let Err(_) = token {
            return Err(E::custom(format!("fail to deserialize Token")));
        }

        Ok(token.unwrap())
    }
}

impl<'de> Deserialize<'de> for Token {
    fn deserialize<D>(deserializer: D) -> Result<Self, <D as Deserializer<'de>>::Error>
    where
        D: Deserializer<'de>,
    {
        deserializer.deserialize_identifier(TokenVisitor)
    }
}

#[cfg(test)]
mod deserialize_token {
    use super::*;

    #[derive(Deserialize)]
    struct TokenWrapper {
        pub token: Token,
    }

    #[test]
    fn deserialize_ok() {
        // this test is executed with 38 chars
        let wrapper = serde_json::from_str::<TokenWrapper>(
            r#"{"token": "pt-9749250e-d157-4f80-9ee2-359ce8524308"}"#,
        )
        .unwrap();
        assert_eq!(
            wrapper.token.as_str(),
            "pt-9749250e-d157-4f80-9ee2-359ce8524308"
        );
    }

    #[test]
    fn deserialize_err() {
        // this test is executed with 38 chars
        let result = serde_json::from_str::<TokenWrapper>(
            r#"{"token": "pt-9749250e-d157-4f80-9ee2-359ce852430"}"#,
        );
        assert!(result.is_err());
    }
}

/// Pair of PeerId and Token.
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq, Eq, Ord, Hash)]
pub struct PeerInfo {
    peer_id: PeerId,
    token: Token,
}

impl PeerInfo {
    pub fn new(peer_id: PeerId, token: Token) -> Self {
        Self { peer_id, token }
    }

    pub fn try_create(
        peer_id: impl Into<String>,
        token: impl Into<String>,
    ) -> Result<Self, error::Error> {
        Ok(PeerInfo {
            peer_id: PeerId::new(peer_id),
            token: Token::try_create(token)?,
        })
    }

    pub fn peer_id(&self) -> PeerId {
        return self.peer_id.clone();
    }

    pub fn token(&self) -> Token {
        return self.token.clone();
    }
}

/// Query for POST /peers.
///
/// [API](http://35.200.46.204/#/1.peers/peer)
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq)]
pub struct CreatePeerQuery {
    /// SkyWay's API Key.
    pub key: String,
    /// Registered domain of the API Key
    pub domain: String,
    /// Peer Id that user want to use.
    pub peer_id: PeerId,
    /// Whether does user want to use TURN server or not.
    pub turn: bool,
}

/// Response from POST /peers
///
/// [API](http://35.200.46.204/#/1.peers/peer)
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq)]
pub struct CreatedResponse {
    /// Fixed value as `"PEERS_CREATE"`.
    pub command_type: String,
    /// Pair of PeerId and Token. PeerId is not allocated in the server in this timing.
    pub params: PeerInfo,
}

/// Events from GET /peer/events
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq)]
#[serde(tag = "event")]
pub(crate) enum EventEnum {
    OPEN(PeerOpenEvent),
    CLOSE(PeerCloseEvent),
    CONNECTION(PeerConnectionEvent),
    CALL(PeerCallEvent),
    ERROR(PeerErrorEvent),
    TIMEOUT,
}

/// Response from GET /peers/{peer_id}/events
///
/// [API](http://35.200.46.204/#/1.peers/peer_event)
///
/// Indicates peer object is registered to SkyWay Server
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq)]
pub struct PeerOpenEvent {
    /// Pair of PeerId and Token. PeerId has been allocated in the server.
    pub params: PeerInfo,
}

/// Response from GET /peers/{peer_id}/events
///
/// [API](http://35.200.46.204/#/1.peers/peer_event)
///
/// Indicates peer object is deleted
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq)]
pub struct PeerCloseEvent {
    /// Pair of PeerId and Token. Just for indicating which Peer Object is deleted.
    pub params: PeerInfo,
}

/// Response from GET /peers/{peer_id}/events
///
/// [API](http://35.200.46.204/#/1.peers/peer_event)
///
/// Shows Error about PeerObject
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq)]
pub struct PeerErrorEvent {
    /// Pair of PeerId and Token. Indicate which Peer Object is regarded.
    pub params: PeerInfo,
    /// Shows detail of the error.
    pub error_message: String,
}

/// Shows that the Peer Object receives a request to establish DataConnection with neighbour.
///
/// [API](http://35.200.46.204/#/1.peers/peer_event)
///
/// DataConnection is automatically established when the request comes.
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq)]
pub struct PeerConnectionEvent {
    /// Pair of PeerId and Token. Indicate which Peer Object is regarded.
    pub params: PeerInfo,
    /// Id to identify the DataConnection
    pub data_params: DataConnectionIdWrapper,
}

/// Shows that the Peer Object receives a request to establish MediaConnection with neighbour.
///
/// [API](http://35.200.46.204/#/1.peers/peer_event)
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq)]
pub struct PeerCallEvent {
    pub params: PeerInfo,
    pub call_params: MediaConnectionIdWrapper,
}

/// Response from GET /peer/{peer_id}/status
///
/// [API](http://35.200.46.204/#/1.peers/peer_status)
#[derive(Serialize, Deserialize, Debug, Clone, PartialOrd, PartialEq)]
pub struct PeerStatusMessage {
    pub peer_id: PeerId,
    pub disconnected: bool,
}