Merge pull request #69 from kazuhitoyokoi/master-updatefunctionnodetemplate3

HiroyasuNishiyama · web-flow · commit 57dc4b5f77c1 · 2018-06-14T19:20:01.000+09:00
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -76,6 +76,15 @@ module.exports = function (grunt) {
             generateNode_handleSetTimeout: {
                 command: 'node bin/node-red-nodegen.js samples/handle-setTimeout.js -o ./nodegen'
             },
+            generateNode_useTheSameDateObjectFromOutsideTheSandbox: {
+                command: 'node bin/node-red-nodegen.js samples/use-the-same-Date-object-from-outside-the-sandbox.js -o ./nodegen'
+            },
+            generateNode_logADebugMessage: {
+                command: 'node bin/node-red-nodegen.js samples/log-a-Debug-Message.js -o ./nodegen'
+            },
+            generateNode_logATraceMessage: {
+                command: 'node bin/node-red-nodegen.js samples/log-a-Trace-Message.js -o ./nodegen'
+            },
             generateNode_logAWarningMessage: {
                 command: 'node bin/node-red-nodegen.js samples/log-a-Warning-Message.js -o ./nodegen'
             },
diff --git a/samples/log-a-Debug-Message.js b/samples/log-a-Debug-Message.js
@@ -0,0 +1,3 @@
+// name: log a Debug Message
+// outputs: 1
+node.debug('test');
diff --git a/samples/log-a-Trace-Message.js b/samples/log-a-Trace-Message.js
@@ -0,0 +1,3 @@
+// name: log a Trace Message
+// outputs: 1
+node.trace('test');
diff --git a/samples/use-the-same-Date-object-from-outside-the-sandbox.js b/samples/use-the-same-Date-object-from-outside-the-sandbox.js
@@ -0,0 +1,4 @@
+// name: use the same Date object from outside the sandbox
+// outputs: 1
+msg.payload=global.get('typeTest')(new Date());
+return msg;
diff --git a/templates/function/node.js.mustache b/templates/function/node.js.mustache
@@ -65,6 +65,8 @@ module.exports = function(RED) {
                                  "log:__node__.log,"+
                                  "error:__node__.error,"+
                                  "warn:__node__.warn,"+
+                                 "debug:__node__.debug,"+
+                                 "trace:__node__.trace,"+
                                  "on:__node__.on,"+
                                  "status:__node__.status,"+
                                  "send:function(msgs){ __node__.send(__msgid__,msgs);}"+
@@ -78,6 +80,7 @@ module.exports = function(RED) {
             console:console,
             util:util,
             Buffer:Buffer,
+            Date: Date,
             RED: {
                 util: RED.util
             },
@@ -91,6 +94,12 @@ module.exports = function(RED) {
                 warn: function() {
                     node.warn.apply(node, arguments);
                 },
+                debug: function() {
+                    node.debug.apply(node, arguments);
+                },
+                trace: function() {
+                    node.trace.apply(node, arguments);
+                },
                 send: function(id, msgs) {
                     sendResults(node, id, msgs);
                 },
@@ -196,7 +205,14 @@ module.exports = function(RED) {
         }
         var context = vm.createContext(sandbox);
         try {
-            this.script = vm.createScript(functionText);
+            this.script = vm.createScript(functionText, {
+                filename: 'Function node:'+this.id+(this.name?' ['+this.name+']':''), // filename for stack traces
+                displayErrors: true
+                // Using the following options causes node 4/6 to not include the line number
+                // in the stack output. So don't use them.
+                // lineOffset: -11, // line number offset to be used for stack traces
+                // columnOffset: 0, // column number offset to be used for stack traces
+            });
             this.on("input", function(msg) {
                 try {
                     var start = process.hrtime();
@@ -211,6 +227,13 @@ module.exports = function(RED) {
                         this.status({fill:"yellow",shape:"dot",text:""+converted});
                     }
                 } catch(err) {
+                    //remove unwanted part
+                    var index = err.stack.search(/\n\s*at ContextifyScript.Script.runInContext/);
+                    err.stack = err.stack.slice(0, index).split('\n').slice(0,-1).join('\n');
+                    var stack = err.stack.split(/\r?\n/);
+
+                    //store the error in msg to be used in flows
+                    msg.error = err;
 
                     var line = 0;
                     var errorMessage;
diff --git a/test/nodegen/node-red-contrib-log-a-debug-message/node_spec.js b/test/nodegen/node-red-contrib-log-a-debug-message/node_spec.js
@@ -0,0 +1,66 @@
+/**
+ * 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.
+ **/
+
+var should = require("should");
+var helper = require("node-red-node-test-helper");
+var functionNode = require("../../../nodegen/node-red-contrib-log-a-debug-message");
+
+describe('node-red-contrib-log-a-debug-message', function () {
+
+    before(function (done) {
+        helper.startServer(done);
+    });
+
+    after(function(done) {
+        helper.stopServer(done);
+    });
+
+    afterEach(function () {
+        helper.unload();
+    });
+
+    it('should be loaded', function (done) {
+        var flow = [{id: "n1", type: "log-a-debug-message", name: "log-a-debug-message" }];
+        helper.load(functionNode, flow, function () {
+            var n1 = helper.getNode('n1');
+            n1.should.have.property('name', 'log-a-debug-message');
+            done();
+        });
+    });
+    it('should log a Debug Message', function (done) {
+        var flow = [{id: "n1", type: "log-a-debug-message", wires: [["n2"]]},
+                    {id: "n2", type: "helper"}];
+        helper.load(functionNode, flow, function () {
+            var n1 = helper.getNode("n1");
+            n1.receive({payload: "foo", topic: "bar"});
+            try {
+                helper.log().called.should.be.true();
+                var logEvents = helper.log().args.filter(function (evt) {
+                    return evt[0].type == "log-a-debug-message";
+                });
+                logEvents.should.have.length(1);
+                var msg = logEvents[0][0];
+                msg.should.have.property('level', helper.log().DEBUG);
+                msg.should.have.property('id', 'n1');
+                msg.should.have.property('type', 'log-a-debug-message');
+                msg.should.have.property('msg', 'test');
+                done();
+            } catch (err) {
+                done(err);
+            }
+        });
+    });
+});
diff --git a/test/nodegen/node-red-contrib-log-a-trace-message/node_spec.js b/test/nodegen/node-red-contrib-log-a-trace-message/node_spec.js
@@ -0,0 +1,66 @@
+/**
+ * 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.
+ **/
+
+var should = require("should");
+var helper = require("node-red-node-test-helper");
+var functionNode = require("../../../nodegen/node-red-contrib-log-a-trace-message");
+
+describe('node-red-contrib-log-a-trace-message', function () {
+
+    before(function (done) {
+        helper.startServer(done);
+    });
+
+    after(function(done) {
+        helper.stopServer(done);
+    });
+
+    afterEach(function () {
+        helper.unload();
+    });
+
+    it('should be loaded', function (done) {
+        var flow = [{id: "n1", type: "log-a-trace-message", name: "log-a-trace-message" }];
+        helper.load(functionNode, flow, function () {
+            var n1 = helper.getNode('n1');
+            n1.should.have.property('name', 'log-a-trace-message');
+            done();
+        });
+    });
+    it('should log a Trace Message', function (done) {
+        var flow = [{id: "n1", type: "log-a-trace-message", wires: [["n2"]]},
+                    {id: "n2", type: "helper"}];
+        helper.load(functionNode, flow, function () {
+            var n1 = helper.getNode("n1");
+            n1.receive({payload: "foo", topic: "bar"});
+            try {
+                helper.log().called.should.be.true();
+                var logEvents = helper.log().args.filter(function (evt) {
+                    return evt[0].type == "log-a-trace-message";
+                });
+                logEvents.should.have.length(1);
+                var msg = logEvents[0][0];
+                msg.should.have.property('level', helper.log().TRACE);
+                msg.should.have.property('id', 'n1');
+                msg.should.have.property('type', 'log-a-trace-message');
+                msg.should.have.property('msg', 'test');
+                done();
+            } catch (err) {
+                done(err);
+            }
+        });
+    });
+});
diff --git a/test/nodegen/node-red-contrib-use-the-same-date-object-from-outside-the-sandbox/node_spec.js b/test/nodegen/node-red-contrib-use-the-same-date-object-from-outside-the-sandbox/node_spec.js
@@ -0,0 +1,57 @@
+/**
+ * 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.
+ **/
+
+var should = require("should");
+var helper = require("node-red-node-test-helper");
+var functionNode = require("../../../nodegen/node-red-contrib-use-the-same-date-object-from-outside-the-sandbox");
+
+describe('use-the-same-date-object-from-outside-the-sandbox', function () {
+
+    before(function (done) {
+        helper.startServer(done);
+    });
+
+    after(function (done) {
+        helper.stopServer(done);
+    });
+
+    afterEach(function () {
+        helper.unload();
+    });
+
+    it('should be loaded', function (done) {
+        var flow = [{id: "n1", type: "use-the-same-date-object-from-outside-the-sandbox", name: "use-the-same-date-object-from-outside-the-sandbox" }];
+        helper.load(functionNode, flow, function () {
+            var n1 = helper.getNode('n1');
+            n1.should.have.property('name', 'use-the-same-date-object-from-outside-the-sandbox');
+            done();
+        });
+    });
+    it('should use the same Date object from outside the sandbox', function (done) {
+        var flow = [{id: "n1", type: "use-the-same-date-object-from-outside-the-sandbox", wires: [["n2"]]},
+                    {id: "n2", type: "helper"}];
+        helper.load(functionNode, flow, function () {
+            var n1 = helper.getNode("n1");
+            var n2 = helper.getNode("n2");
+            n1.context().global.set("typeTest", function (d) { return d instanceof Date });
+            n2.on("input", function (msg) {
+                msg.should.have.property('payload', true);
+                done();
+            });
+            n1.receive({payload: "foo", topic: "bar"});
+        });
+    });
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+// name: log a Debug Message`
	`2`	`+// outputs: 1`
	`3`	`+node.debug('test');`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+// name: log a Trace Message`
	`2`	`+// outputs: 1`
	`3`	`+node.trace('test');`