Skip to content

refactor CLI code #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mykmelez wants to merge 16 commits into
base: master
Choose a base branch
from
Open

refactor CLI code #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
7bea10e
move runApp function to lib/ module
mykmelez Jun 14, 2017
17f5cd1
move readPackageMetadata to lib/util module
mykmelez Jun 14, 2017
9aba0fc
move packageApp function to lib/ module
mykmelez Jun 14, 2017
4fd30e2
refactor runtime installation/updating
mykmelez Jun 14, 2017
f46884b
move last command impl out of cli.js
mykmelez Jun 15, 2017
cddc99c
Merge branch 'master' into refactor-cli
mykmelez Jun 16, 2017
32605d8
separate cli from lib of package command
mykmelez Jun 16, 2017
6fca15a
make failure reading project metadata fall through to outer promise c…
mykmelez Jun 16, 2017
6052bff
separate cli from lib of run command
mykmelez Jun 16, 2017
8a565f8
only process.exit in command code
mykmelez Jun 16, 2017
4285efc
separate command libs
mykmelez Jun 16, 2017
f43b0ec
break lib dependency on bin
mykmelez Jun 16, 2017
3bc6127
correct executability status
mykmelez Jun 16, 2017
14e0667
Merge branch 'master' into refactor-cli
mykmelez Dec 18, 2017
e62de08
Merge branch 'master' into refactor-cli
mykmelez Mar 8, 2018
902ddbe
Merge branch 'master' into refactor-cli
mykmelez Apr 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
355 changes: 7 additions & 348 deletions bin/cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,11 @@
// Polyfill Promise.prototype.finally().
require('promise.prototype.finally').shim();

const chalk = require('chalk');
const cli = require('cli');
const commandLineArgs = require('command-line-args');
const commandLineCommands = require('command-line-commands');
const commandLineUsage = require('command-line-usage');
const fs = require('fs-extra');
const klaw = require('klaw');
const os = require('os');
const normalizePackageData = require('normalize-package-data');
const packageJson = require('../package.json');
const path = require('path');
const pify = require('pify');
const readPkgUp = require('read-pkg-up');
const semver = require('semver');
const spawn = require('child_process').spawn;

const distDir = path.join(__dirname, '..', 'dist', process.platform);
const installDir = path.join(distDir, process.platform === 'darwin' ? 'Runtime.app' : 'runtime');

const validCommands = [ null, 'package', 'run', 'version', 'help', 'update' ];
const validCommands = [ null, 'package', 'run', 'version', 'help', 'update', 'install-xulapp' ];
let parsedCommands = {};

try {
Expand All @@ -59,16 +44,19 @@ const argv = parsedCommands.argv;

switch (command) {
case 'package':
packageApp();
require('../lib/package')(argv);
break;
case 'run':
runApp();
require('../lib/run')(argv);
break;
case 'help':
displayHelp();
break;
case 'update':
updateRuntime();
require('../lib/update')();
break;
case 'install-xulapp':
require('../lib/install-xulapp')();
break;
default:
if (argv.includes('-v') ||
Expand All @@ -81,264 +69,6 @@ switch (command) {
break;
}

function runApp() {
const optionDefinitions = [
{ name: 'debug', type: Boolean },
{ name: 'jsdebugger', type: Boolean },
{ name: 'path', type: String, defaultOption: true, defaultValue: process.cwd() },
{ name: 'wait-for-jsdebugger', type: Boolean },
];
const options = commandLineArgs(optionDefinitions, { argv: argv, partial: true });

const executableDir = process.platform === 'darwin' ? path.join(installDir, 'Contents', 'MacOS') : installDir;
let executable = path.join(executableDir, `firefox${process.platform === 'win32' ? '.exe' : ''}`);
const resourcesDir = process.platform === 'darwin' ? path.join(installDir, 'Contents', 'Resources') : installDir;
const applicationIni = path.join(resourcesDir, 'qbrt', 'application.ini');
const profileDir = fs.mkdtempSync(path.join(os.tmpdir(), `${packageJson.name}-profile-`));

const shellDir = path.join(__dirname, '..', 'shell');
const appDir = fs.existsSync(options.path) ? path.resolve(options.path) : shellDir;

readProjectMetadata(appDir, function transformer(appPackageResult) {
// First try `main` (Electron), then try `bin` (pkg), and finally fall back to `index.js`.
appPackageResult.pkg.main = appPackageResult.pkg.main || appPackageResult.pkg.bin || 'index.js';
return appPackageResult;
})
.then(appPackageResult => {
return appPackageResult;
}, error => {
console.error(error);
process.exit(1);
})
.then(appPackageResult => {
const mainEntryPoint = path.join(appPackageResult.path, '..', appPackageResult.pkg.main);

// Args like 'app', 'new-instance', and 'profile' are handled by nsAppRunner,
// which supports uni-dash (-foo), duo-dash (--foo), and slash (/foo) variants
// (the latter only on Windows).
//
// But args like 'aqq' and 'jsdebugger' are handled by nsCommandLine methods,
// which don't support duo-dash arguments on Windows. So, for maximal
// compatibility (and minimal complexity, modulo this over-long explanation),
// we always pass uni-dash args to the runtime.
//
// Per nsBrowserApp, the 'app' flag always needs to be the first in the list.

let executableArgs = [
'-app', applicationIni,
'-profile', profileDir,
// TODO: figure out why we need 'new-instance' for it to work.
'-new-instance',
'-aqq', mainEntryPoint,
...(options._unknown || []),
];

if (appDir === shellDir) {
executableArgs.push(options.path);
}

if (options.jsdebugger) {
executableArgs.push('-jsdebugger');
}
if (options['wait-for-jsdebugger']) {
executableArgs.push('-wait-for-jsdebugger');
}

const spawnOptions = {};

if (options.debug) {
switch (process.platform) {
case 'win32':
console.error('The --debug option is not yet supported on Windows.');
process.exit(1);
break;
case 'darwin':
executableArgs.unshift(executable, '--');
executable = 'lldb';
break;
case 'linux':
executableArgs.unshift('--args', executable);
executable = 'gdb';
break;
}
spawnOptions.stdio = 'inherit';
}

const child = spawn(executable, executableArgs, spawnOptions);
// In theory, we should be able to specify the stdio: 'inherit' option
// when spawning the child to forward its output to our stdout/err streams.
// But that doesn't work on Windows in a MozillaBuild console.
if (!options.debug) {
child.stdout.on('data', data => process.stdout.write(data));
child.stderr.on('data', data => process.stderr.write(data));
}

child.on('close', code => {
fs.removeSync(profileDir);
process.exit(code);
});

process.on('SIGINT', () => {
// If we get a SIGINT, then kill our child process. Tests send us
// this signal, as might the user from a terminal window invocation.
child.kill('SIGINT');
});
});
}

function packageApp() {
const optionDefinitions = [
{ name: 'path', alias: 'p', type: String, defaultOption: true, defaultValue: argv[0] || process.cwd() },
];
const options = commandLineArgs(optionDefinitions, { argv: argv });
const shellDir = path.join(__dirname, '..', 'shell');
const appSourceDir = fs.existsSync(options.path) ? path.resolve(options.path) : shellDir;
let appName;
let appPackageJson;
let appTargetDir;
let appVersion;
let packageFile;
let tempDir;
let stageDir;

readProjectMetadata(appSourceDir, function transformer(appPackageResult) {
// `productName` is a key commonly used in `package.json` files of Electron apps.
appPackageResult.pkg.name = appPackageResult.pkg.productName || appPackageResult.pkg.name ||
path.basename(appSourceDir);
return appPackageResult;
})
.then(appPackageResult => {
return appPackageResult;
}, error => {
console.error(error);
process.exit(1);
})
.then(appPackageResult => {
appPackageJson = appPackageResult.pkg;
appName = appPackageJson.name;
appVersion = appPackageJson.version;
packageFile = `${appName}.` + (appVersion ? `v${appVersion}.` : '') +
{ win32: 'zip', darwin: 'dmg', linux: 'tgz' }[process.platform];
cli.spinner(` Packaging ${options.path} -> ${packageFile} …`);
return appPackageJson;
})
.then(appPackageJson => {
return pify(fs.mkdtemp)(path.join(os.tmpdir(), `${appPackageJson.name}-`));
})
.then(tempDirArg => {
tempDir = tempDirArg;
const stageDirName = process.platform === 'darwin' ? `${appName}.app` : appName;
stageDir = path.join(tempDir, stageDirName);
appTargetDir = process.platform === 'darwin' ?
path.join(stageDir, 'Contents', 'Resources', 'webapp') :
path.join(stageDir, 'webapp');
})
.then(() => {
// Copy the runtime to the staging dir.
return pify(fs.copy)(installDir, stageDir);
})
.then(() => {
// Rename launcher script to the app's name.
const exeDir = process.platform === 'darwin' ? path.join(stageDir, 'Contents', 'MacOS') : stageDir;
const source = path.join(exeDir, process.platform === 'win32' ? 'launcher.bat' : 'launcher.sh');
const target = path.join(exeDir, process.platform === 'win32' ? `${appName}.bat` : appName);
return pify(fs.move)(source, target);
})
.then(() => {
// Update the Info.plist file with the new name of the launcher script.
if (process.platform === 'darwin') {
const plist = require('simple-plist');
const plistFile = path.join(stageDir, 'Contents', 'Info.plist');
return pify(plist.readFile)(plistFile)
.then(appPlist => {
appPlist.CFBundleExecutable = appName;
return pify(plist.writeFile)(plistFile, appPlist);
});
}
})
.then(() => {
// Copy the app to the stage directory.
return pify(fs.copy)(appSourceDir, appTargetDir)
.then(() => {
if (appSourceDir === shellDir) {
const appTargetPackageJSONFile = path.join(appTargetDir, 'package.json');
appPackageJson.mainURL = options.path;
return pify(fs.writeFile)(appTargetPackageJSONFile, JSON.stringify(appPackageJson));
}
});
})
.then(() => {
if (process.platform === 'darwin') {
const hdiutilArgs = ['create', '-srcfolder', stageDir];
return new Promise((resolve, reject) => {
// macOS 10.9 (Mavericks) has a bug in hdiutil that causes image
// creation to fail with obscure error -5341. The problem doesn't seem
// to exist in earlier and later macOS versions, and the workaround
// causes the image to be larger than necessary (due to padding
// that avoids a resize), so we only do it on macOS 10.9.
if (semver.major(os.release()) === 13) {
let totalSizeInBytes = 0;
klaw(stageDir)
.on('data', item => {
totalSizeInBytes += item.stats.size;
})
.on('end', () => {
// Tests succeed with padding as low as 15MiB on my macOS 10.9 VM.
const size = (Math.ceil(totalSizeInBytes/1024/1024) + 15) + 'm';
hdiutilArgs.push('-size', size);
resolve();
});
}
else {
resolve();
}
})
.then(() => {
return new Promise((resolve, reject) => {
hdiutilArgs.push(packageFile);
const child = spawn('hdiutil', hdiutilArgs, { stdio: 'inherit' });
child.on('exit', resolve);
// TODO: handle errors returned by hdiutil.
});
});
}
else if (process.platform === 'linux') {
const archiver = require('archiver');
return new Promise((resolve, reject) => {
const tarFile = fs.createWriteStream(packageFile);
const archive = archiver('tar', { gzip: true });
tarFile.on('close', resolve);
archive.on('error', reject);
archive.pipe(tarFile);
archive.directory(stageDir, path.basename(stageDir));
archive.finalize();
});
}
else if (process.platform === 'win32') {
const archiver = require('archiver');
return new Promise((resolve, reject) => {
const zipFile = fs.createWriteStream(packageFile);
const archive = archiver('zip');
zipFile.on('close', resolve);
archive.on('error', reject);
archive.pipe(zipFile);
archive.directory(stageDir, path.basename(stageDir));
archive.finalize();
});
}
})
.then(() => {
cli.spinner(chalk.green.bold('✓ ') + `Packaging ${options.path} -> ${packageFile} … done!`, true);
})
.catch((error) => {
cli.spinner(chalk.red.bold('✗ ') + `Packaging ${options.path} -> ${packageFile} … failed!`, true);
console.error(error);
})
.finally(() => {
return fs.remove(stageDir);
});
}

function displayVersion() {
console.log(packageJson.version);
}
Expand Down Expand Up @@ -387,74 +117,3 @@ function displayHelp() {
const usage = commandLineUsage(sections);
console.log(usage);
}

function updateRuntime() {
const installRuntime = require('./install-runtime');
let exitCode = 0;
cli.spinner(' Updating runtime …');
installRuntime()
.then(() => {
cli.spinner(chalk.green.bold('✓ ') + 'Updating runtime … done!', true);
})
.catch(error => {
exitCode = 1;
cli.spinner(chalk.red.bold('✗ ') + 'Updating runtime … failed!', true);
console.error(error);
})
.finally(() => {
process.exit(exitCode);
});
}

function readProjectMetadata(projectDir, transformer) {
function transform(result) {
if (typeof transformer === 'function') {
result = transformer(result);
}
return result;
}

function removeUnused(metadata) {
// Remove unneeded keys that were added by `normalize-package-data`.
delete metadata._id;
if (metadata.readme === 'ERROR: No README data found!') {
delete metadata.readme;
}
return metadata;
}

return readPkgUp({cwd: projectDir}).then(result => {
// If the app doesn't have a package.json file, then result.pkg will be
// undefined, but we assume it's defined in other parts of the codebase,
// so ensure that it's defined, even if it's just an empty object.
result.pkg = result.pkg || {};

// If the app doesn't have a package.json file, then result.path will be
// undefined, but we assume it's defined in other parts of the codebase,
// so ensure that it's defined, even if the file doesn't actually exist.
result.path = result.path || path.join(projectDir, 'package.json');

let metadata = result.pkg;

result = transform(result);

// `normalizePackageData` will throw if there are any errors
// (e.g., invalid values for `name` or `version`) in the
// `package.json` file.
// To expose warnings, pass a callback as a second argument.
try {
normalizePackageData(metadata);
}
catch (error) {
throw error;
}

result.pkg = removeUnused(metadata);

return result;
})
.catch(error => {
console.error(error);
process.exit(1);
});
}
Loading