vscode/test/automation/src/playwrightElectron.ts
2025-10-26 20:38:49 -07:00

87 lines
4.0 KiB
TypeScript

/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as playwright from '@playwright/test';
import type { LaunchOptions } from './code';
import { PlaywrightDriver } from './playwrightDriver';
import { IElectronConfiguration, resolveElectronConfiguration } from './electron';
import { measureAndLog } from './logger';
import { ChildProcess } from 'child_process';
export async function launch(options: LaunchOptions): Promise<{ electronProcess: ChildProcess; driver: PlaywrightDriver }> {
// Resolve electron config and update
const { electronPath, args, env } = await resolveElectronConfiguration(options);
args.push('--enable-smoke-test-driver');
// Launch electron via playwright
const { electron, context, page } = await launchElectron({ electronPath, args, env }, options);
const electronProcess = electron.process();
return {
electronProcess,
driver: new PlaywrightDriver(electron, context, page, undefined /* no server process */, Promise.resolve() /* Window is open already */, options)
};
}
async function launchElectron(configuration: IElectronConfiguration, options: LaunchOptions) {
const { logger, tracing, snapshots } = options;
const playwrightImpl = options.playwright ?? playwright;
const electron = await measureAndLog(() => playwrightImpl._electron.launch({
executablePath: configuration.electronPath,
args: configuration.args,
recordVideo: options.videosPath
? {
dir: options.videosPath,
size: { width: 1920, height: 1080 }
} : undefined,
env: configuration.env as { [key: string]: string },
timeout: 0
}), 'playwright-electron#launch', logger);
let window = electron.windows()[0];
if (!window) {
window = await measureAndLog(() => electron.waitForEvent('window', { timeout: 0 }), 'playwright-electron#firstWindow', logger);
}
const context = window.context();
if (tracing) {
try {
await measureAndLog(() => context.tracing.start({ screenshots: true, snapshots }), 'context.tracing.start()', logger);
} catch (error) {
logger.log(`Playwright (Electron): Failed to start playwright tracing (${error})`); // do not fail the build when this fails
}
}
if (options.verbose) {
electron.on('window', () => logger.log(`Playwright (Electron): electron.on('window')`));
electron.on('close', () => logger.log(`Playwright (Electron): electron.on('close')`));
context.on('page', () => logger.log(`Playwright (Electron): context.on('page')`));
context.on('requestfailed', e => logger.log(`Playwright (Electron): context.on('requestfailed') [${e.failure()?.errorText} for ${e.url()}]`));
window.on('dialog', () => logger.log(`Playwright (Electron): window.on('dialog')`));
window.on('domcontentloaded', () => logger.log(`Playwright (Electron): window.on('domcontentloaded')`));
window.on('load', () => logger.log(`Playwright (Electron): window.on('load')`));
window.on('popup', () => logger.log(`Playwright (Electron): window.on('popup')`));
window.on('framenavigated', () => logger.log(`Playwright (Electron): window.on('framenavigated')`));
window.on('requestfailed', e => logger.log(`Playwright (Electron): window.on('requestfailed') [${e.failure()?.errorText} for ${e.url()}]`));
}
window.on('console', e => logger.log(`Playwright (Electron): window.on('console') [${e.text()}]`));
window.on('pageerror', async (error) => logger.log(`Playwright (Electron) ERROR: page error: ${error}`));
window.on('crash', () => logger.log('Playwright (Electron) ERROR: page crash'));
window.on('close', () => logger.log('Playwright (Electron): page close'));
window.on('response', async (response) => {
if (response.status() >= 400) {
logger.log(`Playwright (Electron) ERROR: HTTP status ${response.status()} for ${response.url()}`);
}
});
return { electron, context, page: window };
}