eventsource_test.js
24.4 KB
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
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
var EventSource = require('../lib/eventsource')
, http = require('http')
, https = require('https')
, fs = require('fs')
, assert = require('assert')
, u = require('url');
var _port = 20000;
var servers = 0;
process.on('exit', function () {
if (servers != 0) {
console.error("************ Didn't kill all servers - there is still %d running.", servers);
}
});
function createServer(callback) {
var server = http.createServer();
configureServer(server, 'http', _port++, callback);
}
function createHttpsServer(callback) {
var options = {
key: fs.readFileSync(__dirname + '/key.pem'),
cert: fs.readFileSync(__dirname + '/certificate.pem')
};
var server = https.createServer(options);
configureServer(server, 'https', _port++, callback);
}
function configureServer(server, protocol, port, callback) {
var responses = [];
var oldClose = server.close;
server.close = function() {
responses.forEach(function (res) {
res.end();
});
servers--;
oldClose.apply(this, arguments);
};
server.on('request', function (req, res) {
responses.push(res);
});
server.url = protocol + '://localhost:' + port;
server.listen(port, function onOpen(err) {
servers++;
callback(err, server);
});
}
function writeEvents(chunks) {
return function (req, res) {
res.writeHead(200, {'Content-Type': 'text/event-stream'});
chunks.forEach(function (chunk) {
res.write(chunk);
});
res.write(':'); // send a dummy comment to ensure that the head is flushed
};
}
describe('Parser', function () {
it('parses multibyte characters', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["id: 1\ndata: €豆腐\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (m) {
assert.equal("€豆腐", m.data);
server.close(done);
};
});
});
it('parses empty lines with multibyte characters', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["\n\n\n\nid: 1\ndata: 我現在都看實況不玩遊戲\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (m) {
assert.equal("我現在都看實況不玩遊戲", m.data);
server.close(done);
};
});
});
it('parses one one-line message in one chunk', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["data: Hello\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (m) {
assert.equal("Hello", m.data);
server.close(done);
};
});
});
it('parses one one-line message in two chunks', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["data: Hel", "lo\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (m) {
assert.equal("Hello", m.data);
server.close(done);
};
});
});
it('parses two one-line messages in one chunk', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["data: Hello\n\n", "data: World\n\n"]));
var es = new EventSource(server.url);
es.onmessage = first;
function first(m) {
assert.equal("Hello", m.data);
es.onmessage = second;
}
function second(m) {
assert.equal("World", m.data);
server.close(done);
}
});
});
it('parses one two-line message in one chunk', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["data: Hello\ndata:World\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (m) {
assert.equal("Hello\nWorld", m.data);
server.close(done);
};
});
});
it('parses really chopped up unicode data', function (done) {
createServer(function (err, server) {
if (err) return done(err);
var chopped = "data: Aslak\n\ndata: Hellesøy\n\n".split("");
server.on('request', writeEvents(chopped));
var es = new EventSource(server.url);
es.onmessage = first;
function first(m) {
assert.equal("Aslak", m.data);
es.onmessage = second;
}
function second(m) {
assert.equal("Hellesøy", m.data);
server.close(done);
}
});
});
it('accepts CRLF as separator', function (done) {
createServer(function (err, server) {
if (err) return done(err);
var chopped = "data: Aslak\r\n\r\ndata: Hellesøy\r\n\r\n".split("");
server.on('request', writeEvents(chopped));
var es = new EventSource(server.url);
es.onmessage = first;
function first(m) {
assert.equal("Aslak", m.data);
es.onmessage = second;
}
function second(m) {
assert.equal("Hellesøy", m.data);
server.close(done);
}
});
});
it('accepts CR as separator', function (done) {
createServer(function (err, server) {
if (err) return done(err);
var chopped = "data: Aslak\r\rdata: Hellesøy\r\r".split("");
server.on('request', writeEvents(chopped));
var es = new EventSource(server.url);
es.onmessage = first;
function first(m) {
assert.equal("Aslak", m.data);
es.onmessage = second;
}
function second(m) {
assert.equal("Hellesøy", m.data);
server.close(done);
}
});
});
it('delivers message with explicit event', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["event: greeting\ndata: Hello\n\n"]));
var es = new EventSource(server.url);
es.addEventListener('greeting', function (m) {
assert.equal("Hello", m.data);
server.close(done);
});
});
});
it('ignores comments', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["data: Hello\n\n:nothing to see here\n\ndata: World\n\n"]));
var es = new EventSource(server.url);
es.onmessage = first;
function first(m) {
assert.equal("Hello", m.data);
es.onmessage = second;
}
function second(m) {
assert.equal("World", m.data);
server.close(done);
}
});
});
it('ignores empty comments', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["data: Hello\n\n:\n\ndata: World\n\n"]));
var es = new EventSource(server.url);
es.onmessage = first;
function first(m) {
assert.equal("Hello", m.data);
es.onmessage = second;
}
function second(m) {
assert.equal("World", m.data);
server.close(done);
}
});
});
it('does not ignore multilines strings', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["data: line one\ndata:\ndata: line two\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (m) {
assert.equal('line one\n\nline two', m.data);
server.close(done);
};
});
});
it('does not ignore multilines strings even in data beginning', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["data:\ndata:line one\ndata: line two\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (m) {
assert.equal('\nline one\nline two', m.data);
server.close(done);
};
});
});
it('causes entire event to be ignored for empty event field', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', writeEvents(["event:\n\ndata: Hello\n\n"]));
var es = new EventSource(server.url);
var originalEmit = es.emit;
es.emit = function (event) {
assert.ok(event === 'message' || event === 'newListener');
return originalEmit.apply(this, arguments);
};
es.onmessage = function (m) {
assert.equal('Hello', m.data);
server.close(done);
};
});
});
it('parses relatively huge messages efficiently', function (done) {
this.timeout(1000);
createServer(function (err, server) {
if (err) return done(err);
var longMessage = "data: " + new Array(100000).join('a') + "\n\n";
server.on('request', writeEvents([longMessage]));
var es = new EventSource(server.url);
es.onmessage = function () {
server.close(done);
};
});
});
});
describe('HTTP Request', function () {
it('passes cache-control: no-cache to server', function (done) {
createServer(function (err, server) {
if (err) return done(err);
server.on('request', function (req) {
assert.equal('no-cache', req.headers['cache-control']);
server.close(done);
});
new EventSource(server.url);
});
});
it('sets request headers', function (done) {
var server = createServer(function (err, server) {
if (err) return done(err);
server.on('request', function (req) {
assert.equal(req.headers['user-agent'], 'test');
assert.equal(req.headers['cookie'], 'test=test');
assert.equal(req.headers['last-event-id'], '99');
server.close(done);
});
var headers = {
'User-Agent': 'test',
'Cookie': 'test=test',
'Last-Event-ID': '99'
};
new EventSource(server.url, {headers: headers});
});
});
it("does not set request headers that don't have a value", function (done) {
var server = createServer(function (err, server) {
if (err) return done(err);
server.on('request', function (req) {
assert.equal(req.headers['user-agent'], 'test');
assert.equal(req.headers['cookie'], 'test=test');
assert.equal(req.headers['last-event-id'], '99');
assert.equal(req.headers['X-Something'], undefined);
server.close(done);
});
var headers = {
'User-Agent': 'test',
'Cookie': 'test=test',
'Last-Event-ID': '99',
'X-Something': null
};
assert.doesNotThrow(
function() {
new EventSource(server.url, {headers: headers});
}
);
});
});
[301, 307].forEach(function (status) {
it('follows http ' + status + ' redirect', function (done) {
var redirectSuffix = '/foobar';
var clientRequestedRedirectUrl = false;
createServer(function (err, server) {
if(err) return done(err);
server.on('request', function (req, res) {
if (req.url === '/') {
res.writeHead(status, {
'Connection': 'Close',
'Location': server.url + redirectSuffix
});
res.end();
} else if (req.url === redirectSuffix) {
clientRequestedRedirectUrl = true;
res.writeHead(200, {'Content-Type': 'text/event-stream'});
res.end();
}
});
var es = new EventSource(server.url);
es.onopen = function () {
assert.ok(clientRequestedRedirectUrl);
assert.equal(server.url + redirectSuffix, es.url);
server.close(done);
};
});
});
it('causes error event when response is ' + status + ' with missing location', function (done) {
var redirectSuffix = '/foobar';
var clientRequestedRedirectUrl = false;
createServer(function (err, server) {
if(err) return done(err);
server.on('request', function (req, res) {
res.writeHead(status, {
'Connection': 'Close'
});
res.end();
});
var es = new EventSource(server.url);
es.onerror = function (err) {
assert.equal(err.status, status);
server.close(done);
};
});
});
});
[401, 403].forEach(function (status) {
it('causes error event when response status is ' + status, function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', function (req, res) {
res.writeHead(status, {'Content-Type': 'text/html'});
res.end();
});
var es = new EventSource(server.url);
es.onerror = function (err) {
assert.equal(err.status, status);
server.close(done);
};
});
});
});
});
describe('HTTPS Support', function () {
it('uses https for https urls', function (done) {
createHttpsServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(["data: hello\n\n"]));
var es = new EventSource(server.url, {rejectUnauthorized: false});
es.onmessage = function (m) {
assert.equal("hello", m.data);
server.close(done);
}
});
});
});
describe('Reconnection', function () {
it('is attempted when server is down', function (done) {
var es = new EventSource('http://localhost:' + _port);
es.reconnectInterval = 0;
es.onerror = function () {
es.onerror = null;
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(["data: hello\n\n"]));
es.onmessage = function (m) {
assert.equal("hello", m.data);
server.close(done);
}
});
};
});
it('is attempted when server goes down after connection', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(["data: hello\n\n"]));
var es = new EventSource(server.url);
es.reconnectInterval = 0;
es.onmessage = function (m) {
assert.equal("hello", m.data);
server.close(function (err) {
if(err) return done(err);
var port = u.parse(es.url).port;
configureServer(http.createServer(), 'http', port, function (err, server2) {
if(err) return done(err);
server2.on('request', writeEvents(["data: world\n\n"]));
es.onmessage = function (m) {
assert.equal("world", m.data);
server2.close(done);
};
});
});
};
});
});
it('is stopped when server goes down and eventsource is being closed', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(["data: hello\n\n"]));
var es = new EventSource(server.url);
es.reconnectInterval = 0;
es.onmessage = function (m) {
assert.equal("hello", m.data);
server.close(function (err) {
if(err) return done(err);
// The server has closed down. es.onerror should now get called,
// because es's remote connection was dropped.
});
};
es.onerror = function () {
// We received an error because the remote connection was closed.
// We close es, so we do not want es to reconnect.
es.close();
var port = u.parse(es.url).port;
configureServer(http.createServer(), 'http', port, function (err, server2) {
if(err) return done(err);
server2.on('request', writeEvents(["data: world\n\n"]));
es.onmessage = function (m) {
return done(new Error("Unexpected message: " + m.data));
};
setTimeout(function () {
// We have not received any message within 100ms, we can
// presume this works correctly.
server2.close(done);
}, 100);
});
};
});
});
it('is not attempted when server responds with HTTP 204', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', function (req, res) {
res.writeHead(204);
res.end();
});
var es = new EventSource(server.url);
es.reconnectInterval = 0;
es.onerror = function (e) {
assert.equal(e.status, 204);
server.close(function (err) {
if(err) return done(err);
var port = u.parse(es.url).port;
configureServer(http.createServer(), 'http', port, function (err, server2) {
if(err) return done(err);
// this will be verified by the readyState
// going from CONNECTING to CLOSED,
// along with the tests verifying that the
// state is CONNECTING when a server closes.
// it's next to impossible to write a fail-safe
// test for this, though.
var ival = setInterval(function () {
if (es.readyState == EventSource.CLOSED) {
clearInterval(ival);
server2.close(done);
}
}, 5);
});
});
};
});
});
it('sends Last-Event-ID http header when it has previously been passed in an event from the server', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(['id: 10\ndata: Hello\n\n']));
var es = new EventSource(server.url);
es.reconnectInterval = 0;
es.onmessage = function () {
server.close(function (err) {
if(err) return done(err);
var port = u.parse(es.url).port;
configureServer(http.createServer(), 'http', port, function (err, server2) {
server2.on('request', function (req, res) {
assert.equal('10', req.headers['last-event-id']);
server2.close(done);
});
});
});
};
});
});
it('sends correct Last-Event-ID http header when an initial Last-Event-ID header was specified in the constructor', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', function (req, res) {
assert.equal('9', req.headers['last-event-id']);
server.close(done);
});
new EventSource(server.url, {headers: {'Last-Event-ID': '9'}});
});
});
it('does not send Last-Event-ID http header when it has not been previously sent by the server', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(['data: Hello\n\n']));
var es = new EventSource(server.url);
es.reconnectInterval = 0;
es.onmessage = function () {
server.close(function (err) {
if(err) return done(err);
var port = u.parse(es.url).port;
configureServer(http.createServer(), 'http', port, function (err, server2) {
server2.on('request', function (req, res) {
assert.equal(undefined, req.headers['last-event-id']);
server2.close(done);
});
});
});
};
});
});
});
describe('readyState', function () {
it('has CONNECTING constant', function () {
assert.equal(0, EventSource.CONNECTING);
});
it('has OPEN constant', function () {
assert.equal(1, EventSource.OPEN);
});
it('has CLOSED constant', function () {
assert.equal(2, EventSource.CLOSED);
});
it('is CONNECTING before connection has been established', function (done) {
var es = new EventSource('http://localhost:' + _port);
assert.equal(EventSource.CONNECTING, es.readyState);
es.onerror = function () {
es.close();
done();
}
});
it('is CONNECTING when server has closed the connection', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents([]));
var es = new EventSource(server.url);
es.reconnectInterval = 0;
es.onopen = function (m) {
server.close(function (err) {
if(err) return done(err);
es.onerror = function () {
es.onerror = null;
assert.equal(EventSource.CONNECTING, es.readyState);
done();
};
});
};
});
});
it('is OPEN when connection has been established', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents([]));
var es = new EventSource(server.url);
es.onopen = function () {
assert.equal(EventSource.OPEN, es.readyState);
server.close(done);
}
});
});
it('is CLOSED after connection has been closed', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents([]));
var es = new EventSource(server.url);
es.onopen = function () {
es.close();
assert.equal(EventSource.CLOSED, es.readyState);
server.close(done);
}
});
});
});
describe('Properties', function () {
it('url exposes original request url', function () {
var url = 'http://localhost:' + _port;
var es = new EventSource(url);
assert.equal(url, es.url);
});
});
describe('Events', function () {
it('calls onopen when connection is established', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents([]));
var es = new EventSource(server.url);
es.onopen = function (event) {
assert.equal(event.type, 'open');
server.close(done);
}
});
});
it('supplies the correct origin', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(["data: hello\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (event) {
assert.equal(event.origin, server.url);
server.close(done);
}
});
});
it('emits open event when connection is established', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents([]));
var es = new EventSource(server.url);
es.addEventListener('open', function (event) {
assert.equal(event.type, 'open');
server.close(done);
});
});
});
it('does not emit error when connection is closed by client', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents([]));
var es = new EventSource(server.url);
es.addEventListener('open', function () {
es.close();
process.nextTick(function () {
server.close(done);
});
});
es.addEventListener('error', function () {
done(new Error('error should not be emitted'));
});
});
});
it('populates message\'s lastEventId correctly when the last event has an associated id', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(["id: 123\ndata: hello\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (m) {
assert.equal(m.lastEventId, "123");
server.close(done);
};
});
});
it('populates message\'s lastEventId correctly when the last event doesn\'t have an associated id', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(["id: 123\ndata: Hello\n\n", "data: World\n\n"]));
var es = new EventSource(server.url);
es.onmessage = first;
function first() {
es.onmessage = second;
}
function second(m) {
assert.equal(m.data, "World");
assert.equal(m.lastEventId, "123"); //expect to get back the previous event id
server.close(done);
}
});
});
it('populates messages with enumerable properties so they can be inspected via console.log().', function (done) {
createServer(function (err, server) {
if(err) return done(err);
server.on('request', writeEvents(["data: World\n\n"]));
var es = new EventSource(server.url);
es.onmessage = function (m) {
var enumerableAttributes = Object.keys(m);
assert.notEqual(enumerableAttributes.indexOf("data"), -1);
assert.notEqual(enumerableAttributes.indexOf("type"), -1);
server.close(done);
};
});
});
});