1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00

Merge pull request #2679 from rorysavage77/mutex-for-flow-modification

Updated flow modification methods to support mutex serialization
This commit is contained in:
Nick O'Leary 2020-09-03 14:17:56 +01:00 committed by GitHub
commit 0c5eae2349
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 117 additions and 88 deletions

View File

@ -27,6 +27,7 @@
], ],
"dependencies": { "dependencies": {
"ajv": "6.12.3", "ajv": "6.12.3",
"async-mutex": "0.2.4",
"basic-auth": "2.0.1", "basic-auth": "2.0.1",
"bcryptjs": "2.4.3", "bcryptjs": "2.4.3",
"body-parser": "1.19.0", "body-parser": "1.19.0",

View File

@ -34,6 +34,8 @@
*/ */
var runtime; var runtime;
var Mutex = require('async-mutex').Mutex;
const mutex = new Mutex();
var api = module.exports = { var api = module.exports = {
init: function(_runtime) { init: function(_runtime) {
@ -64,35 +66,37 @@ var api = module.exports = {
* @memberof @node-red/runtime_flows * @memberof @node-red/runtime_flows
*/ */
setFlows: function(opts) { setFlows: function(opts) {
return new Promise(function(resolve,reject) { return mutex.runExclusive(function() {
return new Promise(function(resolve,reject) {
var flows = opts.flows; var flows = opts.flows;
var deploymentType = opts.deploymentType||"full"; var deploymentType = opts.deploymentType||"full";
runtime.log.audit({event: "flows.set",type:deploymentType}, opts.req); runtime.log.audit({event: "flows.set",type:deploymentType}, opts.req);
var apiPromise; var apiPromise;
if (deploymentType === 'reload') { if (deploymentType === 'reload') {
apiPromise = runtime.nodes.loadFlows(true); apiPromise = runtime.nodes.loadFlows(true);
} else { } else {
if (flows.hasOwnProperty('rev')) { if (flows.hasOwnProperty('rev')) {
var currentVersion = runtime.nodes.getFlows().rev; var currentVersion = runtime.nodes.getFlows().rev;
if (currentVersion !== flows.rev) { if (currentVersion !== flows.rev) {
var err; var err;
err = new Error(); err = new Error();
err.code = "version_mismatch"; err.code = "version_mismatch";
err.status = 409; err.status = 409;
//TODO: log warning //TODO: log warning
return reject(err); return reject(err);
}
} }
apiPromise = runtime.nodes.setFlows(flows.flows,flows.credentials,deploymentType);
} }
apiPromise = runtime.nodes.setFlows(flows.flows,flows.credentials,deploymentType); apiPromise.then(function(flowId) {
} return resolve({rev:flowId});
apiPromise.then(function(flowId) { }).catch(function(err) {
return resolve({rev:flowId}); runtime.log.warn(runtime.log._("api.flows.error-"+(deploymentType === 'reload'?'reload':'save'),{message:err.message}));
}).catch(function(err) { runtime.log.warn(err.stack);
runtime.log.warn(runtime.log._("api.flows.error-"+(deploymentType === 'reload'?'reload':'save'),{message:err.message})); return reject(err);
runtime.log.warn(err.stack); });
return reject(err);
}); });
}); });
}, },
@ -107,19 +111,23 @@ var api = module.exports = {
* @memberof @node-red/runtime_flows * @memberof @node-red/runtime_flows
*/ */
addFlow: function(opts) { addFlow: function(opts) {
return new Promise(function(resolve,reject) { return mutex.runExclusive(function() {
var flow = opts.flow; return new Promise(function (resolve, reject) {
runtime.nodes.addFlow(flow).then(function(id) { var flow = opts.flow;
runtime.log.audit({event: "flow.add",id:id}, opts.req); runtime.nodes.addFlow(flow).then(function (id) {
return resolve(id); runtime.log.audit({event: "flow.add", id: id}, opts.req);
}).catch(function(err) { return resolve(id);
runtime.log.audit({event: "flow.add",error:err.code||"unexpected_error",message:err.toString()}, opts.req); }).catch(function (err) {
err.status = 400; runtime.log.audit({
return reject(err); event: "flow.add",
error: err.code || "unexpected_error",
message: err.toString()
}, opts.req);
err.status = 400;
return reject(err);
})
}) })
}) });
}, },
/** /**
@ -145,7 +153,6 @@ var api = module.exports = {
return reject(err); return reject(err);
} }
}) })
}, },
/** /**
* Updates an existing flow configuration * Updates an existing flow configuration
@ -158,33 +165,42 @@ var api = module.exports = {
* @memberof @node-red/runtime_flows * @memberof @node-red/runtime_flows
*/ */
updateFlow: function(opts) { updateFlow: function(opts) {
return new Promise(function (resolve,reject) { return mutex.runExclusive(function() {
var flow = opts.flow; return new Promise(function (resolve, reject) {
var id = opts.id; var flow = opts.flow;
try { var id = opts.id;
runtime.nodes.updateFlow(id,flow).then(function() { try {
runtime.log.audit({event: "flow.update",id:id}, opts.req); runtime.nodes.updateFlow(id, flow).then(function () {
return resolve(id); runtime.log.audit({event: "flow.update", id: id}, opts.req);
}).catch(function(err) { return resolve(id);
runtime.log.audit({event: "flow.update",error:err.code||"unexpected_error",message:err.toString()}, opts.req); }).catch(function (err) {
err.status = 400; runtime.log.audit({
return reject(err); event: "flow.update",
}) error: err.code || "unexpected_error",
} catch(err) { message: err.toString()
if (err.code === 404) { }, opts.req);
runtime.log.audit({event: "flow.update",id:id,error:"not_found"}, opts.req); err.status = 400;
// TODO: this swap around of .code and .status isn't ideal return reject(err);
err.status = 404; })
err.code = "not_found"; } catch (err) {
return reject(err); if (err.code === 404) {
} else { runtime.log.audit({event: "flow.update", id: id, error: "not_found"}, opts.req);
runtime.log.audit({event: "flow.update",error:err.code||"unexpected_error",message:err.toString()}, opts.req); // TODO: this swap around of .code and .status isn't ideal
err.status = 400; err.status = 404;
return reject(err); err.code = "not_found";
return reject(err);
} else {
runtime.log.audit({
event: "flow.update",
error: err.code || "unexpected_error",
message: err.toString()
}, opts.req);
err.status = 400;
return reject(err);
}
} }
} });
}); });
}, },
/** /**
* Deletes a flow * Deletes a flow
@ -196,30 +212,42 @@ var api = module.exports = {
* @memberof @node-red/runtime_flows * @memberof @node-red/runtime_flows
*/ */
deleteFlow: function(opts) { deleteFlow: function(opts) {
return new Promise(function (resolve,reject) { return mutex.runExclusive(function() {
var id = opts.id; return new Promise(function (resolve, reject) {
try { var id = opts.id;
runtime.nodes.removeFlow(id).then(function() { try {
runtime.log.audit({event: "flow.remove",id:id}, opts.req); runtime.nodes.removeFlow(id).then(function () {
return resolve(); runtime.log.audit({event: "flow.remove", id: id}, opts.req);
}).catch(function(err) { return resolve();
runtime.log.audit({event: "flow.remove",id:id,error:err.code||"unexpected_error",message:err.toString()}, opts.req); }).catch(function (err) {
err.status = 400; runtime.log.audit({
return reject(err); event: "flow.remove",
}); id: id,
} catch(err) { error: err.code || "unexpected_error",
if (err.code === 404) { message: err.toString()
runtime.log.audit({event: "flow.remove",id:id,error:"not_found"}, opts.req); }, opts.req);
// TODO: this swap around of .code and .status isn't ideal err.status = 400;
err.status = 404; return reject(err);
err.code = "not_found"; });
return reject(err); } catch (err) {
} else { if (err.code === 404) {
runtime.log.audit({event: "flow.remove",id:id,error:err.code||"unexpected_error",message:err.toString()}, opts.req); runtime.log.audit({event: "flow.remove", id: id, error: "not_found"}, opts.req);
err.status = 400; // TODO: this swap around of .code and .status isn't ideal
return reject(err); err.status = 404;
err.code = "not_found";
return reject(err);
} else {
runtime.log.audit({
event: "flow.remove",
id: id,
error: err.code || "unexpected_error",
message: err.toString()
}, opts.req);
err.status = 400;
return reject(err);
}
} }
} });
}); });
}, },
@ -264,5 +292,4 @@ var api = module.exports = {
resolve(sendCredentials); resolve(sendCredentials);
}) })
} }
} }

View File

@ -18,6 +18,7 @@
"dependencies": { "dependencies": {
"@node-red/registry": "1.1.3", "@node-red/registry": "1.1.3",
"@node-red/util": "1.1.3", "@node-red/util": "1.1.3",
"async-mutex": "0.2.4",
"clone": "2.1.2", "clone": "2.1.2",
"express": "4.17.1", "express": "4.17.1",
"fs-extra": "8.1.0", "fs-extra": "8.1.0",