archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-25 15:07:39 +00:00
Code Issues Projects Releases Wiki Activity

refactor(CLI): Upgrade to v7 of open library

Browse Source 
It's to unify open browser method with dashboard plugin, and this method feels more solid
This commit is contained in:
Mariusz Nowak 2022-01-06 14:20:48 +01:00 committed by Mariusz Nowak
parent 95a61a2fc6
commit 80fef65397
3 changed files with 12 additions and 183 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

173
lib/utils/open.js
View File

@ -1,173 +0,0 @@
'use strict';
// copied from https://raw.githubusercontent.com/sindresorhus/open/master/index.js
// and adapted for node 6 support. Because open>6 requries node >= 8 but open<6 fails npm audit
// changes:
// * use bluebird.promisify instead of util.promisfy
// * Object.assign instead of spread
// * use Array.prototype.push.apply(a,b) instead of a.push(...b)
// * async/await -> then :|
// * prettified with our config
const { promisify } = require('bluebird');
const chalk = require('chalk');
const path = require('path');
const childProcess = require('child_process');
const fs = require('fs');
const isWsl = require('is-wsl');
const { legacy, log } = require('@serverless/utils/log');
const pAccess = promisify(fs.access);
const pExecFile = promisify(childProcess.execFile);
// Path to included `xdg-open`
const localXdgOpenPath = path.join(__dirname, 'xdg-open');
// Convert a path from WSL format to Windows format:
// `/mnt/c/Program Files/Example/MyApp.exe` → `C:\Program Files\Example\MyApp.exe`
const wslToWindowsPath = (filePath) =>
pExecFile('wslpath', ['-w', filePath]).then(({ stdout }) => stdout.trim());
module.exports = async (target, options) => {
if (typeof target !== 'string') {
throw new TypeError('Expected a `target`');
}
options = Object.assign(
{
wait: false,
background: false,
},
options
);
let command;
let appArguments = [];
const cliArguments = [];
const childProcessOptions = {};
if (Array.isArray(options.app)) {
appArguments = options.app.slice(1);
options.app = options.app[0];
}
return Promise.resolve()
.then(() => {
if (process.platform === 'darwin') {
command = 'open';
if (options.wait) {
cliArguments.push('--wait-apps');
}
if (options.background) {
cliArguments.push('--background');
}
if (options.app) {
cliArguments.push('-a', options.app);
}
return null;
} else if (process.platform === 'win32' || isWsl) {
command = `cmd${isWsl ? '.exe' : ''}`;
cliArguments.push('/c', 'start', '""', '/b');
target = target.replace(/&/g, '^&');
if (options.wait) {
cliArguments.push('/wait');
}
return Promise.resolve()
.then(() => {
if (options.app) {
if (isWsl && options.app.startsWith('/mnt/')) {
return wslToWindowsPath(options.app).then((windowsPath) => {
options.app = windowsPath;
cliArguments.push(options.app);
});
}
cliArguments.push(options.app);
}
return null;
})
.then(() => {
if (appArguments.length > 0) {
Array.prototype.push.apply(cliArguments, appArguments);
}
return null;
});
}
return Promise.resolve()
.then(() => {
if (options.app) {
command = options.app;
} else {
// When bundled by Webpack, there's no actual package file path and no local `xdg-open`.
const isBundled = !__dirname || __dirname === '/';
// Check if local `xdg-open` exists and is executable.
return pAccess(localXdgOpenPath, fs.constants.X_OK)
.then(() => true)
.catch(() => false)
.then((exeLocalXdgOpen) => {
const useSystemXdgOpen =
process.versions.electron ||
process.platform === 'android' ||
isBundled ||
!exeLocalXdgOpen;
command = useSystemXdgOpen ? 'xdg-open' : localXdgOpenPath;
});
}
return null;
})
.then(() => {
if (appArguments.length > 0) {
Array.prototype.push.apply(cliArguments, appArguments);
}
if (!options.wait) {
// `xdg-open` will block the process unless stdio is ignored
// and it's detached from the parent even if it's unref'd.
childProcessOptions.stdio = 'ignore';
childProcessOptions.detached = true;
}
});
})
.then(() => {
cliArguments.push(target);
if (process.platform === 'darwin' && appArguments.length > 0) {
cliArguments.push('--args');
Array.prototype.push.apply(cliArguments, appArguments);
}
const subprocess = childProcess.spawn(command, cliArguments, childProcessOptions);
if (options.wait) {
return new Promise((resolve, reject) => {
subprocess.once('error', reject);
subprocess.once('close', (exitCode) => {
if (exitCode > 0) {
reject(new Error(`Exited with code ${exitCode}`));
return;
}
resolve(subprocess);
});
});
}
subprocess.once('error', (error) => {
if (process.env.SLS_DEBUG) {
legacy.write(
`Serverless: ${chalk.red(`Opening of browser window errored with ${error.stack}`)}\n`
);
}
log.info(`Opening of browser window errored with ${error.stack}`);
});
subprocess.unref();
return subprocess;
});
};

21
lib/utils/openBrowser.js
View File

@ -2,7 +2,7 @@
/* eslint-disable no-console */
const opn = require('./open');
const open = require('open');
const chalk = require('chalk');
const isDockerContainer = require('is-docker');
const { legacy, log, style } = require('@serverless/utils/log');
@ -17,13 +17,14 @@ module.exports = function openBrowser(url) {
let browser = process.env.BROWSER;
if (browser === 'none' || isDockerContainer()) return;
if (process.platform === 'darwin' && browser === 'open') browser = undefined;
const options = { wait: false, app: browser };
opn(url, options).catch((err) => {
if (process.env.SLS_DEBUG) {
legacy.write(
`Serverless: ${chalk.red(`Opening of browser window errored with ${err.stack}`)}\n`
);
}
log.info(`Opening of browser window errored with ${err.stack}`);
});
open(url).then((subprocess) =>
subprocess.on('error', (err) => {
if (process.env.SLS_DEBUG) {
legacy.write(
`Serverless: ${chalk.red(`Opening of browser window errored with ${err.stack}`)}\n`
);
}
log.info(`Opening of browser window errored with ${err.stack}`);
})
);
};

1
package.json
View File

@ -64,6 +64,7 @@
"ncjsm": "^4.2.0",
"node-fetch": "^2.6.6",
"object-hash": "^2.2.0",
"open": "^7.4.2",
"path2": "^0.1.0",
"process-utils": "^4.0.0",
"promise-queue": "^2.2.5",