Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

chore: better Electron error message when no executable path is given (#13318)

Browse source
This commit is contained in:
Max Schmitt 2022-04-05 18:45:21 +02:00 committed by GitHub
parent 2ee3e9b74f
commit 844ecbe2eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
packages/playwright-core/src/server/electron/electron.ts
View file

@ -24,6 +24,7 @@ import { CRExecutionContext } from '../chromium/crExecutionContext';
import * as js from '../javascript'; import * as js from '../javascript';
import { Page } from '../page'; import { Page } from '../page';
import { TimeoutSettings } from '../../utils/timeoutSettings'; import { TimeoutSettings } from '../../utils/timeoutSettings';
import { wrapInASCIIBox } from '../../utils/utils';
import { WebSocketTransport } from '../transport'; import { WebSocketTransport } from '../transport';
import { launchProcess, envArrayToObject } from '../../utils/processLauncher'; import { launchProcess, envArrayToObject } from '../../utils/processLauncher';
import { BrowserContext, validateBrowserContextOptions } from '../browserContext'; import { BrowserContext, validateBrowserContextOptions } from '../browserContext';
@ -134,12 +135,32 @@ export class Electron extends SdkObject {
const browserLogsCollector = new RecentLogsCollector(); const browserLogsCollector = new RecentLogsCollector();
const env = options.env ? envArrayToObject(options.env) : process.env; const env = options.env ? envArrayToObject(options.env) : process.env;
let command: string;
if (options.executablePath) {
command = options.executablePath;
} else {
try {
// By default we fallback to the Electron App executable path.
// 'electron/index.js' resolves to the actual Electron App.
command = require('electron/index.js');
} catch (error: any) {
if ((error as NodeJS.ErrnoException)?.code === 'MODULE_NOT_FOUND') {
throw new Error('\n' + wrapInASCIIBox([
'Electron executablePath not found!',
'Please install it using `npm install -D electron` or set the executablePath to your Electron executable.',
].join('\n'), 1));
}
throw error;
}
}
// When debugging Playwright test that runs Electron, NODE_OPTIONS // When debugging Playwright test that runs Electron, NODE_OPTIONS
// will make the debugger attach to Electron's Node. But Playwright // will make the debugger attach to Electron's Node. But Playwright
// also needs to attach to drive the automation. Disable external debugging. // also needs to attach to drive the automation. Disable external debugging.
delete env.NODE_OPTIONS; delete env.NODE_OPTIONS;
const { launchedProcess, gracefullyClose, kill } = await launchProcess({ const { launchedProcess, gracefullyClose, kill } = await launchProcess({
command: options.executablePath || require('electron/index.js'), command,
args: electronArguments, args: electronArguments,
env, env,
log: (message: string) => { log: (message: string) => {