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
//! # SSE Client
//! EventSource implementation to handle streams of Server-Sent Events.
//! It handles connections, redirections, retries and message parsing.
//!
//! To know more about SSE: <a href="https://html.spec.whatwg.org/multipage/server-sent-events.html" target="_new">Standard</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventSource" target="_new">EventSource interface</a>
//!
//! # Example:
//!
//! ```no_run
//! extern crate sse_client;
//! use sse_client::EventSource;
//!
//!
//! let event_source = EventSource::new("http://event-stream-address/sub").unwrap();
//!
//! event_source.on_message(|message| {
//!     println!("New message event {:?}", message);
//! });
//!
//! event_source.add_event_listener("error", |error| {
//!     println!("Error {:?}", error);
//! });
//!
//! ```
//!
//! Or:
//! ```no_run
//! extern crate sse_client;
//! use sse_client::EventSource;
//!
//!
//! let event_source = EventSource::new("http://event-stream-address/sub").unwrap();
//!
//! for event in event_source.receiver().iter() {
//!     println!("New Message: {}", event.data);
//! }
//!
//! ```
extern crate url;

#[cfg(feature = "native-tls")]
extern crate native_tls_crate as native_tls;

#[cfg(test)]
extern crate http_test_server;

#[cfg(feature = "native-tls")]
mod tls;
mod network;
mod pub_sub;
mod data;

use std::sync::{Arc, Mutex, mpsc };
use url::{Url, ParseError};
use network::EventStream;
use pub_sub::Bus;
use data::{EventBuilder, EventBuilderState};

pub use data::Event;
pub use network::State;


/// Interface to interact with `event-streams`
pub struct EventSource {
    bus: Arc<Mutex<Bus<Event>>>,
    stream: Arc<Mutex<EventStream>>
}

impl EventSource {
    /// Create object and starts connection with event-stream
    ///
    /// # Example
    ///
    /// ```no_run
    /// # extern crate sse_client;
    /// # use sse_client::EventSource;
    /// let event_source = EventSource::new("http://example.com/sub").unwrap();
    /// ```
    pub fn new(url: &str) -> Result<EventSource, ParseError> {
        let event_stream = Arc::new(Mutex::new(EventStream::new(Url::parse(url)?).unwrap()));
        let stream_for_update = Arc::clone(&event_stream);
        let stream = Arc::clone(&event_stream);
        let mut event_stream = event_stream.lock().unwrap();

        let bus = Arc::new(Mutex::new(Bus::new()));

        let event_bus = Arc::clone(&bus);
        event_stream.on_open(move || {
            publish_initial_stream_event(&event_bus);
        });

        let event_bus = Arc::clone(&bus);
        event_stream.on_error(move |message| {
            let event_bus = event_bus.lock().unwrap();
            let event = Event::new("error", &message);
            event_bus.publish(event.type_.clone(), event);
        });

        let event_builder = Arc::new(Mutex::new(EventBuilder::new()));
        let event_bus = Arc::clone(&bus);

        event_stream.on_message(move |message| {
            handle_message(&message, &event_builder, &event_bus, &stream_for_update);
        });

        Ok(EventSource{ stream, bus })
    }

    /// Close connection.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # extern crate sse_client;
    /// # use sse_client::EventSource;
    /// let event_source = EventSource::new("http://example.com/sub").unwrap();
    /// event_source.close();
    /// ```
    pub fn close(&self) {
        self.stream.lock().unwrap().close();
    }

    /// Triggered when connection with stream is stabilished.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # extern crate sse_client;
    /// # use sse_client::EventSource;
    /// let event_source = EventSource::new("http://example.com/sub").unwrap();
    ///
    /// event_source.on_open(|| {
    ///     println!("Connection stabilished!");
    /// });
    /// ```
    pub fn on_open<F>(&self, listener: F) where F: Fn() + Send + 'static {
        self.add_event_listener("stream_opened", move |_| { listener(); });
    }

    /// Triggered when `message` event is received.
    /// Any event that doesn't contain an `event` field is considered a `message` event.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # extern crate sse_client;
    /// # use sse_client::EventSource;
    /// let event_source = EventSource::new("http://example.com/sub").unwrap();
    ///
    /// event_source.on_message(|message| {
    ///     println!("Message received: {}", message.data);
    /// });
    /// ```
    pub fn on_message<F>(&self, listener: F) where F: Fn(Event) + Send + 'static {
        self.add_event_listener("message", listener);
    }

    /// Triggered when event with specified type is received.
    ///
    /// Any connection error is notified as event with type `error`.
    ///
    /// Events with no type defined have `message` as default type.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # extern crate sse_client;
    /// # use sse_client::EventSource;
    /// let event_source = EventSource::new("http://example.com/sub").unwrap();
    ///
    ///
    /// event_source.add_event_listener("myEvent", |event| {
    ///     println!("Event {} received: {}", event.type_, event.data);
    /// });
    ///
    /// event_source.add_event_listener("error", |error| {
    ///     println!("Error: {}", error.data);
    /// });
    ///
    /// // equivalent to `on_message`
    /// event_source.add_event_listener("message", |message| {
    ///     println!("Message received: {}", message.data);
    /// });
    /// ```
    pub fn add_event_listener<F>(&self, event_type: &str, listener: F) where F: Fn(Event) + Send + 'static {
        let mut bus = self.bus.lock().unwrap();
        bus.subscribe(event_type.to_string(), listener);
    }

    /// Returns client [`State`].
    ///
    /// # Example
    ///
    /// ```no_run
    /// # extern crate sse_client;
    /// # use sse_client::EventSource;
    /// use sse_client::State;
    /// let event_source = EventSource::new("http://example.com/sub").unwrap();
    ///
    /// assert_eq!(event_source.state(), State::Connecting);
    /// ```
    /// [`State`]: enum.State.html
    pub fn state(&self) -> State {
        self.stream.lock().unwrap().state()
    }

    /// Returns a receiver that is triggered on any new message or error.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # extern crate sse_client;
    /// # use sse_client::EventSource;
    /// let event_source = EventSource::new("http://example.com/sub").unwrap();
    ///
    /// for event in event_source.receiver().iter() {
    ///     println!("New Message: {}", event.data);
    /// }
    ///
    /// ```
    /// ```no_run
    /// # extern crate sse_client;
    /// # use sse_client::EventSource;
    /// let event_source = EventSource::new("http://example.com/sub").unwrap();
    /// let rx = event_source.receiver();
    ///
    /// let event = rx.recv().unwrap();
    /// //...
    ///
    /// ```
    pub fn receiver(&self) -> mpsc::Receiver<Event> {
        let (tx, rx) = mpsc::channel();
        let error_tx = tx.clone();

        self.on_message(move |event| {
            tx.send(event).unwrap();
        });

        self.add_event_listener("error", move |error| {
            error_tx.send(error).unwrap();
        });

        rx
    }
}

fn publish_initial_stream_event(event_bus: &Arc<Mutex<Bus<Event>>>) {
    let event_bus = event_bus.lock().unwrap();
    let event = Event::new("stream_opened", "");
    event_bus.publish(event.type_.clone(), event);
}

fn handle_message(
    message: &str,
    event_builder: &Arc<Mutex<EventBuilder>>,
    event_bus: &Arc<Mutex<Bus<Event>>>,
    event_stream: &Arc<Mutex<EventStream>>) {

    let mut event_builder = event_builder.lock().unwrap();

    if let EventBuilderState::Complete(event) = event_builder.update(&message) {
        let event_bus = event_bus.lock().unwrap();
        event_stream.lock().unwrap().set_last_id(event.id.clone());
        event_bus.publish(event.type_.clone(), event);
        event_builder.clear();
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::thread;
    use std::time::Duration;
    use std::sync::mpsc;
    use http_test_server::{ TestServer, Resource };
    use http_test_server::http::Status;

    fn setup() -> (TestServer, Resource, String) {
        let server = TestServer::new().unwrap();
        let resource = server.create_resource("/sub");
        resource.header("Content-Type", "text/event-stream").stream();
        let address = format!("http://localhost:{}/sub", server.port());
        thread::sleep(Duration::from_millis(100));
        (server, resource, address)
    }


    #[test]
    fn should_create_client() {
        let (_server, _stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();

        event_source.close();
    }

    #[test]
    fn should_thrown_an_error_when_malformed_url_provided() {
        match EventSource::new("127.0.0.1:1236/sub") {
            Ok(_) => assert!(false, "should had thrown an error"),
            Err(_) => assert!(true)
        }
    }

    #[test]
    fn accept_closure_as_listeners() {
        let (tx, rx) = mpsc::channel();
        let (_server, stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();

        event_source.on_message(move |message| {
            tx.send(message.data).unwrap();
        });

        while event_source.state() == State::Connecting {
            thread::sleep(Duration::from_millis(100));
        }

        stream_endpoint
            .send_line("data: some message").send_line("");

        let message = rx.recv().unwrap();
        assert_eq!(message, "some message");

        event_source.close();
    }

    #[test]
    fn should_trigger_listeners_when_message_received() {
        let (tx, rx) = mpsc::channel();
        let tx2 = tx.clone();
        let (_server, stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();

        event_source.on_message(move |message| {
            tx.send(message.data).unwrap();
        });

        event_source.on_message(move |message| {
            tx2.send(message.data).unwrap();
        });

        while event_source.state() == State::Connecting {
            thread::sleep(Duration::from_millis(100));
        }

        stream_endpoint.send_line("data: some message").send_line("");

        let message = rx.recv().unwrap();
        let message2 = rx.recv().unwrap();

        assert_eq!(message, "some message");
        assert_eq!(message2, "some message");

        event_source.close();
    }

    #[test]
    fn should_not_trigger_listeners_for_comments() {
        let (tx, rx) = mpsc::channel();

        let (_server, stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();

        event_source.on_message(move |message| {
            tx.send(message.data).unwrap();
        });

        while event_source.state() != State::Open {
            thread::sleep(Duration::from_millis(100));
        };

        stream_endpoint
            .send_line("data: message")
            .send_line("")
            .send_line(":this is a comment")
            .send_line(":this is another comment")
            .send_line("data: this is a message")
            .send_line("");

        let message = rx.recv().unwrap();
        let message2 = rx.recv().unwrap();

        assert_eq!(message, "message");
        assert_eq!(message2, "this is a message");

        event_source.close();
    }

    #[test]
    fn ignore_empty_messages() {
        let (tx, rx) = mpsc::channel();

        let (_server, stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();

        event_source.on_message(move |message| {
            tx.send(message.data).unwrap();
        });

        while event_source.state() != State::Open {
            thread::sleep(Duration::from_millis(100));
        };

        stream_endpoint
            .send_line("data: message")
            .send_line("")
            .send_line("")
            .send_line("data: this is a message")
            .send_line("");

        let message = rx.recv().unwrap();
        let message2 = rx.recv().unwrap();

        assert_eq!(message, "message");
        assert_eq!(message2, "this is a message");

        event_source.close();
    }

    #[test]
    fn event_trigger_its_defined_listener() {
        let (tx, rx) = mpsc::channel();
        let (_server, stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();

        event_source.add_event_listener("myEvent", move |event| {
            tx.send(event).unwrap();
        });

        while event_source.state() == State::Connecting {
            thread::sleep(Duration::from_millis(100));
        }

        stream_endpoint
            .send_line("event: myEvent")
            .send_line("data: my message\n");

        let message = rx.recv().unwrap();

        assert_eq!(message.type_, String::from("myEvent"));
        assert_eq!(message.data, String::from("my message"));

        event_source.close();
    }

    #[test]
    fn dont_trigger_on_message_for_event() {
        let (tx, rx) = mpsc::channel();
        let (_server, stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();

        event_source.on_message(move |_| {
            tx.send("NOOOOOOOOOOOOOOOOOOO!").unwrap();
        });

        stream_endpoint
            .send("event: myEvent\n")
            .send("data: my message\n\n");

        thread::sleep(Duration::from_millis(500));
        assert!(rx.try_recv().is_err());

        event_source.close();
    }

    #[test]
    fn should_close_connection() {
        let (tx, rx) = mpsc::channel();

        let (_server, stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();

         event_source.on_message(move |message| {
            tx.send(message.data).unwrap();
        });

        while event_source.state() != State::Open {
            thread::sleep(Duration::from_millis(100));
        };

        stream_endpoint.send("\ndata: some message\n\n");
        rx.recv().unwrap();
        event_source.close();
        stream_endpoint.send("\ndata: some message\n\n");

        thread::sleep(Duration::from_millis(400));
        assert!(rx.try_recv().is_err());
    }

    #[test]
    fn should_trigger_on_open_callback_when_connected() {
        let (tx, rx) = mpsc::channel();
        let (_server, stream_endpoint, address) = setup();
        stream_endpoint.delay(Duration::from_millis(200));

        let event_source = EventSource::new(&address).unwrap();

        event_source.on_open(move || {
            tx.send("open").unwrap();
        });

        rx.recv().unwrap();

        event_source.close();
    }

    #[test]
    fn should_return_stream_connection_status() {
        let (_server, stream_endpoint, address) = setup();
        stream_endpoint
            .delay(Duration::from_millis(200))
            .stream();

        let event_source = EventSource::new(&address).unwrap();
        thread::sleep(Duration::from_millis(100));

        assert_eq!(event_source.state(), State::Connecting);

        thread::sleep(Duration::from_millis(200));

        assert_eq!(event_source.state(), State::Open);

        event_source.close();
        thread::sleep(Duration::from_millis(200));

        assert_eq!(event_source.state(), State::Closed);
    }


    #[test]
    fn should_send_last_event_id_on_reconnection() {
        let (server, stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();
        thread::sleep(Duration::from_millis(100));

        stream_endpoint.send("id: helpMe\n");
        stream_endpoint.send("data: my message\n\n");

        thread::sleep(Duration::from_millis(500));

        stream_endpoint.close_open_connections();

        let request = server.requests().recv().unwrap();

        assert_eq!(request.headers.get("Last-Event-ID").unwrap(), "helpMe");

        event_source.close();
    }

    #[test]
    fn should_expose_blocking_api() {
        let (_server, stream_endpoint, address) = setup();
        let event_source = EventSource::new(&address).unwrap();
        thread::sleep(Duration::from_millis(100));
        let rx = event_source.receiver();

        stream_endpoint.send("data: some message\n\n");
        stream_endpoint.send("data: some message 2\n\n");

        assert_eq!(rx.recv().unwrap().data, "some message");
        assert_eq!(rx.recv().unwrap().data, "some message 2");

        event_source.close();
    }

    #[test]
    fn receiver_should_get_error_events() {
        let (_server, stream_endpoint, address) = setup();
        stream_endpoint
            .delay(Duration::from_millis(100))
            .status(Status::InternalServerError);
        let event_source = EventSource::new(&address).unwrap();
        let rx = event_source.receiver();

        assert_eq!(rx.recv().unwrap().type_, "error");

        event_source.close();
    }
}