-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Phoenix expected a transport to be API compatible with the JS WebSocket API. This is a little bit unflexible and configuring the authToken that is handled differently depending on the transport was a bit awkward. Thus, we introduce a new Transport class that should be implemented by the given transport, falling back to a a WebSocket compatible wrapper, keeping API compatibility. The websocket specific handling (readyState, onopen, etc.) could be further abstracted in the future, to make integrating new transports like WebTransport easier. Then, it would also make sense to document the Transport API for others to implement their own transports.
- Loading branch information
Showing
5 changed files
with
148 additions
and
45 deletions.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| import { global, SOCKET_STATES, AUTH_TOKEN_PREFIX } from "./constants" | ||
|
|
||
| export default class Transport { | ||
| constructor(url, options = {}) { | ||
| this.url = url | ||
| this.options = options | ||
| // TODO: abstract websocket specifics (e.g. readyState)? | ||
| this.readyState = SOCKET_STATES.connecting | ||
| this.onopen = null | ||
| this.onerror = null | ||
| this.onmessage = null | ||
| this.onclose = null | ||
| this.authToken = options.authToken | ||
| } | ||
|
|
||
| static isTransport(transport) { | ||
| return transport.prototype instanceof Transport | ||
| } | ||
|
|
||
| send(_data) { | ||
| throw new Error("send() must be implemented by subclass") | ||
| } | ||
|
|
||
| close(_code, _reason) { | ||
| throw new Error("close() must be implemented by subclass") | ||
| } | ||
|
|
||
| // Helper methods for subclasses to trigger events | ||
| triggerOpen() { | ||
| this.readyState = SOCKET_STATES.open | ||
| if (this.onopen) this.onopen() | ||
| } | ||
|
|
||
| triggerError(error) { | ||
| if (this.onerror) this.onerror(error) | ||
| } | ||
|
|
||
| triggerMessage(message) { | ||
| if (this.onmessage) this.onmessage(message) | ||
| } | ||
|
|
||
| triggerClose(event) { | ||
| this.readyState = SOCKET_STATES.closed | ||
| if (this.onclose) this.onclose(event) | ||
| } | ||
| } | ||
|
|
||
| export class WebSocketTransport extends Transport { | ||
| constructor(url, options = {}) { | ||
| super(url, options) | ||
|
|
||
| // Handle WebSocket-specific protocol setup | ||
| const subprotocols = ["phoenix"] | ||
| if (this.authToken) { | ||
| subprotocols.push(`${AUTH_TOKEN_PREFIX}${btoa(this.authToken).replace(/=/g, "")}`) | ||
| } | ||
|
|
||
| const WebSocket = options.WebSocket || global.WebSocket | ||
| this.ws = new WebSocket(url, subprotocols) | ||
| this.ws.binaryType = options.binaryType | ||
|
|
||
| this.ws.onopen = () => this.triggerOpen() | ||
| this.ws.onerror = (error) => this.triggerError(error) | ||
| this.ws.onmessage = (event) => this.triggerMessage(event) | ||
| this.ws.onclose = (event) => this.triggerClose(event) | ||
| } | ||
|
|
||
| send(data) { | ||
| this.ws.send(data) | ||
| } | ||
|
|
||
| close(code, reason) { | ||
| this.ws.close(code, reason) | ||
| } | ||
| } | ||
|
|
||
| export class WrapperTransport { | ||
| constructor(transport) { | ||
| return class extends WebSocketTransport { | ||
| constructor(url, options) { | ||
| options.WebSocket = transport | ||
| super(url, options) | ||
| } | ||
| } | ||
| } | ||
| } |
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.