node-red-contrib-websocket-server 0.0.4 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-websocket-server",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "websocket test with websocket open/close event information",
   "keywords": [
     "websocket",

package/websocket.js

@@ -516,17 +516,16 @@ module.exports = function(RED) {
                 }
             }
             if (payload) {
-                if (msg._session) {
+                if (msg.hasOwnProperty("_session")) {
                     if (Array.isArray(msg._session))
                     {
-                        for (var i = 0; i <  msg._session.lenght; i++)
-                        {
-                            node.serverConfig.reply(msg._session[i],payload);
-                        }
+                        msg._session.forEach(function(sessionId){
+                            node.serverConfig.reply(sessionId,payload);
+                        });
                     }
                     else
                     {
-                        node.serverConfig.reply(msg._session.id,payload);
+                        node.serverConfig.reply(msg._session,payload);
                     }
                 } else {
                     node.serverConfig.broadcast(payload,function(error) {

package/node-red-out.log

@@ -1,7 +0,0 @@
-4 Dec 01:39:37 - [error] [websocket_in:74d0f57c24d46886] Missing server configuration
-4 Dec 01:39:37 - [error] [websocket_out:6869372869b99a04] Missing server configuration
-4 Dec 01:39:37 - [error] [websocket_Open/Close:623fd1447a52eebe] Missing server configuration
-4 Dec 01:39:37 - [error] [websocket_Drop:a9022ea21938b95d] Missing server configuration
-4 Dec 08:21:06 - [error] [websocket_out:53c713250b4ce90c] Missing server configuration
-4 Dec 08:21:50 - [error] [websocket_out:53c713250b4ce90c] Missing server configuration
-4 Dec 08:22:02 - [error] [websocket_out:53c713250b4ce90c] Missing server configuration

package/websocket_old.js

@@ -1,587 +0,0 @@
-/**
- * Copyright JS Foundation and other contributors, http://js.foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- **/
-
-module.exports = function(RED) {
-    "use strict";
-    var ws = require("ws");
-    var inspect = require("util").inspect;
-    var url = require("url");
-    var HttpsProxyAgent = require('https-proxy-agent');
-    const { getProxyForUrl } = require('./lib/proxyHelper');
-
-    var serverUpgradeAdded = false;
-    function handleServerUpgrade(request, socket, head) {
-        const pathname = url.parse(request.url).pathname;
-        if (listenerNodes.hasOwnProperty(pathname)) {
-            listenerNodes[pathname].server.handleUpgrade(request, socket, head, function done(ws) {
-                listenerNodes[pathname].server.emit('connection', ws, request);
-            });
-        } else {
-            // Don't destroy the socket as other listeners may want to handle the
-            // event.
-        }
-    }
-    var listenerNodes = {};
-
-    // A node red node that sets up a local websocket server
-    function WebSocketListenerNode(n) {
-        // Create a RED node
-        RED.nodes.createNode(this,n);
-        var node = this;
-
-        // Store local copies of the node configuration (as defined in the .html)
-        node.path = n.path;
-        if (typeof n.subprotocol === "string") {
-            // Split the string on comma and trim each result
-            node.subprotocol = n.subprotocol.split(",").map(v => v.trim())
-        } else {
-            node.subprotocol = [];
-        }
-        node.wholemsg = (n.wholemsg === "true");
-
-        node._inputNodes = [];    // collection of nodes that want to receive events
-        node._openNodes = [];
-        node._clients = {};
-        node._intervals = {};
-        node.heartbeatInterval = {};
-        // match absolute url
-        node.isServer = !/^ws{1,2}:\/\//i.test(node.path);
-        node.closing = false;
-        node.tls = n.tls;
-        node.upgradeHeaders = n.headers
-
-        if (n.hb) {
-            var heartbeat = parseInt(n.hb);
-            if (heartbeat > 0) {
-                node.heartbeat = heartbeat * 1000;
-            }
-        }
-        node.pingaction = n.pingaction;
-
-        function startconn() {    // Connect to remote endpoint
-            node.tout = null;
-            const prox = getProxyForUrl(node.brokerurl, RED.settings.proxyOptions);
-            let agent = undefined;
-            if (prox) {
-                agent = new HttpsProxyAgent(prox);
-            }
-
-            var options = {};
-            if (agent) {
-                options.agent = agent;
-            }
-            if (node.tls) {
-                var tlsNode = RED.nodes.getNode(node.tls);
-                if (tlsNode) {
-                    tlsNode.addTLSOptions(options);
-                }
-            }
-
-            // We need to check if undefined, to guard against previous installs, that will not have had this property set (applies to 3.1.x setups)
-            // Else this will be breaking potentially
-            if(node.upgradeHeaders !== undefined && node.upgradeHeaders.length > 0){
-                options.headers = {};
-                for(let i = 0;i<node.upgradeHeaders.length;i++){
-                    const header = node.upgradeHeaders[i];
-                    const keyType = header.keyType;
-                    const keyValue = header.keyValue;
-                    const valueType = header.valueType;
-                    const valueValue = header.valueValue;
-                    
-                    const headerName = keyType === 'other' ? keyValue : keyType;
-                    let headerValue;
-                    
-                    switch(valueType){
-                        case 'other':
-                            headerValue = valueValue;
-                            break;
-                            
-                        case 'env':
-                            headerValue = RED.util.evaluateNodeProperty(valueValue,valueType,node);
-                            break;
-
-                        default:
-                            headerValue = valueType;
-                            break;
-                    }
-
-                    if(headerName && headerValue){
-                        options.headers[headerName] = headerValue
-                    }
-
-                }
-            }
-
-            var socket = new ws(node.path,node.subprotocol,options);
-            socket.setMaxListeners(0);
-            node.server = socket; // keep for closing
-            handleConnection(socket);
-        }
-
-        function handleConnection(/*socket*/socket) {
-            var id = RED.util.generateId();
-            socket.nrId = id;
-            socket.nrPendingPing = true;
-            socket.nrPendingPong = false;
-            node._clients[id] = socket;
-            node.emit('opened',{count:Object.keys(node._clients).length,id:id});
-            //node.handleOpenCloseEvent(id,socket,'open');
-            node.handleOpenCloseEvent(id,socket,'open');
-
-
-            //dorobit reakciu na ping v resp pri kazdom novom pripojeni nastavit casovac ze ma ocakavat ping,
-            //ak nepride tak ukonci spojenie
-            //ak pride restuje casovac a zacne pocitat odznovu
-
-            if (node.pingaction !== "none")
-            {
-                //clearInterval(node.heartbeatInterval);
-                node.heartbeatInterval[id] = setInterval(function() {
-                    if (node.pingaction === "send"){
-                        if (socket.nrPendingPong){
-                            var msg = {};
-                            //node.warn("No pong received " + node.heartbeat);
-                            msg._session = {"id":id};
-                            //node.serverConfig.drop(msg._session.id);
-                            node.drop(msg._session.id);
-                            socket.nrErrorHandler(new Error("timeout"));
-                            return;
-                        }
-                        //node.warn("No pong received " + node.heartbeat);
-                        socket.nrPendingPong = true;
-                        try {
-                            socket.ping();
-                        } catch(err) {
-                            node.warn(err);
-                        }
-                    }
-                    else if (node.pingaction === "receive") {
-                        if (socket.nrPendingPing){
-                            var msg = {};
-                            //node.warn("No pong received " + node.heartbeat);
-                            msg._session = {"id":id};
-                            //node.serverConfig.drop(msg._session.id);
-                            node.drop(msg._session.id);
-                            socket.nrErrorHandler(new Error("timeout"));
-                            return;
-                        }
-                    }
-                },node.heartbeat);
-            }
-   
-            socket.on('close',function() {
-                clearInterval(node.heartbeatInterval[id]);
-                if (node.isServer) {
-                    delete node._clients[id];
-                    node.emit('closed',{count:Object.keys(node._clients).length,id:id});
-                    node.handleOpenCloseEvent(id,socket,'close');
-                } else {
-                    node.emit('closed',{count:'',id:id});
-                }
-                if (!node.closing && !node.isServer) {
-                    clearTimeout(node.tout);
-                    node.tout = setTimeout(function() { startconn(); }, 3000); // try to reconnect every 3 secs... bit fast ?
-                }
-            });
-            socket.on('message',function(data,flags) {
-                node.handleEvent(id,socket,'message',data,flags);
-            });
-            socket.nrErrorHandler = function(err) {
-                clearInterval(node.heartbeatInterval[id]);
-                node.emit('erro',{err:err,id:id});
-                if (!node.closing && !node.isServer) {
-                    clearTimeout(node.tout);
-                    node.tout = setTimeout(function() { startconn(); }, 3000); // try to reconnect every 3 secs... bit fast ?
-                }
-            }
-            socket.on('error',socket.nrErrorHandler);
-            socket.on('ping', function() {
-                socket.nrPendingPing = false;
-            })
-            socket.on('pong', function() {
-                socket.nrPendingPong = false;
-            })
-        }
-
-        if (node.isServer) {
-            if (!serverUpgradeAdded) {
-                RED.server.on('upgrade', handleServerUpgrade);
-                serverUpgradeAdded = true
-            }
-
-            var path = RED.settings.httpNodeRoot || "/";
-            path = path + (path.slice(-1) == "/" ? "":"/") + (node.path.charAt(0) == "/" ? node.path.substring(1) : node.path);
-            node.fullPath = path;
-
-            if (listenerNodes.hasOwnProperty(path)) {
-                node.error(RED._("Cannot have two WebSocket listeners on the same path: __path__",{path: node.path}));
-                return;
-            }
-            listenerNodes[node.fullPath] = node;
-            var serverOptions = {
-                noServer: true
-            }
-            if (RED.settings.webSocketNodeVerifyClient) {
-                serverOptions.verifyClient = RED.settings.webSocketNodeVerifyClient;
-            }
-            // Create a WebSocket Server
-            node.server = new ws.Server(serverOptions);
-            node.server.setMaxListeners(0);
-            node.server.on('connection', handleConnection);
-            // Not adding server-initiated heartbeats yet
-            // node.heartbeatInterval = setInterval(function() {
-            //     node.server.clients.forEach(function(ws) {
-            //         if (ws.nrPendingHeartbeat) {
-            //             // No pong received
-            //             ws.terminate();
-            //             ws.nrErrorHandler(new Error("timeout"));
-            //             return;
-            //         }
-            //         ws.nrPendingHeartbeat = true;
-            //         ws.ping();
-            //     });
-            // })
-        }
-        else {
-            node.closing = false;
-            startconn(); // start outbound connection
-        }
-
-        node.on("close", function(done) {
-            /*if (node.heartbeatInterval[id]) {
-                clearInterval(node.heartbeatInterval[id]);
-            }*/
-           try {
-                clearInterval(node.heartbeatInterval[id]);
-            }
-            catch(e) { // swallow any errors
-            }
-            if (node.isServer) {
-                delete listenerNodes[node.fullPath];
-                node.server.close();
-                node._inputNodes = [];
-                node._openNodes = [];
-                done();
-            }
-     
-        });
-    }
-    RED.nodes.registerType("websocket_server",WebSocketListenerNode);
-
-    WebSocketListenerNode.prototype.registerInputNode = function(/*Node*/handler) {
-        this._inputNodes.push(handler);
-    }
-
-    WebSocketListenerNode.prototype.registerOpenNode = function(/*Node*/handler) {
-        this._openNodes.push(handler);
-    }
-
-    WebSocketListenerNode.prototype.removeInputNode = function(/*Node*/handler) {
-        this._inputNodes.forEach(function(node, i, inputNodes) {
-            if (node === handler) {
-                inputNodes.splice(i, 1);
-            }
-        });
-        this._openNodes.forEach(function(node, i, openNodes) {
-            if (node === handler) {
-                openNodes.splice(i, 1);
-            }
-        });
-    }
-
-     WebSocketListenerNode.prototype.handleEvent = function(id,/*socket*/socket,/*String*/event,/*Object*/data,/*Object*/flags) {
-        var msg;
-        if (this.wholemsg) {
-            try {
-                msg = JSON.parse(data);
-                if (typeof msg !== "object" && !Array.isArray(msg) && (msg !== null)) {
-                    msg = { payload:msg };
-                }
-            }
-            catch(err) {
-                msg = { payload:data };
-            }
-        } else {
-            msg = {
-                payload:data
-            };
-        }
-        msg._session = {type:"websocket",id:id};
-        for (var i = 0; i < this._inputNodes.length; i++) {
-            this._inputNodes[i].send(msg);
-        }
-    }
-
-    WebSocketListenerNode.prototype.handleOpenCloseEvent = function(id,/*socket*/socket,/*String*/event,) {
-
-        var msg;
-        msg = {"event" : event};
-        //msg = {"ip" : socket. };
-        msg._session = {type:"websocket",id:id};
-        for (var i = 0; i < this._openNodes.length; i++) {
-            this._openNodes[i].send(msg);
-        }
-    }
-
-
-    WebSocketListenerNode.prototype.broadcast = function(data) {
-        for (let client in this._clients) {
-            if (this._clients.hasOwnProperty(client)) {
-                try {
-                    this._clients[client].send(data);
-                } catch(err) {
-                    this.warn("An error occurred while sending: "+" "+client+" "+err.toString());
-                }
-            }
-        }
-        
-    }
-
-    WebSocketListenerNode.prototype.reply = function(id,data) {
-        var session = this._clients[id];
-        if (session) {
-            try {
-                session.send(data);
-            }
-            catch(e) { // swallow any errors
-            }
-        }
-    }
-
-    WebSocketListenerNode.prototype.drop = function(id) {
-        var session = this._clients[id];
-        if (session) {
-            try {
-                session.close();
-            }
-            catch(e) { // swallow any errors
-            }
-        }
-    }
-
-    function WebsocketOpenCloseNode(n) {
-        RED.nodes.createNode(this,n);
-        this.server = (n.client)?n.client:n.server;
-        var node = this;
-        this.serverConfig = RED.nodes.getNode(this.server);
-        if (this.serverConfig) {
-            this.serverConfig.registerOpenNode(this);
-            // TODO: nls
-            this.serverConfig.on('opened', function(event) {
-                node.status({
-                    fill:"green",shape:"dot",text:RED._("connected " + event.count),
-                    event:"connect",
-                    _session: {type:"websocket",id:event.id}
-                });
-            });
-            this.serverConfig.on('erro', function(event) {
-                node.status({
-                    fill:"red",shape:"ring",text:"error",
-                    event:"error",
-                    _session: {type:"websocket",id:event.id}
-                });
-            });
-            this.serverConfig.on('closed', function(event) {
-                var status;
-                if (event.count > 0) {
-                    status = {fill:"green",shape:"dot",text:RED._("connected " + event.count)};
-                } else {
-                    status = {fill:"red",shape:"ring",text:"disconnected"};
-                }
-                status.event = "disconnect";
-                status._session = {type:"websocket",id:event.id}
-                node.status(status);
-            });
-        } else {
-            this.error(RED._("Missing server configuration"));
-        }
-        this.on('close', function() {
-            if (node.serverConfig) {
-                node.serverConfig.removeInputNode(node);
-            }
-            node.status({});
-        });
-    }
-    RED.nodes.registerType("websocket_Open/Close", WebsocketOpenCloseNode);
-    
-    function WebSocketInNode(n) {
-        RED.nodes.createNode(this,n);
-        this.server = (n.client)?n.client:n.server;
-        var node = this;
-        this.serverConfig = RED.nodes.getNode(this.server);
-        if (this.serverConfig) {
-            this.serverConfig.registerInputNode(this);
-            // TODO: nls
-            this.serverConfig.on('opened', function(event) {
-                node.status({
-                    fill:"green",shape:"dot",text:RED._("connected " + event.count),
-                    event:"connect",
-                    _session: {type:"websocket",id:event.id}
-                });
-            });
-            this.serverConfig.on('erro', function(event) {
-                node.status({
-                    fill:"red",shape:"ring",text:"error",
-                    event:"error",
-                    _session: {type:"websocket",id:event.id}
-                });
-            });
-            this.serverConfig.on('closed', function(event) {
-                var status;
-                if (event.count > 0) {
-                    status = {fill:"green",shape:"dot",text:RED._("connected " + event.count)};
-                } else {
-                    status = {fill:"red",shape:"ring",text:"disconnected"};
-                }
-                status.event = "disconnect";
-                status._session = {type:"websocket",id:event.id}
-                node.status(status);
-            });
-        } else {
-            this.error(RED._("Missing server configuration"));
-        }
-        this.on('close', function() {
-            if (node.serverConfig) {
-                node.serverConfig.removeInputNode(node);
-            }
-            node.status({});
-        });
-    }
-    RED.nodes.registerType("websocket_in",WebSocketInNode);
-
-    function WebSocketOutNode(n) {
-        RED.nodes.createNode(this,n);
-        var node = this;
-        this.server = (n.client)?n.client:n.server;
-        this.serverConfig = RED.nodes.getNode(this.server);
-        if (!this.serverConfig) {
-            return this.error(RED._("Missing server configuration"));
-        }
-        else {
-            // TODO: nls
-            this.serverConfig.on('opened', function(event) {
-                node.status({
-                    fill:"green",shape:"dot",text:RED._("connected " + event.count),
-                    event:"connect",
-                    _session: {type:"websocket",id:event.id}
-                });
-            });
-            this.serverConfig.on('erro', function(event) {
-                node.status({
-                    fill:"red",shape:"ring",text:"error",
-                    event:"error",
-                    _session: {type:"websocket",id:event.id}
-                })
-            });
-            this.serverConfig.on('closed', function(event) {
-                var status;
-                if (event.count > 0) {
-                    status = {fill:"green",shape:"dot",text:RED._("connected " + event.count)};
-                } else {
-                    status = {fill:"red",shape:"ring",text:"disconnected"};
-                }
-                status.event = "disconnect";
-                status._session = {type:"websocket",id:event.id}
-                node.status(status);
-            });
-        }
-        this.on("input", function(msg, nodeSend, nodeDone) {
-            var payload;
-            if (this.serverConfig.wholemsg) {
-                var sess;
-                if (msg._session) { sess = JSON.stringify(msg._session); }
-                delete msg._session;
-                payload = JSON.stringify(msg);
-                if (sess) { msg._session = JSON.parse(sess); }
-            }
-            else if (msg.hasOwnProperty("payload")) {
-                if (!Buffer.isBuffer(msg.payload)) { // if it's not a buffer make sure it's a string.
-                    payload = RED.util.ensureString(msg.payload);
-                }
-                else {
-                    payload = msg.payload;
-                }
-            }
-            if (payload) {
-                if (msg._session && msg._session.type == "websocket") {
-                    node.serverConfig.reply(msg._session.id,payload);
-                } else {
-                    node.serverConfig.broadcast(payload,function(error) {
-                        if (!!error) {
-                            node.warn("An error occurred while sending: "+inspect(error));
-                        }
-                    });
-                }
-            }
-            nodeDone();
-        });
-        this.on('close', function() {
-            node.status({});
-        });
-    }
-    RED.nodes.registerType("websocket_out",WebSocketOutNode);
-
-    function WebSocketDropNode(n) {
-        RED.nodes.createNode(this,n);
-        var node = this;
-        this.server = (n.client)?n.client:n.server;
-        this.serverConfig = RED.nodes.getNode(this.server);
-        if (!this.serverConfig) {
-            return this.error(RED._("Missing server configuration"));
-        }
-        else {
-            // TODO: nls
-            this.serverConfig.on('opened', function(event) {
-                node.status({
-                    fill:"green",shape:"dot",text:RED._("connected " + event.count),
-                    event:"connect",
-                    _session: {type:"websocket",id:event.id}
-                });
-            });
-            this.serverConfig.on('erro', function(event) {
-                node.status({
-                    fill:"red",shape:"ring",text:"error",
-                    event:"error",
-                    _session: {type:"websocket",id:event.id}
-                })
-            });
-            this.serverConfig.on('closed', function(event) {
-                var status;
-                if (event.count > 0) {
-                    status = {fill:"green",shape:"dot",text:RED._("connected " + event.count)};
-                } else {
-                    status = {fill:"red",shape:"ring",text:"disconnected"};
-                }
-                status.event = "disconnect";
-                status._session = {type:"websocket",id:event.id}
-                node.status(status);
-            });
-        }
-        this.on("input", function(msg, nodeDone) {
-            if (msg._session.id) {
-                this.serverConfig.drop(msg._session.id);
-            }
-            else {
-                node.warn("Valid msg._session required.");
-            }
-            nodeDone();
-        });
-        this.on('close', function() {
-            node.status({});
-        });
-    }
-    RED.nodes.registerType("websocket_Drop",WebSocketDropNode);
-}