From cae247160f4b4eff98df31caf0afe1e49af9d6f2 Mon Sep 17 00:00:00 2001
From: Dave Conway-Jones <conway@uk.ibm.com>
Date: Sun, 26 Dec 2021 15:28:16 +0000
Subject: [PATCH] Let tcprequest split incoming strings on delimiter (as per
 tcpin node)

and fixup i18n messages
---
 .../nodes/core/network/31-tcpin.html          | 16 ++++++++--
 .../@node-red/nodes/core/network/31-tcpin.js  | 30 ++++++++++++++-----
 .../nodes/locales/en-US/messages.json         | 10 ++++---
 3 files changed, 42 insertions(+), 14 deletions(-)

diff --git a/packages/node_modules/@node-red/nodes/core/network/31-tcpin.html b/packages/node_modules/@node-red/nodes/core/network/31-tcpin.html
index bbdbcc495..97c8eb4d7 100644
--- a/packages/node_modules/@node-red/nodes/core/network/31-tcpin.html
+++ b/packages/node_modules/@node-red/nodes/core/network/31-tcpin.html
@@ -50,7 +50,7 @@
     </div>
 
     <div id="node-row-newline" class="form-row hidden" style="padding-left:110px;">
-        <span data-i18n="tcpin.label.delimited"></span> <input type="text" id="node-input-newline" style="width:110px;">
+        <span data-i18n="tcpin.label.delimited"></span> <input type="text" id="node-input-newline" style="width:110px;" data-i18n="[placeholder]tcpin.label.optional">
     </div>
 
     <div class="form-row">
@@ -274,7 +274,7 @@
         </select>
     </div>
     <div class="form-row">
-        <label for="node-input-out"> </label>
+        <label for="node-input-out"><i class="fa fa-sign-out fa-rotate-90"></i> <span data-i18n="tcpin.label.close"></span></label>
         <select type="text" id="node-input-out" style="width:54%;">
             <option value="time" data-i18n="tcpin.return.timeout"></option>
             <option value="char" data-i18n="tcpin.return.character"></option>
@@ -285,6 +285,9 @@
         <input type="text" id="node-input-splitc" style="width:50px;">
         <span id="node-units"></span>
     </div>
+    <div id="node-row-newline" class="form-row hidden" style="padding-left:162px;">
+        <span data-i18n="tcpin.label.delimited"></span> <input type="text" id="node-input-newline" style="width:110px;" data-i18n="[placeholder]tcpin.label.optional">
+    </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">
@@ -302,6 +305,7 @@
             out: {value:"time", required:true},
             ret: {value:"buffer"},
             splitc: {value:"0", required:true},
+            newline: {value:""},
             tls: {type:"tls-config", value:'', required:false}
         },
         inputs:1,
@@ -319,6 +323,14 @@
                 $("#node-input-ret").val("buffer");
                 this.ret = "buffer";
             }
+            $("#node-input-ret").on("change", function() {
+                if ($("#node-input-ret").val() === "string" && $("#node-input-out").val() === "sit") { $("#node-row-newline").show(); }
+                else { $("#node-row-newline").hide(); }
+            });
+            $("#node-input-out").on("change", function() {
+                if ($("#node-input-ret").val() === "string" && $("#node-input-out").val() === "sit") { $("#node-row-newline").show(); }
+                else { $("#node-row-newline").hide(); }
+            });
             $("#node-input-out").on('focus', function () { previous = this.value; }).on("change", function() {
                 $("#node-input-splitc").show();
                 if (previous === null) { previous = $("#node-input-out").val(); }
diff --git a/packages/node_modules/@node-red/nodes/core/network/31-tcpin.js b/packages/node_modules/@node-red/nodes/core/network/31-tcpin.js
index e77600ed8..c4e6fcafc 100644
--- a/packages/node_modules/@node-red/nodes/core/network/31-tcpin.js
+++ b/packages/node_modules/@node-red/nodes/core/network/31-tcpin.js
@@ -229,7 +229,7 @@ module.exports = function(RED) {
                             buffer = buffer+data;
                             var parts = buffer.split(node.newline);
                             for (var i = 0; i<parts.length-1; i+=1) {
-                                msg = {topic:node.topic, payload:parts[i], ip:socket.remoteAddress, port:socket.remotePort};
+                                msg = {topic:node.topic, payload:parts[i] + node.newline.trimEnd(), ip:socket.remoteAddress, port:socket.remotePort};
                                 msg._session = {type:"tcp",id:id};
                                 node.send(msg);
                             }
@@ -575,7 +575,7 @@ module.exports = function(RED) {
                 }
                 else { buf = Buffer.alloc(65536); } // set it to 64k... hopefully big enough for most TCP packets.... but only hopefully
 
-                var connOpts = {host: host, port: port};
+                var connOpts = {host:host, port:port};
                 if (n.tls) {
                     connOpts = tlsNode.addTLSOptions(connOpts);
                     const allowUnauthorized = getAllowUnauthorized();
@@ -588,8 +588,7 @@ module.exports = function(RED) {
                         ...connOpts
                     };
 
-                    if (!options.keepAlive)
-                    options.singleUse = true;
+                    if (!options.keepAlive) { options.singleUse = true; }
 
                     const context = options.secureContext || tls.createSecureContext(options);
 
@@ -640,17 +639,32 @@ module.exports = function(RED) {
                 else {
                     node.warn(RED._("tcpin.errors.no-host"));
                 }
-
+                var chunk = "";
                 clients[connection_id].client.on('data', function(data) {
                     if (node.out === "sit") { // if we are staying connected just send the buffer
                         if (clients[connection_id]) {
                             const msg = clients[connection_id].lastMsg || {};
                             msg.payload = RED.util.cloneMessage(data);
                             if (node.ret === "string") {
-                                try { msg.payload = msg.payload.toString(); }
-                                catch(e) { node.error("Failed to create string", msg); }
+                                try {
+                                    if (node.newline && node.newline !== "" ) {
+                                        chunk += msg.payload.toString();
+                                        let parts = chunk.split(node.newline);
+                                        for (var i=0; i<parts.length-1; i+=1) {
+                                            let m = RED.util.cloneMessage(msg);
+                                            m.payload = parts[i] + node.newline.trimEnd();
+                                            nodeSend(m);
+                                        }
+                                        chunk = parts[parts.length-1];
+                                    }
+                                    else {
+                                        msg.payload = msg.payload.toString();
+                                        nodeSend(msg);
+                                    }
+                                }
+                                catch(e) { node.error(RED._("tcpin.errors.bad-string"), msg); }
                             }
-                            nodeSend(msg);
+                            else { nodeSend(msg); }
                         }
                     }
                     // else if (node.splitc === 0) {
diff --git a/packages/node_modules/@node-red/nodes/locales/en-US/messages.json b/packages/node_modules/@node-red/nodes/locales/en-US/messages.json
index cda9c71eb..8d159038b 100755
--- a/packages/node_modules/@node-red/nodes/locales/en-US/messages.json
+++ b/packages/node_modules/@node-red/nodes/locales/en-US/messages.json
@@ -579,7 +579,9 @@
             "server": "Server",
             "return": "Return",
             "ms": "ms",
-            "chars": "chars"
+            "chars": "chars",
+            "close": "Close",
+            "optional": "(optional)"
         },
         "type": {
             "listen": "Listen on",
@@ -596,7 +598,7 @@
         "return": {
             "timeout": "after a fixed timeout of",
             "character": "when character received is",
-            "number": "a fixed number of chars",
+            "number": "after a fixed number of characters",
             "never": "never - keep connection open",
             "immed": "immediately - don't wait for reply"
         },
@@ -616,11 +618,11 @@
             "timeout": "timeout closed socket port __port__",
             "cannot-listen": "unable to listen on port __port__, error: __error__",
             "error": "error: __error__",
-
             "socket-error": "socket error from __host__:__port__",
             "no-host": "Host and/or port not set",
             "connect-timeout": "connect timeout",
-            "connect-fail": "connect failed"
+            "connect-fail": "connect failed",
+            "bad-string": "failed to convert to string"
         }
     },
     "udp": {