forked from robtaussig/react-use-websocket
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathuse-websocket.test.ts
722 lines (582 loc) · 20.8 KB
/
use-websocket.test.ts
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
import { renderHook, waitFor, render } from '@testing-library/react';
import { useWebSocket } from './use-websocket';
import WS from "jest-websocket-mock";
import { Options } from './types';
import { ReadyState } from './constants';
import { parseSocketIOUrl } from './socket-io';
let server: WS;
const URL = 'ws://localhost:1234';
const SOCKET_IO_URL = parseSocketIOUrl(URL);
const noop = () => { };
const DEFAULT_OPTIONS: Options = {};
let options: Options;
const sleep = (duration: number): Promise<void> => new Promise(resolve => setTimeout(() => resolve(), duration));
console.error = noop;
beforeEach(() => {
server = new WS(URL);
options = { ...DEFAULT_OPTIONS };
});
afterEach(() => {
WS.clean();
});
test('useWebsocket should work with just a url provided', () => {
expect(() => {
renderHook(() => useWebSocket(URL));
}).not.toThrow();
})
test('readyState changes across readyState transitions', async () => {
const {
result,
rerender,
} = renderHook(({ initialValue }) => useWebSocket(URL, options, initialValue), {
initialProps: { initialValue: false }
})
expect(result.current.readyState).toEqual(ReadyState.UNINSTANTIATED);
rerender({ initialValue: true });
expect(result.current.readyState).toEqual(ReadyState.CONNECTING);
await server.connected;
expect(result.current.readyState).toEqual(ReadyState.OPEN);
server.close();
await expect(result.current.readyState).toEqual(ReadyState.CLOSED);
})
test('a function-promise based url works the same as a string-based url', async () => {
const getUrl = () => {
return new Promise<string>(resolve => {
setTimeout(() => resolve(URL), 1000);
});
}
const {
result,
rerender,
} = renderHook(({ initialValue }) => useWebSocket(getUrl, options, initialValue), {
initialProps: { initialValue: false }
})
expect(result.current.readyState).toEqual(ReadyState.UNINSTANTIATED);
rerender({ initialValue: true });
expect(result.current.readyState).toEqual(ReadyState.CONNECTING);
await server.connected;
expect(result.current.readyState).toEqual(ReadyState.OPEN);
server.close();
await expect(result.current.readyState).toEqual(ReadyState.CLOSED);
})
test('a function-promise based url retries until it resolves if retryOnError is true', async () => {
let attemptsUntilSuccess = 2;
options.retryOnError = true;
options.reconnectAttempts = 3;
options.reconnectInterval = 500;
const onReconnectStopFn1 = jest.fn();
options.onReconnectStop = onReconnectStopFn1;
const getUrl = () => {
return new Promise<string>((resolve, reject) => {
if (attemptsUntilSuccess > 0) {
attemptsUntilSuccess--;
reject('Failed to get url');
} else {
resolve(URL);
}
});
};
const {
result,
rerender,
} = renderHook(({ initialValue }) => useWebSocket(getUrl, options, initialValue), {
initialProps: { initialValue: false }
});
expect(result.current.readyState).toEqual(ReadyState.UNINSTANTIATED);
rerender({ initialValue: true });
await sleep(1000);
expect(result.current.readyState).toEqual(ReadyState.CONNECTING);
await sleep(1000);
await expect(result.current.readyState).toEqual(ReadyState.OPEN);
expect(options.onReconnectStop).not.toHaveBeenCalled();
});
test('a function-promise based url stops retrying if it has exceeded reconnectAttempts', async () => {
let attemptsUntilSuccess = 3;
options.retryOnError = true;
options.reconnectAttempts = 2;
options.reconnectInterval = 500;
const onReconnectStopFn1 = jest.fn();
options.onReconnectStop = onReconnectStopFn1;
const getUrl = () => {
return new Promise<string>((resolve, reject) => {
if (attemptsUntilSuccess > 0) {
attemptsUntilSuccess--;
reject('Failed to get url');
} else {
resolve(URL);
}
});
};
const {
result,
rerender,
} = renderHook(({ initialValue }) => useWebSocket(getUrl, options, initialValue), {
initialProps: { initialValue: false }
});
expect(result.current.readyState).toEqual(ReadyState.UNINSTANTIATED);
rerender({ initialValue: true });
await sleep(1000);
expect(result.current.readyState).toEqual(ReadyState.CONNECTING);
await sleep(1000);
await expect(result.current.readyState).toEqual(ReadyState.CLOSED);
expect(options.onReconnectStop).toHaveBeenCalled();
});
test('a function-promise based url does not retry if retryOnError is false', async () => {
let attemptsUntilSuccess = 2;
options.retryOnError = false;
options.reconnectAttempts = 3;
options.reconnectInterval = 500;
const onReconnectStopFn1 = jest.fn();
options.onReconnectStop = onReconnectStopFn1;
const getUrl = () => {
return new Promise<string>((resolve, reject) => {
if (attemptsUntilSuccess > 0) {
attemptsUntilSuccess--;
reject('Failed to get url');
} else {
resolve(URL);
}
});
};
const {
result,
rerender,
} = renderHook(({ initialValue }) => useWebSocket(getUrl, options, initialValue), {
initialProps: { initialValue: false }
});
expect(result.current.readyState).toEqual(ReadyState.UNINSTANTIATED);
rerender({ initialValue: true });
await sleep(1000);
expect(result.current.readyState).toEqual(ReadyState.CLOSED);
await sleep(1000);
expect(options.onReconnectStop).not.toHaveBeenCalled();
});
test('lastMessage updates when websocket receives a message', async () => {
const {
result,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
expect(result.current.lastMessage).toBe(null);
server.send('Hello');
expect(result.current.lastMessage?.data).toBe('Hello');
server.send('There');
server.send('Friend');
expect(result.current.lastMessage?.data).toBe('Friend');
})
test('lastJsonMessage updates with a json object when websocket receives a message', async () => {
const {
result,
} = renderHook(() => useWebSocket<{ name: string }>(URL, options))
await server.connected;
expect(result.current.lastJsonMessage).toBe(null);
server.send(JSON.stringify({ name: 'Bob' }));
expect(result.current.lastJsonMessage.name).toBe('Bob');
})
test('sendMessage passes message to websocket and sends to server', async () => {
const {
result,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
result.current.sendMessage("Hello");
await expect(server).toReceiveMessage("Hello");
})
test('if sendMessage is called before the websocket opens, the message will be queued and sent when the websocket opens', async () => {
const {
result,
} = renderHook(() => useWebSocket(URL, options))
expect(result.current.readyState).not.toEqual(ReadyState.OPEN);
result.current.sendMessage("Hello");
await expect(server).toReceiveMessage("Hello");
})
test('sendJsonMessage allows component to pass a json object which is serialized and sent to server', async () => {
const {
result,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
result.current.sendJsonMessage({ name: 'Bob' });
await expect(server).toReceiveMessage(JSON.stringify({ name: 'Bob' }));
})
test('getWebSocket returns the underlying websocket if unshared', async () => {
const {
result
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
const ws = result.current.getWebSocket();
expect(ws instanceof WebSocket).toBe(true);
ws?.close();
await waitFor(() => expect(result.current.readyState).toBe(ReadyState.CLOSED));
})
test('getWebSocket returns a protected websocket when shared', async () => {
options.share = true;
const {
result,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
const ws = result.current.getWebSocket();
ws?.close();
await expect(result.current.readyState).toBe(ReadyState.OPEN);
})
test('websocket is closed when the component unmounts', async () => {
const {
result,
unmount,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
const ws = result.current.getWebSocket();
unmount();
expect(ws?.readyState).toBe(ReadyState.CLOSING);
await sleep(500);
expect(ws?.readyState).toBe(ReadyState.CLOSED);
})
test('shared websockets receive updates as if unshared', async () => {
const {
result: component1,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
const {
result: component2,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
const {
result: component3,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
server.send('Hello all');
expect(component1.current.lastMessage?.data).toBe('Hello all');
expect(component2.current.lastMessage?.data).toBe('Hello all');
expect(component3.current.lastMessage?.data).toBe('Hello all');
})
test('shared=false websocket can re-connect after timeout', async () => {
options.heartbeat = {
message: 'ping',
returnMessage: 'pong',
timeout: 100,
interval: 30,
};
options.share = false;
options.reconnectInterval = 10;
options.reconnectAttempts = 10;
options.shouldReconnect = () => true;
options.filter = event => event.data !== '"pong"';
const {
result: component1,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
expect(component1.current.getWebSocket()?.readyState).toBe(WebSocket.OPEN);
await sleep(200);
await server.connected;
server.send('pong');
expect(component1.current.getWebSocket()?.readyState).toBe(WebSocket.OPEN);
});
test('shared=true websocket can re-connect after timeout', async () => {
options.heartbeat = {
message: 'ping',
returnMessage: 'pong',
timeout: 100,
interval: 10,
};
options.share = true;
options.reconnectInterval = 10;
options.reconnectAttempts = 10;
options.shouldReconnect = () => true;
options.filter = event => event.data !== '"pong"';
const {
result: component1,
} = renderHook(() => useWebSocket(URL, options))
await server.connected;
expect(component1.current.getWebSocket()?.readyState).toBe(WebSocket.OPEN);
await sleep(200);
await server.connected;
server.send('pong');
expect(component1.current.getWebSocket()?.readyState).toBe(WebSocket.OPEN);
});
test('shared websockets each have callbacks invoked as if unshared', async () => {
const component1OnClose = jest.fn(() => { });
renderHook(() => useWebSocket(URL, {
...options,
onClose: component1OnClose,
}));
await server.connected;
const component2OnClose = jest.fn(() => { });
renderHook(() => useWebSocket(URL, {
...options,
onClose: component2OnClose,
}));
await server.connected;
const component3OnClose = jest.fn(() => { });
renderHook(() => useWebSocket(URL, {
...options,
onClose: component3OnClose,
}));
await server.connected;
expect(component1OnClose).not.toHaveBeenCalled();
expect(component2OnClose).not.toHaveBeenCalled();
expect(component3OnClose).not.toHaveBeenCalled();
server.close();
await sleep(500);
expect(component1OnClose).toHaveBeenCalledTimes(1);
expect(component2OnClose).toHaveBeenCalledTimes(1);
expect(component3OnClose).toHaveBeenCalledTimes(1);
})
test('Options#fromSocketIO changes the WS url to support socket.io\'s required query params', async () => {
options.fromSocketIO = true;
const {
result
} = renderHook(() => useWebSocket(URL, options));
await waitFor(() => {
const ws = result.current.getWebSocket();
expect(ws?.url).toEqual(SOCKET_IO_URL);
});
});
test('Options#queryParams append object-based params as string to url', async () => {
options.queryParams = { type: 'user', id: 5 };
const {
result
} = renderHook(() => useWebSocket(URL, options));
await waitFor(() => {
const ws = result.current.getWebSocket();
expect(ws?.url).toEqual(`${URL}/?type=user&id=5`);
});
});
test('Options#protocols pass the value on to the instantiated WebSocket', async () => {
options.protocols = 'chat';
const {
result
} = renderHook(() => useWebSocket(URL, options));
await waitFor(() => {
const ws = result.current.getWebSocket();
if (ws instanceof WebSocket) {
expect(ws?.protocol).toEqual('chat');
}
});
});
test('Options#share subscribes multiple components to a single WebSocket, so long as the URL is the same', async () => {
options.share = true;
const onConnectionFn = jest.fn();
server.on('connection', onConnectionFn);
renderHook(() => useWebSocket(URL, options));
renderHook(() => useWebSocket(URL, options));
renderHook(() => useWebSocket(URL, options));
await sleep(500);
expect(onConnectionFn).toHaveBeenCalledTimes(1);
});
test('if Options#share is not true, multiple websockets will be opened for the same url', async () => {
const onConnectionFn = jest.fn();
server.on('connection', onConnectionFn);
renderHook(() => useWebSocket(URL, options));
renderHook(() => useWebSocket(URL, options));
renderHook(() => useWebSocket(URL, options));
await sleep(500);
expect(onConnectionFn).toHaveBeenCalledTimes(3);
});
test('Options#onOpen is called with the open event when the websocket connection opens', async () => {
const onOpenFn = jest.fn();
options.onOpen = onOpenFn;
renderHook(() => useWebSocket(URL, options));
await server.connected;
expect(onOpenFn).toHaveBeenCalledTimes(1);
expect(onOpenFn.mock.calls[0][0].constructor.name).toBe('Event');
});
test('Options#onClose is called with the close event when the websocket connection closes', async () => {
const onCloseFn = jest.fn();
options.onClose = onCloseFn;
renderHook(() => useWebSocket(URL, options));
await server.connected;
server.close();
await waitFor(() => {
expect(onCloseFn).toHaveBeenCalledTimes(1);
expect(onCloseFn.mock.calls[0][0].constructor.name).toBe('CloseEvent');
});
});
test('Options#onMessage is called with the MessageEvent when the websocket receives a message', async () => {
const onMessageFn = jest.fn();
options.onMessage = onMessageFn;
renderHook(() => useWebSocket(URL, options));
await server.connected;
server.send('Hello');
await waitFor(() => {
expect(onMessageFn).toHaveBeenCalledTimes(1);
expect(onMessageFn.mock.calls[0][0].constructor.name).toBe('MessageEvent');
});
});
test('Options#onError is called when the websocket connection errors out', async () => {
const onErrorFn = jest.fn();
options.onError = onErrorFn;
renderHook(() => useWebSocket(URL, options));
await server.connected;
server.error();
await waitFor(() => {
expect(onErrorFn).toHaveBeenCalledTimes(1);
expect(onErrorFn.mock.calls[0][0].constructor.name).toBe('MessageEvent');
});
});
test('Options#shouldReconnect controls whether a closed websocket should attempt to reconnect', async () => {
options.shouldReconnect = () => false;
options.reconnectInterval = 500; //Default interval is too long for tests
const onConnectionFn = jest.fn((ws: any) => ws.close());
server.on('connection', onConnectionFn);
renderHook(() => useWebSocket(URL, options));
await sleep(600);//100ms buffer to avoid race condition
expect(onConnectionFn).toHaveBeenCalledTimes(1);
options.shouldReconnect = () => true;
renderHook(() => useWebSocket(URL, options));
await sleep(600);
expect(onConnectionFn).toHaveBeenCalledTimes(3);
});
test('Options#onReconnectStop is called when the websocket exceeds maximum reconnect attempts provided in options, or 20 by default', async () => {
options.shouldReconnect = () => true;
options.reconnectAttempts = 3;
options.reconnectInterval = 500; //Default interval is too long for tests
const onReconnectStopFn = jest.fn((numAttempts: number) => { });
options.onReconnectStop = onReconnectStopFn;
renderHook(() => useWebSocket(URL, options));
await server.connected;
server.close();
expect(onReconnectStopFn).not.toHaveBeenCalled();
await sleep(2000);
expect(onReconnectStopFn).toHaveBeenCalled();
expect(onReconnectStopFn.mock.calls[0][0]).toBe(3);
});
test('Options#filter accepts all incoming messages, but only where it returns true will the message update a component', async () => {
options.filter = () => false;
const { result } = renderHook(() => useWebSocket(URL, options));
await server.connected;
server.send('Hello');
await sleep(500);
expect(result.current.lastMessage).toBeNull();
});
test('Options#retryOnError controls whether a websocket should attempt to reconnect after an error event', async () => {
options.retryOnError = false;
options.reconnectAttempts = 3;
options.reconnectInterval = 500;
const onReconnectStopFn1 = jest.fn();
options.onReconnectStop = onReconnectStopFn1;
renderHook(() => useWebSocket(URL, options));
await server.connected;
server.error();
await sleep(1600);
expect(onReconnectStopFn1).not.toHaveBeenCalled();
options.retryOnError = true;
const onReconnectStopFn2 = jest.fn();
options.onReconnectStop = onReconnectStopFn2;
renderHook(() => useWebSocket(URL, options));
await server.connected;
server.error();
await sleep(1600);
expect(onReconnectStopFn2).toHaveBeenCalled();
});
test('Options#eventSourceOptions, if provided, instantiates an EventSource instead of a WebSocket', async () => {
options.eventSourceOptions = { withCredentials: true };
const {
result,
rerender
} = renderHook(() => useWebSocket(URL, options));
rerender();
waitFor(() => expect(result.current.getWebSocket() instanceof EventSource).toBe(true));
});
test.each([false, true])('Options#heartbeat, if provided, sends a message to the server at the specified interval and works when share is %s', async (shareOption) => {
options.heartbeat = {
message: 'ping',
timeout: 10000,
interval: 500,
};
options.share = shareOption;
renderHook(() => useWebSocket(URL, options));
if (shareOption) {
renderHook(() => useWebSocket(URL, options));
}
await server.connected;
await sleep(1600);
await expect(server).toHaveReceivedMessages(["ping", "ping", "ping"]);
});
test.each([false, true])('Options#heartbeat, if provided, close websocket if no message is received from server within specified timeout and works when share is %s', async (shareOption) => {
options.heartbeat = {
message: 'ping',
timeout: 1000,
interval: 400,
};
options.share = shareOption;
const {
result,
} = renderHook(() => useWebSocket(URL, options));
if (shareOption) {
renderHook(() => useWebSocket(URL, options));
}
await server.connected;
await sleep(1600);
expect(server.messages).toEqual(['ping', 'ping'])
expect(result.current.readyState).toBe(WebSocket.CLOSED);
});
test.each([false, true])('Options#heartbeat, if provided, do not close websocket if a message is received from server within specified timeout and works when share is %s', async (shareOption) => {
options.heartbeat = {
message: 'ping',
timeout: 1000,
interval: 500,
};
options.share = shareOption;
const {
result,
} = renderHook(() => useWebSocket(URL, options));
if (shareOption) {
renderHook(() => useWebSocket(URL, options));
}
await server.connected;
server.send('ping')
await sleep(500);
server.send('ping')
await sleep(500);
server.send('ping')
await sleep(500);
server.send('ping')
await sleep(500);
expect(result.current.readyState).toBe(WebSocket.OPEN);
});
test.each([false, true])('Options#heartbeat, if provided, lastMessage is updated if server message does not matches the returnMessage property of heartbeatOptions and works when share is %s', async (shareOption) => {
options.heartbeat = {
message: 'ping',
returnMessage: 'pong',
timeout: 1000,
interval: 500,
};
options.share = shareOption;
const {
result,
} = renderHook(() => useWebSocket(URL, options));
if (shareOption) {
renderHook(() => useWebSocket(URL, options));
}
await server.connected;
server.send('pong');
expect(result.current.lastMessage?.data).toBe(undefined);
server.send('ping');
expect(result.current.lastMessage?.data).toBe('ping');
});
test.each([false, true])('Options#heartbeat, can handle case when interval is very close to timeout', async (shareOption) => {
options.heartbeat = {
message: "ping",
returnMessage: "pong",
timeout: 1000,
interval: 800,
};
options.share = shareOption;
const { result } = renderHook(() => useWebSocket(URL, options));
if (shareOption) {
renderHook(() => useWebSocket(URL, options));
}
await server.connected;
await sleep(50);
expect(result.current.readyState).toEqual(ReadyState.OPEN);
result.current.sendMessage("token");
await sleep(50);
expect(server).toHaveReceivedMessages(["token"]);
server.send("authorized");
await sleep(50);
expect(result.current.lastMessage?.data).toEqual("authorized");
await sleep(850);
// it does not matter is it shared mode or not, in both cases only one timer is used that means only one ping message is sent for all subscribers
expect(server.messages).toEqual(["token", "ping"]);
server.send("pong");
expect(result.current.readyState).toBe(WebSocket.OPEN);
}
);
// //TODO: Write companion tests for useSocketIO