/
client.ts
691 lines (640 loc) · 22.7 KB
/
client.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
/**
*
* client
*
*/
import { Sink, ID, Disposable } from './types';
import { GRAPHQL_TRANSPORT_WS_PROTOCOL } from './protocol';
import {
Message,
MessageType,
parseMessage,
stringifyMessage,
SubscribePayload,
} from './message';
import { isObject } from './utils';
// this file is the entry point for browsers, re-export relevant elements
export * from './message';
export * from './protocol';
export type EventConnecting = 'connecting';
export type EventConnected = 'connected'; // connected = socket opened + acknowledged
export type EventClosed = 'closed';
export type Event = EventConnecting | EventConnected | EventClosed;
/**
* The first argument is actually the `WebSocket`, but to avoid
* bundling DOM typings because the client can run in Node env too,
* you should assert the websocket type during implementation.
*
* Also, the second argument is the optional payload that the server may
* send through the `ConnectionAck` message.
*/
export type EventConnectedListener = (
socket: unknown,
payload?: Record<string, unknown>,
) => void;
export type EventConnectingListener = () => void;
/**
* The argument is actually the websocket `CloseEvent`, but to avoid
* bundling DOM typings because the client can run in Node env too,
* you should assert the websocket type during implementation.
*/
export type EventClosedListener = (event: unknown) => void;
export type EventListener<E extends Event> = E extends EventConnecting
? EventConnectingListener
: E extends EventConnected
? EventConnectedListener
: E extends EventClosed
? EventClosedListener
: never;
type CancellerRef = { current: (() => void) | null };
/** Configuration used for the GraphQL over WebSocket client. */
export interface ClientOptions {
/** URL of the GraphQL over WebSocket Protocol compliant server to connect. */
url: string;
/**
* Optional parameters, passed through the `payload` field with the `ConnectionInit` message,
* that the client specifies when establishing a connection with the server. You can use this
* for securely passing arguments for authentication.
*
* If you decide to return a promise, keep in mind that the server might kick you off if it
* takes too long to resolve! Check the `connectionInitWaitTimeout` on the server for more info.
*
* Throwing an error from within this function will close the socket with the `Error` message
* in the close event reason.
*/
connectionParams?:
| Record<string, unknown>
| (() => Promise<Record<string, unknown>> | Record<string, unknown>);
/**
* Should the connection be established immediately and persisted
* or after the first listener subscribed.
*
* @default true
*/
lazy?: boolean;
/**
* Used ONLY when the client is in non-lazy mode (`lazy = false`). When
* using this mode, the errors might have no sinks to report to; however,
* to avoid swallowing errors, consider using `onNonLazyError`, which will
* be called when either:
* - An unrecoverable error/close event occurs
* - Silent retry attempts have been exceeded
*
* After a client has errored out, it will NOT perform any automatic actions.
*
* The argument can be a websocket `CloseEvent` or an `Error`. To avoid bundling
* DOM types, you should derive and assert the correct type. When receiving:
* - A `CloseEvent`: retry attempts have been exceeded or the specific
* close event is labeled as fatal (read more in `retryAttempts`).
* - An `Error`: some internal issue has occured, all internal errors are
* fatal by nature.
*
* @default console.error
*/
onNonLazyError?: (errorOrCloseEvent: unknown) => void;
/**
* How long should the client wait before closing the socket after the last oparation has
* completed. This is meant to be used in combination with `lazy`. You might want to have
* a calmdown time before actually closing the connection. Kinda' like a lazy close "debounce".
*
* @default 0 // close immediately
*/
keepAlive?: number;
/**
* How many times should the client try to reconnect on abnormal socket closure before it errors out?
*
* The library classifies the following close events as fatal:
* - `1002: Protocol Error`
* - `1011: Internal Error`
* - `4400: Bad Request`
* - `4401: Unauthorized` _tried subscribing before connect ack_
* - `4409: Subscriber for <id> already exists` _distinction is very important_
* - `4429: Too many initialisation requests`
*
* These events are reported immediately and the client will not reconnect.
*
* @default 5
*/
retryAttempts?: number;
/**
* Control the wait time between retries. You may implement your own strategy
* by timing the resolution of the returned promise with the retries count.
* `retries` argument counts actual connection attempts, so it will begin with
* 0 after the first retryable disconnect.
*
* @default Randomised exponential backoff
*/
retryWait?: (retries: number) => Promise<void>;
/**
* Register listeners before initialising the client. This way
* you can ensure to catch all client relevant emitted events.
*
* The listeners passed in will **always** be the first ones
* to get the emitted event before other registered listeners.
*/
on?: Partial<{ [event in Event]: EventListener<event> }>;
/**
* A custom WebSocket implementation to use instead of the
* one provided by the global scope. Mostly useful for when
* using the client outside of the browser environment.
*/
webSocketImpl?: unknown;
/**
* A custom ID generator for identifying subscriptions.
*
* The default generates a v4 UUID to be used as the ID using `Math`
* as the random number generator. Supply your own generator
* in case you need more uniqueness.
*
* Reference: https://stackoverflow.com/a/2117523/709884
*/
generateID?: () => ID;
}
export interface Client extends Disposable {
/**
* Listens on the client which dispatches events about the socket state.
*/
on<E extends Event>(event: E, listener: EventListener<E>): () => void;
/**
* Subscribes through the WebSocket following the config parameters. It
* uses the `sink` to emit received data or errors. Returns a _cleanup_
* function used for dropping the subscription and cleaning stuff up.
*/
subscribe<T = unknown>(payload: SubscribePayload, sink: Sink<T>): () => void;
}
/** Creates a disposable GraphQL over WebSocket client. */
export function createClient(options: ClientOptions): Client {
const {
url,
connectionParams,
lazy = true,
onNonLazyError = console.error,
keepAlive = 0,
retryAttempts = 5,
retryWait = async function randomisedExponentialBackoff(retries) {
let retryDelay = 1000; // start with 1s delay
for (let i = 0; i < retries; i++) {
retryDelay *= 2;
}
await new Promise((resolve) =>
setTimeout(
resolve,
retryDelay +
// add random timeout from 300ms to 3s
Math.floor(Math.random() * (3000 - 300) + 300),
),
);
},
on,
webSocketImpl,
/**
* Generates a v4 UUID to be used as the ID using `Math`
* as the random number generator. Supply your own generator
* in case you need more uniqueness.
*
* Reference: https://stackoverflow.com/a/2117523/709884
*/
generateID = function generateUUID() {
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
const r = (Math.random() * 16) | 0,
v = c == 'x' ? r : (r & 0x3) | 0x8;
return v.toString(16);
});
},
} = options;
let ws;
if (webSocketImpl) {
if (!isWebSocket(webSocketImpl)) {
throw new Error('Invalid WebSocket implementation provided');
}
ws = webSocketImpl;
} else if (typeof WebSocket !== 'undefined') {
ws = WebSocket;
} else if (typeof global !== 'undefined') {
ws =
global.WebSocket ||
// @ts-expect-error: Support more browsers
global.MozWebSocket;
} else if (typeof window !== 'undefined') {
ws =
window.WebSocket ||
// @ts-expect-error: Support more browsers
window.MozWebSocket;
}
if (!ws) {
throw new Error('WebSocket implementation missing');
}
const WebSocketImpl = ws;
// websocket status emitter, subscriptions are handled differently
const emitter = (() => {
const listeners: { [event in Event]: EventListener<event>[] } = {
connecting: on?.connecting ? [on.connecting] : [],
connected: on?.connected ? [on.connected] : [],
closed: on?.closed ? [on.closed] : [],
};
return {
on<E extends Event>(event: E, listener: EventListener<E>) {
const l = listeners[event] as EventListener<E>[];
l.push(listener);
return () => {
l.splice(l.indexOf(listener), 1);
};
},
emit<E extends Event>(event: E, ...args: Parameters<EventListener<E>>) {
for (const listener of listeners[event]) {
// @ts-expect-error: The args should fit
listener(...args);
}
},
reset() {
(Object.keys(listeners) as (keyof typeof listeners)[]).forEach(
(event) => {
listeners[event] = [];
},
);
},
};
})();
let state = {
disposed: false,
socket: null as WebSocket | null,
acknowledged: false,
locks: 0,
retrying: false,
retries: 0,
};
// all those waiting for the `retryWait` to resolve
const retryWaiting: (() => void)[] = [];
type ConnectReturn = Promise<
[
socket: WebSocket,
throwOnCloseOrWaitForCancel: (cleanup?: () => void) => Promise<void>,
]
>;
async function connect(
cancellerRef: CancellerRef,
callDepth = 0,
): ConnectReturn {
if (callDepth) {
// prevents too many recursive calls when reavaluating/re-connecting
if (callDepth > 10) {
throw new Error('Kept trying to connect but the socket never settled.');
}
// wait a bit for socket state changes in recursive calls
await new Promise((resolve) => setTimeout(resolve, callDepth * 50));
}
// retry wait strategy for all callers
if (state.retrying) {
if (retryWaiting.length) {
// if others are waiting for retry, I'll wait too
await new Promise<void>((resolve) => retryWaiting.push(resolve));
} else {
retryWaiting.push(() => {
/** fake waiter to lead following connects in the `retryWaiting` queue */
});
// use retry wait strategy
await retryWait(state.retries);
state = {
...state,
retrying: false, // avoid leading to waiting queue
retries: state.retries + 1, // is about to create a new WebSocket
};
// complete all waiting and clear the queue
while (retryWaiting.length) {
retryWaiting.pop()?.();
}
}
}
// socket already exists. can be ready or pending, check and behave accordingly
if (state.socket) {
switch (state.socket.readyState) {
case WebSocketImpl.OPEN: {
// if the socket is not acknowledged, wait a bit and reavaluate
if (!state.acknowledged) return connect(cancellerRef, callDepth + 1);
return makeConnectReturn(state.socket, cancellerRef);
}
case WebSocketImpl.CONNECTING: {
// if the socket is in the connecting phase, wait a bit and reavaluate
return connect(cancellerRef, callDepth + 1);
}
case WebSocketImpl.CLOSED:
break; // just continue, we'll make a new one
case WebSocketImpl.CLOSING: {
// if the socket is in the closing phase, wait a bit and connect
return connect(cancellerRef, callDepth + 1);
}
default:
throw new Error(`Impossible ready state ${state.socket.readyState}`);
}
}
// establish connection and assign to singleton
const socket = new WebSocketImpl(url, GRAPHQL_TRANSPORT_WS_PROTOCOL);
state = {
...state,
acknowledged: false,
socket,
};
emitter.emit('connecting');
await new Promise<void>((resolve, reject) => {
let cancelled = false;
cancellerRef.current = () => (cancelled = true);
/**
* `onerror` handler is unnecessary because even if an error occurs, the `onclose` handler will be called
*
* From: https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_client_applications
* > If an error occurs while attempting to connect, first a simple event with the name error is sent to the
* > WebSocket object (thereby invoking its onerror handler), and then the CloseEvent is sent to the WebSocket
* > object (thereby invoking its onclose handler) to indicate the reason for the connection's closing.
*/
socket.onclose = (event) => {
socket.onclose = null;
state = { ...state, acknowledged: false, socket: null };
emitter.emit('closed', event);
return reject(event);
};
socket.onmessage = (event: MessageEvent) => {
socket.onmessage = null;
if (cancelled) {
socket.close(3499, 'Client cancelled the socket before connecting');
return;
}
try {
const message = parseMessage(event.data);
if (message.type !== MessageType.ConnectionAck) {
throw new Error(`First message cannot be of type ${message.type}`);
}
state = {
...state,
acknowledged: true,
socket,
retrying: false,
retries: 0,
};
emitter.emit('connected', socket, message.payload); // connected = socket opened + acknowledged
return resolve();
} catch (err) {
socket.close(
4400,
err instanceof Error ? err.message : new Error(err).message,
);
}
};
// as soon as the socket opens and the connectionParams
// resolve, send the connection initalisation request
socket.onopen = () => {
socket.onopen = null;
if (cancelled) {
socket.close(3499, 'Client cancelled the socket before connecting');
return;
}
(async () => {
try {
socket.send(
stringifyMessage<MessageType.ConnectionInit>({
type: MessageType.ConnectionInit,
payload:
typeof connectionParams === 'function'
? await connectionParams()
: connectionParams,
}),
);
} catch (err) {
// even if not open, call close again to report error
socket.close(
4400,
err instanceof Error ? err.message : new Error(err).message,
);
}
})();
};
});
return makeConnectReturn(socket, cancellerRef);
}
async function makeConnectReturn(
socket: WebSocket,
cancellerRef: CancellerRef,
): ConnectReturn {
return [
socket,
(cleanup) =>
new Promise((resolve, reject) => {
if (socket.readyState === WebSocketImpl.CLOSED) {
return reject(new Error('Socket has already been closed'));
}
state.locks++;
socket.addEventListener('close', listener);
function listener(event: LikeCloseEvent) {
cancellerRef.current = null;
state.locks--;
socket.removeEventListener('close', listener);
return reject(event);
}
cancellerRef.current = () => {
cancellerRef.current = null;
cleanup?.();
state.locks--;
if (!state.locks) {
if (keepAlive > 0 && isFinite(keepAlive)) {
// if the keepalive is set, allow for the specified calmdown
// time and then close. but only if no lock got created in the
// meantime and if the socket is still open
setTimeout(() => {
if (!state.locks && socket.OPEN) {
socket.close(1000, 'Normal Closure');
}
}, keepAlive);
} else {
// otherwise close immediately
socket.close(1000, 'Normal Closure');
}
}
socket.removeEventListener('close', listener);
return resolve();
};
}),
];
}
/**
* Checks the `connect` problem and evaluates if the client should
* retry. If the problem is worth throwing, it will be thrown immediately.
*/
function shouldRetryConnectOrThrow(errOrCloseEvent: unknown): boolean {
// throw non `CloseEvent`s immediately, something else is wrong
if (!isLikeCloseEvent(errOrCloseEvent)) {
throw errOrCloseEvent;
}
// some close codes are worth reporting immediately
if (
[
1002, // Protocol Error
1011, // Internal Error
4400, // Bad Request
4401, // Unauthorized (tried subscribing before connect ack)
4409, // Subscriber for <id> already exists (distinction is very important)
4429, // Too many initialisation requests
].includes(errOrCloseEvent.code)
) {
throw errOrCloseEvent;
}
// already disposed or normal closure, shouldnt try again
if (state.disposed || errOrCloseEvent.code === 1000) {
return false;
}
// user cancelled early, shouldnt try again
if (errOrCloseEvent.code === 3499) {
return false;
}
// retries are not allowed or we tried to many times, report error
if (!retryAttempts || state.retries >= retryAttempts) {
throw errOrCloseEvent;
}
// looks good, start retrying
state.retrying = true;
return true;
}
// in non-lazy (hot?) mode always hold one connection lock to persist the socket
if (!lazy) {
(async () => {
for (;;) {
try {
const [, throwOnCloseOrWaitForCancel] = await connect({
current: null,
});
await throwOnCloseOrWaitForCancel();
// cancelled, shouldnt try again
return;
} catch (errOrCloseEvent) {
try {
// return and report if shouldnt try again
if (!shouldRetryConnectOrThrow(errOrCloseEvent))
return onNonLazyError?.(errOrCloseEvent);
} catch {
// report thrown error, no further retries
return onNonLazyError?.(errOrCloseEvent);
}
}
}
})();
}
// to avoid parsing the same message in each
// subscriber, we memo one on the last received data
let lastData: unknown, lastMessage: Message;
function memoParseMessage(data: unknown) {
if (data !== lastData) {
lastMessage = parseMessage(data);
lastData = data;
}
return lastMessage;
}
return {
on: emitter.on,
subscribe(payload, sink) {
const id = generateID();
let completed = false;
const cancellerRef: CancellerRef = { current: null };
const messageListener = ({ data }: MessageEvent) => {
const message = memoParseMessage(data);
switch (message.type) {
case MessageType.Next: {
if (message.id === id) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
sink.next(message.payload as any);
}
return;
}
case MessageType.Error: {
if (message.id === id) {
sink.error(message.payload);
// the canceller must be set at this point
// because you cannot receive a message
// if there is no existing connection
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
cancellerRef.current!();
// TODO-db-201025 calling canceller will complete the sink, meaning that both the `error` and `complete` will be
// called. neither promises or observables care; once they settle, additional calls to the resolvers will be ignored
}
return;
}
case MessageType.Complete: {
if (message.id === id) {
completed = true;
// the canceller must be set at this point
// because you cannot receive a message
// if there is no existing connection
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
cancellerRef.current!();
// calling canceller will complete the sink
}
return;
}
}
};
(async () => {
for (;;) {
try {
const [socket, throwOnCloseOrWaitForCancel] = await connect(
cancellerRef,
);
socket.addEventListener('message', messageListener);
socket.send(
stringifyMessage<MessageType.Subscribe>({
id: id,
type: MessageType.Subscribe,
payload,
}),
);
// either the canceller will be called and the promise resolved
// or the socket closed and the promise rejected
await throwOnCloseOrWaitForCancel(() => {
// if not completed already, send complete message to server on cancel
if (!completed) {
socket.send(
stringifyMessage<MessageType.Complete>({
id: id,
type: MessageType.Complete,
}),
);
}
});
socket.removeEventListener('message', messageListener);
// cancelled, shouldnt try again
return;
} catch (errOrCloseEvent) {
// return if shouldnt try again
if (!shouldRetryConnectOrThrow(errOrCloseEvent)) return;
}
}
})()
.catch(sink.error)
.then(sink.complete); // resolves on cancel or normal closure
return () => {
cancellerRef.current?.();
};
},
dispose() {
state.disposed = true;
state.socket?.close(1000, 'Normal Closure');
emitter.reset();
},
};
}
/** Minimal close event interface required by the lib for error and socket close handling. */
interface LikeCloseEvent {
/** Returns the WebSocket connection close code provided by the server. */
readonly code: number;
/** Returns the WebSocket connection close reason provided by the server. */
readonly reason: string;
}
function isLikeCloseEvent(val: unknown): val is LikeCloseEvent {
return isObject(val) && 'code' in val && 'reason' in val;
}
function isWebSocket(val: unknown): val is typeof WebSocket {
return (
typeof val === 'function' &&
'constructor' in val &&
'CLOSED' in val &&
'CLOSING' in val &&
'CONNECTING' in val &&
'OPEN' in val
);
}