github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

use a promise instead of a callback to track task completion

Browse source 
Original commit: elastic/kibana-plugin-helpers@c6dacf3507
This commit is contained in:
spalger 2016-11-17 13:02:57 -07:00
parent 66c5ec54ef
commit b5166d80d3
2 changed files with 79 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

152
packages/kbn-plugin-helpers/tasks/build/build_action.js
View file

@ -1,87 +1,87 @@
module.exports = function (plugin, callback) {
if (!callback) callback = function () {};
module.exports = function (plugin) {
return new Promise(function (resolve, reject) {
var vfs = require('vinyl-fs');
var zip = require('gulp-zip');
var map = require('through2-map').obj;
var rename = require('gulp-rename');
var join = require('path').join;
var inquirer = require('inquirer');
var vfs = require('vinyl-fs');
var zip = require('gulp-zip');
var map = require('through2-map').obj;
var rename = require('gulp-rename');
var join = require('path').join;
var inquirer = require('inquirer');
function main() {
var kibanaVersion = (plugin.pkg.kibana && plugin.pkg.kibana.version) || plugin.pkg.version;
var deps = Object.keys(plugin.pkg.dependencies || {});
var buildId = `${plugin.id}-${plugin.version}`;
function main() {
var kibanaVersion = (plugin.pkg.kibana && plugin.pkg.kibana.version) || plugin.pkg.version;
var deps = Object.keys(plugin.pkg.dependencies || {});
var buildId = `${plugin.id}-${plugin.version}`;
if (kibanaVersion === 'kibana') {
askForKibanaVersion(function (customKibanaVersion) {
build(buildId, deps, customKibanaVersion);
});
} else {
build(buildId, deps, kibanaVersion);
}
}
function askForKibanaVersion(cb) {
inquirer.prompt([
{
type: 'input',
name: 'kibanaVersion',
message: 'What version of Kibana are you building for?'
if (kibanaVersion === 'kibana') {
askForKibanaVersion(function (customKibanaVersion) {
build(buildId, deps, customKibanaVersion);
});
} else {
build(buildId, deps, kibanaVersion);
}
]).then(function (answers) {
cb(answers.kibanaVersion);
});
}
function toBuffer(string) {
if (typeof Buffer.from === 'function') {
return Buffer.from(string, 'utf8');
} else {
// this was deprecated in node v5 in favor
// of Buffer.from(string, encoding)
return new Buffer(string, 'utf8');
}
}
function build(buildId, deps, kibanaVersion) {
var files = [
'package.json',
'index.js',
'{lib,public,server,webpackShims}/**/*'
];
if (deps.length === 1) {
files.push(`node_modules/${ deps[0] }/**/*`);
} else if (deps.length) {
files.push(`node_modules/{${ deps.join(',') }}/**/*`);
}
vfs
.src(files, { cwd: plugin.root, base: plugin.root })
// rewrite the target kibana version while the
// file is on it's way to the archive
.pipe(map(function (file) {
if (file.basename === 'package.json') {
const pkg = JSON.parse(file.contents.toString('utf8'));
if (!pkg.kibana) pkg.kibana = {};
pkg.kibana.version = kibanaVersion;
file.contents = toBuffer(JSON.stringify(pkg));
function askForKibanaVersion(cb) {
inquirer.prompt([
{
type: 'input',
name: 'kibanaVersion',
message: 'What version of Kibana are you building for?'
}
]).then(function (answers) {
cb(answers.kibanaVersion);
});
}
return file;
}))
function toBuffer(string) {
if (typeof Buffer.from === 'function') {
return Buffer.from(string, 'utf8');
} else {
// this was deprecated in node v5 in favor
// of Buffer.from(string, encoding)
return new Buffer(string, 'utf8');
}
}
// put all files inside the correct directoried
.pipe(rename(function nestFileInDir(path) {
path.dirname = join('kibana', plugin.id, path.dirname);
}))
function build(buildId, deps, kibanaVersion) {
var files = [
'package.json',
'index.js',
'{lib,public,server,webpackShims}/**/*'
];
.pipe(zip(`${buildId}.zip`))
.pipe(vfs.dest(join(plugin.root, 'build')))
.on('end', callback);
}
if (deps.length === 1) {
files.push(`node_modules/${ deps[0] }/**/*`);
} else if (deps.length) {
files.push(`node_modules/{${ deps.join(',') }}/**/*`);
}
main();
vfs
.src(files, { cwd: plugin.root, base: plugin.root })
// rewrite the target kibana version while the
// file is on it's way to the archive
.pipe(map(function (file) {
if (file.basename === 'package.json') {
const pkg = JSON.parse(file.contents.toString('utf8'));
if (!pkg.kibana) pkg.kibana = {};
pkg.kibana.version = kibanaVersion;
file.contents = toBuffer(JSON.stringify(pkg));
}
return file;
}))
// put all files inside the correct directoried
.pipe(rename(function nestFileInDir(path) {
path.dirname = join('kibana', plugin.id, path.dirname);
}))
.pipe(zip(`${buildId}.zip`))
.pipe(vfs.dest(join(plugin.root, 'build')))
.on('end', resolve);
}
main();
});
};

8
packages/kbn-plugin-helpers/tasks/build/build_action.spec.js
View file

@ -13,12 +13,10 @@ describe('build_action', () => {
beforeEach(() => del(PLUGIN_BUILD_DIR));
afterEach(() => del(PLUGIN_BUILD_DIR));
it('creates a zip in the build directory', (done) => {
buildAction(PLUGIN, () => {
it('creates a zip in the build directory', () => {
return buildAction(PLUGIN).then(() => {
if (!fs.existsSync(resolve(PLUGIN_BUILD_DIR, PLUGIN.id + '-' + PLUGIN.version + '.zip'))) {
done(new Error('expected the plugin to build a zip file'));
} else {
done();
throw new Error('expected the plugin to build a zip file');
}
});
});