From 426444b0425bf6cba9323a11097881cbf5ea9f44 Mon Sep 17 00:00:00 2001
From: Dave C-J <dave@conway-jones.co.uk>
Date: Thu, 17 Oct 2013 22:45:17 +0100
Subject: [PATCH] Tweaks to timer node - limit delays/rate to +ve numbers...
 add bit more info, slight tidy up.

---
 nodes/core/89-delay.html |  49 ++++++++++++++++++---------------------
 nodes/core/89-delay.js   |  23 +++++++-----------
 public/icons/timer.png   | Bin 0 -> 1319 bytes
 3 files changed, 30 insertions(+), 42 deletions(-)
 create mode 100644 public/icons/timer.png

diff --git a/nodes/core/89-delay.html b/nodes/core/89-delay.html
index 39f28a6a9..60e73df4c 100644
--- a/nodes/core/89-delay.html
+++ b/nodes/core/89-delay.html
@@ -14,14 +14,12 @@
   limitations under the License.
 -->
 
-<!-- First, the content of the edit dialog is defined.                       -->
 <script type="text/x-red" data-template-name="delay">
-
     <div class="form-row">
         <label for="node-input-pauseType"><i class="icon-tasks"></i> Action</label>
         <select id="node-input-pauseType" style="width:270px !important">
           <option value="delay">Delay message</option>
-          <option value="rate">Limit rate to</option>
+          <option value="rate">Limit message rate</option>
         </select>
     </div>
     <div id="delay-details" class="form-row">
@@ -35,11 +33,10 @@
           <option value="days">Days</option>
         </select>
     </div>
-    
     <div id="rate-details" class="form-row">
         <label for="node-input-rate"><i class="icon-time"></i> To</label>
-        <input type="text" id="node-input-rate" placeholder="1" style="direction:rtl; width:50px !important">
-        <label for="node-input-reateUnits">message(s) per</label>
+        <input type="text" id="node-input-rate" placeholder="1" style="direction:rtl; width:40px !important">
+        <label for="node-input-rateUnits" style="width:120px !important">message(s) per</label>
         <select id="node-input-rateUnits" style="width:140px !important">
           <option value="second">Second</option>
           <option value="minute">Minute</option>
@@ -47,37 +44,35 @@
           <option value="day">Day</option>
         </select>
     </div>
-    
     <div class="form-row">
         <label for="node-input-name"><i class="icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
-    
 </script>
 
-<!-- Next, some simple help text is provided for the node.                   -->
+
 <script type="text/x-red" data-help-name="delay">
-    <p>Introduces a delay into a flow or rate limts messges</p>
-    <p>Default delay is 5 seconds and rate limit of 1 msg/second, but both can be configured</p>
+    <p>Introduces a delay into a flow or rate limits messages</p>
+    <p>Default delay is 5 seconds or rate limit of 1 message/second, but both can be configured</p>
+    <p>The rate limiter will delay messages by buffering in a time released queue. A warning is generated if the buffer is larger than 1000 items.</p>
 </script>
 
-<!-- Finally, the node type is registered along with all of its properties   -->
 <script type="text/javascript">
     RED.nodes.registerType('delay',{
-        category: 'function',      // the palette category
+        category: 'function',
         color:"#E6E0F8",
-        defaults: {             // defines the editable properties of the node
-            name: {value:""},   //  along with default values.
+        defaults: {
+            name: {value:""},
             pauseType: {value:"delay", required:true},
             timeout: {value:"5", required:true, validate:RED.validators.number()},
             timeoutUnits: {value:"seconds"},
             rate: {value:"1", required:true, validate:RED.validators.number()},
             rateUnits: {value: "second"}
         },
-        inputs:1,                // set the number of inputs - only 0 or 1
-        outputs:1,               // set the number of outputs - 0 to n
-        icon: "arrow-in.png",    // set the icon (held in public/icons)
-        label: function() {      // sets the default label contents
+        inputs:1,
+        outputs:1,
+        icon: "timer.png",
+        label: function() {
             if (this.pauseType == "delay") {
               var units = this.timeoutUnits ? this.timeoutUnits.charAt(0) : "s";
               return this.name||"delay "+this.timeout+" " + units;
@@ -85,15 +80,15 @@
               var units = this.rateUnits ? this.rateUnits.charAt(0) : "s";
               return this.name||"limit "+this.rate+" msg/"+ units;
             }
-            return "foo";
+            return "";
         },
-        labelStyle: function() { // sets the class to apply to the label
+        labelStyle: function() {
             return this.name?"node_label_italic":"";
         },
         oneditprepare: function() {
-          $( "#node-input-timeout" ).spinner();
-          $( "#node-input-rate" ).spinner();
-        
+          $( "#node-input-timeout" ).spinner({ min:1, max:60 });
+          $( "#node-input-rate" ).spinner({ min:1});
+
           if (this.pauseType == "delay") {
             $("#delay-details").show();
             $("#rate-details").hide();
@@ -101,13 +96,13 @@
             $("#delay-details").hide();
             $("#rate-details").show();
           }
-          
+
           if (!this.timeoutUnits) {
             $("#node-input-timeoutUnits option").filter(function() {
-              return $(this).val() == 'seconds'; 
+              return $(this).val() == 'seconds';
             }).attr('selected', true);
           }
-          
+
           $("#node-input-pauseType").on("change",function() {
             if (this.value == "delay") {
               $("#delay-details").show();
diff --git a/nodes/core/89-delay.js b/nodes/core/89-delay.js
index ed6ebe947..986f1fcc3 100644
--- a/nodes/core/89-delay.js
+++ b/nodes/core/89-delay.js
@@ -13,20 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  **/
- 
+
 // Simple node to introduce a pause into a flow
 
-// Require main module
 var RED = require("../../red/red");
 
-// main node definition
 function DelayNode(n) {
    RED.nodes.createNode(this,n);
-   
+
    this.pauseType = n.pauseType;
    this.timeoutUnits = n.timeoutUnits;
    this.rateUnits = n.rateUnits;
-   
+
    if (n.timeoutUnits == "milliseconds") {
      this.timeout = n.timout;
    } else if (n.timeoutUnits == "seconds") {
@@ -38,7 +36,7 @@ function DelayNode(n) {
    } else if (n.timeoutUnits == "days") {
      this.timeout = n.timeout * (24 * 60 * 60 * 1000);
    }
-   
+
    if (n.rateUnits == "second") {
      this.rate = 1000/n.rate;
    } else if (n.rateUnits == "minute") {
@@ -48,13 +46,13 @@ function DelayNode(n) {
    } else if (n.rateUnits == "day") {
      this.rate = (24 * 60 * 60 * 1000)/n.rate;
    }
-   
+
    this.name = n.name;
    this.idList = [];
    this.buffer = [];
    this.intervalID = -1;
    var node= this;
-   
+
    if (this.pauseType == "delay") {
       this.on("input", function(msg) {
         var node= this;
@@ -73,7 +71,7 @@ function DelayNode(n) {
        this.idList = [];
      });
    } else if (this.pauseType == "rate") {
-   
+
      this.on("input", function(msg) {
        if ( node.intervalID != -1) {
          node.buffer.push(msg);
@@ -87,7 +85,7 @@ function DelayNode(n) {
              clearInterval(node.intervalID);
              node.intervalID = -1;
            }
-     
+
            if (node.buffer.length > 0) {
              node.send(node.buffer.shift());
            }
@@ -101,9 +99,4 @@ function DelayNode(n) {
      });
    }
 }
-
-
-
-// register node
 RED.nodes.registerType("delay",DelayNode);
-
diff --git a/public/icons/timer.png b/public/icons/timer.png
new file mode 100644
index 0000000000000000000000000000000000000000..507d76d4d4ed030303bfedc7b6ab057528ca823f
GIT binary patch
literal 1319
zcmV+?1=#wDP)<h;3K|Lk000e1NJLTq001KZ001%w1^@s6)>C3<00001b5ch_0Itp)
z=>Px#24YJ`L;wH)0002_L%V+f000SaNLh0L01FcU01FcV0GgZ_000EKNkl<ZSi|j@
zTZola6vu!2n;Az<(=-*E(x9@mm<Z7lEzlqfB#O`;x*PQpBw_SWFZC4lR4+!572S{?
zg0hE9u!y2a6EBHkw;}B^nnmhljx+vxnDq_2&vVWk2PBADu=&nj`>efgd++t%8%Ah^
zM(F=YYB7wK)K+zt`hf$qLA^|EiSblNuI{`^Er#O*Fb;ShxDMzAMggA#OM#<60?q+C
zfWyFkpg;IcMJ82RqsUCOHcgB1@#^!z+oe9JPRn$jqJwG(Gb39X7*s0j4rM3fdsv+u
z;~na@ilOhQ3o1cKHI0csU9EP+??$;Ft=_NpgrZ~NeS3_LQCF+I6@zxG%PS5iHPtd^
zvbssVFZ!)D3@ZDh)hpB+)XwPVDHx+J%_4LnzWdb`)n!sMP3kiBSM_zZy-uFXZ)>z#
z>mY^qlhn5>QQBQi88sGd8KE^Hv^~5}H6qh!!KXapG3RUQ-&us#tLF^{qJ}`}O`G~f
z2z9G>s-r7WI-PT=C1lrS#;86Vx{7j5j8_+{b0g1XbS_f&g;1~hj5@u^?SG0vG3P{e
zOJ>Y>>LqFm>L~Rt^{D!TdSk`&TVkh_^qxAeiS6I0U9bL?&ACc#Cw9R0Y~ab@m7ce$
zPgS<(R`s4?mXz|0dNrGGuR4}koH?zioH0qA61i6Gi|?UGTRKgH%KzV*9hR!|P#?({
zJJinVffxNwb!Wx!KJ{I7$`FTSEo0`WUuAPWUI5o*rD_lGbJkA-a;B8h4&Z6v7oac3
z3*cs8qk0w40<=aUtw-g~-3RQ-_zMc)+KkbaQu;05>ZP#Sl2UpLcq6Lsps~P}z=yz+
z=1_}8O6f>c@{;Bk!1T<MKPuMe2Au>*DLn?P&!9y4Jr{TpIBN)FQYLpO<4-MOpj6)5
zXp-!NehAo>$(0H&1jaUjg-W@eOs7R93ZrV|w(3<%DIEY-0^OM*3HUJ-G)tp_wsP(Q
z_&pn(Pzis%q$gk}aCaC`8u9>etVyIuq_%YWU@P!x><EAv>ZDjZHiU=+V;{%jZ4V=k
z4dqDY(AmKG8Eb0+e3mih039hMn^=T>zzN__-~ezWc>O~-LCoI~`bzqw05)cfPGDA(
z`A!X5Gju61H|u{?#6h<!Q?Oi}aE7l(<A7yxXaal>>?|U*F9h=>a2qf`{^%L9XC81z
zHvbx+w=8fMtKVdGVtXtwh6xesRqLdlt!~bAb*Zy+q}LXhqNILxT?0Tq979T^x3*Gj
zR|lpl$f{^ZVA2xB_o!<taCF!ai8-DNpw^pRiDwR;U4zJcfUzi0yV+gnO?5&Rp`k!{
zwY5ZQURIA+0M+8^?VzX_bi4Xf1xRgHm#E`wL@G774U7x9FDvtPtM?9dZ)(X5+EdAG
zkNQd=wAuBxe?(zUVCR=A_*wN^b!9CKo!_s`3Sqyx5O@N(sYYGd0_+Yvau7HkplT{G
zBTm-2l_CnT0eCj0v?(0-U*mOhUZ(7V*kyZdOuexK>rq$0+nLS2LY(?4Fd*0#_nK9e
z#oY{bsgK4ZQrl3#z1Cw<9#*q@Q{vmp170oy7RG~6NeAM=Xfv=0_&UJTiR`pZjL-;;
d&<OoU^bZc_S3r5~&UXL+002ovPDHLkV1k-)WfuSd

literal 0
HcmV?d00001