From dd293da6fbc61357ac81785bb035c7f58b1909de Mon Sep 17 00:00:00 2001
From: Ben Hardill <b.hardill@gmail.com>
Date: Tue, 1 Oct 2013 12:42:31 +0100
Subject: [PATCH] Fix some scope issues in delay node and add rate limiting
 node

---
 nodes/core/89-delay.js                     | 15 +++++-----
 nodes/core/{89-pause.html => 89-rate.html} | 18 ++++++------
 nodes/core/{89-pause.js => 89-rate.js}     | 34 ++++++++++++----------
 3 files changed, 35 insertions(+), 32 deletions(-)
 rename nodes/core/{89-pause.html => 89-rate.html} (82%)
 rename nodes/core/{89-pause.js => 89-rate.js} (65%)

diff --git a/nodes/core/89-delay.js b/nodes/core/89-delay.js
index 3a534c6c0..1a3bfbd43 100644
--- a/nodes/core/89-delay.js
+++ b/nodes/core/89-delay.js
@@ -18,31 +18,32 @@
 
 // Require main module
 var RED = require("../../red/red");
-var idList = [];
 
 // main node definition
 function DelayNode(n) {
    RED.nodes.createNode(this,n);
    
    this.timeout = n.timeout * 1000;
-   this.name = n.name
+   this.name = n.name;
+   this.idList = [];
    
    this.on("input", function(msg) {
        var node= this;
        var id;
        id = setTimeout(function(){
-              idList.splice(idList.indexOf(id),1);
+              node.idList.splice(node.idList.indexOf(id),1);
               node.send(msg);
             }, node.timeout);
-       idList.push(id);
+       this.idList.push(id);
    });
 }
 
 // register node
-RED.nodes.registerType("pause",DelayNode);
+RED.nodes.registerType("delay",DelayNode);
 
 DelayNode.prototype.close = function() {
-   for (var i=0; i<idList.length; i++ ) {
-       clearTimeout(idList[i]);
+   for (var i=0; i<this.idList.length; i++ ) {
+       clearTimeout(this.idList[i]);
    }
+   this.idList = [];
 }
diff --git a/nodes/core/89-pause.html b/nodes/core/89-rate.html
similarity index 82%
rename from nodes/core/89-pause.html
rename to nodes/core/89-rate.html
index 208b85f5e..4d50134d0 100644
--- a/nodes/core/89-pause.html
+++ b/nodes/core/89-rate.html
@@ -15,10 +15,10 @@
 -->
 
 <!-- First, the content of the edit dialog is defined.                       -->
-<script type="text/x-red" data-template-name="pause">
+<script type="text/x-red" data-template-name="rateLimit">
     <div class="form-row">
-        <label for="node-input-topic"><i class="icon-tasks"></i> Pause</label>
-        <input type="text" id="node-input-timeout" placeholder="Time">
+        <label for="node-input-topic"><i class="icon-tasks"></i> Rate</label>
+        <input type="text" id="node-input-timeout" placeholder="msg/second">
     </div>
     
     <div class="form-row">
@@ -28,25 +28,25 @@
 </script>
 
 <!-- Next, some simple help text is provided for the node.                   -->
-<script type="text/x-red" data-help-name="pause">
-    <p>Introduces a pause into a flow</p>
-    <p>Default pause is 5 seconds but can be configured</p>
+<script type="text/x-red" data-help-name="rateLimit">
+    <p>Rate limts msgs</p>
+    <p>Default is 1 msg per seconds but can be configured</p>
 </script>
 
 <!-- Finally, the node type is registered along with all of its properties   -->
 <script type="text/javascript">
-    RED.nodes.registerType('pause',{
+    RED.nodes.registerType('rateLimit',{
         category: 'function',      // the palette category
         color:"#E6E0F8",
         defaults: {             // defines the editable properties of the node
             name: {value:""},   //  along with default values.
-            timeout: {value:"5", required:true, validate:RED.validators.number()}
+            rate: {value:"1", required:true, validate:RED.validators.number()}
         },
         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
-            return this.name||"pause "+this.timeout+" s";
+            return this.name||this.topic||"limit "+this.rate+" msg/s";
         },
         labelStyle: function() { // sets the class to apply to the label
             return this.name?"node_label_italic":"";
diff --git a/nodes/core/89-pause.js b/nodes/core/89-rate.js
similarity index 65%
rename from nodes/core/89-pause.js
rename to nodes/core/89-rate.js
index ff1923e07..b11a4342d 100644
--- a/nodes/core/89-pause.js
+++ b/nodes/core/89-rate.js
@@ -18,31 +18,33 @@
 
 // Require main module
 var RED = require("../../red/red");
-var idList = [];
+
 
 // main node definition
-function PauseNode(n) {
+function RateLimitNode(n) {
    RED.nodes.createNode(this,n);
-   
-   this.timeout = n.timeout * 1000;
+   this.buffer = [];
+   this.timeout = 1000/n.rate;
    this.name = n.name
    
+   var node= this
+   
+   this.intervalID = setInterval(function() {
+      if (node.buffer.length > 0) {
+         node.send(node.buffer.shift());
+      }
+   },this.timeout);
+   
    this.on("input", function(msg) {
-       var node= this;
-       var id;
-       id = setTimeout(function(){
-              idList.splice(idList.indexOf(id),1);
-              node.send(msg);
-            }, node.timeout);
-       idList.push(id);
+       this.buffer.push(msg);
    });
 }
 
 // register node
-RED.nodes.registerType("pause",PauseNode);
+RED.nodes.registerType("rateLimit",RateLimitNode);
 
-PauseNode.prototype.close = function() {
-   for (var i=0; i<idList.length; i++ ) {
-       clearTimeout(idList[i]);
-   }
+RateLimitNode.prototype.close = function() {
+   clearInterval(this.intervalID);
+   this.buffer = [];
 }
+