mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
623 lines
19 KiB
JavaScript
623 lines
19 KiB
JavaScript
/**
|
|
* Copyright 2014, 2015 IBM Corp.
|
|
*
|
|
* 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 clone = require("clone");
|
|
var when = require("when");
|
|
|
|
var Flow = require('./Flow');
|
|
|
|
var typeRegistry = require("../registry");
|
|
var context = require("../context")
|
|
var credentials = require("../credentials");
|
|
|
|
var flowUtil = require("./util");
|
|
var log = require("../../log");
|
|
var events = require("../../events");
|
|
var redUtil = require("../../util");
|
|
var deprecated = require("../registry/deprecated");
|
|
|
|
var storage = null;
|
|
var settings = null;
|
|
|
|
var activeConfig = null;
|
|
var activeFlowConfig = null;
|
|
|
|
var activeFlows = {};
|
|
var started = false;
|
|
|
|
var activeNodesToFlow = {};
|
|
var subflowInstanceNodeMap = {};
|
|
|
|
var typeEventRegistered = false;
|
|
|
|
function init(_settings, _storage) {
|
|
if (started) {
|
|
throw new Error("Cannot init without a stop");
|
|
}
|
|
settings = _settings;
|
|
storage = _storage;
|
|
started = false;
|
|
if (!typeEventRegistered) {
|
|
events.on('type-registered',function(type) {
|
|
if (activeFlowConfig && activeFlowConfig.missingTypes.length > 0) {
|
|
var i = activeFlowConfig.missingTypes.indexOf(type);
|
|
if (i != -1) {
|
|
log.info(log._("nodes.flows.registered-missing", {type:type}));
|
|
activeFlowConfig.missingTypes.splice(i,1);
|
|
if (activeFlowConfig.missingTypes.length === 0 && started) {
|
|
start();
|
|
}
|
|
}
|
|
}
|
|
});
|
|
typeEventRegistered = true;
|
|
}
|
|
}
|
|
function load() {
|
|
return storage.getFlows().then(function(flows) {
|
|
return credentials.load().then(function() {
|
|
return setConfig(flows,"load");
|
|
});
|
|
}).otherwise(function(err) {
|
|
log.warn(log._("nodes.flows.error",{message:err.toString()}));
|
|
console.log(err.stack);
|
|
});
|
|
}
|
|
|
|
function setConfig(_config,type,muteLog) {
|
|
var config = clone(_config);
|
|
type = type||"full";
|
|
|
|
var credentialsChanged = false;
|
|
var credentialSavePromise = null;
|
|
var configSavePromise = null;
|
|
|
|
var diff;
|
|
var newFlowConfig = flowUtil.parseConfig(clone(config));
|
|
if (type !== 'full' && type !== 'load') {
|
|
diff = flowUtil.diffConfigs(activeFlowConfig,newFlowConfig);
|
|
}
|
|
config.forEach(function(node) {
|
|
if (node.credentials) {
|
|
credentials.extract(node);
|
|
credentialsChanged = true;
|
|
}
|
|
});
|
|
if (credentialsChanged) {
|
|
credentialSavePromise = credentials.save();
|
|
} else {
|
|
credentialSavePromise = when.resolve();
|
|
}
|
|
if (type === 'load') {
|
|
configSavePromise = credentialSavePromise;
|
|
type = 'full';
|
|
} else {
|
|
configSavePromise = credentialSavePromise.then(function() {
|
|
return storage.saveFlows(config);
|
|
});
|
|
}
|
|
|
|
return configSavePromise
|
|
.then(function() {
|
|
activeConfig = config;
|
|
activeFlowConfig = newFlowConfig;
|
|
return credentials.clean(activeConfig).then(function() {
|
|
if (started) {
|
|
return stop(type,diff,muteLog).then(function() {
|
|
context.clean(activeFlowConfig);
|
|
start(type,diff,muteLog);
|
|
}).otherwise(function(err) {
|
|
})
|
|
}
|
|
});
|
|
});
|
|
}
|
|
|
|
function getNode(id) {
|
|
var node;
|
|
if (activeNodesToFlow[id]) {
|
|
return activeFlows[activeNodesToFlow[id]].getNode(id);
|
|
}
|
|
for (var flowId in activeFlows) {
|
|
if (activeFlows.hasOwnProperty(flowId)) {
|
|
node = activeFlows[flowId].getNode(id);
|
|
if (node) {
|
|
return node;
|
|
}
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
function eachNode(cb) {
|
|
for (var id in activeFlowConfig.allNodes) {
|
|
if (activeFlowConfig.allNodes.hasOwnProperty(id)) {
|
|
cb(activeFlowConfig.allNodes[id]);
|
|
}
|
|
}
|
|
}
|
|
|
|
function getConfig() {
|
|
return activeConfig;
|
|
}
|
|
|
|
function delegateError(node,logMessage,msg) {
|
|
if (activeFlows[node.z]) {
|
|
activeFlows[node.z].handleError(node,logMessage,msg);
|
|
} else if (activeNodesToFlow[node.z]) {
|
|
activeFlows[activeNodesToFlow[node.z]].handleError(node,logMessage,msg);
|
|
} else if (activeFlowConfig.subflows[node.z]) {
|
|
subflowInstanceNodeMap[node.id].forEach(function(n) {
|
|
delegateError(getNode(n),logMessage,msg);
|
|
});
|
|
}
|
|
}
|
|
function handleError(node,logMessage,msg) {
|
|
if (node.z) {
|
|
delegateError(node,logMessage,msg);
|
|
} else {
|
|
if (activeFlowConfig.configs[node.id]) {
|
|
activeFlowConfig.configs[node.id]._users.forEach(function(id) {
|
|
var userNode = activeFlowConfig.allNodes[id];
|
|
delegateError(userNode,logMessage,msg);
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
function delegateStatus(node,statusMessage) {
|
|
if (activeFlows[node.z]) {
|
|
activeFlows[node.z].handleStatus(node,statusMessage);
|
|
}
|
|
}
|
|
function handleStatus(node,statusMessage) {
|
|
events.emit("node-status",{
|
|
id: node.id,
|
|
status:statusMessage
|
|
});
|
|
if (node.z) {
|
|
delegateStatus(node,statusMessage);
|
|
} else {
|
|
if (activeFlowConfig.configs[node.id]) {
|
|
activeFlowConfig.configs[node.id]._users.forEach(function(id) {
|
|
var userNode = activeFlowConfig.allNodes[id];
|
|
delegateStatus(userNode,statusMessage);
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
function start(type,diff,muteLog) {
|
|
//dumpActiveNodes();
|
|
type = type||"full";
|
|
started = true;
|
|
var i;
|
|
if (activeFlowConfig.missingTypes.length > 0) {
|
|
log.info(log._("nodes.flows.missing-types"));
|
|
var knownUnknowns = 0;
|
|
for (i=0;i<activeFlowConfig.missingTypes.length;i++) {
|
|
var nodeType = activeFlowConfig.missingTypes[i];
|
|
var info = deprecated.get(nodeType);
|
|
if (info) {
|
|
log.info(log._("nodes.flows.missing-type-provided",{type:activeFlowConfig.missingTypes[i],module:info.module}));
|
|
knownUnknowns += 1;
|
|
} else {
|
|
log.info(" - "+activeFlowConfig.missingTypes[i]);
|
|
}
|
|
}
|
|
if (knownUnknowns > 0) {
|
|
log.info(log._("nodes.flows.missing-type-install-1"));
|
|
log.info(" npm install <module name>");
|
|
log.info(log._("nodes.flows.missing-type-install-2"));
|
|
log.info(" "+settings.userDir);
|
|
}
|
|
return when.resolve();
|
|
}
|
|
if (!muteLog) {
|
|
if (diff) {
|
|
log.info(log._("nodes.flows.starting-modified-"+type));
|
|
} else {
|
|
log.info(log._("nodes.flows.starting-flows"));
|
|
}
|
|
}
|
|
var id;
|
|
if (!diff) {
|
|
if (!activeFlows['global']) {
|
|
activeFlows['global'] = Flow.create(activeFlowConfig);
|
|
}
|
|
for (id in activeFlowConfig.flows) {
|
|
if (activeFlowConfig.flows.hasOwnProperty(id)) {
|
|
if (!activeFlows[id]) {
|
|
activeFlows[id] = Flow.create(activeFlowConfig,activeFlowConfig.flows[id]);
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
activeFlows['global'].update(activeFlowConfig,activeFlowConfig);
|
|
for (id in activeFlowConfig.flows) {
|
|
if (activeFlowConfig.flows.hasOwnProperty(id)) {
|
|
if (activeFlows[id]) {
|
|
activeFlows[id].update(activeFlowConfig,activeFlowConfig.flows[id]);
|
|
} else {
|
|
activeFlows[id] = Flow.create(activeFlowConfig,activeFlowConfig.flows[id]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
for (id in activeFlows) {
|
|
if (activeFlows.hasOwnProperty(id)) {
|
|
activeFlows[id].start(diff);
|
|
var activeNodes = activeFlows[id].getActiveNodes();
|
|
Object.keys(activeNodes).forEach(function(nid) {
|
|
activeNodesToFlow[nid] = id;
|
|
if (activeNodes[nid]._alias) {
|
|
subflowInstanceNodeMap[activeNodes[nid]._alias] = subflowInstanceNodeMap[activeNodes[nid]._alias] || [];
|
|
subflowInstanceNodeMap[activeNodes[nid]._alias].push(nid);
|
|
}
|
|
});
|
|
|
|
}
|
|
}
|
|
events.emit("nodes-started");
|
|
if (!muteLog) {
|
|
if (diff) {
|
|
log.info(log._("nodes.flows.started-modified-"+type));
|
|
} else {
|
|
log.info(log._("nodes.flows.started-flows"));
|
|
}
|
|
}
|
|
return when.resolve();
|
|
}
|
|
|
|
function stop(type,diff,muteLog) {
|
|
type = type||"full";
|
|
if (!muteLog) {
|
|
if (diff) {
|
|
log.info(log._("nodes.flows.stopping-modified-"+type));
|
|
} else {
|
|
log.info(log._("nodes.flows.stopping-flows"));
|
|
}
|
|
}
|
|
started = false;
|
|
var promises = [];
|
|
var stopList;
|
|
if (type === 'nodes') {
|
|
stopList = diff.changed.concat(diff.removed);
|
|
} else if (type === 'flows') {
|
|
stopList = diff.changed.concat(diff.removed).concat(diff.linked);
|
|
}
|
|
for (var id in activeFlows) {
|
|
if (activeFlows.hasOwnProperty(id)) {
|
|
promises = promises.concat(activeFlows[id].stop(stopList));
|
|
if (!diff || diff.removed.indexOf(id)!==-1) {
|
|
delete activeFlows[id];
|
|
}
|
|
}
|
|
}
|
|
|
|
return when.promise(function(resolve,reject) {
|
|
when.settle(promises).then(function() {
|
|
for (id in activeNodesToFlow) {
|
|
if (activeNodesToFlow.hasOwnProperty(id)) {
|
|
if (!activeFlows[activeNodesToFlow[id]]) {
|
|
delete activeNodesToFlow[id];
|
|
}
|
|
}
|
|
}
|
|
if (stopList) {
|
|
stopList.forEach(function(id) {
|
|
delete activeNodesToFlow[id];
|
|
});
|
|
}
|
|
// Ideally we'd prune just what got stopped - but mapping stopList
|
|
// id to the list of subflow instance nodes is something only Flow
|
|
// can do... so cheat by wiping the map knowing it'll be rebuilt
|
|
// in start()
|
|
subflowInstanceNodeMap = {};
|
|
if (!muteLog) {
|
|
if (diff) {
|
|
log.info(log._("nodes.flows.stopped-modified-"+type));
|
|
} else {
|
|
log.info(log._("nodes.flows.stopped-flows"));
|
|
}
|
|
}
|
|
resolve();
|
|
});
|
|
});
|
|
}
|
|
|
|
|
|
function checkTypeInUse(id) {
|
|
var nodeInfo = typeRegistry.getNodeInfo(id);
|
|
if (!nodeInfo) {
|
|
throw new Error(log._("nodes.index.unrecognised-id", {id:id}));
|
|
} else {
|
|
var inUse = {};
|
|
var config = getConfig();
|
|
config.forEach(function(n) {
|
|
inUse[n.type] = (inUse[n.type]||0)+1;
|
|
});
|
|
var nodesInUse = [];
|
|
nodeInfo.types.forEach(function(t) {
|
|
if (inUse[t]) {
|
|
nodesInUse.push(t);
|
|
}
|
|
});
|
|
if (nodesInUse.length > 0) {
|
|
var msg = nodesInUse.join(", ");
|
|
var err = new Error(log._("nodes.index.type-in-use", {msg:msg}));
|
|
err.code = "type_in_use";
|
|
throw err;
|
|
}
|
|
}
|
|
}
|
|
|
|
function updateMissingTypes() {
|
|
var subflowInstanceRE = /^subflow:(.+)$/;
|
|
activeFlowConfig.missingTypes = [];
|
|
|
|
for (var id in activeFlowConfig.allNodes) {
|
|
if (activeFlowConfig.allNodes.hasOwnProperty(id)) {
|
|
var node = activeFlowConfig.allNodes[id];
|
|
if (node.type !== 'tab' && node.type !== 'subflow') {
|
|
var subflowDetails = subflowInstanceRE.exec(node.type);
|
|
if ( (subflowDetails && !activeFlowConfig.subflows[subflowDetails[1]]) || (!subflowDetails && !typeRegistry.get(node.type)) ) {
|
|
if (activeFlowConfig.missingTypes.indexOf(node.type) === -1) {
|
|
activeFlowConfig.missingTypes.push(node.type);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function addFlow(flow) {
|
|
var i,node;
|
|
if (!flow.hasOwnProperty('nodes')) {
|
|
throw new Error('missing nodes property');
|
|
}
|
|
flow.id = redUtil.generateId();
|
|
|
|
var nodes = [{
|
|
type:'tab',
|
|
label:flow.label,
|
|
id:flow.id
|
|
}];
|
|
|
|
for (i=0;i<flow.nodes.length;i++) {
|
|
node = flow.nodes[i];
|
|
if (activeFlowConfig.allNodes[node.id]) {
|
|
// TODO nls
|
|
return when.reject(new Error('duplicate id'));
|
|
}
|
|
if (node.type === 'tab' || node.type === 'subflow') {
|
|
return when.reject(new Error('invalid node type: '+node.type));
|
|
}
|
|
node.z = flow.id;
|
|
nodes.push(node);
|
|
}
|
|
if (flow.configs) {
|
|
for (i=0;i<flow.configs.length;i++) {
|
|
node = flow.configs[i];
|
|
if (activeFlowConfig.allNodes[node.id]) {
|
|
// TODO nls
|
|
return when.reject(new Error('duplicate id'));
|
|
}
|
|
if (node.type === 'tab' || node.type === 'subflow') {
|
|
return when.reject(new Error('invalid node type: '+node.type));
|
|
}
|
|
node.z = flow.id;
|
|
nodes.push(node);
|
|
}
|
|
}
|
|
var newConfig = clone(activeConfig);
|
|
newConfig = newConfig.concat(nodes);
|
|
|
|
return setConfig(newConfig,'flows',true).then(function() {
|
|
log.info(log._("nodes.flows.added-flow",{label:(flow.label?flow.label+" ":"")+"["+flow.id+"]"}));
|
|
return flow.id;
|
|
});
|
|
}
|
|
|
|
function getFlow(id) {
|
|
var flow;
|
|
if (id === 'global') {
|
|
flow = activeFlowConfig;
|
|
} else {
|
|
flow = activeFlowConfig.flows[id];
|
|
}
|
|
if (!flow) {
|
|
return null;
|
|
}
|
|
var result = {
|
|
id: id
|
|
};
|
|
if (flow.label) {
|
|
result.label = flow.label;
|
|
}
|
|
if (id !== 'global') {
|
|
result.nodes = [];
|
|
}
|
|
if (flow.nodes) {
|
|
var nodeIds = Object.keys(flow.nodes);
|
|
if (nodeIds.length > 0) {
|
|
result.nodes = nodeIds.map(function(nodeId) {
|
|
return clone(flow.nodes[nodeId]);
|
|
})
|
|
}
|
|
}
|
|
if (flow.configs) {
|
|
var configIds = Object.keys(flow.configs);
|
|
result.configs = configIds.map(function(configId) {
|
|
return clone(flow.configs[configId]);
|
|
})
|
|
if (result.configs.length === 0) {
|
|
delete result.configs;
|
|
}
|
|
}
|
|
if (flow.subflows) {
|
|
var subflowIds = Object.keys(flow.subflows);
|
|
result.subflows = subflowIds.map(function(subflowId) {
|
|
var subflow = clone(flow.subflows[subflowId]);
|
|
var nodeIds = Object.keys(subflow.nodes);
|
|
subflow.nodes = nodeIds.map(function(id) {
|
|
return subflow.nodes[id];
|
|
});
|
|
if (subflow.configs) {
|
|
var configIds = Object.keys(subflow.configs);
|
|
subflow.configs = configIds.map(function(id) {
|
|
return subflow.configs[id];
|
|
})
|
|
}
|
|
delete subflow.instances;
|
|
return subflow;
|
|
});
|
|
if (result.subflows.length === 0) {
|
|
delete result.subflows;
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
function updateFlow(id,newFlow) {
|
|
var label = id;
|
|
if (id !== 'global') {
|
|
if (!activeFlowConfig.flows[id]) {
|
|
var e = new Error();
|
|
e.code = 404;
|
|
throw e;
|
|
}
|
|
label = activeFlowConfig.flows[id].label;
|
|
}
|
|
var newConfig = clone(activeConfig);
|
|
var nodes;
|
|
|
|
if (id === 'global') {
|
|
// Remove all nodes whose z is not a known flow
|
|
// When subflows can be owned by a flow, this logic will have to take
|
|
// that into account
|
|
newConfig = newConfig.filter(function(node) {
|
|
return node.type === 'tab' || (node.hasOwnProperty('z') && activeFlowConfig.flows.hasOwnProperty(node.z));
|
|
})
|
|
|
|
// Add in the new config nodes
|
|
nodes = newFlow.configs||[];
|
|
if (newFlow.subflows) {
|
|
// Add in the new subflows
|
|
newFlow.subflows.forEach(function(sf) {
|
|
nodes = nodes.concat(sf.nodes||[]).concat(sf.configs||[]);
|
|
delete sf.nodes;
|
|
delete sf.configs;
|
|
nodes.push(sf);
|
|
});
|
|
}
|
|
} else {
|
|
newConfig = newConfig.filter(function(node) {
|
|
return node.z !== id && node.id !== id;
|
|
});
|
|
var tabNode = {
|
|
type:'tab',
|
|
label:newFlow.label,
|
|
id:id
|
|
}
|
|
nodes = [tabNode].concat(newFlow.nodes||[]).concat(newFlow.configs||[]);
|
|
nodes.forEach(function(n) {
|
|
n.z = id;
|
|
});
|
|
}
|
|
|
|
newConfig = newConfig.concat(nodes);
|
|
return setConfig(newConfig,'flows',true).then(function() {
|
|
log.info(log._("nodes.flows.updated-flow",{label:(label?label+" ":"")+"["+id+"]"}));
|
|
})
|
|
}
|
|
|
|
function removeFlow(id) {
|
|
if (id === 'global') {
|
|
// TODO: nls + error code
|
|
throw new Error('not allowed to remove global');
|
|
}
|
|
var flow = activeFlowConfig.flows[id];
|
|
if (!flow) {
|
|
var e = new Error();
|
|
e.code = 404;
|
|
throw e;
|
|
}
|
|
|
|
var newConfig = clone(activeConfig);
|
|
newConfig = newConfig.filter(function(node) {
|
|
return node.z !== id && node.id !== id;
|
|
});
|
|
|
|
return setConfig(newConfig,'flows',true).then(function() {
|
|
log.info(log._("nodes.flows.removed-flow",{label:(flow.label?flow.label+" ":"")+"["+flow.id+"]"}));
|
|
});
|
|
}
|
|
|
|
module.exports = {
|
|
init: init,
|
|
|
|
/**
|
|
* Load the current flow configuration from storage
|
|
* @return a promise for the loading of the config
|
|
*/
|
|
load: load,
|
|
|
|
get:getNode,
|
|
eachNode: eachNode,
|
|
|
|
/**
|
|
* Gets the current flow configuration
|
|
*/
|
|
getFlows: getConfig,
|
|
|
|
/**
|
|
* Sets the current active config.
|
|
* @param config the configuration to enable
|
|
* @param type the type of deployment to do: full (default), nodes, flows, load
|
|
* @return a promise for the saving/starting of the new flow
|
|
*/
|
|
setFlows: setConfig,
|
|
|
|
/**
|
|
* Starts the current flow configuration
|
|
*/
|
|
startFlows: start,
|
|
|
|
/**
|
|
* Stops the current flow configuration
|
|
* @return a promise for the stopping of the flow
|
|
*/
|
|
stopFlows: stop,
|
|
|
|
get started() { return started },
|
|
|
|
handleError: handleError,
|
|
handleStatus: handleStatus,
|
|
|
|
checkTypeInUse: checkTypeInUse,
|
|
|
|
addFlow: addFlow,
|
|
getFlow: getFlow,
|
|
updateFlow: updateFlow,
|
|
removeFlow: removeFlow,
|
|
disableFlow:null,
|
|
enableFlow:null
|
|
|
|
};
|