pluginfw/plugins.js: converted to Promise API

pull/3559/head
Ray Bellis 2019-01-18 13:52:37 +00:00
parent 8d85ae582e
commit 80b3019154
1 changed files with 69 additions and 84 deletions

View File

@ -1,7 +1,6 @@
var npm = require("npm/lib/npm.js"); var npm = require("npm/lib/npm.js");
var readInstalled = require("./read-installed.js"); var readInstalled = require("./read-installed.js");
var path = require("path"); var path = require("path");
var async = require("async");
var fs = require("fs"); var fs = require("fs");
var tsort = require("./tsort"); var tsort = require("./tsort");
var util = require("util"); var util = require("util");
@ -15,6 +14,7 @@ exports.plugins = {};
exports.parts = []; exports.parts = [];
exports.hooks = {}; exports.hooks = {};
// @TODO RPB this appears to be unused
exports.ensure = function (cb) { exports.ensure = function (cb) {
if (!exports.loaded) if (!exports.loaded)
exports.update(cb); exports.update(cb);
@ -53,109 +53,94 @@ exports.formatHooks = function (hook_set_name) {
return "<dl>" + res.join("\n") + "</dl>"; return "<dl>" + res.join("\n") + "</dl>";
}; };
exports.callInit = function (cb) { exports.callInit = function () {
const fsp_stat = util.promisify(fs.stat);
const fsp_writeFile = util.promisify(fs.writeFile);
var hooks = require("./hooks"); var hooks = require("./hooks");
async.map( let p = Object.keys(exports.plugins).map(function (plugin_name) {
Object.keys(exports.plugins), let plugin = exports.plugins[plugin_name];
function (plugin_name, cb) { let ep_init = path.normalize(path.join(plugin.package.path, ".ep_initialized"));
var plugin = exports.plugins[plugin_name]; return fsp_stat(ep_init).catch(async function() {
fs.stat(path.normalize(path.join(plugin.package.path, ".ep_initialized")), function (err, stats) { await fsp_writeFile(ep_init, "done");
if (err) { await hooks.aCallAll("init_" + plugin_name, {});
async.waterfall([ });
function (cb) { fs.writeFile(path.normalize(path.join(plugin.package.path, ".ep_initialized")), 'done', cb); }, });
function (cb) { hooks.aCallAll("init_" + plugin_name, {}, cb); },
cb, return Promise.all(p);
]);
} else {
cb();
}
});
},
function () { cb(); }
);
} }
exports.pathNormalization = function (part, hook_fn_name) { exports.pathNormalization = function (part, hook_fn_name) {
return path.normalize(path.join(path.dirname(exports.plugins[part.plugin].package.path), hook_fn_name)); return path.normalize(path.join(path.dirname(exports.plugins[part.plugin].package.path), hook_fn_name));
} }
exports.update = function (cb) { exports.update = async function () {
exports.getPackages(function (er, packages) { let packages = await exports.getPackages();
var parts = []; var parts = [];
var plugins = {}; var plugins = {};
// Load plugin metadata ep.json // Load plugin metadata ep.json
async.forEach( let p = Object.keys(packages).map(function (plugin_name) {
Object.keys(packages), return loadPlugin(packages, plugin_name, plugins, parts);
function (plugin_name, cb) {
loadPlugin(packages, plugin_name, plugins, parts, cb);
},
function (err) {
if (err) cb(err);
exports.plugins = plugins;
exports.parts = sortParts(parts);
exports.hooks = pluginUtils.extractHooks(exports.parts, "hooks", exports.pathNormalization);
exports.loaded = true;
exports.callInit(cb);
}
);
}); });
};
exports.getPackages = function (cb) { return Promise.all(p).then(function() {
exports.plugins = plugins;
exports.parts = sortParts(parts);
exports.hooks = pluginUtils.extractHooks(exports.parts, "hooks", exports.pathNormalization);
exports.loaded = true;
}).then(exports.callInit);
}
exports.getPackages = async function () {
// Load list of installed NPM packages, flatten it to a list, and filter out only packages with names that // Load list of installed NPM packages, flatten it to a list, and filter out only packages with names that
var dir = path.resolve(npm.dir, '..'); var dir = path.resolve(npm.dir, '..');
readInstalled(dir, function (er, data) { let data = await util.promisify(readInstalled)(dir);
if (er) cb(er, null);
var packages = {}; var packages = {};
function flatten(deps) { function flatten(deps) {
_.chain(deps).keys().each(function (name) { _.chain(deps).keys().each(function (name) {
if (name.indexOf(exports.prefix) === 0) { if (name.indexOf(exports.prefix) === 0) {
packages[name] = _.clone(deps[name]); packages[name] = _.clone(deps[name]);
// Delete anything that creates loops so that the plugin // Delete anything that creates loops so that the plugin
// list can be sent as JSON to the web client // list can be sent as JSON to the web client
delete packages[name].dependencies; delete packages[name].dependencies;
delete packages[name].parent; delete packages[name].parent;
} }
// I don't think we need recursion // I don't think we need recursion
//if (deps[name].dependencies !== undefined) flatten(deps[name].dependencies); //if (deps[name].dependencies !== undefined) flatten(deps[name].dependencies);
}); });
} }
var tmp = {}; var tmp = {};
tmp[data.name] = data; tmp[data.name] = data;
flatten(tmp[data.name].dependencies); flatten(tmp[data.name].dependencies);
cb(null, packages); return packages;
});
}; };
function loadPlugin(packages, plugin_name, plugins, parts, cb) { async function loadPlugin(packages, plugin_name, plugins, parts) {
let fsp_readFile = util.promisify(fs.readFile);
var plugin_path = path.resolve(packages[plugin_name].path, "ep.json"); var plugin_path = path.resolve(packages[plugin_name].path, "ep.json");
fs.readFile( try {
plugin_path, let data = await fsp_readFile(plugin_path);
function (er, data) { try {
if (er) { var plugin = JSON.parse(data);
console.error("Unable to load plugin definition file " + plugin_path); plugin['package'] = packages[plugin_name];
return cb(); plugins[plugin_name] = plugin;
} _.each(plugin.parts, function (part) {
try { part.plugin = plugin_name;
var plugin = JSON.parse(data); part.full_name = plugin_name + "/" + part.name;
plugin['package'] = packages[plugin_name]; parts[part.full_name] = part;
plugins[plugin_name] = plugin; });
_.each(plugin.parts, function (part) { } catch (ex) {
part.plugin = plugin_name; console.error("Unable to parse plugin definition file " + plugin_path + ": " + ex.toString());
part.full_name = plugin_name + "/" + part.name;
parts[part.full_name] = part;
});
} catch (ex) {
console.error("Unable to parse plugin definition file " + plugin_path + ": " + ex.toString());
}
cb();
} }
); } catch (er) {
console.error("Unable to load plugin definition file " + plugin_path);
}
} }
function partsToParentChildList(parts) { function partsToParentChildList(parts) {