websocketing 0.1.0

WebSocketing is a WebSockets actor framework.
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
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
use std::{sync::Arc, time::Duration};

use async_tungstenite::{accept_async, tokio::{TokioAdapter, connect_async}, tungstenite::{Bytes, Message}};

use futures::{StreamExt, pin_mut};
use highly_sendable::{ConnectionMessage, ConnectionStateId};
use tokio::{join, net::TcpListener, sync::Notify, time::timeout};

use crate::{WebSocketActor, WebSocketActorInputMessage, WebSocketActorState, WebSocketActorOutputMessage};

const SERVER_URL: &str = "127.0.0.1:8080";

const SERVER_URL_CLIENT_SIDE: &str  = "ws://localhost:8080"; //"http://localhost:8080";

const CHANNEL_CLOSED: &str = "Channel closed unexpectedly";

const ONE_TWO_THREE: &[u8] = &[1, 2, 3];

const MESSAGE_EXPECTED: &str  = "Messsage expected";

const MESSAGE_SEND_ERROR: &str  = "Messsage send error";

#[tokio::test(flavor = "multi_thread", worker_threads = 3)]
async fn not_connected()
{

    let connection_state_id = ConnectionStateId::new();

    let io_client = WebSocketActorState::spawn();

    io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::SendMessage(Message::Binary(Bytes::new())))).await.expect(CHANNEL_CLOSED);

    let message = io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

    let (id, message) = message.take_id_and_message();

    assert_eq!(id, connection_state_id);

    assert!(message.is_not_connected());

    io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::Close)).await.expect(CHANNEL_CLOSED);

    let message = io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

    let (id, message) = message.take_id_and_message();

    assert_eq!(id, connection_state_id);

    assert!(message.is_not_connected());

    io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::CloseNow)).await.expect(CHANNEL_CLOSED);

    let message = io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

    let (id, message) = message.take_id_and_message();

    assert_eq!(id, connection_state_id);

    assert!(message.is_not_connected());

}

//Without the server-client notifications, it looks like Tokio locks-up when ther server task exits.


#[tokio::test(flavor = "multi_thread", worker_threads = 5)]
async fn basics_client_side_actor_only()
{

    let server_notify = Arc::new(Notify::new());

    let client_notify = Arc::new(Notify::new());

    let server_notify_clone = server_notify.clone();

    let client_notify_clone = client_notify.clone();

    let server = tokio::spawn(async move
    {

        let try_socket = TcpListener::bind(SERVER_URL).await;

        let listener = try_socket.expect("Failed to bind");

        let (stream, addr) = listener.accept().await.expect("Failed to accepet incoming connection.");

        println!("{} has connected to the test server.\n", addr);

        let adapted_steam = TokioAdapter::new(stream);

        //Get a client connection.

        let ws_stream = accept_async(adapted_steam).await.expect("WebSocket handshake failed - Server");

        //Pinning

        pin_mut!(ws_stream);

        //

        println!("Server pinging\n");

        let new_message = Message::Ping(Bytes::new());

        ws_stream.send(new_message).await.expect(MESSAGE_SEND_ERROR);

        //Pong?

        let message_future = ws_stream.next();

        let res = timeout(Duration::new(4, 0), message_future).await;

        println!("Client message details:");

        println!("{:#?}\n", res);

        //assert!(res.is_ok());

        //

        println!("Server - Closing\n");

        ws_stream.close(None).await.expect(MESSAGE_SEND_ERROR);

        println!("Server - Closed\n");

        //Is there a followup close frame?

        let next = ws_stream.next().await;

        println!("Server - close frame from the client:\n");

        println!("{:#?}\n", next);

        client_notify_clone.notify_one();

        server_notify_clone.notified().await;

    });

    let server_notify_clone = server_notify.clone();

    let client_notify_clone = client_notify.clone();

    let client = tokio::spawn(async move
    {

        let io_client = WebSocketActorState::spawn();

        let (ws_stream, response) = connect_async(SERVER_URL_CLIENT_SIDE).await.expect("WebSocket handshake failed - Client");

        println!("The client has connected with the following response: {:#?}\n", response);

        let mut connection_state_id = ConnectionStateId::new();

        //Send the connection to the client-actor.

        io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::WebSocket(ws_stream))).await.expect(CHANNEL_CLOSED);

        //Is the client-actor engaged?

        let message = io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

        let (id, message) = message.take_id_and_message();

        assert_ne!(id, connection_state_id);

        //connection_state_id = id;

        assert!(message.is_web_socket_engaged());

        //

        println!("Client: Server message 1\n\n");

        let message_future = io_client.output_receiver_ref().recv();

        let res = timeout(Duration::new(4, 0), message_future).await;

        println!("Client: Server message details - timeout:\n");

        println!("{:#?}\n", res);

        assert!(res.is_ok());

        //io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::Close)).await.expect(CHANNEL_CLOSED);

        //Closing

        println!("Client: Server message 2\n\n");

        //let message_future = io_client.output_receiver_ref().recv(); //.await.expect(CHANNEL_CLOSED);

        //println!("Server message 2 - not-timeout\n\n");

        let res = io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

        println!("Client: Server message 2 - post-not-timeout\n\n");

        //println!("Server message 2 - timeout\n\n");

        //let res = timeout(Duration::new(4, 0), message_future).await;

        //println!("Server message 2 - post-timeout\n\n");

        //let (id, message) = message.take_id_and_message();

        println!("Client: Server message details:\n");

        //println!("{}\n", id);

        println!("{:#?}\n", res);

        //Closed

        //io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::Close)).await.expect(CHANNEL_CLOSED);

        println!("Client: Server message 3\n\n");

        let message_future = io_client.output_receiver_ref().recv();

        let res = timeout(Duration::new(4, 0), message_future).await;

        println!("Client: Server message details:\n");

        println!("{:#?}\n\n", res); 

        println!("Client - Done\n\n");

        server_notify_clone.notify_one();

        client_notify_clone.notified().await;

    });

    let (server_result, client_result) = join!(server, client);

    assert!(server_result.is_ok());

    assert!(client_result.is_ok());

}

#[tokio::test(flavor = "multi_thread", worker_threads = 5)]
async fn basics_server_side_actor_only()
{

}

#[tokio::test(flavor = "multi_thread", worker_threads = 5)]
async fn basics()
{

    let server = tokio::spawn(async
    {

        let server_io_client = WebSocketActorState::spawn();

        let try_socket = TcpListener::bind(SERVER_URL).await;

        let listener = try_socket.expect("Failed to bind");

        let (stream, addr) = listener.accept().await.expect("Failed to accepet incoming connection.");

        println!("{} has connected to the test server.\n", addr);

        let adapted_steam = TokioAdapter::new(stream);

        //Get a client connection.

        let ws_stream = accept_async(adapted_steam).await.expect("WebSocket handshake failed - Server");

        let mut connection_state_id = ConnectionStateId::new();

        //Send the connection to the server-actor.

        server_io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::WebSocket(ws_stream))).await.expect(CHANNEL_CLOSED);

        //Is the server-actor engaged?

        let message = server_io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

        let (id, message) = message.take_id_and_message();

        assert_ne!(id, connection_state_id);

        connection_state_id = id;

        assert!(message.is_web_socket_engaged());

        //

        println!("Server sending ping\n");

        let new_message = Message::Ping(Bytes::from_static(ONE_TWO_THREE));

        server_io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::SendMessage(new_message))).await.expect(CHANNEL_CLOSED);

        println!("Server sent ping\n");

        let message = server_io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

        let (id, message) = message.take_id_and_message();

        println!("{:#?}\n", message);

        assert_eq!(id, connection_state_id);

        assert!(message.is_message());

        if let WebSocketActorOutputMessage::Message(the_message) = message
        {

            assert!(the_message.is_pong());

            if let Message::Pong(message_data) = the_message
            {

                assert_eq!(message_data, ONE_TWO_THREE);

            }

        }
        else
        {

            panic!("{}", MESSAGE_EXPECTED);
            
        }

    });

    let client = tokio::spawn(async
    {

        let io_client = WebSocketActorState::spawn();

        let (ws_stream, response) = connect_async(SERVER_URL_CLIENT_SIDE).await.expect("WebSocket handshake failed - Client");

        println!("The client has connected with the following response: {:#?}\n", response);

        let mut connection_state_id = ConnectionStateId::new();

        //Send the connection to the client-actor.

        io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::WebSocket(ws_stream))).await.expect(CHANNEL_CLOSED);

        //Is the client-actor engaged?

        let message = io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

        let (id, message) = message.take_id_and_message();

        assert_ne!(id, connection_state_id);

        connection_state_id = id;

        assert!(message.is_web_socket_engaged());

        //

        let message_future = io_client.output_receiver_ref().recv();

        let res = timeout(Duration::new(4, 0), message_future).await;

        println!("Client message details:");

        println!("{:#?}\n", res);

        assert!(res.is_ok());

        io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::Close)).await.expect(CHANNEL_CLOSED);

        let message = io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

        let (id, message) = message.take_id_and_message();

        println!("Client message details:");

        println!("{}\n", id);

        println!("{:#?}\n", message); 

        io_client.input_sender_ref().send(connection_state_id.connection_message(WebSocketActorInputMessage::Close)).await.expect(CHANNEL_CLOSED);

        let message = io_client.output_receiver_ref().recv().await.expect(CHANNEL_CLOSED);

        let (id, message) = message.take_id_and_message();

        println!("Last client message details:");

        println!("{}\n", id);

        println!("{:#?}\n", message); 

    });

    let (server_result, client_result) = join!(server, client);

    assert!(server_result.is_ok());

    assert!(client_result.is_ok());

}