Support HTTP long polling as an alternative to WebSockets #859
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| import WS from 'ws'; | ||
| import {Socket as EIOSocket} from 'engine.io-client'; | ||
|
|
||
| export interface GristClientSocketOptions { | ||
| headers?: Record<string, string>; | ||
| } | ||
|
|
||
| export class GristClientSocket { | ||
| private _wsSocket: WS.WebSocket | WebSocket | undefined; | ||
| private _eioSocket: EIOSocket | undefined; | ||
|
|
||
| // Set to true when the connection process is complete, either succesfully or | ||
| // after the WebSocket and polling transports have both failed. Events from | ||
| // the underlying socket are not forwarded to the client until that point. | ||
| private _openDone: boolean = false; | ||
|
|
||
| private _messageHandler: null | ((data: string) => void); | ||
| private _openHandler: null | (() => void); | ||
| private _errorHandler: null | ((err: Error) => void); | ||
| private _closeHandler: null | (() => void); | ||
|
|
||
| constructor(private _url: string, private _options?: GristClientSocketOptions) { | ||
| this._createWSSocket(); | ||
| } | ||
|
|
||
| public set onmessage(cb: null | ((data: string) => void)) { | ||
| this._messageHandler = cb; | ||
| } | ||
|
|
||
| public set onopen(cb: null | (() => void)) { | ||
| this._openHandler = cb; | ||
| } | ||
|
|
||
| public set onerror(cb: null | ((err: Error) => void)) { | ||
| this._errorHandler = cb; | ||
| } | ||
|
|
||
| public set onclose(cb: null | (() => void)) { | ||
| this._closeHandler = cb; | ||
| } | ||
|
|
||
| public close() { | ||
| if (this._wsSocket) { | ||
| this._wsSocket.close(); | ||
| } else { | ||
| this._eioSocket!.close(); | ||
| } | ||
| } | ||
|
|
||
| public send(data: string) { | ||
| if (this._wsSocket) { | ||
| this._wsSocket.send(data); | ||
| } else { | ||
| this._eioSocket!.send(data); | ||
| } | ||
| } | ||
|
|
||
| // pause() and resume() are used for tests and assume a WS.WebSocket transport | ||
| public pause() { | ||
| (this._wsSocket as WS.WebSocket)?.pause(); | ||
| } | ||
|
|
||
| public resume() { | ||
| (this._wsSocket as WS.WebSocket)?.resume(); | ||
| } | ||
|
|
||
| private _createWSSocket() { | ||
| if(typeof WebSocket !== 'undefined') { | ||
| this._wsSocket = new WebSocket(this._url); | ||
| } else { | ||
| this._wsSocket = new WS(this._url, undefined, this._options); | ||
| } | ||
| this._wsSocket.onmessage = this._onWSMessage.bind(this); | ||
| this._wsSocket.onopen = this._onWSOpen.bind(this); | ||
| this._wsSocket.onerror = this._onWSError.bind(this); | ||
| this._wsSocket.onclose = this._onWSClose.bind(this); | ||
| } | ||
|
|
||
| private _destroyWSSocket() { | ||
| if (this._wsSocket) { | ||
| this._wsSocket.onmessage = null; | ||
| this._wsSocket.onopen = null; | ||
| this._wsSocket.onerror = null; | ||
| this._wsSocket.onclose = null; | ||
| this._wsSocket = undefined; | ||
| } | ||
| } | ||
|
|
||
| private _onWSMessage(event: WS.MessageEvent | MessageEvent<any>) { | ||
| if (this._openDone) { | ||
| // event.data is guaranteed to be a string here because we only send text frames. | ||
| // https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/message_event#event_properties | ||
| this._messageHandler?.(event.data); | ||
| } | ||
| } | ||
|
|
||
| private _onWSOpen() { | ||
| // The connection was established successfully. Any future events can now | ||
| // be forwarded to the client. | ||
| this._openDone = true; | ||
| this._openHandler?.(); | ||
| } | ||
|
|
||
| private _onWSError(ev: Event) { | ||
|
There was a problem hiding this comment. Are you sure it's impossible to receive the There was a problem hiding this comment. Good catch. I ended up simplifying the logic, replacing |
||
| // The first connection attempt failed. Trigger an attempt with another transport. | ||
| this._destroyWSSocket(); | ||
| this._createEIOSocket(); | ||
| } | ||
|
|
||
| private _onWSClose() { | ||
| if (this._openDone) { | ||
| this._closeHandler?.(); | ||
| } | ||
| } | ||
|
|
||
| private _createEIOSocket() { | ||
| this._eioSocket = new EIOSocket(this._url, { | ||
| path: new URL(this._url).pathname, | ||
| addTrailingSlash: false, | ||
| transports: ['polling'], | ||
| upgrade: false, | ||
| extraHeaders: this._options?.headers, | ||
| withCredentials: true, | ||
| }); | ||
|
|
||
| this._eioSocket.on('message', this._onEIOMessage.bind(this)); | ||
| this._eioSocket.on('open', this._onEIOOpen.bind(this)); | ||
| this._eioSocket.on('error', this._onEIOError.bind(this)); | ||
| this._eioSocket.on('close', this._onEIOClose.bind(this)); | ||
| } | ||
|
|
||
| private _onEIOMessage(data: string) { | ||
| this._messageHandler?.(data); | ||
| } | ||
|
|
||
| private _onEIOOpen() { | ||
| this._openHandler?.(); | ||
|
There was a problem hiding this comment. Doesn't this need to set There was a problem hiding this comment. As mentioned below, I reworked the logic and there's only one state check left, in |
||
| } | ||
|
|
||
| private _onEIOError(ev: any) { | ||
| // We will make no further attempt to connect. Any future events can now | ||
| // be forwarded to the client. | ||
| this._openDone = true; | ||
| this._errorHandler?.(ev); | ||
| } | ||
|
|
||
| private _onEIOClose() { | ||
| this._closeHandler?.(); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be helpful to have a comment that exactly one of
_wsSocket,_eioSocketis set.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.