153 lines
5.2 KiB
JavaScript
153 lines
5.2 KiB
JavaScript
import { Transport } from "../transport.js";
|
|
import { yeast } from "../contrib/yeast.js";
|
|
import { pick } from "../util.js";
|
|
import { nextTick, usingBrowserWebSocket, WebSocket, } from "./websocket-constructor.js";
|
|
import { encodePacket } from "engine.io-parser";
|
|
// detect ReactNative environment
|
|
const isReactNative = typeof navigator !== "undefined" &&
|
|
typeof navigator.product === "string" &&
|
|
navigator.product.toLowerCase() === "reactnative";
|
|
export class WS extends Transport {
|
|
/**
|
|
* WebSocket transport constructor.
|
|
*
|
|
* @param {Object} opts - connection options
|
|
* @protected
|
|
*/
|
|
constructor(opts) {
|
|
super(opts);
|
|
this.supportsBinary = !opts.forceBase64;
|
|
}
|
|
get name() {
|
|
return "websocket";
|
|
}
|
|
doOpen() {
|
|
if (!this.check()) {
|
|
// let probe timeout
|
|
return;
|
|
}
|
|
const uri = this.uri();
|
|
const protocols = this.opts.protocols;
|
|
// React Native only supports the 'headers' option, and will print a warning if anything else is passed
|
|
const opts = isReactNative
|
|
? {}
|
|
: pick(this.opts, "agent", "perMessageDeflate", "pfx", "key", "passphrase", "cert", "ca", "ciphers", "rejectUnauthorized", "localAddress", "protocolVersion", "origin", "maxPayload", "family", "checkServerIdentity");
|
|
if (this.opts.extraHeaders) {
|
|
opts.headers = this.opts.extraHeaders;
|
|
}
|
|
try {
|
|
this.ws =
|
|
usingBrowserWebSocket && !isReactNative
|
|
? protocols
|
|
? new WebSocket(uri, protocols)
|
|
: new WebSocket(uri)
|
|
: new WebSocket(uri, protocols, opts);
|
|
}
|
|
catch (err) {
|
|
return this.emitReserved("error", err);
|
|
}
|
|
this.ws.binaryType = this.socket.binaryType;
|
|
this.addEventListeners();
|
|
}
|
|
/**
|
|
* Adds event listeners to the socket
|
|
*
|
|
* @private
|
|
*/
|
|
addEventListeners() {
|
|
this.ws.onopen = () => {
|
|
if (this.opts.autoUnref) {
|
|
this.ws._socket.unref();
|
|
}
|
|
this.onOpen();
|
|
};
|
|
this.ws.onclose = (closeEvent) => this.onClose({
|
|
description: "websocket connection closed",
|
|
context: closeEvent,
|
|
});
|
|
this.ws.onmessage = (ev) => this.onData(ev.data);
|
|
this.ws.onerror = (e) => this.onError("websocket error", e);
|
|
}
|
|
write(packets) {
|
|
this.writable = false;
|
|
// encodePacket efficient as it uses WS framing
|
|
// no need for encodePayload
|
|
for (let i = 0; i < packets.length; i++) {
|
|
const packet = packets[i];
|
|
const lastPacket = i === packets.length - 1;
|
|
encodePacket(packet, this.supportsBinary, (data) => {
|
|
// always create a new object (GH-437)
|
|
const opts = {};
|
|
if (!usingBrowserWebSocket) {
|
|
if (packet.options) {
|
|
opts.compress = packet.options.compress;
|
|
}
|
|
if (this.opts.perMessageDeflate) {
|
|
const len =
|
|
// @ts-ignore
|
|
"string" === typeof data ? Buffer.byteLength(data) : data.length;
|
|
if (len < this.opts.perMessageDeflate.threshold) {
|
|
opts.compress = false;
|
|
}
|
|
}
|
|
}
|
|
// Sometimes the websocket has already been closed but the browser didn't
|
|
// have a chance of informing us about it yet, in that case send will
|
|
// throw an error
|
|
try {
|
|
if (usingBrowserWebSocket) {
|
|
// TypeError is thrown when passing the second argument on Safari
|
|
this.ws.send(data);
|
|
}
|
|
else {
|
|
this.ws.send(data, opts);
|
|
}
|
|
}
|
|
catch (e) {
|
|
}
|
|
if (lastPacket) {
|
|
// fake drain
|
|
// defer to next tick to allow Socket to clear writeBuffer
|
|
nextTick(() => {
|
|
this.writable = true;
|
|
this.emitReserved("drain");
|
|
}, this.setTimeoutFn);
|
|
}
|
|
});
|
|
}
|
|
}
|
|
doClose() {
|
|
if (typeof this.ws !== "undefined") {
|
|
this.ws.close();
|
|
this.ws = null;
|
|
}
|
|
}
|
|
/**
|
|
* Generates uri for connection.
|
|
*
|
|
* @private
|
|
*/
|
|
uri() {
|
|
const schema = this.opts.secure ? "wss" : "ws";
|
|
const query = this.query || {};
|
|
// append timestamp to URI
|
|
if (this.opts.timestampRequests) {
|
|
query[this.opts.timestampParam] = yeast();
|
|
}
|
|
// communicate binary support capabilities
|
|
if (!this.supportsBinary) {
|
|
query.b64 = 1;
|
|
}
|
|
return this.createUri(schema, query);
|
|
}
|
|
/**
|
|
* Feature detection for WebSocket.
|
|
*
|
|
* @return {Boolean} whether this transport is available.
|
|
* @private
|
|
*/
|
|
check() {
|
|
return !!WebSocket;
|
|
}
|
|
}
|