@node-red/nodes 2.2.1 → 3.0.0-beta.2

package/core/network/21-httprequest.html

@@ -100,14 +100,109 @@
         <option value="obj" data-i18n="httpin.json"></option>
         </select>
     </div>
+
+    <div class="form-row form-tips" id="tip-json" hidden><span data-i18n="httpin.tip.req"></span></div>
+
+    <div class="form-row" style="margin-bottom:0;">
+        <label><i class="fa fa-list"></i> <span data-i18n="httpin.label.headers"></span></label>
+    </div>
+    <div class="form-row node-input-headers-container-row">
+        <ol id="node-input-headers-container"></ol>
+    </div>
+
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
         <input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
     </div>
-    <div class="form-tips" id="tip-json" hidden><span data-i18n="httpin.tip.req"></span></div>
 </script>
 
 <script type="text/javascript">
+(function() {
+    const headerTypes = [
+        { value: "Accept", label: "Accept", hasValue: false },
+        { value: "Accept-Encoding", label: "Accept-Encoding", hasValue: false },
+        { value: "Accept-Language", label: "Accept-Language", hasValue: false },
+        { value: "Authorization", label: "Authorization", hasValue: false },
+        { value: "Content-Type", label: "Content-Type", hasValue: false },
+        { value: "Cache-Control", label: "Cache-Control", hasValue: false },
+        { value: "User-Agent", label: "User-Agent", hasValue: false },
+        { value: "Location", label: "Location", hasValue: false },
+        { value: "other", label: RED._("node-red:httpin.label.other"),
+          hasValue: true, icon: "red/images/typedInput/az.svg" },
+        { value: "msg", label: "msg.", hasValue: true },
+    ]
+    const headerOptions = {};
+    const defaultOptions = [
+        { value: "other", label: RED._("node-red:httpin.label.other"),
+          hasValue: true, icon: "red/images/typedInput/az.svg" },
+        { value: "msg", label: "msg.", hasValue: true },
+    ];
+    headerOptions["accept"] = [
+        { value: "text/plain", label: "text/plain", hasValue: false },
+        { value: "text/html", label: "text/html", hasValue: false },
+        { value: "application/json", label: "application/json", hasValue: false },
+        { value: "application/xml", label: "application/xml", hasValue: false },
+        ...defaultOptions,
+    ];
+    headerOptions["accept-encoding"] = [
+        { value: "gzip", label: "gzip", hasValue: false },
+        { value: "deflate", label: "deflate", hasValue: false },
+        { value: "compress", label: "compress", hasValue: false },
+        { value: "br", label: "br", hasValue: false },
+        { value: "gzip, deflate", label: "gzip, deflate", hasValue: false },
+        { value: "gzip, deflate, br", label: "gzip, deflate, br", hasValue: false },
+        ...defaultOptions,
+    ];
+    headerOptions["accept-language"] = [
+        { value: "*", label: "*", hasValue: false },
+        { value: "en-GB, en-US, en;q=0.9", label: "en-GB, en-US, en;q=0.9", hasValue: false },
+        { value: "de-AT, de-DE;q=0.9, en;q=0.5", label: "de-AT, de-DE;q=0.9, en;q=0.5", hasValue: false },
+        { value: "es-mx,es,en;q=0.5", label: "es-mx,es,en;q=0.5", hasValue: false },
+        { value: "fr-CH, fr;q=0.9, en;q=0.8", label: "fr-CH, fr;q=0.9, en;q=0.8", hasValue: false },
+        { value: "zh-CN, zh-TW; q = 0.9, zh-HK; q = 0.8, zh; q = 0.7, en; q = 0.6", label: "zh-CN, zh-TW; q = 0.9, zh-HK; q = 0.8, zh; q = 0.7, en; q = 0.6", hasValue: false },
+        { value: "ja-JP, jp", label: "ja-JP, jp", hasValue: false },
+        ...defaultOptions,
+    ];
+    headerOptions["content-type"] = [
+        { value: "text/css", label: "text/css", hasValue: false },
+        { value: "text/plain", label: "text/plain", hasValue: false },
+        { value: "text/html", label: "text/html", hasValue: false },
+        { value: "application/json", label: "application/json", hasValue: false },
+        { value: "application/octet-stream", label: "application/octet-stream", hasValue: false },
+        { value: "application/pdf", label: "application/pdf", hasValue: false },
+        { value: "application/xml", label: "application/xml", hasValue: false },
+        { value: "application/zip", label: "application/zip", hasValue: false },
+        { value: "multipart/form-data", label: "multipart/form-data", hasValue: false },
+        { value: "audio/aac", label: "audio/aac", hasValue: false },
+        { value: "audio/ac3", label: "audio/ac3", hasValue: false },
+        { value: "audio/basic", label: "audio/basic", hasValue: false },
+        { value: "audio/mp4", label: "audio/mp4", hasValue: false },
+        { value: "audio/ogg", label: "audio/ogg", hasValue: false },
+        { value: "image/bmp", label: "image/bmp", hasValue: false },
+        { value: "image/gif", label: "image/gif", hasValue: false },
+        { value: "image/jpeg", label: "image/jpeg", hasValue: false },
+        { value: "image/png", label: "image/png", hasValue: false },
+        { value: "image/tiff", label: "image/tiff", hasValue: false },
+        ...defaultOptions,
+    ];
+    headerOptions["cache-control"] = [
+        { value: "max-age=0", label: "max-age=0", hasValue: false },
+        { value: "max-age=86400", label: "max-age=86400", hasValue: false },
+        { value: "no-cache", label: "no-cache", hasValue: false },
+        ...defaultOptions,
+    ];
+
+    headerOptions["user-agent"] = [
+        { value: "Mozilla/5.0", label: "Mozilla/5.0", hasValue: false },
+        ...defaultOptions,
+    ];
+
+    function getHeaderOptions(headerName) {
+        const lc = (headerName || "").toLowerCase();
+        let opts = headerOptions[lc];
+        return opts || defaultOptions;
+    }
+
     RED.nodes.registerType('http request',{
         category: 'network',
         color:"rgb(231, 231, 174)",
@@ -116,12 +211,25 @@
             method:{value:"GET"},
             ret: {value:"txt"},
             paytoqs: {value: false},
-            url:{value:"",validate:function(v) { return (v.trim().length === 0) || (v.indexOf("://") === -1) || (v.trim().indexOf("http") === 0)} },
-            tls: {type:"tls-config",required: false},
+            url:{
+                value:"",
+                validate: function(v, opt) {
+                    if ((v.trim().length === 0) ||
+                        (v.indexOf("://") === -1) ||
+                        (v.trim().indexOf("http") === 0)) {
+                        return true;
+                    }
+                    return RED._("node-red:httpin.errors.invalid-url");
+                }
+            },
+            tls: {type:"tls-config",required: false,
+                  label:RED._("node-red:httpin.tls-config") },
             persist: {value:false},
-            proxy: {type:"http proxy",required: false},
+            proxy: {type:"http proxy",required: false,
+                    label:RED._("node-red:httpin.proxy-config") },
             authType: {value: ""},
-            senderr: {value: false}
+            senderr: {value: false},
+            headers: { value: [] }
         },
         credentials: {
             user: {type:"text"},
@@ -144,6 +252,7 @@
             return this.name?"node_label_italic":"";
         },
         oneditprepare: function() {
+            const node = this;
             $("#node-input-useAuth").on("change", function() {
                 if ($(this).is(":checked")) {
                     $(".node-input-useAuth-row").show();
@@ -157,9 +266,10 @@
                     $('#node-input-user').val('');
                     $('#node-input-password').val('');
                 }
+                RED.tray.resize();
             });
             $("#node-input-authType-select").on("change", function() {
-                var val = $(this).val();
+                const val = $(this).val();
                 $("#node-input-authType").val(val);
                 if (val === "basic" || val === "digest") {
                     $(".node-input-basic-row").show();
@@ -171,6 +281,7 @@
                     $('#node-span-token').show();
                     $('#node-input-user').val('');
                 }
+                RED.tray.resize();
             });
             $("#node-input-method").on("change", function() {
                 if ($(this).val() == "GET") {
@@ -178,17 +289,18 @@
                 } else {
                     $(".node-input-paytoqs-row").hide();
                 }
+                RED.tray.resize();
             });
-            if (this.paytoqs === true || this.paytoqs == "query") {
+            if (node.paytoqs === true || node.paytoqs == "query") {
                 $("#node-input-paytoqs").val("query");
-            } else if (this.paytoqs === "body") {
+            } else if (node.paytoqs === "body") {
                 $("#node-input-paytoqs").val("body");
             } else {
                 $("#node-input-paytoqs").val("ignore");
             }
-            if (this.authType) {
+            if (node.authType) {
                 $('#node-input-useAuth').prop('checked', true);
-                $("#node-input-authType-select").val(this.authType);
+                $("#node-input-authType-select").val(node.authType);
                 $("#node-input-authType-select").change();
             } else {
                 $('#node-input-useAuth').prop('checked', false);
@@ -201,8 +313,9 @@
                 } else {
                     $("#node-row-tls").hide();
                 }
+                RED.tray.resize();
             }
-            if (this.tls) {
+            if (node.tls) {
                 $('#node-input-usetls').prop('checked', true);
             } else {
                 $('#node-input-usetls').prop('checked', false);
@@ -218,8 +331,9 @@
                 } else {
                     $("#node-input-useProxy-row").hide();
                 }
+                RED.tray.resize();
             }
-            if (this.proxy) {
+            if (node.proxy) {
                 $("#node-input-useProxy").prop("checked", true);
             } else {
                 $("#node-input-useProxy").prop("checked", false);
@@ -235,7 +349,70 @@
                 } else {
                     $("#tip-json").hide();
                 }
+                RED.tray.resize();
             });
+            const hasMatch = function (arr, value) {
+                return arr.some(function (ht) {
+                    return ht.value === value
+                });
+            }
+            const headerList = $("#node-input-headers-container").css('min-height', '150px').css('min-width', '450px').editableList({
+                addItem: function (container, i, header) {
+                    const row = $('<div/>').css({
+                        overflow: 'hidden',
+                        whiteSpace: 'nowrap',
+                        display: 'flex'
+                    }).appendTo(container);
+                    const propertNameCell = $('<div/>').css({ 'flex-grow': 1 }).appendTo(row);
+                    const propertyName = $('<input/>', { class: "node-input-header-name", type: "text", style: "width: 100%" })
+                        .appendTo(propertNameCell)
+                        .typedInput({ types: headerTypes });
+
+                    const propertyValueCell = $('<div/>').css({ 'flex-grow': 1, 'margin-left': '10px' }).appendTo(row);
+                    const propertyValue = $('<input/>', { class: "node-input-header-value", type: "text", style: "width: 100%" })
+                        .appendTo(propertyValueCell)
+                        .typedInput({
+                            types: getHeaderOptions(header.keyType)
+                        });
+
+                    const setup = function(_header) {
+                        const headerTypeIsAPreset = function(h) {return hasMatch(headerTypes, h) };
+                        const headerValueIsAPreset = function(h, v) {return hasMatch(getHeaderOptions(h), v) };
+                        const {keyType, keyValue, valueType, valueValue} = header;
+                        if(keyType == "msg" || keyType == "other") {
+                            propertyName.typedInput('type', keyType);
+                            propertyName.typedInput('value', keyValue);
+                        } else if (headerTypeIsAPreset(keyType)) {
+                            propertyName.typedInput('type', keyType);
+                        } else {
+                            propertyName.typedInput('type', "other");
+                            propertyName.typedInput('value', keyValue);
+                        }
+                        if(valueType == "msg" || valueType == "other") {
+                            propertyValue.typedInput('type', valueType);
+                            propertyValue.typedInput('value', valueValue);
+                        } else if (headerValueIsAPreset(propertyName.typedInput('type'), valueType)) {
+                            propertyValue.typedInput('type', valueType);
+                        } else {
+                            propertyValue.typedInput('type', "other");
+                            propertyValue.typedInput('value', valueValue);
+                        }
+                    }
+                    setup(header);
+
+                    propertyName.on('change', function (event) {
+                        propertyValue.typedInput('types', getHeaderOptions(propertyName.typedInput('type')));
+                    });
+
+                },
+                removable: true
+            });
+            if (node.headers) {
+                for (let index = 0; index < node.headers.length; index++) {
+                    const element = node.headers[index];
+                    headerList.editableList('addItem', node.headers[index]);
+                }
+            }
         },
         oneditsave: function() {
             if (!$("#node-input-usetls").is(':checked')) {
@@ -244,6 +421,36 @@
             if (!$("#node-input-useProxy").is(":checked")) {
                 $("#node-input-proxy").val("_ADD_");
             }
+            const headers = $("#node-input-headers-container").editableList('items');
+            const node = this;
+            node.headers = [];
+            headers.each(function(i) {
+                const header = $(this);
+                const keyType = header.find(".node-input-header-name").typedInput('type');
+                const keyValue = header.find(".node-input-header-name").typedInput('value');
+                const valueType = header.find(".node-input-header-value").typedInput('type');
+                const valueValue = header.find(".node-input-header-value").typedInput('value');
+                if (keyType !== '' || keyType === 'other' || keyType === 'msg') {
+                    node.headers.push({
+                        keyType, keyValue, valueType, valueValue
+                    })
+                }
+            });
+        },
+        oneditresize: function(size) {
+            const dlg = $("#dialog-form");
+            const expandRow = dlg.find('.node-input-headers-container-row');
+            let height = dlg.height() - 5;
+            if(expandRow && expandRow.length){
+                const siblingRows = dlg.find('> .form-row:not(.node-input-headers-container-row)');
+                for (let i = 0; i < siblingRows.size(); i++) {
+                    const cr = $(siblingRows[i]);
+                    if(cr.is(":visible"))
+                        height -= cr.outerHeight(true);
+                }
+                $("#node-input-headers-container").editableList('height',height);
+            } 
         }
     });
+})();    
 </script>

package/core/network/21-httprequest.js

@@ -73,7 +73,7 @@ in your Node-RED user directory (${RED.settings.userDir}).
         var paytobody = false;
         var redirectList = [];
         var sendErrorsToCatch = n.senderr;
-
+        node.headers = n.headers || [];
         var nodeHTTPPersistent = n["persist"];
         if (n.tls) {
             var tlsNode = RED.nodes.getNode(n.tls);
@@ -105,6 +105,37 @@ in your Node-RED user directory (${RED.settings.userDir}).
             timingLog = RED.settings.httpRequestTimingLog;
         }
 
+        /**
+         * Case insensitive header value update util function
+         * @param {object} headersObject The opt.headers object to update
+         * @param {string} name The header name
+         * @param {string} value The header value to set (if blank, header is removed)
+         */
+        const updateHeader = function(headersObject, name, value ) {
+            const hn = name.toLowerCase();
+            const keys = Object.keys(headersObject);
+            const matchingKeys = keys.filter(e => e.toLowerCase() == hn)
+            const updateKey = (k,v) => {
+                delete headersObject[k]; //delete incase of case change
+                if(v) { headersObject[name] = v } //re-add with requested name & value
+            }
+            if(matchingKeys.length == 0) {
+                updateKey(name, value)
+            } else {
+                matchingKeys.forEach(k => {
+                    updateKey(k, value);
+                });
+            }
+        }
+        /**
+         * @param {Object} headersObject
+         * @param {string} name
+         * @return {any} value
+        */
+        const getHeaderValue = (headersObject, name) => {
+            const asLowercase = name.toLowercase();
+            return headersObject[Object.keys(headersObject).find(k => k.toLowerCase() === asLowercase)];
+        }
         this.on("input",function(msg,nodeSend,nodeDone) {
             checkNodeAgentPatch();
             //reset redirectList on each request
@@ -183,7 +214,6 @@ in your Node-RED user directory (${RED.settings.userDir}).
             // TODO: add UI option to auto decompress. Setting to false for 1.x compatibility
             opts.decompress = false;
             opts.method = method;
-            opts.headers = {};
             opts.retry = 0;
             opts.responseType = 'buffer';
             opts.maxRedirects = 21;
@@ -229,34 +259,85 @@ in your Node-RED user directory (${RED.settings.userDir}).
                 ]
             }
 
-            var ctSet = "Content-Type"; // set default camel case
-            var clSet = "Content-Length";
+            let ctSet = "Content-Type"; // set default camel case
+            let clSet = "Content-Length";
+            const normaliseKnownHeader = function (name) {
+                const _name = name.toLowerCase();
+                // only normalise the known headers used later in this
+                // function. Otherwise leave them alone.
+                switch (_name) {
+                    case "content-type":
+                        ctSet = name;
+                        name = _name;
+                        break;
+                    case "content-length":
+                        clSet = name;
+                        name = _name;
+                        break;
+                }
+                return name;
+            }
+
+            opts.headers = {};
+            //add msg.headers 
+            //NOTE: ui headers will take precidence over msg.headers
             if (msg.headers) {
                 if (msg.headers.hasOwnProperty('x-node-red-request-node')) {
-                    var headerHash = msg.headers['x-node-red-request-node'];
+                    const headerHash = msg.headers['x-node-red-request-node'];
                     delete msg.headers['x-node-red-request-node'];
-                    var hash = hashSum(msg.headers);
+                    const hash = hashSum(msg.headers);
                     if (hash === headerHash) {
                         delete msg.headers;
                     }
                 }
                 if (msg.headers) {
-                    for (var v in msg.headers) {
-                        if (msg.headers.hasOwnProperty(v)) {
-                            var name = v.toLowerCase();
-                            if (name !== "content-type" && name !== "content-length") {
-                                // only normalise the known headers used later in this
-                                // function. Otherwise leave them alone.
-                                name = v;
+                    for (let hn in msg.headers) {
+                        const name = normaliseKnownHeader(hn);
+                        updateHeader(opts.headers, name, msg.headers[hn]);
+                    }
+                }
+            }
+
+            //add/remove/update headers from UI.
+            if (node.headers.length) {
+                for (let index = 0; index < node.headers.length; index++) {
+                    const header = node.headers[index];
+                    let headerName, headerValue;
+                    if (header.keyType === "other") {
+                        headerName = header.keyValue
+                    } else if (header.keyType === "msg") {
+                        RED.util.evaluateNodeProperty(header.keyValue, header.keyType, node, msg, (err, value) => {
+                            if (err) {
+                                //ignore header
+                            } else {
+                                headerName = value;
                             }
-                            else if (name === 'content-type') { ctSet = v; }
-                            else { clSet = v; }
-                            opts.headers[name] = msg.headers[v];
-                        }
+                        });
+                    } else {
+                        headerName = header.keyType
+                    }
+                    if (!headerName) {
+                        continue; //skip if header name is empyy
                     }
+                    if (header.valueType === "other") {
+                        headerValue = header.valueValue
+                    } else if (header.valueType === "msg") {
+                        RED.util.evaluateNodeProperty(header.valueValue, header.valueType, node, msg, (err, value) => {
+                            if (err) {
+                                //ignore header
+                            } else {
+                                headerValue = value;
+                            }
+                        });
+                    } else {
+                        headerValue = header.valueType
+                    }
+                    const hn = normaliseKnownHeader(headerName);
+                    updateHeader(opts.headers, hn, headerValue);
                 }
             }
 
+
             if (msg.hasOwnProperty('followRedirects')) {
                 opts.followRedirect = !!msg.followRedirects;
             }

package/core/network/22-websocket.html

@@ -83,13 +83,19 @@
             return true;
         }
         else {
-            return RED.nodes.node(this.server) != null;
+            if (RED.nodes.node(this.server) != null) {
+                return true;
+            }
+            return RED._("node-red:websocket.errors.missing-server");
         }
     }
 
     function ws_validateclient() {
         if ($("#node-input-mode").val() === 'client' || (this.client && !this.server)) {
-            return RED.nodes.node(this.client) != null;
+            if (RED.nodes.node(this.client) != null) {
+                return true;
+            }
+            return RED._("node-red:websocket.errors.missing-client");
         }
         else {
             return true;
@@ -138,7 +144,9 @@
     RED.nodes.registerType('websocket-listener',{
         category: 'config',
         defaults: {
-            path: {value:"",required:true,validate:RED.validators.regex(/^((?!\/debug\/ws).)*$/)},
+            path: {value:"",required:true,
+                   label:RED._("node-red:websocket.label.path"),
+                   validate:RED.validators.regex(/^((?!\/debug\/ws).)*$/)},
             wholemsg: {value:"false"}
         },
         inputs:0,
@@ -174,10 +182,16 @@
     RED.nodes.registerType('websocket-client',{
         category: 'config',
         defaults: {
-            path: {value:"",required:true,validate:RED.validators.regex(/^((?!\/debug\/ws).)*$/)},
+            path: {
+                value:"",required:true,
+                label:RED._("node-red:websocket.label.path"),
+                validate:RED.validators.regex(/^((?!\/debug\/ws).)*$/)},
             tls: {type:"tls-config",required: false},
             wholemsg: {value:"false"},
-            hb: {value: "", validate: RED.validators.number(/*blank allowed*/true) },
+            hb: {
+                value: "",
+                label:RED._("node-red:websocket.sendheartbeat"),
+                validate: RED.validators.number(/*blank allowed*/true) },
             subprotocol: {value:"",required: false}
         },
         inputs:0,

package/core/network/22-websocket.js

@@ -35,8 +35,6 @@ module.exports = function(RED) {
         }
     }
     var listenerNodes = {};
-    var activeListenerNodes = 0;
-
 
     // A node red node that sets up a local websocket server
     function WebSocketListenerNode(n) {
@@ -166,7 +164,6 @@ module.exports = function(RED) {
         }
 
         if (node.isServer) {
-            activeListenerNodes++;
             if (!serverUpgradeAdded) {
                 RED.server.on('upgrade', handleServerUpgrade);
                 serverUpgradeAdded = true
@@ -210,7 +207,7 @@ module.exports = function(RED) {
             startconn(); // start outbound connection
         }
 
-        node.on("close", function() {
+        node.on("close", function(done) {
             if (node.heartbeatInterval) {
                 clearInterval(node.heartbeatInterval);
             }
@@ -218,19 +215,25 @@ module.exports = function(RED) {
                 delete listenerNodes[node.fullPath];
                 node.server.close();
                 node._inputNodes = [];
-                activeListenerNodes--;
-                // if (activeListenerNodes === 0 && serverUpgradeAdded) {
-                //     RED.server.removeListener('upgrade', handleServerUpgrade);
-                //     serverUpgradeAdded = false;
-                // }
             }
             else {
                 node.closing = true;
                 node.server.close();
-                if (node.tout) {
-                    clearTimeout(node.tout);
-                    node.tout = null;
-                }
+                //wait 20*50 (1000ms max) for ws to close. 
+                //call done when readyState === ws.CLOSED (or 1000ms, whichever comes fist)
+                const closeMonitorInterval = 20;
+                let closeMonitorCount = 50;
+                let si = setInterval(() => {
+                    if(node.server.readyState === ws.CLOSED || closeMonitorCount <= 0) {
+                        if (node.tout) {
+                            clearTimeout(node.tout);
+                            node.tout = null;
+                        }
+                        clearInterval(si);
+                        return done();
+                    }
+                    closeMonitorCount--;
+                }, closeMonitorInterval);
             }
         });
     }