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

Update runtime apis to support multiple libraries

Browse Source
This commit is contained in:
Nick O'Leary
2019-04-25 11:32:09 +01:00
parent 5e43a02cd3
commit b581e33611
15 changed files with 553 additions and 713 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
packages/node_modules/@node-red/runtime/lib/api/library.js vendored
View File

@@ -29,6 +29,7 @@ var api = module.exports = {
* Gets an entry from the library.
* @param {Object} opts
* @param {User} opts.user - the user calling the api
* @param {String} opts.library - the library
* @param {String} opts.type - the type of entry
* @param {String} opts.path - the path of the entry
* @return {Promise<String|Object>} - resolves when complete
@@ -36,12 +37,12 @@ var api = module.exports = {
*/
getEntry: function(opts) {
return new Promise(function(resolve,reject) {
runtime.library.getEntry(opts.type,opts.path).then(function(result) {
runtime.log.audit({event: "library.get",type:opts.type,path:opts.path});
runtime.library.getEntry(opts.library,opts.type,opts.path).then(function(result) {
runtime.log.audit({event: "library.get",library:opts.library,type:opts.type,path:opts.path});
return resolve(result);
}).catch(function(err) {
if (err) {
runtime.log.warn(runtime.log._("api.library.error-load-entry",{path:opts.path,message:err.toString()}));
runtime.log.warn(runtime.log._("api.library.error-load-entry",{library:opts.library,type:opts.type,path:opts.path,message:err.toString()}));
if (err.code === 'forbidden') {
err.status = 403;
return reject(err);
@@ -50,10 +51,10 @@ var api = module.exports = {
} else {
err.status = 400;
}
runtime.log.audit({event: "library.get",type:opts.type,path:opts.path,error:err.code});
runtime.log.audit({event: "library.get",library:opts.library,type:opts.type,path:opts.path,error:err.code});
return reject(err);
}
runtime.log.audit({event: "library.get",type:opts.type,error:"not_found"});
runtime.log.audit({event: "library.get",library:opts.library,type:opts.type,error:"not_found"});
var error = new Error();
error.code = "not_found";
error.status = 404;
@@ -66,6 +67,7 @@ var api = module.exports = {
* Saves an entry to the library
* @param {Object} opts
* @param {User} opts.user - the user calling the api
* @param {String} opts.library - the library
* @param {String} opts.type - the type of entry
* @param {String} opts.path - the path of the entry
* @param {Object} opts.meta - any meta data associated with the entry
@@ -75,7 +77,7 @@ var api = module.exports = {
*/
saveEntry: function(opts) {
return new Promise(function(resolve,reject) {
runtime.library.saveEntry(opts.type,opts.path,opts.meta,opts.body).then(function() {
runtime.library.saveEntry(opts.library,opts.type,opts.path,opts.meta,opts.body).then(function() {
runtime.log.audit({event: "library.set",type:opts.type,path:opts.path});
return resolve();
}).catch(function(err) {
@@ -91,30 +93,5 @@ var api = module.exports = {
return reject(error);
});
})
},
/**
* Returns a complete listing of all entries of a given type in the library.
* @param {Object} opts
* @param {User} opts.user - the user calling the api
* @param {String} opts.type - the type of entry
* @return {Promise<Object>} - the entry listing
* @memberof @node-red/runtime_library
*/
getEntries: function(opts) {
return new Promise(function(resolve,reject) {
if (opts.type !== 'flows') {
return reject(new Error("API only supports flows"));
}
runtime.storage.getAllFlows().then(function(flows) {
runtime.log.audit({event: "library.get.all",type:"flow"});
var examples = runtime.nodes.getNodeExampleFlows();
if (examples) {
flows.d = flows.d||{};
flows.d._examples_ = examples;
}
return resolve(flows);
});
})
}
}

101
packages/node_modules/@node-red/runtime/lib/library/examples.js vendored Normal file
View File

@@ -0,0 +1,101 @@
/**
* 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 fs = require('fs');
var runtime;
function init(_runtime) {
runtime = _runtime;
}
function getEntry(type,path) {
var examples = runtime.nodes.getNodeExampleFlows();
var result = [];
if (path === "") {
return Promise.resolve(Object.keys(examples));
} else {
path = path.replace(/\/$/,"");
var parts = path.split("/");
var module = parts.shift();
if (module[0] === "@") {
module = module+"/"+parts.shift();
}
if (examples.hasOwnProperty(module)) {
examples = examples[module];
examples = parts.reduce(function(ex,k) {
if (ex) {
if (ex.d && ex.d[k]) {
return ex.d[k]
}
if (ex.f && ex.f.indexOf(k) > -1) {
return runtime.nodes.getNodeExampleFlowPath(module,parts.join("/"));
}
} else {
return null;
}
},examples);
if (!examples) {
return new Promise(function (resolve,reject) {
var error = new Error("not_found");
error.code = "not_found";
return reject(error);
});
} else if (typeof examples === 'string') {
return new Promise(function(resolve,reject) {
try {
fs.readFile(examples,'utf8',function(err, data) {
runtime.log.audit({event: "library.get",library:"_examples",type:"flow",path:path});
if (err) {
return reject(err);
}
return resolve(data);
})
} catch(err) {
return reject(err);
}
});
} else {
if (examples.d) {
for (var d in examples.d) {
if (examples.d.hasOwnProperty(d)) {
result.push(d);
}
}
}
if (examples.f) {
examples.f.forEach(function(f) {
result.push({fn:f})
})
}
return Promise.resolve(result);
}
} else {
return new Promise(function (resolve,reject) {
var error = new Error("not_found");
error.code = "not_found";
return reject(error);
});
}
}
}
module.exports = {
name: '_examples_',
init: init,
getEntry: getEntry
}

86
packages/node_modules/@node-red/runtime/lib/library/index.js vendored
View File

@@ -14,18 +14,22 @@
* limitations under the License.
**/
var fs = require('fs');
var fspath = require('path');
var runtime;
var knownTypes = {};
var storage;
var libraries = {};
function init(runtime) {
knownTypes = {
'flows': 'node-red'
};
libraries["_examples_"] = require("./examples");
libraries["_examples_"].init(runtime);
libraries["local"] = require("./local");
libraries["local"].init(runtime);
function init(_runtime) {
runtime = _runtime;
storage = runtime.storage;
knownTypes = {};
}
function registerType(id,type) {
@@ -37,66 +41,34 @@ function registerType(id,type) {
knownTypes[type] = id;
}
// function getAllEntries(type) {
// if (!knownTypes.hasOwnProperty(type)) {
// throw new Error(`Unknown library type '${type}'`);
// }
// }
function getEntry(type,path) {
if (type !== 'flows') {
if (!knownTypes.hasOwnProperty(type)) {
throw new Error(`Unknown library type '${type}'`);
}
return storage.getLibraryEntry(type,path);
function getEntry(library,type,path) {
if (!knownTypes.hasOwnProperty(type)) {
throw new Error(`Unknown library type '${type}'`);
}
if (libraries.hasOwnProperty(library)) {
return libraries[library].getEntry(type,path);
} else {
return new Promise(function(resolve,reject) {
if (path.indexOf("_examples_/") === 0) {
var m = /^_examples_\/(@.*?\/[^\/]+|[^\/]+)\/(.*)$/.exec(path);
if (m) {
var module = m[1];
var entryPath = m[2];
var fullPath = runtime.nodes.getNodeExampleFlowPath(module,entryPath);
if (fullPath) {
try {
fs.readFile(fullPath,'utf8',function(err, data) {
runtime.log.audit({event: "library.get",type:"flow",path:path});
if (err) {
return reject(err);
}
return resolve(data);
})
} catch(err) {
return reject(err);
}
return;
}
}
// IF we get here, we didn't find the file
var error = new Error("not_found");
error.code = "not_found";
return reject(error);
} else {
resolve(storage.getFlow(path));
}
});
throw new Error(`Unknown library '${library}'`);
}
}
function saveEntry(type,path,meta,body) {
if (type !== 'flows') {
if (!knownTypes.hasOwnProperty(type)) {
throw new Error(`Unknown library type '${type}'`);
function saveEntry(library,type,path,meta,body) {
if (!knownTypes.hasOwnProperty(type)) {
throw new Error(`Unknown library type '${type}'`);
}
if (libraries.hasOwnProperty(library)) {
if (libraries[library].hasOwnProperty("saveEntry")) {
return libraries[library].saveEntry(type,path,meta,body);
} else {
throw new Error(`Library '${library}' is read-only`);
}
return storage.saveLibraryEntry(type,path,meta,body);
} else {
return storage.saveFlow(path,body);
throw new Error(`Unknown library '${library}'`);
}
}
module.exports = {
init: init,
register: registerType,
// getAllEntries: getAllEntries,
getEntry: getEntry,
saveEntry: saveEntry

37
packages/node_modules/@node-red/runtime/lib/library/local.js vendored Normal file
View File

@@ -0,0 +1,37 @@
/**
* 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 runtime;
var storage;
function init(_runtime) {
runtime = _runtime;
storage = runtime.storage;
}
function getEntry(type,path) {
return storage.getLibraryEntry(type,path);
}
function saveEntry(type,path,meta,body) {
return storage.saveLibraryEntry(type,path,meta,body);
}
module.exports = {
name: 'local',
init: init,
getEntry: getEntry,
saveEntry: saveEntry
}