irc-framework/src/transports/websocket.js

A better IRC framework for node.js

'use strict';

/**
 * Websocket transport
 */

const EventEmitter = require('eventemitter3');

module.exports = class Connection extends EventEmitter {
    constructor(options) {
        super();

        this.options = options || {};

        this.socket = null;
        this.connected = false;
        this.last_socket_error = null;

        this.encoding = 'utf8';
        this.incoming_buffer = '';

        this.protocol_fallback = false;

        // JSON does not allow undefined and websocket protocol does not allow falsy
        // if the protocol is falsy then the user intends no protocol, so set to undefined
        this.protocol = options.websocket_protocol ?
            options.websocket_protocol :
            undefined;
    }

    isConnected() {
        return this.connected;
    }

    writeLine(line, cb) {
        this.debugOut('writeLine() socket=' + (this.socket ? 'yes' : 'no') + ' connected=' + this.connected);

        if (this.socket && this.connected) {
            this.socket.send(line);
        }

        // Websocket.send() does not support callbacks
        // call the callback in the next tick instead
        if (cb) {
            setTimeout(cb, 0);
        }
    }

    debugOut(out) {
        this.emit('debug', out);
    }

    connect() {
        const that = this;
        const options = this.options;
        let socket = null;
        let ws_addr = '';

        this.debugOut('Connection.connect()');

        this.disposeSocket();
        this.requested_disconnect = false;

        // Build the websocket address. eg. ws://ws.rizon.net:8080
        ws_addr += (options.tls || options.ssl) ? 'wss://' : 'ws://';
        ws_addr += options.host;
        ws_addr += options.port ? ':' + options.port : '';
        ws_addr += options.path ? options.path : '';

        socket = this.socket = new WebSocket(ws_addr, this.protocol);

        socket.onopen = function() {
            that.onSocketFullyConnected();
        };
        socket.onclose = function(event) {
            that.onSocketClose(event);
        };
        socket.onmessage = function(event) {
            that.onSocketMessage(event.data);
        };
        socket.onerror = function(err) {
            that.debugOut('socketError() ' + err.message);
            that.last_socket_error = err;
        };
    }

    // Called when the socket is connected and ready to start sending/receiving data.
    onSocketFullyConnected() {
        this.debugOut('socketFullyConnected()');
        this.last_socket_error = null;
        this.connected = true;
        this.emit('open');
    }

    onSocketClose(event) {
        const possible_protocol_error = !this.connected && event.code === 1006;
        if (possible_protocol_error && !this.protocol_fallback && this.protocol !== undefined) {
            // First connection attempt failed possibly due to mismatched protocol,
            //  retry the connection with undefined protocol
            // After this attempt, normal reconnect functions apply which will
            //  reconstruct this websocket, resetting these variables
            this.debugOut('socketClose() possible protocol error, retrying with no protocol');
            this.protocol_fallback = true;
            this.protocol = undefined;
            this.connect();
            return;
        }

        this.debugOut('socketClose()');
        this.connected = false;
        this.emit('close', this.last_socket_error ? this.last_socket_error : false);
    }

    onSocketMessage(data) {
        if (typeof data !== 'string') {
            this.last_socket_error = new Error('Websocket received unexpected binary data, closing the connection');
            this.debugOut('socketData() ' + this.last_socket_error.message);
            this.close();
            return;
        }

        this.debugOut('socketData() ' + JSON.stringify(data));

        const that = this;
        let lines = null;

        this.incoming_buffer += data + '\n';

        lines = this.incoming_buffer.split('\n');
        if (lines[lines.length - 1] !== '') {
            this.incoming_buffer = lines.pop();
        } else {
            lines.pop();
            this.incoming_buffer = '';
        }

        lines.forEach(function(line) {
            that.emit('line', line);
        });
    }

    disposeSocket() {
        this.debugOut('Connection.disposeSocket() connected=' + this.connected);

        if (this.socket && this.connected) {
            this.socket.close();
        }

        if (this.socket) {
            this.socket.onopen = null;
            this.socket.onclose = null;
            this.socket.onmessage = null;
            this.socket.onerror = null;
            this.socket = null;
        }
    }

    close() {
        if (this.socket && this.connected) {
            this.socket.close();
        }
    }

    setEncoding(encoding) {
    }
};