frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2025-03-01 10:36:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add support of subflow env var

Browse Source
This commit is contained in:
Hiroyasu Nishiyama
2019-01-26 23:15:20 +09:00
parent 4baaaa8d59
commit a413f3cded
13 changed files with 835 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
packages/node_modules/@node-red/editor-client/locales/en-US/editor.json vendored
View File

@@ -901,6 +901,7 @@
"editor-tab": {
"properties": "Properties",
"description": "Description",
"appearance": "Appearance"
"appearance": "Appearance",
"env": "Env Var"
}
}

3
packages/node_modules/@node-red/editor-client/locales/ja/editor.json vendored
View File

@@ -901,6 +901,7 @@
"editor-tab": {
"properties": "プロパティ",
"description": "説明",
"appearance": "外観"
"appearance": "外観",
"env": "環境変数"
}
}

7
packages/node_modules/@node-red/editor-client/src/js/nodes.js vendored
View File

@@ -358,7 +358,10 @@ RED.nodes = (function() {
}
subflows[sf.id] = sf;
RED.nodes.registerType("subflow:"+sf.id, {
defaults:{name:{value:""}},
defaults:{
name:{value:""},
env:{value:[]}
},
icon: function() { return sf.icon||"subflow.png" },
category: sf.category || "subflows",
inputs: sf.in.length,
@@ -535,6 +538,7 @@ RED.nodes = (function() {
node.category = n.category;
node.in = [];
node.out = [];
node.env = n.env;
n.in.forEach(function(p) {
var nIn = {x:p.x,y:p.y,wires:[]};
@@ -1018,6 +1022,7 @@ RED.nodes = (function() {
node.name = n.name;
node.outputs = subflow.out.length;
node.inputs = subflow.in.length;
node.env = n.env;
} else {
if (!node._def) {
if (node.x && node.y) {

135
packages/node_modules/@node-red/editor-client/src/js/ui/editor.js vendored
View File

@@ -540,7 +540,113 @@ RED.editor = (function() {
return label;
}
function buildEditForm(container,formId,type,ns) {
function buildEnvForm(container, node) {
var env_container = $('#node-input-env-container');
env_container
.css('min-height','250px').css('min-width','450px')
.editableList({
addItem: function(container, i, opt) {
var row = $('<div/>').appendTo(container);
var nameField = $('<input/>', {
class: "node-input-env-name",
type: "text",
style: "margin-length: 5px; width: 32%;"
}).appendTo(row);
var valueField = $('<input/>',{
class: "node-input-env-value",
type: "text",
style: "margin-left: 5px; width: 65%;"
}).appendTo(row)
valueField.typedInput({default:'str',
types:['str','num','bool','json','bin','re','date']
});
if (opt) {
nameField.val(opt.name);
valueField.typedInput('type', opt.type);
valueField.typedInput('value', opt.value);
}
},
sortable: true,
removable: true
});
var envs = node.env;
if (envs) {
for (var i = 0; i < envs.length; i++) {
var env = envs[i];
env_container.editableList('addItem', env);
}
}
}
function convEnv(editable_list) {
if (editable_list) {
var env = [];
editable_list.each(function(i) {
var entry = $(this);
var nf = entry.find(".node-input-env-name");
var vf = entry.find(".node-input-env-value");
var name = nf.val();
var value = vf.typedInput("value");
var type = vf.typedInput("type");
var info = {
name: name,
label: "",
value: value,
type: type,
target_type: "env var",
target: name
};
var item = {
name: name,
type: type,
value: value,
info: info
};
env.push(item);
});
return env;
}
return null;
}
function isSameEnv(env0, env1) {
function isSameInfo(info0, info1) {
if (info0 && info1 &&
(info0.name === info1.name) &&
(info0.label === info1.label) &&
(info0.value === info1.value) &&
(info0.type === info1.type) &&
(info0.target_type === info1.target_type) &&
(info0.target === info1.target)) {
return true;
}
return false;
}
function inEnv(env, item) {
for(var i = 0; i < env.length; i++) {
var item1 = env[i];
if ((item1.name !== item.name) ||
(item1.type !== item.type) ||
(item1.value !== item.value) ||
!isSameInfo(item1.info, item.info)) {
return false;
}
}
return true;
}
if (env0 && env1 && (env0.length === env1.length)) {
for (var i = 0; i < env0.length; i++) {
var item0 = env0[i];
if (!inEnv(env1, item0)) {
return false;
}
}
return true;
}
return false;
}
function buildEditForm(container,formId,type,ns,node) {
var dialogForm = $('<form id="'+formId+'" class="form-horizontal" autocomplete="off"></form>').appendTo(container);
dialogForm.html($("script[data-template-name='"+type+"']").html());
ns = ns||"node-red";
@@ -561,6 +667,11 @@ RED.editor = (function() {
}
$(this).attr("data-i18n",keys.join(";"));
});
if ((type === "subflow") || (type === "subflow-template")) {
buildEnvForm(dialogForm, node);
}
// Add dummy fields to prevent 'Enter' submitting the form in some
// cases, and also prevent browser auto-fill of password
// Add in reverse order as they are prepended...
@@ -1268,6 +1379,16 @@ RED.editor = (function() {
}
}
if (type === "subflow") {
var old_env = editing_node.env;
var new_env = convEnv($("#node-input-env-container").editableList("items"));
if (!isSameEnv(old_env, new_env)) {
editing_node.env = new_env;
changes.env = editing_node.env;
changed = true;
}
}
if (changed) {
var wasChanged = editing_node.changed;
editing_node.changed = true;
@@ -1373,7 +1494,7 @@ RED.editor = (function() {
content: $('<div>', {class:"editor-tray-content"}).appendTo(editorContent).hide(),
iconClass: "fa fa-cog"
};
buildEditForm(nodePropertiesTab.content,"dialog-form",type,ns);
buildEditForm(nodePropertiesTab.content,"dialog-form",type,ns,node);
editorTabs.addTab(nodePropertiesTab);
if (!node._def.defaults || !node._def.defaults.hasOwnProperty('info')) {
@@ -1986,6 +2107,14 @@ RED.editor = (function() {
changed = true;
}
var old_env = editing_node.env;
var new_env = convEnv($("#node-input-env-container").editableList("items"));
if (!isSameEnv(old_env, new_env)) {
editing_node.env = new_env;
changes.env = editing_node.env;
changed = true;
}
RED.palette.refresh();
if (changed) {
@@ -2063,7 +2192,7 @@ RED.editor = (function() {
content: $('<div>', {class:"editor-tray-content"}).appendTo(editorContent).hide(),
iconClass: "fa fa-cog"
};
buildEditForm(nodePropertiesTab.content,"dialog-form","subflow-template");
buildEditForm(nodePropertiesTab.content,"dialog-form","subflow-template", undefined, editing_node);
editorTabs.addTab(nodePropertiesTab);
var descriptionTab = {

8
packages/node_modules/@node-red/editor-client/src/js/ui/subflow.js vendored
View File

@@ -17,10 +17,16 @@
RED.subflow = (function() {
var _subflowEditTemplate = '<script type="text/x-red" data-template-name="subflow"><div class="form-row"><label for="node-input-name" data-i18n="[append]editor:common.label.name"><i class="fa fa-tag"></i> </label><input type="text" id="node-input-name"></div></script>';
var _subflowEditTemplate = '<script type="text/x-red" data-template-name="subflow">'+
'<div class="form-row"><label for="node-input-name" data-i18n="[append]editor:common.label.name"><i class="fa fa-tag"></i> </label><input type="text" id="node-input-name"></div>'+
'<div class="form-row"><label data-i18n="[append]editor:editor-tab.env"><i class="fa fa-th-list"></i> </label></div>'+
'<div class="form-row node-input-env-container-row"><ol id="node-input-env-container"></ol></div>'+
'</script>';
var _subflowTemplateEditTemplate = '<script type="text/x-red" data-template-name="subflow-template">'+
'<div class="form-row"><i class="fa fa-tag"></i> <label for="subflow-input-name" data-i18n="common.label.name"></label><input type="text" id="subflow-input-name"></div>'+
'<div class="form-row"><i class="fa fa-folder-o"></i> <label for="subflow-input-category" data-i18n="editor:subflow.category"></label><select style="width: 250px;" id="subflow-input-category"></select><input style="display:none; margin-left: 10px; width:calc(100% - 250px)" type="text" id="subflow-input-custom-category"></div>'+
'<div class="form-row"><label data-i18n="[append]editor:editor-tab.env"><i class="fa fa-th-list"></i> </label></div>'+
'<div class="form-row node-input-env-container-row"><ol id="node-input-env-container"></ol></div>'+
'<div class="form-row form-tips" id="subflow-dialog-user-count"></div>'+
'</script>';

4
packages/node_modules/@node-red/nodes/core/core/80-function.js vendored
View File

@@ -158,9 +158,7 @@ module.exports = function(RED) {
},
env: {
get: function(envVar) {
// For now, just return the env var. This will eventually
// also return project settings and subflow instance properties
return process.env[envVar]
return node.getenv(envVar);
}
},
setTimeout: function () {

2
packages/node_modules/@node-red/nodes/core/logic/15-change.js vendored
View File

@@ -94,7 +94,7 @@ module.exports = function(RED) {
this.error(RED._("change.errors.invalid-expr",{error:e.message}));
}
} else if (rule.tot === 'env') {
rule.to = RED.util.evaluateNodeProperty(rule.to,'env');
rule.to = RED.util.evaluateNodeProperty(rule.to,'env',node);
}
}

19
packages/node_modules/@node-red/runtime/lib/nodes/Node.js vendored
View File

@@ -34,6 +34,9 @@ function Node(n) {
if (n._alias) {
this._alias = n._alias;
}
if (n.env) {
this.env = n.env;
}
if (n._flow) {
// Make this a non-enumerable property as it may cause
// circular references. Any existing code that tries to JSON serialise
@@ -236,6 +239,22 @@ Node.prototype.receive = function(msg) {
}
};
Node.prototype.getenv = function(name) {
var flow = this._flow;
if (flow) {
var val = flow.getSetting(name);
return val;
}
return undefined;
};
Node.prototype.setenv = function(name, val) {
var flow = this._flow;
if (flow) {
flow.setSetting(name, val);
}
};
function log_helper(self, level, msg) {
var o = {
level: level,

4
packages/node_modules/@node-red/runtime/lib/nodes/flows/Flow.js vendored
View File

@@ -461,6 +461,10 @@ class Flow {
}
console.log("==================")
}
getenv(name) {
return process.env[name];
}
}
/**

72
packages/node_modules/@node-red/runtime/lib/nodes/flows/Subflow.js vendored
View File

@@ -22,6 +22,35 @@ const flowUtil = require("./util");
var Log;
/**
* Convert env var definition of subflow template and instance to env var dic
* @param {Hash} env1 env var definition of template
* @param {Hash} env2 env var definition of instance
* @return {Hash} env var dic
*/
function env2Dic(env0, env1) {
var dic = {};
function add(env) {
for(var i = 0; i < env.length; i++) {
var item = env[i];
var name = item.name;
var info = Object.assign({}, item.info);
info.name = name;
dic[name] = item;
dic[name+"_type"] = { value: item.type };
dic[name+"_info"] = { value: info };
}
}
if (env0) {
add(env0);
}
if (env1) {
add(env1);
}
return dic;
}
/**
* This class represents a subflow - which is handled as a special type of Flow
*/
@@ -104,12 +133,14 @@ class Subflow extends Flow {
var self = this;
// Create a subflow node to accept inbound messages and route appropriately
var Node = require("../Node");
var env = env2Dic(this.subflowDef.env, this.subflowInstance.env);
var subflowInstanceConfig = {
id: this.subflowInstance.id,
type: this.subflowInstance.type,
z: this.subflowInstance.z,
name: this.subflowInstance.name,
wires: [],
env: env,
_flow: this
}
if (this.subflowDef.in) {
@@ -164,7 +195,7 @@ class Subflow extends Flow {
self.node._updateWires(subflowInstanceConfig.wires);
}
}
}
};
// Wire the subflow outputs
if (this.subflowDef.out) {
@@ -172,7 +203,7 @@ class Subflow extends Flow {
for (var i=0;i<this.subflowDef.out.length;i++) {
// i: the output index
// This is what this Output is wired to
wires = this.subflowDef.out[i].wires;
var wires = this.subflowDef.out[i].wires;
for (var j=0;j<wires.length;j++) {
if (wires[j].id === this.subflowDef.id) {
// A subflow input wired straight to a subflow output
@@ -192,6 +223,42 @@ class Subflow extends Flow {
super.start(diff);
}
/**
* Get environment variable of subflow
* @param {String} name name of env var
* @return {Object} val value of env var
*/
getSetting(name) {
var node = this.node;
if (node) {
var env = node.env;
if (env && env.hasOwnProperty(name)) {
return env[name].value;
}
}
var parent = this.parent;
if (parent) {
var val = parent.getSetting(name);
return val;
}
return undefined;
}
/**
* Set environment variable of subflow
* @param {String} name name of env var
* @param {Object} val value of env var
*/
setSetting(name, val) {
var node = this.node;
if (node) {
var env = node.env;
if (env) {
env[name] = { name: name, type: "str", value: val, info: null };
}
}
}
/**
* Handle a status event from a node within this flow.
* @param {Node} node The original node that triggered the event
@@ -234,7 +301,6 @@ class Subflow extends Flow {
return handled;
}
}

38
packages/node_modules/@node-red/util/lib/util.js vendored
View File

@@ -413,6 +413,20 @@ function setObjectProperty(msg,prop,value,createMissing) {
}
}
/**
* Get value of environment variable.
* @param {Node} node - accessing node
* @param {String} name - name of variable
* @return {String} value of env var
*/
function getenv(node, name) {
if (node && node.getenv) {
return node.getenv(name);
}
return process.env[name];
}
/**
* Checks if a String contains any Environment Variable specifiers and returns
* it with their values substituted in place.
@@ -420,24 +434,27 @@ function setObjectProperty(msg,prop,value,createMissing) {
* For example, if the env var `WHO` is set to `Joe`, the string `Hello ${WHO}!`
* will return `Hello Joe!`.
* @param {String} value - the string to parse
* @param {Node} node - the node evaluating the property
* @return {String} The parsed string
* @memberof @node-red/util_util
*/
function evaluateEnvProperty(value) {
function evaluateEnvProperty(value, node) {
if (/^\${[^}]+}$/.test(value)) {
// ${ENV_VAR}
value = value.substring(2,value.length-1);
value = process.env.hasOwnProperty(value)?process.env[value]:""
var name = value.substring(2,value.length-1);
var val = getenv(node, name);
return val ? val : "";
} else if (!/\${\S+}/.test(value)) {
// ENV_VAR
value = process.env.hasOwnProperty(value)?process.env[value]:""
var val = getenv(node, value);
return val ? val : "";
} else {
// FOO${ENV_VAR}BAR
value = value.replace(/\${([^}]+)}/g, function(match, v) {
return process.env.hasOwnProperty(v)?process.env[v]:""
return value.replace(/\${([^}]+)}/g, function(match, name) {
var val = getenv(node, name);
return (val ? val : "");
});
}
return value;
}
@@ -513,7 +530,7 @@ function evaluateNodeProperty(value, type, node, msg, callback) {
var expr = prepareJSONataExpression(value,node);
result = evaluateJSONataExpression(expr,msg);
} else if (type === 'env') {
result = evaluateEnvProperty(value);
result = evaluateEnvProperty(value, node);
}
if (callback) {
callback(null,result);
@@ -540,8 +557,9 @@ function prepareJSONataExpression(value,node) {
expr.assign('globalContext',function(val) {
return node.context().global.get(val);
});
expr.assign('env', function(val) {
return process.env[val];
expr.assign('env', function(name) {
var val = getenv(node, name);
return (val ? val : "");
})
expr.registerFunction('clone', cloneMessage, '<(oa)-:o>');
expr._legacyMode = /(^|[^a-zA-Z0-9_'"])msg([^a-zA-Z0-9_'"]|$)/.test(value);