{report.projectNames.length === 1 && !!report.projectNames[0] &&
Project: {report.projectNames[0]}
}
diff --git a/packages/html-reporter/src/testResultView.tsx b/packages/html-reporter/src/testResultView.tsx
index 410677cb02..bdaec18d24 100644
--- a/packages/html-reporter/src/testResultView.tsx
+++ b/packages/html-reporter/src/testResultView.tsx
@@ -36,8 +36,9 @@ function groupImageDiffs(screenshots: Set
): ImageDiffWithAnchors
const snapshotNameToImageDiff = new Map();
for (const attachment of screenshots) {
const match = attachment.name.match(/^(.*)-(expected|actual|diff|previous)(\.[^.]+)?$/);
- if (!match)
+ if (!match) {
continue;
+ }
const [, name, category, extension = ''] = match;
const snapshotName = name + extension;
let imageDiff = snapshotNameToImageDiff.get(snapshotName);
@@ -46,14 +47,18 @@ function groupImageDiffs(screenshots: Set): ImageDiffWithAnchors
snapshotNameToImageDiff.set(snapshotName, imageDiff);
}
imageDiff.anchors.push(`attachment-${attachment.name}`);
- if (category === 'actual')
+ if (category === 'actual') {
imageDiff.actual = { attachment };
- if (category === 'expected')
+ }
+ if (category === 'expected') {
imageDiff.expected = { attachment, title: 'Expected' };
- if (category === 'previous')
+ }
+ if (category === 'previous') {
imageDiff.expected = { attachment, title: 'Previous' };
- if (category === 'diff')
+ }
+ if (category === 'diff') {
imageDiff.diff = { attachment };
+ }
}
for (const [name, diff] of snapshotNameToImageDiff) {
if (!diff.actual || !diff.expected) {
@@ -88,8 +93,9 @@ export const TestResultView: React.FC<{
return
{!!errors.length &&
{errors.map((error, index) => {
- if (error.type === 'screenshot')
+ if (error.type === 'screenshot') {
return ;
+ }
return ;
})}
}
@@ -177,15 +183,18 @@ const StepTreeItem: React.FC<{
const attachmentName = step.title.match(/^attach "(.*)"$/)?.[1];
return
{msToString(step.duration)}
- {attachmentName && { evt.stopPropagation(); }}>{icons.attachment()}}
+ {attachmentName && {
+ evt.stopPropagation();
+ }}>{icons.attachment()}}
{statusIcon(step.error || step.duration === -1 ? 'failed' : 'passed')}
{step.title}
{step.count > 1 && <> ✕ {step.count}}
{step.location && — {step.location.file}:{step.location.line}}
} loadChildren={step.steps.length + (step.snippet ? 1 : 0) ? () => {
const children = step.steps.map((s, i) => );
- if (step.snippet)
+ if (step.snippet) {
children.unshift();
+ }
return children;
} : undefined} depth={depth}/>;
};
diff --git a/packages/html-reporter/src/treeItem.tsx b/packages/html-reporter/src/treeItem.tsx
index 926a398a05..7f06cf1fb7 100644
--- a/packages/html-reporter/src/treeItem.tsx
+++ b/packages/html-reporter/src/treeItem.tsx
@@ -30,7 +30,9 @@ export const TreeItem: React.FunctionComponent<{
}> = ({ title, loadChildren, onClick, expandByDefault, depth, selected, style }) => {
const [expanded, setExpanded] = React.useState(expandByDefault || false);
return
-
{ onClick?.(); setExpanded(!expanded); }} >
+ {
+ onClick?.(); setExpanded(!expanded);
+ }} >
{loadChildren && !!expanded && icons.downArrow()}
{loadChildren && !expanded && icons.rightArrow()}
{!loadChildren && {icons.rightArrow()}}
diff --git a/packages/html-reporter/src/utils.ts b/packages/html-reporter/src/utils.ts
index 65404b2fe7..60dc3c1be9 100644
--- a/packages/html-reporter/src/utils.ts
+++ b/packages/html-reporter/src/utils.ts
@@ -15,26 +15,32 @@
*/
export function msToString(ms: number): string {
- if (!isFinite(ms))
+ if (!isFinite(ms)) {
return '-';
+ }
- if (ms === 0)
+ if (ms === 0) {
return '0ms';
+ }
- if (ms < 1000)
+ if (ms < 1000) {
return ms.toFixed(0) + 'ms';
+ }
const seconds = ms / 1000;
- if (seconds < 60)
+ if (seconds < 60) {
return seconds.toFixed(1) + 's';
+ }
const minutes = seconds / 60;
- if (minutes < 60)
+ if (minutes < 60) {
return minutes.toFixed(1) + 'm';
+ }
const hours = minutes / 60;
- if (hours < 24)
+ if (hours < 24) {
return hours.toFixed(1) + 'h';
+ }
const days = hours / 24;
return days.toFixed(1) + 'd';
@@ -43,8 +49,9 @@ export function msToString(ms: number): string {
// hash string to integer in range [0, 6] for color index, to get same color for same tag
export function hashStringToInt(str: string) {
let hash = 0;
- for (let i = 0; i < str.length; i++)
+ for (let i = 0; i < str.length; i++) {
hash = str.charCodeAt(i) + ((hash << 8) - hash);
+ }
return Math.abs(hash % 6);
}
diff --git a/packages/playwright-core/src/androidServerImpl.ts b/packages/playwright-core/src/androidServerImpl.ts
index f0108e67c7..c45f4ca6bf 100644
--- a/packages/playwright-core/src/androidServerImpl.ts
+++ b/packages/playwright-core/src/androidServerImpl.ts
@@ -32,17 +32,20 @@ export class AndroidServerLauncherImpl {
omitDriverInstall: options.omitDriverInstall,
});
- if (devices.length === 0)
+ if (devices.length === 0) {
throw new Error('No devices found');
+ }
if (options.deviceSerialNumber) {
devices = devices.filter(d => d.serial === options.deviceSerialNumber);
- if (devices.length === 0)
+ if (devices.length === 0) {
throw new Error(`No device with serial number '${options.deviceSerialNumber}' was found`);
+ }
}
- if (devices.length > 1)
+ if (devices.length > 1) {
throw new Error(`More than one device found. Please specify deviceSerialNumber`);
+ }
const device = devices[0];
diff --git a/packages/playwright-core/src/browserServerImpl.ts b/packages/playwright-core/src/browserServerImpl.ts
index dfe960c5ea..73455aa5c0 100644
--- a/packages/playwright-core/src/browserServerImpl.ts
+++ b/packages/playwright-core/src/browserServerImpl.ts
@@ -80,7 +80,8 @@ export class BrowserServerLauncherImpl implements BrowserServerLauncher {
function toProtocolLogger(logger: Logger | undefined): ProtocolLogger | undefined {
return logger ? (direction: 'send' | 'receive', message: object) => {
- if (logger.isEnabled('protocol', 'verbose'))
+ if (logger.isEnabled('protocol', 'verbose')) {
logger.log('protocol', 'verbose', (direction === 'send' ? 'SEND ► ' : '◀ RECV ') + JSON.stringify(message), [], {});
+ }
} : undefined;
}
diff --git a/packages/playwright-core/src/cli/driver.ts b/packages/playwright-core/src/cli/driver.ts
index e48dc2a4d2..5448618562 100644
--- a/packages/playwright-core/src/cli/driver.ts
+++ b/packages/playwright-core/src/cli/driver.ts
@@ -41,8 +41,9 @@ export function runDriver() {
// Certain Language Binding JSON parsers (e.g. .NET) do not like strings with lone surrogates.
const isJavaScriptLanguageBinding = !process.env.PW_LANG_NAME || process.env.PW_LANG_NAME === 'javascript';
const replacer = !isJavaScriptLanguageBinding && (String.prototype as any).toWellFormed ? (key: string, value: any): any => {
- if (typeof value === 'string')
+ if (typeof value === 'string') {
return value.toWellFormed();
+ }
return value;
} : undefined;
dispatcherConnection.onmessage = message => transport.send(JSON.stringify(message, replacer));
@@ -85,8 +86,9 @@ export async function runServer(options: RunServerOptions) {
export async function launchBrowserServer(browserName: string, configFile?: string) {
let options: LaunchServerOptions = {};
- if (configFile)
+ if (configFile) {
options = JSON.parse(fs.readFileSync(configFile).toString());
+ }
const browserType = (playwright as any)[browserName] as BrowserType;
const server = await browserType.launchServer(options);
console.log(server.wsEndpoint());
diff --git a/packages/playwright-core/src/cli/program.ts b/packages/playwright-core/src/cli/program.ts
index 7ce1c4f928..2c0a4b519f 100644
--- a/packages/playwright-core/src/cli/program.ts
+++ b/packages/playwright-core/src/cli/program.ts
@@ -82,42 +82,50 @@ function suggestedBrowsersToInstall() {
function defaultBrowsersToInstall(options: { noShell?: boolean, onlyShell?: boolean }): Executable[] {
let executables = registry.defaultExecutables();
- if (options.noShell)
+ if (options.noShell) {
executables = executables.filter(e => e.name !== 'chromium-headless-shell');
- if (options.onlyShell)
+ }
+ if (options.onlyShell) {
executables = executables.filter(e => e.name !== 'chromium');
+ }
return executables;
}
function checkBrowsersToInstall(args: string[], options: { noShell?: boolean, onlyShell?: boolean }): Executable[] {
- if (options.noShell && options.onlyShell)
+ if (options.noShell && options.onlyShell) {
throw new Error(`Only one of --no-shell and --only-shell can be specified`);
+ }
const faultyArguments: string[] = [];
const executables: Executable[] = [];
const handleArgument = (arg: string) => {
const executable = registry.findExecutable(arg);
- if (!executable || executable.installType === 'none')
+ if (!executable || executable.installType === 'none') {
faultyArguments.push(arg);
- else
+ } else {
executables.push(executable);
- if (executable?.browserName === 'chromium')
+ }
+ if (executable?.browserName === 'chromium') {
executables.push(registry.findExecutable('ffmpeg')!);
+ }
};
for (const arg of args) {
if (arg === 'chromium') {
- if (!options.onlyShell)
+ if (!options.onlyShell) {
handleArgument('chromium');
- if (!options.noShell)
+ }
+ if (!options.noShell) {
handleArgument('chromium-headless-shell');
+ }
} else {
handleArgument(arg);
}
}
- if (faultyArguments.length)
+ if (faultyArguments.length) {
throw new Error(`Invalid installation targets: ${faultyArguments.map(name => `'${name}'`).join(', ')}. Expecting one of: ${suggestedBrowsersToInstall()}`);
+ }
return executables;
}
@@ -132,8 +140,9 @@ program
.option('--no-shell', 'do not install chromium headless shell')
.action(async function(args: string[], options: { withDeps?: boolean, force?: boolean, dryRun?: boolean, shell?: boolean, noShell?: boolean, onlyShell?: boolean }) {
// For '--no-shell' option, commander sets `shell: false` instead.
- if (options.shell === false)
+ if (options.shell === false) {
options.noShell = true;
+ }
if (isLikelyNpxGlobal()) {
console.error(wrapInASCIIBox([
`WARNING: It looks like you are running 'npx playwright install' without first`,
@@ -157,8 +166,9 @@ program
try {
const hasNoArguments = !args.length;
const executables = hasNoArguments ? defaultBrowsersToInstall(options) : checkBrowsersToInstall(args, options);
- if (options.withDeps)
+ if (options.withDeps) {
await registry.installDeps(executables, !!options.dryRun);
+ }
if (options.dryRun) {
for (const executable of executables) {
const version = executable.browserVersion ? `version ` + executable.browserVersion : '';
@@ -167,8 +177,9 @@ program
if (executable.downloadURLs?.length) {
const [url, ...fallbacks] = executable.downloadURLs;
console.log(` Download url: ${url}`);
- for (let i = 0; i < fallbacks.length; ++i)
+ for (let i = 0; i < fallbacks.length; ++i) {
console.log(` Download fallback ${i + 1}: ${fallbacks[i]}`);
+ }
}
console.log(``);
}
@@ -213,10 +224,11 @@ program
.option('--dry-run', 'Do not execute installation commands, only print them')
.action(async function(args: string[], options: { dryRun?: boolean }) {
try {
- if (!args.length)
+ if (!args.length) {
await registry.installDeps(defaultBrowsersToInstall({}), !!options.dryRun);
- else
+ } else {
await registry.installDeps(checkBrowsersToInstall(args, {}), !!options.dryRun);
+ }
} catch (e) {
console.log(`Failed to install browser dependencies\n${e}`);
gracefullyProcessExitDoNotHang(1);
@@ -313,12 +325,15 @@ program
.option('--stdin', 'Accept trace URLs over stdin to update the viewer')
.description('show trace viewer')
.action(function(traces, options) {
- if (options.browser === 'cr')
+ if (options.browser === 'cr') {
options.browser = 'chromium';
- if (options.browser === 'ff')
+ }
+ if (options.browser === 'ff') {
options.browser = 'firefox';
- if (options.browser === 'wk')
+ }
+ if (options.browser === 'wk') {
options.browser = 'webkit';
+ }
const openOptions: TraceViewerServerOptions = {
host: options.host,
@@ -326,10 +341,11 @@ program
isServer: !!options.stdin,
};
- if (options.port !== undefined || options.host !== undefined)
+ if (options.port !== undefined || options.host !== undefined) {
runTraceInBrowser(traces, openOptions).catch(logErrorAndExit);
- else
+ } else {
runTraceViewerApp(traces, options.browser, openOptions, true).catch(logErrorAndExit);
+ }
}).addHelpText('afterAll', `
Examples:
@@ -367,8 +383,9 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
validateOptions(options);
const browserType = lookupBrowserType(options);
const launchOptions: LaunchOptions = extraOptions;
- if (options.channel)
+ if (options.channel) {
launchOptions.channel = options.channel as any;
+ }
launchOptions.handleSIGINT = false;
const contextOptions: BrowserContextOptions =
@@ -378,8 +395,9 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
// In headful mode, use host device scale factor for things to look nice.
// In headless, keep things the way it works in Playwright by default.
// Assume high-dpi on MacOS. TODO: this is not perfect.
- if (!extraOptions.headless)
+ if (!extraOptions.headless) {
contextOptions.deviceScaleFactor = os.platform() === 'darwin' ? 2 : 1;
+ }
// Work around the WebKit GTK scrolling issue.
if (browserType.name() === 'webkit' && process.platform === 'linux') {
@@ -387,11 +405,13 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
delete contextOptions.isMobile;
}
- if (contextOptions.isMobile && browserType.name() === 'firefox')
+ if (contextOptions.isMobile && browserType.name() === 'firefox') {
contextOptions.isMobile = undefined;
+ }
- if (options.blockServiceWorkers)
+ if (options.blockServiceWorkers) {
contextOptions.serviceWorkers = 'block';
+ }
// Proxy
@@ -399,8 +419,9 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
launchOptions.proxy = {
server: options.proxyServer
};
- if (options.proxyBypass)
+ if (options.proxyBypass) {
launchOptions.proxy.bypass = options.proxyBypass;
+ }
}
const browser = await browserType.launch(launchOptions);
@@ -411,8 +432,9 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
process.stdout.write(text);
process.stdout.write('\n-------------8<-------------\n');
const autoExitCondition = process.env.PWTEST_CLI_AUTO_EXIT_WHEN;
- if (autoExitCondition && text.includes(autoExitCondition))
+ if (autoExitCondition && text.includes(autoExitCondition)) {
closeBrowser();
+ }
};
// Make sure we exit abnormally when browser crashes.
const logs: string[] = [];
@@ -434,8 +456,9 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
if (options.viewportSize) {
try {
const [width, height] = options.viewportSize.split(',').map(n => +n);
- if (isNaN(width) || isNaN(height))
+ if (isNaN(width) || isNaN(height)) {
throw new Error('bad values');
+ }
contextOptions.viewport = { width, height };
} catch (e) {
throw new Error('Invalid viewport size format: use "width,height", for example --viewport-size="800,600"');
@@ -459,38 +482,45 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
// User agent
- if (options.userAgent)
+ if (options.userAgent) {
contextOptions.userAgent = options.userAgent;
+ }
// Lang
- if (options.lang)
+ if (options.lang) {
contextOptions.locale = options.lang;
+ }
// Color scheme
- if (options.colorScheme)
+ if (options.colorScheme) {
contextOptions.colorScheme = options.colorScheme as 'dark' | 'light';
+ }
// Timezone
- if (options.timezone)
+ if (options.timezone) {
contextOptions.timezoneId = options.timezone;
+ }
// Storage
- if (options.loadStorage)
+ if (options.loadStorage) {
contextOptions.storageState = options.loadStorage;
+ }
- if (options.ignoreHttpsErrors)
+ if (options.ignoreHttpsErrors) {
contextOptions.ignoreHTTPSErrors = true;
+ }
// HAR
if (options.saveHar) {
contextOptions.recordHar = { path: path.resolve(process.cwd(), options.saveHar), mode: 'minimal' };
- if (options.saveHarGlob)
+ if (options.saveHarGlob) {
contextOptions.recordHar.urlFilter = options.saveHarGlob;
+ }
contextOptions.serviceWorkers = 'block';
}
@@ -502,15 +532,19 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
async function closeBrowser() {
// We can come here multiple times. For example, saving storage creates
// a temporary page and we call closeBrowser again when that page closes.
- if (closingBrowser)
+ if (closingBrowser) {
return;
+ }
closingBrowser = true;
- if (options.saveTrace)
+ if (options.saveTrace) {
await context.tracing.stop({ path: options.saveTrace });
- if (options.saveStorage)
+ }
+ if (options.saveStorage) {
await context.storageState({ path: options.saveStorage }).catch(e => null);
- if (options.saveHar)
+ }
+ if (options.saveHar) {
await context.close();
+ }
await browser.close();
}
@@ -518,8 +552,9 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
page.on('dialog', () => {}); // Prevent dialogs from being automatically dismissed.
page.on('close', () => {
const hasPage = browser.contexts().some(context => context.pages().length > 0);
- if (hasPage)
+ if (hasPage) {
return;
+ }
// Avoid the error when the last page is closed because the browser has been closed.
closeBrowser().catch(() => {});
});
@@ -533,8 +568,9 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
context.setDefaultTimeout(timeout);
context.setDefaultNavigationTimeout(timeout);
- if (options.saveTrace)
+ if (options.saveTrace) {
await context.tracing.start({ screenshots: true, snapshots: true });
+ }
// Omit options that we add automatically for presentation purpose.
delete launchOptions.headless;
@@ -547,10 +583,11 @@ async function launchContext(options: Options, extraOptions: LaunchOptions): Pro
async function openPage(context: BrowserContext, url: string | undefined): Promise {
const page = await context.newPage();
if (url) {
- if (fs.existsSync(url))
+ if (fs.existsSync(url)) {
url = 'file://' + path.resolve(url);
- else if (!url.startsWith('http') && !url.startsWith('file://') && !url.startsWith('about:') && !url.startsWith('data:'))
+ } else if (!url.startsWith('http') && !url.startsWith('file://') && !url.startsWith('about:') && !url.startsWith('data:')) {
url = 'http://' + url;
+ }
await page.goto(url).catch(error => {
if (process.env.PWTEST_CLI_AUTO_EXIT_WHEN && isTargetClosedError(error)) {
// Tests with PWTEST_CLI_AUTO_EXIT_WHEN might close page too fast, resulting
@@ -623,8 +660,9 @@ async function screenshot(options: Options, captureOptions: CaptureOptions, url:
}
async function pdf(options: Options, captureOptions: CaptureOptions, url: string, path: string) {
- if (options.browser !== 'chromium')
+ if (options.browser !== 'chromium') {
throw new Error('PDF creation is only working with Chromium');
+ }
const { context } = await launchContext({ ...options, browser: 'chromium' }, { headless: true });
console.log('Navigating to ' + url);
const page = await openPage(context, url);
@@ -650,27 +688,31 @@ function lookupBrowserType(options: Options): BrowserType {
case 'wk': browserType = playwright.webkit; break;
case 'ff': browserType = playwright.firefox; break;
}
- if (browserType)
+ if (browserType) {
return browserType;
+ }
program.help();
}
function validateOptions(options: Options) {
if (options.device && !(options.device in playwright.devices)) {
const lines = [`Device descriptor not found: '${options.device}', available devices are:`];
- for (const name in playwright.devices)
+ for (const name in playwright.devices) {
lines.push(` "${name}"`);
+ }
throw new Error(lines.join('\n'));
}
- if (options.colorScheme && !['light', 'dark'].includes(options.colorScheme))
+ if (options.colorScheme && !['light', 'dark'].includes(options.colorScheme)) {
throw new Error('Invalid color scheme, should be one of "light", "dark"');
+ }
}
function logErrorAndExit(e: Error) {
- if (process.env.PWDEBUGIMPL)
+ if (process.env.PWDEBUGIMPL) {
console.error(e);
- else
+ } else {
console.error(e.name + ': ' + e.message);
+ }
gracefullyProcessExitDoNotHang(1);
}
@@ -680,8 +722,9 @@ function codegenId(): string {
function commandWithOpenOptions(command: string, description: string, options: any[][]): Command {
let result = program.command(command).description(description);
- for (const option of options)
+ for (const option of options) {
result = result.option(option[0], ...option.slice(1));
+ }
return result
.option('-b, --browser ', 'browser to use, one of cr, chromium, ff, firefox, wk, webkit', 'chromium')
.option('--block-service-workers', 'block service workers')
diff --git a/packages/playwright-core/src/cli/programWithTestStub.ts b/packages/playwright-core/src/cli/programWithTestStub.ts
index 1c11c14ec2..2ccd71b64a 100644
--- a/packages/playwright-core/src/cli/programWithTestStub.ts
+++ b/packages/playwright-core/src/cli/programWithTestStub.ts
@@ -29,8 +29,9 @@ function printPlaywrightTestError(command: string) {
} catch (e) {
}
}
- if (!packages.length)
+ if (!packages.length) {
packages.push('playwright');
+ }
const packageManager = getPackageManager();
if (packageManager === 'yarn') {
console.error(`Please install @playwright/test package before running "yarn playwright ${command}"`);
@@ -63,5 +64,6 @@ function addExternalPlaywrightTestCommands() {
}
}
-if (!process.env.PW_LANG_NAME)
+if (!process.env.PW_LANG_NAME) {
addExternalPlaywrightTestCommands();
+}
diff --git a/packages/playwright-core/src/client/android.ts b/packages/playwright-core/src/client/android.ts
index 07912bfbdd..3e9ea44341 100644
--- a/packages/playwright-core/src/client/android.ts
+++ b/packages/playwright-core/src/client/android.ts
@@ -58,8 +58,9 @@ export class Android extends ChannelOwner implements ap
}
async launchServer(options: types.LaunchServerOptions = {}): Promise {
- if (!this._serverLauncher)
+ if (!this._serverLauncher) {
throw new Error('Launching server is not supported');
+ }
return await this._serverLauncher.launchServer(options);
}
@@ -78,7 +79,7 @@ export class Android extends ChannelOwner implements ap
let device: AndroidDevice;
let closeError: string | undefined;
const onPipeClosed = () => {
- device?._didClose();
+ device._didClose();
connection.close(closeError);
};
pipe.on('closed', onPipeClosed);
@@ -143,8 +144,9 @@ export class AndroidDevice extends ChannelOwner i
private _onWebViewRemoved(socketName: string) {
const view = this._webViews.get(socketName);
this._webViews.delete(socketName);
- if (view)
+ if (view) {
view.emit(Events.AndroidWebView.Close);
+ }
}
setDefaultTimeout(timeout: number) {
@@ -166,15 +168,18 @@ export class AndroidDevice extends ChannelOwner i
async webView(selector: { pkg?: string; socketName?: string; }, options?: types.TimeoutOptions): Promise {
const predicate = (v: AndroidWebView) => {
- if (selector.pkg)
+ if (selector.pkg) {
return v.pkg() === selector.pkg;
- if (selector.socketName)
+ }
+ if (selector.socketName) {
return v._socketName() === selector.socketName;
+ }
return false;
};
const webView = [...this._webViews.values()].find(predicate);
- if (webView)
+ if (webView) {
return webView;
+ }
return await this.waitForEvent('webview', { ...options, predicate });
}
@@ -229,8 +234,9 @@ export class AndroidDevice extends ChannelOwner i
async screenshot(options: { path?: string } = {}): Promise {
const { binary } = await this._channel.screenshot();
- if (options.path)
+ if (options.path) {
await fs.promises.writeFile(options.path, binary);
+ }
return binary;
}
@@ -240,13 +246,15 @@ export class AndroidDevice extends ChannelOwner i
async close() {
try {
- if (this._shouldCloseConnectionOnClose)
+ if (this._shouldCloseConnectionOnClose) {
this._connection.close();
- else
+ } else {
await this._channel.close();
+ }
} catch (e) {
- if (isTargetClosedError(e))
+ if (isTargetClosedError(e)) {
return;
+ }
throw e;
}
}
@@ -286,8 +294,9 @@ export class AndroidDevice extends ChannelOwner i
const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;
const waiter = Waiter.createForEvent(this, event);
waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);
- if (event !== Events.AndroidDevice.Close)
+ if (event !== Events.AndroidDevice.Close) {
waiter.rejectOnEvent(this, Events.AndroidDevice.Close, () => new TargetClosedError());
+ }
const result = await waiter.waitForEvent(this, event, predicate as any);
waiter.dispose();
return result;
@@ -320,8 +329,9 @@ export class AndroidSocket extends ChannelOwner i
}
async function loadFile(file: string | Buffer): Promise {
- if (isString(file))
+ if (isString(file)) {
return await fs.promises.readFile(file);
+ }
return file;
}
@@ -375,10 +385,12 @@ function toSelectorChannel(selector: api.AndroidSelector): channels.AndroidSelec
} = selector;
const toRegex = (value: RegExp | string | undefined): string | undefined => {
- if (value === undefined)
+ if (value === undefined) {
return undefined;
- if (isRegExp(value))
+ }
+ if (isRegExp(value)) {
return value.source;
+ }
return '^' + value.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&').replace(/-/g, '\\x2d') + '$';
};
@@ -427,8 +439,9 @@ export class AndroidWebView extends EventEmitter implements api.AndroidWebView {
}
async page(): Promise {
- if (!this._pagePromise)
+ if (!this._pagePromise) {
this._pagePromise = this._fetchPage();
+ }
return await this._pagePromise;
}
diff --git a/packages/playwright-core/src/client/artifact.ts b/packages/playwright-core/src/client/artifact.ts
index c3a53c0294..7f07d8e0f2 100644
--- a/packages/playwright-core/src/client/artifact.ts
+++ b/packages/playwright-core/src/client/artifact.ts
@@ -27,8 +27,9 @@ export class Artifact extends ChannelOwner {
}
async pathAfterFinished(): Promise {
- if (this._connection.isRemote())
+ if (this._connection.isRemote()) {
throw new Error(`Path is not available when connecting remotely. Use saveAs() to save a local copy.`);
+ }
return (await this._channel.pathAfterFinished()).value;
}
diff --git a/packages/playwright-core/src/client/browser.ts b/packages/playwright-core/src/client/browser.ts
index be47ddeb51..b5f4bd56f3 100644
--- a/packages/playwright-core/src/client/browser.ts
+++ b/packages/playwright-core/src/client/browser.ts
@@ -65,8 +65,9 @@ export class Browser extends ChannelOwner implements ap
return await this._wrapApiCall(async () => {
for (const context of this._contexts) {
await this._browserType._willCloseContext(context);
- for (const page of context.pages())
+ for (const page of context.pages()) {
page._onClose();
+ }
context._onClose();
}
return await this._innerNewContext(options, true);
@@ -138,14 +139,16 @@ export class Browser extends ChannelOwner implements ap
async close(options: { reason?: string } = {}): Promise {
this._closeReason = options.reason;
try {
- if (this._shouldCloseConnectionOnClose)
+ if (this._shouldCloseConnectionOnClose) {
this._connection.close();
- else
+ } else {
await this._channel.close(options);
+ }
await this._closedPromise;
} catch (e) {
- if (isTargetClosedError(e))
+ if (isTargetClosedError(e)) {
return;
+ }
throw e;
}
}
diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.ts
index 5ff432ec60..28afee001e 100644
--- a/packages/playwright-core/src/client/browserContext.ts
+++ b/packages/playwright-core/src/client/browserContext.ts
@@ -79,8 +79,9 @@ export class BrowserContext extends ChannelOwner
constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.BrowserContextInitializer) {
super(parent, type, guid, initializer);
- if (parent instanceof Browser)
+ if (parent instanceof Browser) {
this._browser = parent;
+ }
this._browser?._contexts.add(this);
this._isChromium = this._browser?._name === 'chromium';
this.tracing = Tracing.from(initializer.tracing);
@@ -107,31 +108,35 @@ export class BrowserContext extends ChannelOwner
const consoleMessage = new ConsoleMessage(event);
this.emit(Events.BrowserContext.Console, consoleMessage);
const page = consoleMessage.page();
- if (page)
+ if (page) {
page.emit(Events.Page.Console, consoleMessage);
+ }
});
this._channel.on('pageError', ({ error, page }) => {
const pageObject = Page.from(page);
const parsedError = parseError(error);
this.emit(Events.BrowserContext.WebError, new WebError(pageObject, parsedError));
- if (pageObject)
+ if (pageObject) {
pageObject.emit(Events.Page.PageError, parsedError);
+ }
});
this._channel.on('dialog', ({ dialog }) => {
const dialogObject = Dialog.from(dialog);
let hasListeners = this.emit(Events.BrowserContext.Dialog, dialogObject);
const page = dialogObject.page();
- if (page)
+ if (page) {
hasListeners = page.emit(Events.Page.Dialog, dialogObject) || hasListeners;
+ }
if (!hasListeners) {
// Although we do similar handling on the server side, we still need this logic
// on the client side due to a possible race condition between two async calls:
// a) removing "dialog" listener subscription (client->server)
// b) actual "dialog" event (server->client)
- if (dialogObject.type() === 'beforeunload')
+ if (dialogObject.type() === 'beforeunload') {
dialog.accept({}).catch(() => {});
- else
+ } else {
dialog.dismiss().catch(() => {});
+ }
}
});
this._channel.on('request', ({ request, page }) => this._onRequest(network.Request.from(request), Page.fromNullable(page)));
@@ -152,36 +157,41 @@ export class BrowserContext extends ChannelOwner
_setOptions(contextOptions: channels.BrowserNewContextParams, browserOptions: LaunchOptions) {
this._options = contextOptions;
- if (this._options.recordHar)
+ if (this._options.recordHar) {
this._harRecorders.set('', { path: this._options.recordHar.path, content: this._options.recordHar.content });
+ }
this.tracing._tracesDir = browserOptions.tracesDir;
}
private _onPage(page: Page): void {
this._pages.add(page);
this.emit(Events.BrowserContext.Page, page);
- if (page._opener && !page._opener.isClosed())
+ if (page._opener && !page._opener.isClosed()) {
page._opener.emit(Events.Page.Popup, page);
+ }
}
private _onRequest(request: network.Request, page: Page | null) {
this.emit(Events.BrowserContext.Request, request);
- if (page)
+ if (page) {
page.emit(Events.Page.Request, request);
+ }
}
private _onResponse(response: network.Response, page: Page | null) {
this.emit(Events.BrowserContext.Response, response);
- if (page)
+ if (page) {
page.emit(Events.Page.Response, response);
+ }
}
private _onRequestFailed(request: network.Request, responseEndTiming: number, failureText: string | undefined, page: Page | null) {
request._failureText = failureText || null;
request._setResponseEndTiming(responseEndTiming);
this.emit(Events.BrowserContext.RequestFailed, request);
- if (page)
+ if (page) {
page.emit(Events.Page.RequestFailed, request);
+ }
}
private _onRequestFinished(params: channels.BrowserContextRequestFinishedEvent) {
@@ -191,10 +201,12 @@ export class BrowserContext extends ChannelOwner
const page = Page.fromNullable(params.page);
request._setResponseEndTiming(responseEndTiming);
this.emit(Events.BrowserContext.RequestFinished, request);
- if (page)
+ if (page) {
page.emit(Events.Page.RequestFinished, request);
- if (response)
+ }
+ if (response) {
response._finishedPromise.resolve(null);
+ }
}
async _onRoute(route: network.Route) {
@@ -203,20 +215,26 @@ export class BrowserContext extends ChannelOwner
const routeHandlers = this._routes.slice();
for (const routeHandler of routeHandlers) {
// If the page or the context was closed we stall all requests right away.
- if (page?._closeWasCalled || this._closeWasCalled)
+ if (page?._closeWasCalled || this._closeWasCalled) {
return;
- if (!routeHandler.matches(route.request().url()))
+ }
+ if (!routeHandler.matches(route.request().url())) {
continue;
+ }
const index = this._routes.indexOf(routeHandler);
- if (index === -1)
+ if (index === -1) {
continue;
- if (routeHandler.willExpire())
+ }
+ if (routeHandler.willExpire()) {
this._routes.splice(index, 1);
+ }
const handled = await routeHandler.handle(route);
- if (!this._routes.length)
+ if (!this._routes.length) {
this._wrapApiCall(() => this._updateInterceptionPatterns(), true).catch(() => {});
- if (handled)
+ }
+ if (handled) {
return;
+ }
}
// If the page is closed or unrouteAll() was called without waiting and interception disabled,
// the method will throw an error - silence it.
@@ -225,16 +243,18 @@ export class BrowserContext extends ChannelOwner
async _onWebSocketRoute(webSocketRoute: network.WebSocketRoute) {
const routeHandler = this._webSocketRoutes.find(route => route.matches(webSocketRoute.url()));
- if (routeHandler)
+ if (routeHandler) {
await routeHandler.handle(webSocketRoute);
- else
+ } else {
webSocketRoute.connectToServer();
+ }
}
async _onBinding(bindingCall: BindingCall) {
const func = this._bindings.get(bindingCall._initializer.name);
- if (!func)
+ if (!func) {
return;
+ }
await bindingCall.call(func);
}
@@ -261,16 +281,19 @@ export class BrowserContext extends ChannelOwner
}
async newPage(): Promise {
- if (this._ownerPage)
+ if (this._ownerPage) {
throw new Error('Please use browser.newContext()');
+ }
return Page.from((await this._channel.newPage()).page);
}
async cookies(urls?: string | string[]): Promise {
- if (!urls)
+ if (!urls) {
urls = [];
- if (urls && typeof urls === 'string')
+ }
+ if (urls && typeof urls === 'string') {
urls = [urls];
+ }
return (await this._channel.cookies({ urls: urls as string[] })).cookies;
}
@@ -380,10 +403,11 @@ export class BrowserContext extends ChannelOwner
const removed = [];
const remaining = [];
for (const route of this._routes) {
- if (urlMatchesEqual(route.url, url) && (!handler || route.handler === handler))
+ if (urlMatchesEqual(route.url, url) && (!handler || route.handler === handler)) {
removed.push(route);
- else
+ } else {
remaining.push(route);
+ }
}
await this._unrouteInternal(removed, remaining, 'default');
}
@@ -391,8 +415,9 @@ export class BrowserContext extends ChannelOwner
private async _unrouteInternal(removed: network.RouteHandler[], remaining: network.RouteHandler[], behavior?: 'wait'|'ignoreErrors'|'default'): Promise {
this._routes = remaining;
await this._updateInterceptionPatterns();
- if (!behavior || behavior === 'default')
+ if (!behavior || behavior === 'default') {
return;
+ }
const promises = removed.map(routeHandler => routeHandler.stop(behavior));
await Promise.all(promises);
}
@@ -417,8 +442,9 @@ export class BrowserContext extends ChannelOwner
const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;
const waiter = Waiter.createForEvent(this, event);
waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);
- if (event !== Events.BrowserContext.Close)
+ if (event !== Events.BrowserContext.Close) {
waiter.rejectOnEvent(this, Events.BrowserContext.Close, () => new TargetClosedError(this._effectiveCloseReason()));
+ }
const result = await waiter.waitForEvent(this, event, predicate as any);
waiter.dispose();
return result;
@@ -444,16 +470,18 @@ export class BrowserContext extends ChannelOwner
async newCDPSession(page: Page | Frame): Promise {
// channelOwner.ts's validation messages don't handle the pseudo-union type, so we're explicit here
- if (!(page instanceof Page) && !(page instanceof Frame))
+ if (!(page instanceof Page) && !(page instanceof Frame)) {
throw new Error('page: expected Page or Frame');
+ }
const result = await this._channel.newCDPSession(page instanceof Page ? { page: page._channel } : { frame: page._channel });
return CDPSession.from(result.session);
}
_onClose() {
- if (this._browser)
+ if (this._browser) {
this._browser._contexts.delete(this);
- this._browserType?._contexts?.delete(this);
+ }
+ this._browserType?._contexts.delete(this);
this._disposeHarRouters();
this.tracing._resetStackCounter();
this.emit(Events.BrowserContext.Close, this);
@@ -464,8 +492,9 @@ export class BrowserContext extends ChannelOwner
}
async close(options: { reason?: string } = {}): Promise {
- if (this._closeWasCalled)
+ if (this._closeWasCalled) {
return;
+ }
this._closeReason = options.reason;
this._closeWasCalled = true;
await this._wrapApiCall(async () => {
@@ -498,8 +527,9 @@ export class BrowserContext extends ChannelOwner
}
async function prepareStorageState(options: BrowserContextOptions): Promise {
- if (typeof options.storageState !== 'string')
+ if (typeof options.storageState !== 'string') {
return options.storageState;
+ }
try {
return JSON.parse(await fs.promises.readFile(options.storageState, 'utf8'));
} catch (e) {
@@ -509,8 +539,9 @@ async function prepareStorageState(options: BrowserContextOptions): Promise {
- if (options.videoSize && !options.videosPath)
+ if (options.videoSize && !options.videosPath) {
throw new Error(`"videoSize" option requires "videosPath" to be specified`);
- if (options.extraHTTPHeaders)
+ }
+ if (options.extraHTTPHeaders) {
network.validateHeaders(options.extraHTTPHeaders);
+ }
const contextParams: channels.BrowserNewContextParams = {
...options,
viewport: options.viewport === null ? undefined : options.viewport,
@@ -546,28 +579,34 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
size: options.videoSize
};
}
- if (contextParams.recordVideo && contextParams.recordVideo.dir)
+ if (contextParams.recordVideo && contextParams.recordVideo.dir) {
contextParams.recordVideo.dir = path.resolve(process.cwd(), contextParams.recordVideo.dir);
+ }
return contextParams;
}
function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
- if (acceptDownloads === undefined)
+ if (acceptDownloads === undefined) {
return undefined;
- if (acceptDownloads)
+ }
+ if (acceptDownloads) {
return 'accept';
+ }
return 'deny';
}
export async function toClientCertificatesProtocol(certs?: BrowserContextOptions['clientCertificates']): Promise {
- if (!certs)
+ if (!certs) {
return undefined;
+ }
const bufferizeContent = async (value?: Buffer, path?: string): Promise => {
- if (value)
+ if (value) {
return value;
- if (path)
+ }
+ if (path) {
return await fs.promises.readFile(path);
+ }
};
return await Promise.all(certs.map(async cert => ({
diff --git a/packages/playwright-core/src/client/browserType.ts b/packages/playwright-core/src/client/browserType.ts
index 06672cc64e..d4eb59ff5a 100644
--- a/packages/playwright-core/src/client/browserType.ts
+++ b/packages/playwright-core/src/client/browserType.ts
@@ -56,8 +56,9 @@ export class BrowserType extends ChannelOwner imple
}
executablePath(): string {
- if (!this._initializer.executablePath)
+ if (!this._initializer.executablePath) {
throw new Error('Browser is not supported on current platform');
+ }
return this._initializer.executablePath;
}
@@ -85,8 +86,9 @@ export class BrowserType extends ChannelOwner imple
}
async launchServer(options: LaunchServerOptions = {}): Promise {
- if (!this._serverLauncher)
+ if (!this._serverLauncher) {
throw new Error('Launching server is not supported');
+ }
options = { ...this._defaultLaunchOptions, ...options };
return await this._serverLauncher.launchServer(options);
}
@@ -115,8 +117,9 @@ export class BrowserType extends ChannelOwner imple
connect(options: api.ConnectOptions & { wsEndpoint: string }): Promise;
connect(wsEndpoint: string, options?: api.ConnectOptions): Promise;
async connect(optionsOrWsEndpoint: string | (api.ConnectOptions & { wsEndpoint: string }), options?: api.ConnectOptions): Promise{
- if (typeof optionsOrWsEndpoint === 'string')
+ if (typeof optionsOrWsEndpoint === 'string') {
return await this._connect({ ...options, wsEndpoint: optionsOrWsEndpoint });
+ }
assert(optionsOrWsEndpoint.wsEndpoint, 'options.wsEndpoint is required');
return await this._connect(optionsOrWsEndpoint);
}
@@ -134,8 +137,9 @@ export class BrowserType extends ChannelOwner imple
slowMo: params.slowMo,
timeout: params.timeout,
};
- if ((params as any).__testHookRedirectPortForwarding)
+ if ((params as any).__testHookRedirectPortForwarding) {
connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
+ }
const { pipe, headers: connectHeaders } = await localUtils._channel.connect(connectParams);
const closePipe = () => pipe.close().catch(() => {});
const connection = new Connection(localUtils, this._instrumentation);
@@ -146,9 +150,10 @@ export class BrowserType extends ChannelOwner imple
let closeError: string | undefined;
const onPipeClosed = (reason?: string) => {
// Emulate all pages, contexts and the browser closing upon disconnect.
- for (const context of browser?.contexts() || []) {
- for (const page of context.pages())
+ for (const context of browser.contexts() || []) {
+ for (const page of context.pages()) {
page._onClose();
+ }
context._onClose();
}
connection.close(reason || closeError);
@@ -158,7 +163,7 @@ export class BrowserType extends ChannelOwner imple
// here and promises did not have a chance to reject.
// The order of rejects vs closure is a part of the API contract and our test runner
// relies on it to attribute rejections to the right test.
- setTimeout(() => browser?._didClose(), 0);
+ setTimeout(() => browser._didClose(), 0);
};
pipe.on('closed', params => onPipeClosed(params.reason));
connection.onmessage = message => this._wrapApiCall(() => pipe.send({ message }).catch(() => onPipeClosed()), /* isInternal */ true);
@@ -174,8 +179,9 @@ export class BrowserType extends ChannelOwner imple
const result = await raceAgainstDeadline(async () => {
// For tests.
- if ((params as any).__testHookBeforeCreateBrowser)
+ if ((params as any).__testHookBeforeCreateBrowser) {
await (params as any).__testHookBeforeCreateBrowser();
+ }
const playwright = await connection!.initializePlaywright();
if (!playwright._initializer.preLaunchedBrowser) {
@@ -202,16 +208,18 @@ export class BrowserType extends ChannelOwner imple
async connectOverCDP(options: api.ConnectOverCDPOptions & { wsEndpoint?: string }): Promise;
async connectOverCDP(endpointURL: string, options?: api.ConnectOverCDPOptions): Promise;
async connectOverCDP(endpointURLOrOptions: (api.ConnectOverCDPOptions & { wsEndpoint?: string })|string, options?: api.ConnectOverCDPOptions) {
- if (typeof endpointURLOrOptions === 'string')
+ if (typeof endpointURLOrOptions === 'string') {
return await this._connectOverCDP(endpointURLOrOptions, options);
+ }
const endpointURL = 'endpointURL' in endpointURLOrOptions ? endpointURLOrOptions.endpointURL : endpointURLOrOptions.wsEndpoint;
assert(endpointURL, 'Cannot connect over CDP without wsEndpoint.');
return await this.connectOverCDP(endpointURL, endpointURLOrOptions);
}
async _connectOverCDP(endpointURL: string, params: api.ConnectOverCDPOptions = {}): Promise {
- if (this.name() !== 'chromium')
+ if (this.name() !== 'chromium') {
throw new Error('Connecting over CDP is only supported in Chromium.');
+ }
const headers = params.headers ? headersObjectToArray(params.headers) : undefined;
const result = await this._channel.connectOverCDP({
endpointURL,
@@ -221,8 +229,9 @@ export class BrowserType extends ChannelOwner imple
});
const browser = Browser.from(result.browser);
this._didLaunchBrowser(browser, {}, params.logger);
- if (result.defaultContext)
+ if (result.defaultContext) {
await this._didCreateContext(BrowserContext.from(result.defaultContext), {}, {}, params.logger);
+ }
return browser;
}
@@ -237,10 +246,12 @@ export class BrowserType extends ChannelOwner imple
context._browserType = this;
this._contexts.add(context);
context._setOptions(contextOptions, browserOptions);
- if (this._defaultContextTimeout !== undefined)
+ if (this._defaultContextTimeout !== undefined) {
context.setDefaultTimeout(this._defaultContextTimeout);
- if (this._defaultContextNavigationTimeout !== undefined)
+ }
+ if (this._defaultContextNavigationTimeout !== undefined) {
context.setDefaultNavigationTimeout(this._defaultContextNavigationTimeout);
+ }
await this._instrumentation.runAfterCreateBrowserContext(context);
}
diff --git a/packages/playwright-core/src/client/channelOwner.ts b/packages/playwright-core/src/client/channelOwner.ts
index a5d753507b..a0f5e127f0 100644
--- a/packages/playwright-core/src/client/channelOwner.ts
+++ b/packages/playwright-core/src/client/channelOwner.ts
@@ -80,37 +80,42 @@ export abstract class ChannelOwner(func: (apiZone: ApiZone) => Promise, isInternal?: boolean): Promise {
const logger = this._logger;
const apiZone = zones.zoneData('apiZone');
- if (apiZone)
+ if (apiZone) {
return await func(apiZone);
+ }
const stackTrace = captureLibraryStackTrace();
let apiName: string | undefined = stackTrace.apiName;
const frames: channels.StackFrame[] = stackTrace.frames;
- if (isInternal === undefined)
+ if (isInternal === undefined) {
isInternal = this._isInternalType;
- if (isInternal)
+ }
+ if (isInternal) {
apiName = undefined;
+ }
// Enclosing zone could have provided the apiName and wallTime.
const expectZone = zones.zoneData('expectZone');
const stepId = expectZone?.stepId;
- if (!isInternal && expectZone)
+ if (!isInternal && expectZone) {
apiName = expectZone.title;
+ }
// If we are coming from the expectZone, there is no need to generate a new
// step for the API call, since it will be generated by the expect itself.
@@ -203,13 +214,15 @@ export abstract class ChannelOwner\n' + e.stack : '';
- if (apiName && !apiName.includes(''))
+ if (apiName && !apiName.includes('')) {
e.message = apiName + ': ' + e.message;
+ }
const stackFrames = '\n' + stringifyStackFrames(stackTrace.frames).join('\n') + innerError;
- if (stackFrames.trim())
+ if (stackFrames.trim()) {
e.stack = e.message + stackFrames;
- else
+ } else {
e.stack = '';
+ }
csi?.onApiCallEnd(callCookie, e);
logApiCall(logger, `<= ${apiName} failed`, isInternal);
throw e;
@@ -233,16 +246,19 @@ export abstract class ChannelOwner {
- if (typeof prop !== 'string')
+ if (typeof prop !== 'string') {
return obj[prop];
- if (prop === 'addListener')
+ }
+ if (prop === 'addListener') {
return (listener: ClientInstrumentationListener) => listeners.push(listener);
- if (prop === 'removeListener')
+ }
+ if (prop === 'removeListener') {
return (listener: ClientInstrumentationListener) => listeners.splice(listeners.indexOf(listener), 1);
- if (prop === 'removeAllListeners')
+ }
+ if (prop === 'removeAllListeners') {
return () => listeners.splice(0, listeners.length);
+ }
if (prop.startsWith('run')) {
return async (...params: any[]) => {
- for (const listener of listeners)
+ for (const listener of listeners) {
await (listener as any)[prop]?.(...params);
+ }
};
}
if (prop.startsWith('on')) {
return (...params: any[]) => {
- for (const listener of listeners)
+ for (const listener of listeners) {
(listener as any)[prop]?.(...params);
+ }
};
}
return obj[prop];
diff --git a/packages/playwright-core/src/client/clock.ts b/packages/playwright-core/src/client/clock.ts
index 73eb538c26..338bf634ed 100644
--- a/packages/playwright-core/src/client/clock.ts
+++ b/packages/playwright-core/src/client/clock.ts
@@ -54,12 +54,15 @@ export class Clock implements api.Clock {
}
function parseTime(time: string | number | Date): { timeNumber?: number, timeString?: string } {
- if (typeof time === 'number')
+ if (typeof time === 'number') {
return { timeNumber: time };
- if (typeof time === 'string')
+ }
+ if (typeof time === 'string') {
return { timeString: time };
- if (!isFinite(time.getTime()))
+ }
+ if (!isFinite(time.getTime())) {
throw new Error(`Invalid date: ${time}`);
+ }
return { timeNumber: time.getTime() };
}
diff --git a/packages/playwright-core/src/client/connection.ts b/packages/playwright-core/src/client/connection.ts
index 75d1878da3..dba0cdd303 100644
--- a/packages/playwright-core/src/client/connection.ts
+++ b/packages/playwright-core/src/client/connection.ts
@@ -112,17 +112,20 @@ export class Connection extends EventEmitter {
}
setIsTracing(isTracing: boolean) {
- if (isTracing)
+ if (isTracing) {
this._tracingCount++;
- else
+ } else {
this._tracingCount--;
+ }
}
async sendMessageToServer(object: ChannelOwner, method: string, params: any, apiName: string | undefined, frames: channels.StackFrame[], stepId?: string): Promise {
- if (this._closedError)
+ if (this._closedError) {
throw this._closedError;
- if (object._wasCollected)
+ }
+ if (object._wasCollected) {
throw new Error('The object has been collected to prevent unbounded heap growth.');
+ }
const guid = object._guid;
const type = object._type;
@@ -134,8 +137,9 @@ export class Connection extends EventEmitter {
}
const location = frames[0] ? { file: frames[0].file, line: frames[0].line, column: frames[0].column } : undefined;
const metadata: channels.Metadata = { apiName, location, internal: !apiName, stepId };
- if (this._tracingCount && frames && type !== 'LocalUtils')
+ if (this._tracingCount && frames && type !== 'LocalUtils') {
this._localUtils?._channel.addStackToTracingNoReply({ callData: { stack: frames, id } }).catch(() => {});
+ }
// We need to exit zones before calling into the server, otherwise
// when we receive events from the server, we would be in an API zone.
zones.exitZones(() => this.onmessage({ ...message, metadata }));
@@ -143,16 +147,19 @@ export class Connection extends EventEmitter {
}
dispatch(message: object) {
- if (this._closedError)
+ if (this._closedError) {
return;
+ }
const { id, guid, method, params, result, error, log } = message as any;
if (id) {
- if (debugLogger.isEnabled('channel'))
+ if (debugLogger.isEnabled('channel')) {
debugLogger.log('channel', ';
const validator = findValidator(type, '', 'Initializer');
initializer = validator(initializer, '', { tChannelImpl: this._tChannelImplFromWire.bind(this), binary: this._rawBuffers ? 'buffer' : 'fromBase64' });
@@ -276,8 +291,9 @@ export class Connection extends EventEmitter {
break;
case 'LocalUtils':
result = new LocalUtils(parent, type, guid, initializer);
- if (!this._localUtils)
+ if (!this._localUtils) {
this._localUtils = result as LocalUtils;
+ }
break;
case 'Page':
result = new Page(parent, type, guid, initializer);
diff --git a/packages/playwright-core/src/client/electron.ts b/packages/playwright-core/src/client/electron.ts
index fe5b6e189e..7d73be023e 100644
--- a/packages/playwright-core/src/client/electron.ts
+++ b/packages/playwright-core/src/client/electron.ts
@@ -74,8 +74,9 @@ export class ElectronApplication extends ChannelOwner this._onPage(page));
this._channel.on('close', () => {
this.emit(Events.ElectronApplication.Close);
@@ -102,8 +103,9 @@ export class ElectronApplication extends ChannelOwner {
- if (this._windows.size)
+ if (this._windows.size) {
return this._windows.values().next().value!;
+ }
return await this.waitForEvent('window', options);
}
@@ -119,8 +121,9 @@ export class ElectronApplication extends ChannelOwner new TargetClosedError());
+ }
const result = await waiter.waitForEvent(this, event, predicate as any);
waiter.dispose();
return result;
diff --git a/packages/playwright-core/src/client/elementHandle.ts b/packages/playwright-core/src/client/elementHandle.ts
index 0a89d3091b..c731781ffb 100644
--- a/packages/playwright-core/src/client/elementHandle.ts
+++ b/packages/playwright-core/src/client/elementHandle.ts
@@ -147,8 +147,9 @@ export class ElementHandle extends JSHandle implements
async setInputFiles(files: string | FilePayload | string[] | FilePayload[], options: channels.ElementHandleSetInputFilesOptions = {}) {
const frame = await this.ownerFrame();
- if (!frame)
+ if (!frame) {
throw new Error('Cannot set input files to detached element');
+ }
const converted = await convertInputFiles(files, frame.page().context());
await this._elementChannel.setInputFiles({ ...converted, ...options });
}
@@ -174,10 +175,11 @@ export class ElementHandle extends JSHandle implements
}
async setChecked(checked: boolean, options?: channels.ElementHandleCheckOptions) {
- if (checked)
+ if (checked) {
await this.check(options);
- else
+ } else {
await this.uncheck(options);
+ }
}
async boundingBox(): Promise {
@@ -187,8 +189,9 @@ export class ElementHandle extends JSHandle implements
async screenshot(options: Omit & { path?: string, mask?: Locator[] } = {}): Promise {
const copy: channels.ElementHandleScreenshotOptions = { ...options, mask: undefined };
- if (!copy.type)
+ if (!copy.type) {
copy.type = determineScreenshotType(options);
+ }
if (options.mask) {
copy.mask = options.mask.map(locator => ({
frame: locator._frame._channel,
@@ -235,18 +238,24 @@ export class ElementHandle extends JSHandle implements
}
export function convertSelectOptionValues(values: string | api.ElementHandle | SelectOption | string[] | api.ElementHandle[] | SelectOption[] | null): { elements?: channels.ElementHandleChannel[], options?: SelectOption[] } {
- if (values === null)
+ if (values === null) {
return {};
- if (!Array.isArray(values))
+ }
+ if (!Array.isArray(values)) {
values = [values as any];
- if (!values.length)
+ }
+ if (!values.length) {
return {};
- for (let i = 0; i < values.length; i++)
+ }
+ for (let i = 0; i < values.length; i++) {
assert(values[i] !== null, `options[${i}]: expected object, got null`);
- if (values[0] instanceof ElementHandle)
+ }
+ if (values[0] instanceof ElementHandle) {
return { elements: (values as ElementHandle[]).map((v: ElementHandle) => v._elementChannel) };
- if (isString(values[0]))
+ }
+ if (isString(values[0])) {
return { options: (values as string[]).map(valueOrLabel => ({ valueOrLabel })) };
+ }
return { options: values as SelectOption[] };
}
@@ -262,16 +271,18 @@ async function resolvePathsAndDirectoryForInputFiles(items: string[]): Promise<[
for (const item of items) {
const stat = await fs.promises.stat(item as string);
if (stat.isDirectory()) {
- if (localDirectory)
+ if (localDirectory) {
throw new Error('Multiple directories are not supported');
+ }
localDirectory = path.resolve(item as string);
} else {
localPaths ??= [];
localPaths.push(path.resolve(item as string));
}
}
- if (localPaths?.length && localDirectory)
+ if (localPaths?.length && localDirectory) {
throw new Error('File paths must be all files or a single directory');
+ }
return [localPaths, localDirectory];
}
@@ -279,8 +290,9 @@ export async function convertInputFiles(files: string | FilePayload | string[] |
const items: (string | FilePayload)[] = Array.isArray(files) ? files.slice() : [files];
if (items.some(item => typeof item === 'string')) {
- if (!items.every(item => typeof item === 'string'))
+ if (!items.every(item => typeof item === 'string')) {
throw new Error('File paths cannot be mixed with buffers');
+ }
const [localPaths, localDirectory] = await resolvePathsAndDirectoryForInputFiles(items);
@@ -312,18 +324,20 @@ export async function convertInputFiles(files: string | FilePayload | string[] |
}
const payloads = items as FilePayload[];
- if (filePayloadExceedsSizeLimit(payloads))
+ if (filePayloadExceedsSizeLimit(payloads)) {
throw new Error('Cannot set buffer larger than 50Mb, please write it to a file and pass its path instead.');
+ }
return { payloads };
}
export function determineScreenshotType(options: { path?: string, type?: 'png' | 'jpeg' }): 'png' | 'jpeg' | undefined {
if (options.path) {
const mimeType = mime.getType(options.path);
- if (mimeType === 'image/png')
+ if (mimeType === 'image/png') {
return 'png';
- else if (mimeType === 'image/jpeg')
+ } else if (mimeType === 'image/jpeg') {
return 'jpeg';
+ }
throw new Error(`path: unsupported mime type "${mimeType}"`);
}
return options.type;
diff --git a/packages/playwright-core/src/client/errors.ts b/packages/playwright-core/src/client/errors.ts
index 51555202e5..fdcfc1e1ac 100644
--- a/packages/playwright-core/src/client/errors.ts
+++ b/packages/playwright-core/src/client/errors.ts
@@ -36,15 +36,17 @@ export function isTargetClosedError(error: Error) {
}
export function serializeError(e: any): SerializedError {
- if (isError(e))
+ if (isError(e)) {
return { error: { message: e.message, stack: e.stack, name: e.name } };
+ }
return { value: serializeValue(e, value => ({ fallThrough: value })) };
}
export function parseError(error: SerializedError): Error {
if (!error.error) {
- if (error.value === undefined)
+ if (error.value === undefined) {
throw new Error('Serialized error must have either an error or a value');
+ }
return parseSerializedValue(error.value, undefined);
}
if (error.error.name === 'TimeoutError') {
diff --git a/packages/playwright-core/src/client/eventEmitter.ts b/packages/playwright-core/src/client/eventEmitter.ts
index c0375a70dc..01d620225d 100644
--- a/packages/playwright-core/src/client/eventEmitter.ts
+++ b/packages/playwright-core/src/client/eventEmitter.ts
@@ -48,8 +48,9 @@ export class EventEmitter implements EventEmitterType {
}
setMaxListeners(n: number): this {
- if (typeof n !== 'number' || n < 0 || Number.isNaN(n))
+ if (typeof n !== 'number' || n < 0 || Number.isNaN(n)) {
throw new RangeError('The value of "n" is out of range. It must be a non-negative number. Received ' + n + '.');
+ }
this._maxListeners = n;
return this;
}
@@ -60,28 +61,32 @@ export class EventEmitter implements EventEmitterType {
emit(type: EventType, ...args: any[]): boolean {
const events = this._events;
- if (events === undefined)
+ if (events === undefined) {
return false;
+ }
- const handler = events?.[type];
- if (handler === undefined)
+ const handler = events[type];
+ if (handler === undefined) {
return false;
+ }
if (typeof handler === 'function') {
this._callHandler(type, handler, args);
} else {
const len = handler.length;
const listeners = handler.slice();
- for (let i = 0; i < len; ++i)
+ for (let i = 0; i < len; ++i) {
this._callHandler(type, listeners[i], args);
+ }
}
return true;
}
private _callHandler(type: EventType, handler: Listener, args: any[]): void {
const promise = Reflect.apply(handler, this, args);
- if (!(promise instanceof Promise))
+ if (!(promise instanceof Promise)) {
return;
+ }
let set = this._pendingHandlers.get(type);
if (!set) {
set = new Set();
@@ -89,10 +94,11 @@ export class EventEmitter implements EventEmitterType {
}
set.add(promise);
promise.catch(e => {
- if (this._rejectionHandler)
+ if (this._rejectionHandler) {
this._rejectionHandler(e);
- else
+ } else {
throw e;
+ }
}).finally(() => set.delete(promise));
}
@@ -183,20 +189,23 @@ export class EventEmitter implements EventEmitterType {
checkListener(listener);
const events = this._events;
- if (events === undefined)
+ if (events === undefined) {
return this;
+ }
const list = events[type];
- if (list === undefined)
+ if (list === undefined) {
return this;
+ }
if (list === listener || (list as any).listener === listener) {
if (--this._eventsCount === 0) {
this._events = Object.create(null);
} else {
delete events[type];
- if (events.removeListener)
+ if (events.removeListener) {
this.emit('removeListener', type, (list as any).listener ?? listener);
+ }
}
} else if (typeof list !== 'function') {
let position = -1;
@@ -210,19 +219,23 @@ export class EventEmitter implements EventEmitterType {
}
}
- if (position < 0)
+ if (position < 0) {
return this;
+ }
- if (position === 0)
+ if (position === 0) {
list.shift();
- else
+ } else {
list.splice(position, 1);
+ }
- if (list.length === 1)
+ if (list.length === 1) {
events[type] = list[0];
+ }
- if (events.removeListener !== undefined)
+ if (events.removeListener !== undefined) {
this.emit('removeListener', type, originalListener || listener);
+ }
}
return this;
@@ -237,21 +250,24 @@ export class EventEmitter implements EventEmitterType {
removeAllListeners(type: EventType | undefined, options: { behavior?: 'wait'|'ignoreErrors'|'default' }): Promise;
removeAllListeners(type?: string, options?: { behavior?: 'wait'|'ignoreErrors'|'default' }): this | Promise {
this._removeAllListeners(type);
- if (!options)
+ if (!options) {
return this;
+ }
if (options.behavior === 'wait') {
const errors: Error[] = [];
this._rejectionHandler = error => errors.push(error);
// eslint-disable-next-line internal-playwright/await-promise-in-class-returns
return this._waitFor(type).then(() => {
- if (errors.length)
+ if (errors.length) {
throw errors[0];
+ }
});
}
- if (options.behavior === 'ignoreErrors')
+ if (options.behavior === 'ignoreErrors') {
this._rejectionHandler = () => {};
+ }
// eslint-disable-next-line internal-playwright/await-promise-in-class-returns
return Promise.resolve();
@@ -259,8 +275,9 @@ export class EventEmitter implements EventEmitterType {
private _removeAllListeners(type?: string) {
const events = this._events;
- if (!events)
+ if (!events) {
return;
+ }
// not listening for removeListener, no need to emit
if (!events.removeListener) {
@@ -268,10 +285,11 @@ export class EventEmitter implements EventEmitterType {
this._events = Object.create(null);
this._eventsCount = 0;
} else if (events[type] !== undefined) {
- if (--this._eventsCount === 0)
+ if (--this._eventsCount === 0) {
this._events = Object.create(null);
- else
+ } else {
delete events[type];
+ }
}
return;
}
@@ -282,8 +300,9 @@ export class EventEmitter implements EventEmitterType {
let key;
for (let i = 0; i < keys.length; ++i) {
key = keys[i];
- if (key === 'removeListener')
+ if (key === 'removeListener') {
continue;
+ }
this._removeAllListeners(key);
}
this._removeAllListeners('removeListener');
@@ -298,8 +317,9 @@ export class EventEmitter implements EventEmitterType {
this.removeListener(type, listeners);
} else if (listeners !== undefined) {
// LIFO order
- for (let i = listeners.length - 1; i >= 0; i--)
+ for (let i = listeners.length - 1; i >= 0; i--) {
this.removeListener(type, listeners[i]);
+ }
}
}
@@ -315,10 +335,12 @@ export class EventEmitter implements EventEmitterType {
const events = this._events;
if (events !== undefined) {
const listener = events[type];
- if (typeof listener === 'function')
+ if (typeof listener === 'function') {
return 1;
- if (listener !== undefined)
+ }
+ if (listener !== undefined) {
return listener.length;
+ }
}
return 0;
}
@@ -333,8 +355,9 @@ export class EventEmitter implements EventEmitterType {
promises = [...(this._pendingHandlers.get(type) || [])];
} else {
promises = [];
- for (const [, pending] of this._pendingHandlers)
+ for (const [, pending] of this._pendingHandlers) {
promises.push(...pending);
+ }
}
await Promise.all(promises);
}
@@ -342,23 +365,27 @@ export class EventEmitter implements EventEmitterType {
private _listeners(target: EventEmitter, type: EventType, unwrap: boolean): Listener[] {
const events = target._events;
- if (events === undefined)
+ if (events === undefined) {
return [];
+ }
const listener = events[type];
- if (listener === undefined)
+ if (listener === undefined) {
return [];
+ }
- if (typeof listener === 'function')
+ if (typeof listener === 'function') {
return unwrap ? [unwrapListener(listener)] : [listener];
+ }
return unwrap ? unwrapListeners(listener) : listener.slice();
}
}
function checkListener(listener: any) {
- if (typeof listener !== 'function')
+ if (typeof listener !== 'function') {
throw new TypeError('The "listener" argument must be of type Function. Received type ' + typeof listener);
+ }
}
class OnceWrapper {
@@ -377,8 +404,9 @@ class OnceWrapper {
}
private _handle(...args: any[]) {
- if (this._fired)
+ if (this._fired) {
return;
+ }
this._fired = true;
this._eventEmitter.removeListener(this._eventType, this.wrapperFunction);
return this._listener.apply(this._eventEmitter, args);
diff --git a/packages/playwright-core/src/client/fetch.ts b/packages/playwright-core/src/client/fetch.ts
index 58928532ac..d508b6fd3a 100644
--- a/packages/playwright-core/src/client/fetch.ts
+++ b/packages/playwright-core/src/client/fetch.ts
@@ -110,8 +110,9 @@ export class APIRequestContext extends ChannelOwner {
return await this._wrapApiCall(async () => {
- if (this._closeReason)
+ if (this._closeReason) {
throw new TargetClosedError(this._closeReason);
+ }
assert(options.request || typeof options.url === 'string', 'First argument must be either URL string or Request');
assert((options.data === undefined ? 0 : 1) + (options.form === undefined ? 0 : 1) + (options.multipart === undefined ? 0 : 1) <= 1, `Only one of 'data', 'form' or 'multipart' can be specified`);
assert(options.maxRedirects === undefined || options.maxRedirects >= 0, `'maxRedirects' must be greater than or equal to '0'`);
@@ -177,10 +179,11 @@ export class APIRequestContext extends ChannelOwner {
if (isFilePayload(value)) {
const payload = value as FilePayload;
- if (!Buffer.isBuffer(payload.buffer))
+ if (!Buffer.isBuffer(payload.buffer)) {
throw new Error(`Unexpected buffer type of 'data.${name}'`);
+ }
return { name, file: filePayloadToJson(payload) };
} else if (value instanceof fs.ReadStream) {
return { name, file: await readStreamToJson(value as fs.ReadStream) };
@@ -284,16 +292,18 @@ async function toFormField(name: string, value: string|number|boolean|fs.ReadStr
}
function isJsonParsable(value: any) {
- if (typeof value !== 'string')
+ if (typeof value !== 'string') {
return false;
+ }
try {
JSON.parse(value);
return true;
} catch (e) {
- if (e instanceof SyntaxError)
+ if (e instanceof SyntaxError) {
return false;
- else
+ } else {
throw e;
+ }
}
}
@@ -335,12 +345,14 @@ export class APIResponse implements api.APIResponse {
async body(): Promise {
try {
const result = await this._request._channel.fetchResponseBody({ fetchUid: this._fetchUid() });
- if (result.binary === undefined)
+ if (result.binary === undefined) {
throw new Error('Response has been disposed');
+ }
return result.binary;
} catch (e) {
- if (isTargetClosedError(e))
+ if (isTargetClosedError(e)) {
throw new Error('Response has been disposed');
+ }
throw e;
}
}
@@ -403,21 +415,25 @@ async function readStreamToJson(stream: fs.ReadStream): Promise implements api.Fr
this._eventEmitter = new EventEmitter();
this._eventEmitter.setMaxListeners(0);
this._parentFrame = Frame.fromNullable(initializer.parentFrame);
- if (this._parentFrame)
+ if (this._parentFrame) {
this._parentFrame._childFrames.add(this);
+ }
this._name = initializer.name;
this._url = initializer.url;
this._loadStates = new Set(initializer.loadStates);
@@ -76,19 +77,23 @@ export class Frame extends ChannelOwner implements api.Fr
this._loadStates.add(event.add);
this._eventEmitter.emit('loadstate', event.add);
}
- if (event.remove)
+ if (event.remove) {
this._loadStates.delete(event.remove);
- if (!this._parentFrame && event.add === 'load' && this._page)
+ }
+ if (!this._parentFrame && event.add === 'load' && this._page) {
this._page.emit(Events.Page.Load, this._page);
- if (!this._parentFrame && event.add === 'domcontentloaded' && this._page)
+ }
+ if (!this._parentFrame && event.add === 'domcontentloaded' && this._page) {
this._page.emit(Events.Page.DOMContentLoaded, this._page);
+ }
});
this._channel.on('navigated', event => {
this._url = event.url;
this._name = event.name;
this._eventEmitter.emit('navigated', event);
- if (!event.error && this._page)
+ if (!event.error && this._page) {
this._page.emit(Events.Page.FrameNavigated, this);
+ }
});
}
@@ -103,8 +108,9 @@ export class Frame extends ChannelOwner implements api.Fr
private _setupNavigationWaiter(options: { timeout?: number }): Waiter {
const waiter = new Waiter(this._page!, '');
- if (this._page!.isClosed())
+ if (this._page!.isClosed()) {
waiter.rejectImmediately(this._page!._closeErrorWithReason());
+ }
waiter.rejectOnEvent(this._page!, Events.Page.Close, () => this._page!._closeErrorWithReason());
waiter.rejectOnEvent(this._page!, Events.Page.Crash, new Error('Navigation failed because page crashed!'));
waiter.rejectOnEvent(this._page!, Events.Page.FrameDetached, new Error('Navigating frame was detached!'), frame => frame === this);
@@ -123,8 +129,9 @@ export class Frame extends ChannelOwner implements api.Fr
const navigatedEvent = await waiter.waitForEvent(this._eventEmitter, 'navigated', event => {
// Any failed navigation results in a rejection.
- if (event.error)
+ if (event.error) {
return true;
+ }
waiter.log(` navigated to "${event.url}"`);
return urlMatches(this._page?.context()._options.baseURL, event.url, options.url);
});
@@ -165,8 +172,9 @@ export class Frame extends ChannelOwner implements api.Fr
}
async waitForURL(url: URLMatch, options: { waitUntil?: LifecycleEvent, timeout?: number } = {}): Promise {
- if (urlMatches(this._page?.context()._options.baseURL, this.url(), url))
+ if (urlMatches(this._page?.context()._options.baseURL, this.url(), url)) {
return await this.waitForLoadState(options.waitUntil, options);
+ }
await this.waitForNavigation({ url, ...options });
}
@@ -201,10 +209,12 @@ export class Frame extends ChannelOwner implements api.Fr
waitForSelector(selector: string, options: channels.FrameWaitForSelectorOptions & { state: 'attached' | 'visible' }): Promise>;
waitForSelector(selector: string, options?: channels.FrameWaitForSelectorOptions): Promise | null>;
async waitForSelector(selector: string, options: channels.FrameWaitForSelectorOptions = {}): Promise | null> {
- if ((options as any).visibility)
+ if ((options as any).visibility) {
throw new Error('options.visibility is not supported, did you mean options.state?');
- if ((options as any).waitFor && (options as any).waitFor !== 'visible')
+ }
+ if ((options as any).waitFor && (options as any).waitFor !== 'visible') {
throw new Error('options.waitFor is not supported, did you mean options.state?');
+ }
const result = await this._channel.waitForSelector({ selector, ...options });
return ElementHandle.fromNullable(result.element) as ElementHandle | null;
}
@@ -421,10 +431,11 @@ export class Frame extends ChannelOwner implements api.Fr
}
async setChecked(selector: string, checked: boolean, options?: channels.FrameCheckOptions) {
- if (checked)
+ if (checked) {
await this.check(selector, options);
- else
+ } else {
await this.uncheck(selector, options);
+ }
}
async waitForTimeout(timeout: number) {
@@ -432,8 +443,9 @@ export class Frame extends ChannelOwner implements api.Fr
}
async waitForFunction(pageFunction: structs.PageFunction, arg?: Arg, options: WaitForFunctionOptions = {}): Promise> {
- if (typeof options.polling === 'string')
+ if (typeof options.polling === 'string') {
assert(options.polling === 'raf', 'Unknown polling option: ' + options.polling);
+ }
const result = await this._channel.waitForFunction({
...options,
pollingInterval: options.polling === 'raf' ? undefined : options.polling,
@@ -450,9 +462,11 @@ export class Frame extends ChannelOwner implements api.Fr
}
export function verifyLoadState(name: string, waitUntil: LifecycleEvent): LifecycleEvent {
- if (waitUntil as unknown === 'networkidle0')
+ if (waitUntil as unknown === 'networkidle0') {
waitUntil = 'networkidle';
- if (!kLifecycleEvents.has(waitUntil))
+ }
+ if (!kLifecycleEvents.has(waitUntil)) {
throw new Error(`${name}: expected one of (load|domcontentloaded|networkidle|commit)`);
+ }
return waitUntil;
}
diff --git a/packages/playwright-core/src/client/harRouter.ts b/packages/playwright-core/src/client/harRouter.ts
index 5e617d7ce9..17320ffd78 100644
--- a/packages/playwright-core/src/client/harRouter.ts
+++ b/packages/playwright-core/src/client/harRouter.ts
@@ -31,8 +31,9 @@ export class HarRouter {
static async create(localUtils: LocalUtils, file: string, notFoundAction: HarNotFoundAction, options: { urlMatch?: URLMatch }): Promise {
const { harId, error } = await localUtils._channel.harOpen({ file });
- if (error)
+ if (error) {
throw new Error(error);
+ }
return new HarRouter(localUtils, harId!, notFoundAction, options);
}
@@ -67,8 +68,9 @@ export class HarRouter {
// TODO: it'd be better to abort such requests, but then we likely need to respect the timing,
// because the request might have been stalled for a long time until the very end of the
// test when HAR was recorded but we'd abort it immediately.
- if (response.status === -1)
+ if (response.status === -1) {
return;
+ }
await route.fulfill({
status: response.status,
headers: Object.fromEntries(response.headers!.map(h => [h.name, h.value])),
@@ -77,8 +79,9 @@ export class HarRouter {
return;
}
- if (response.action === 'error')
+ if (response.action === 'error') {
debugLogger.log('api', 'HAR: ' + response.message!);
+ }
// Report the error, but fall through to the default handler.
if (this._notFoundAction === 'abort') {
diff --git a/packages/playwright-core/src/client/jsHandle.ts b/packages/playwright-core/src/client/jsHandle.ts
index 8577400f3d..3561b28e8e 100644
--- a/packages/playwright-core/src/client/jsHandle.ts
+++ b/packages/playwright-core/src/client/jsHandle.ts
@@ -51,8 +51,9 @@ export class JSHandle extends ChannelOwner im
async getProperties(): Promise> {
const map = new Map();
- for (const { name, value } of (await this._channel.getPropertyList()).properties)
+ for (const { name, value } of (await this._channel.getPropertyList()).properties) {
map.set(name, JSHandle.from(value));
+ }
return map;
}
@@ -72,8 +73,9 @@ export class JSHandle extends ChannelOwner im
try {
await this._channel.dispose();
} catch (e) {
- if (isTargetClosedError(e))
+ if (isTargetClosedError(e)) {
return;
+ }
throw e;
}
}
@@ -92,8 +94,9 @@ export function serializeArgument(arg: any): channels.SerializedArgument {
return handles.length - 1;
};
const value = serializeValue(arg, value => {
- if (value instanceof JSHandle)
+ if (value instanceof JSHandle) {
return { h: pushHandle(value._channel) };
+ }
return { fallThrough: value };
});
return { value, handles };
@@ -104,6 +107,7 @@ export function parseResult(value: channels.SerializedValue): any {
}
export function assertMaxArguments(count: number, max: number): asserts count {
- if (count > max)
+ if (count > max) {
throw new Error('Too many arguments. If you need to pass more than 1 argument to the function wrap them in an object.');
+ }
}
diff --git a/packages/playwright-core/src/client/localUtils.ts b/packages/playwright-core/src/client/localUtils.ts
index 530547b227..6c4bc331fc 100644
--- a/packages/playwright-core/src/client/localUtils.ts
+++ b/packages/playwright-core/src/client/localUtils.ts
@@ -35,7 +35,8 @@ export class LocalUtils extends ChannelOwner {
super(parent, type, guid, initializer);
this.markAsInternalType();
this.devices = {};
- for (const { name, descriptor } of initializer.deviceDescriptors)
+ for (const { name, descriptor } of initializer.deviceDescriptors) {
this.devices[name] = descriptor;
+ }
}
}
diff --git a/packages/playwright-core/src/client/locator.ts b/packages/playwright-core/src/client/locator.ts
index 84e68e1b20..6e7a7df0e1 100644
--- a/packages/playwright-core/src/client/locator.ts
+++ b/packages/playwright-core/src/client/locator.ts
@@ -42,23 +42,27 @@ export class Locator implements api.Locator {
this._frame = frame;
this._selector = selector;
- if (options?.hasText)
+ if (options?.hasText) {
this._selector += ` >> internal:has-text=${escapeForTextSelector(options.hasText, false)}`;
+ }
- if (options?.hasNotText)
+ if (options?.hasNotText) {
this._selector += ` >> internal:has-not-text=${escapeForTextSelector(options.hasNotText, false)}`;
+ }
if (options?.has) {
const locator = options.has;
- if (locator._frame !== frame)
+ if (locator._frame !== frame) {
throw new Error(`Inner "has" locator must belong to the same frame.`);
+ }
this._selector += ` >> internal:has=` + JSON.stringify(locator._selector);
}
if (options?.hasNot) {
const locator = options.hasNot;
- if (locator._frame !== frame)
+ if (locator._frame !== frame) {
throw new Error(`Inner "hasNot" locator must belong to the same frame.`);
+ }
this._selector += ` >> internal:has-not=` + JSON.stringify(locator._selector);
}
}
@@ -70,8 +74,9 @@ export class Locator implements api.Locator {
return await this._frame._wrapApiCall(async () => {
const result = await this._frame._channel.waitForSelector({ selector: this._selector, strict: true, state: 'attached', timeout });
const handle = ElementHandle.fromNullable(result.element) as ElementHandle | null;
- if (!handle)
+ if (!handle) {
throw new Error(`Could not resolve ${this._selector} to DOM Element`);
+ }
try {
return await task(handle, deadline ? deadline - monotonicTime() : 0);
} finally {
@@ -145,10 +150,12 @@ export class Locator implements api.Locator {
}
locator(selectorOrLocator: string | Locator, options?: LocatorOptions): Locator {
- if (isString(selectorOrLocator))
+ if (isString(selectorOrLocator)) {
return new Locator(this._frame, this._selector + ' >> ' + selectorOrLocator, options);
- if (selectorOrLocator._frame !== this._frame)
+ }
+ if (selectorOrLocator._frame !== this._frame) {
throw new Error(`Locators must belong to the same frame.`);
+ }
return new Locator(this._frame, this._selector + ' >> internal:chain=' + JSON.stringify(selectorOrLocator._selector), options);
}
@@ -213,14 +220,16 @@ export class Locator implements api.Locator {
}
and(locator: Locator): Locator {
- if (locator._frame !== this._frame)
+ if (locator._frame !== this._frame) {
throw new Error(`Locators must belong to the same frame.`);
+ }
return new Locator(this._frame, this._selector + ` >> internal:and=` + JSON.stringify(locator._selector));
}
or(locator: Locator): Locator {
- if (locator._frame !== this._frame)
+ if (locator._frame !== this._frame) {
throw new Error(`Locators must belong to the same frame.`);
+ }
return new Locator(this._frame, this._selector + ` >> internal:or=` + JSON.stringify(locator._selector));
}
@@ -306,10 +315,11 @@ export class Locator implements api.Locator {
}
async setChecked(checked: boolean, options?: channels.ElementHandleCheckOptions) {
- if (checked)
+ if (checked) {
await this.check(options);
- else
+ } else {
await this.uncheck(options);
+ }
}
async setInputFiles(files: string | FilePayload | string[] | FilePayload[], options: channels.ElementHandleSetInputFilesOptions = {}) {
@@ -358,8 +368,9 @@ export class Locator implements api.Locator {
const params: channels.FrameExpectParams = { selector: this._selector, expression, ...options, isNot: !!options.isNot };
params.expectedValue = serializeArgument(options.expectedValue);
const result = (await this._frame._channel.expect(params));
- if (result.received !== undefined)
+ if (result.received !== undefined) {
result.received = parseResult(result.received);
+ }
return result;
}
@@ -382,10 +393,12 @@ export class FrameLocator implements api.FrameLocator {
}
locator(selectorOrLocator: string | Locator, options?: LocatorOptions): Locator {
- if (isString(selectorOrLocator))
+ if (isString(selectorOrLocator)) {
return new Locator(this._frame, this._frameSelector + ' >> internal:control=enter-frame >> ' + selectorOrLocator, options);
- if (selectorOrLocator._frame !== this._frame)
+ }
+ if (selectorOrLocator._frame !== this._frame) {
throw new Error(`Locators must belong to the same frame.`);
+ }
return new Locator(this._frame, this._frameSelector + ' >> internal:control=enter-frame >> ' + selectorOrLocator._selector, options);
}
diff --git a/packages/playwright-core/src/client/network.ts b/packages/playwright-core/src/client/network.ts
index cb18681ccf..56e5e879bb 100644
--- a/packages/playwright-core/src/client/network.ts
+++ b/packages/playwright-core/src/client/network.ts
@@ -99,8 +99,9 @@ export class Request extends ChannelOwner implements ap
super(parent, type, guid, initializer);
this.markAsInternalType();
this._redirectedFrom = Request.fromNullable(initializer.redirectedFrom);
- if (this._redirectedFrom)
+ if (this._redirectedFrom) {
this._redirectedFrom._redirectedTo = this;
+ }
this._provisionalHeaders = new RawHeaders(initializer.headers);
this._timing = {
startTime: 0,
@@ -137,15 +138,17 @@ export class Request extends ChannelOwner implements ap
postDataJSON(): Object | null {
const postData = this.postData();
- if (!postData)
+ if (!postData) {
return null;
+ }
const contentType = this.headers()['content-type'];
- if (contentType?.includes('application/x-www-form-urlencoded')) {
+ if (contentType.includes('application/x-www-form-urlencoded')) {
const entries: Record = {};
const parsed = new URLSearchParams(postData);
- for (const [k, v] of parsed.entries())
+ for (const [k, v] of parsed.entries()) {
entries[k] = v;
+ }
return entries;
}
@@ -160,14 +163,16 @@ export class Request extends ChannelOwner implements ap
* @deprecated
*/
headers(): Headers {
- if (this._fallbackOverrides.headers)
+ if (this._fallbackOverrides.headers) {
return RawHeaders._fromHeadersObjectLossy(this._fallbackOverrides.headers).headers();
+ }
return this._provisionalHeaders.headers();
}
async _actualHeaders(): Promise {
- if (this._fallbackOverrides.headers)
+ if (this._fallbackOverrides.headers) {
return RawHeaders._fromHeadersObjectLossy(this._fallbackOverrides.headers);
+ }
if (!this._actualHeadersPromise) {
this._actualHeadersPromise = this._wrapApiCall(async () => {
@@ -236,8 +241,9 @@ export class Request extends ChannelOwner implements ap
}
failure(): { errorText: string; } | null {
- if (this._failureText === null)
+ if (this._failureText === null) {
return null;
+ }
return {
errorText: this._failureText
};
@@ -249,15 +255,17 @@ export class Request extends ChannelOwner implements ap
async sizes(): Promise {
const response = await this.response();
- if (!response)
+ if (!response) {
throw new Error('Unable to fetch sizes for failed request');
+ }
return (await response._channel.sizes()).sizes;
}
_setResponseEndTiming(responseEndTiming: number) {
this._timing.responseEnd = responseEndTiming;
- if (this._timing.responseStart === -1)
+ if (this._timing.responseStart === -1) {
this._timing.responseStart = responseEndTiming;
+ }
}
_finalRequest(): Request {
@@ -265,19 +273,23 @@ export class Request extends ChannelOwner implements ap
}
_applyFallbackOverrides(overrides: FallbackOverrides) {
- if (overrides.url)
+ if (overrides.url) {
this._fallbackOverrides.url = overrides.url;
- if (overrides.method)
+ }
+ if (overrides.method) {
this._fallbackOverrides.method = overrides.method;
- if (overrides.headers)
+ }
+ if (overrides.headers) {
this._fallbackOverrides.headers = overrides.headers;
+ }
- if (isString(overrides.postData))
+ if (isString(overrides.postData)) {
this._fallbackOverrides.postDataBuffer = Buffer.from(overrides.postData, 'utf-8');
- else if (overrides.postData instanceof Buffer)
+ } else if (overrides.postData instanceof Buffer) {
this._fallbackOverrides.postDataBuffer = overrides.postData;
- else if (overrides.postData)
+ } else if (overrides.postData) {
this._fallbackOverrides.postDataBuffer = Buffer.from(JSON.stringify(overrides.postData), 'utf-8');
+ }
}
_fallbackOverridesForContinue() {
@@ -375,10 +387,11 @@ export class Route extends ChannelOwner implements api.Ro
statusOption ??= options.response.status();
headersOption ??= options.response.headers();
if (body === undefined && options.path === undefined) {
- if (options.response._request._connection === this._connection)
+ if (options.response._request._connection === this._connection) {
fetchResponseUid = (options.response as APIResponse)._fetchUid();
- else
+ } else {
body = await options.response.body();
+ }
}
}
@@ -399,16 +412,19 @@ export class Route extends ChannelOwner implements api.Ro
}
const headers: Headers = {};
- for (const header of Object.keys(headersOption || {}))
+ for (const header of Object.keys(headersOption || {})) {
headers[header.toLowerCase()] = String(headersOption![header]);
- if (options.contentType)
+ }
+ if (options.contentType) {
headers['content-type'] = String(options.contentType);
- else if (options.json)
+ } else if (options.json) {
headers['content-type'] = 'application/json';
- else if (options.path)
+ } else if (options.path) {
headers['content-type'] = mime.getType(options.path) || 'application/octet-stream';
- if (length && !('content-length' in headers))
+ }
+ if (length && !('content-length' in headers)) {
headers['content-length'] = String(length);
+ }
await this._raceWithTargetClose(this._channel.fulfill({
status: statusOption || 200,
@@ -427,8 +443,9 @@ export class Route extends ChannelOwner implements api.Ro
}
_checkNotHandled() {
- if (!this._handlingPromise)
+ if (!this._handlingPromise) {
throw new Error('Route is already handled!');
+ }
}
_reportHandled(done: boolean) {
@@ -487,10 +504,11 @@ export class WebSocketRoute extends ChannelOwner
},
send: (message: string | Buffer) => {
- if (isString(message))
+ if (isString(message)) {
this._channel.sendToServer({ message, isBase64: false }).catch(() => {});
- else
+ } else {
this._channel.sendToServer({ message: message.toString('base64'), isBase64: true }).catch(() => {});
+ }
},
async [Symbol.asyncDispose]() {
@@ -499,31 +517,35 @@ export class WebSocketRoute extends ChannelOwner
};
this._channel.on('messageFromPage', ({ message, isBase64 }) => {
- if (this._onPageMessage)
+ if (this._onPageMessage) {
this._onPageMessage(isBase64 ? Buffer.from(message, 'base64') : message);
- else if (this._connected)
+ } else if (this._connected) {
this._channel.sendToServer({ message, isBase64 }).catch(() => {});
+ }
});
this._channel.on('messageFromServer', ({ message, isBase64 }) => {
- if (this._onServerMessage)
+ if (this._onServerMessage) {
this._onServerMessage(isBase64 ? Buffer.from(message, 'base64') : message);
- else
+ } else {
this._channel.sendToPage({ message, isBase64 }).catch(() => {});
+ }
});
this._channel.on('closePage', ({ code, reason, wasClean }) => {
- if (this._onPageClose)
+ if (this._onPageClose) {
this._onPageClose(code, reason);
- else
+ } else {
this._channel.closeServer({ code, reason, wasClean }).catch(() => {});
+ }
});
this._channel.on('closeServer', ({ code, reason, wasClean }) => {
- if (this._onServerClose)
+ if (this._onServerClose) {
this._onServerClose(code, reason);
- else
+ } else {
this._channel.closePage({ code, reason, wasClean }).catch(() => {});
+ }
});
}
@@ -536,18 +558,20 @@ export class WebSocketRoute extends ChannelOwner
}
connectToServer() {
- if (this._connected)
+ if (this._connected) {
throw new Error('Already connected to the server');
+ }
this._connected = true;
this._channel.connect().catch(() => {});
return this._server;
}
send(message: string | Buffer) {
- if (isString(message))
+ if (isString(message)) {
this._channel.sendToPage({ message, isBase64: false }).catch(() => {});
- else
+ } else {
this._channel.sendToPage({ message: message.toString('base64'), isBase64: true }).catch(() => {});
+ }
}
onMessage(handler: (message: string | Buffer) => any) {
@@ -563,8 +587,9 @@ export class WebSocketRoute extends ChannelOwner
}
async _afterHandle() {
- if (this._connected)
+ if (this._connected) {
return;
+ }
// Ensure that websocket is "open" and can send messages without an actual server connection.
await this._channel.ensureOpened();
}
@@ -585,15 +610,17 @@ export class WebSocketRouteHandler {
const patterns: channels.BrowserContextSetWebSocketInterceptionPatternsParams['patterns'] = [];
let all = false;
for (const handler of handlers) {
- if (isString(handler.url))
+ if (isString(handler.url)) {
patterns.push({ glob: handler.url });
- else if (isRegExp(handler.url))
+ } else if (isRegExp(handler.url)) {
patterns.push({ regexSource: handler.url.source, regexFlags: handler.url.flags });
- else
+ } else {
all = true;
+ }
}
- if (all)
+ if (all) {
return [{ glob: '**/*' }];
+ }
return patterns;
}
@@ -753,16 +780,18 @@ export class WebSocket extends ChannelOwner implement
this._isClosed = false;
this._page = parent as Page;
this._channel.on('frameSent', event => {
- if (event.opcode === 1)
+ if (event.opcode === 1) {
this.emit(Events.WebSocket.FrameSent, { payload: event.data });
- else if (event.opcode === 2)
+ } else if (event.opcode === 2) {
this.emit(Events.WebSocket.FrameSent, { payload: Buffer.from(event.data, 'base64') });
+ }
});
this._channel.on('frameReceived', event => {
- if (event.opcode === 1)
+ if (event.opcode === 1) {
this.emit(Events.WebSocket.FrameReceived, { payload: event.data });
- else if (event.opcode === 2)
+ } else if (event.opcode === 2) {
this.emit(Events.WebSocket.FrameReceived, { payload: Buffer.from(event.data, 'base64') });
+ }
});
this._channel.on('socketError', ({ error }) => this.emit(Events.WebSocket.Error, error));
this._channel.on('close', () => {
@@ -785,10 +814,12 @@ export class WebSocket extends ChannelOwner implement
const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;
const waiter = Waiter.createForEvent(this, event);
waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);
- if (event !== Events.WebSocket.Error)
+ if (event !== Events.WebSocket.Error) {
waiter.rejectOnEvent(this, Events.WebSocket.Error, new Error('Socket error'));
- if (event !== Events.WebSocket.Close)
+ }
+ if (event !== Events.WebSocket.Close) {
waiter.rejectOnEvent(this, Events.WebSocket.Close, new Error('Socket closed'));
+ }
waiter.rejectOnEvent(this._page, Events.Page.Close, () => this._page._closeErrorWithReason());
const result = await waiter.waitForEvent(this, event, predicate as any);
waiter.dispose();
@@ -800,8 +831,9 @@ export class WebSocket extends ChannelOwner implement
export function validateHeaders(headers: Headers) {
for (const key of Object.keys(headers)) {
const value = headers[key];
- if (!Object.is(value, undefined) && !isString(value))
+ if (!Object.is(value, undefined) && !isString(value)) {
throw new Error(`Expected value of header "${key}" to be String, but "${typeof value}" is found.`);
+ }
}
}
@@ -827,15 +859,17 @@ export class RouteHandler {
const patterns: channels.BrowserContextSetNetworkInterceptionPatternsParams['patterns'] = [];
let all = false;
for (const handler of handlers) {
- if (isString(handler.url))
+ if (isString(handler.url)) {
patterns.push({ glob: handler.url });
- else if (isRegExp(handler.url))
+ } else if (isRegExp(handler.url)) {
patterns.push({ regexSource: handler.url.source, regexFlags: handler.url.flags });
- else
+ } else {
all = true;
+ }
}
- if (all)
+ if (all) {
return [{ glob: '**/*' }];
+ }
return patterns;
}
@@ -854,8 +888,9 @@ export class RouteHandler {
return await this._handleInternal(route);
} catch (e) {
// If the handler was stopped (without waiting for completion), we ignore all exceptions.
- if (this._ignoreException)
+ if (this._ignoreException) {
return false;
+ }
if (isTargetClosedError(e)) {
// We are failing in the handler because the target close closed.
// Give user a hint!
@@ -878,8 +913,9 @@ export class RouteHandler {
} else {
const promises = [];
for (const activation of this._activeInvocations) {
- if (!activation.route._didThrow)
+ if (!activation.route._didThrow) {
promises.push(activation.complete);
+ }
}
await Promise.all(promises);
}
@@ -915,14 +951,16 @@ export class RawHeaders {
constructor(headers: HeadersArray) {
this._headersArray = headers;
- for (const header of headers)
+ for (const header of headers) {
this._headersMap.set(header.name.toLowerCase(), header.value);
+ }
}
get(name: string): string | null {
const values = this.getAll(name);
- if (!values || !values.length)
+ if (!values || !values.length) {
return null;
+ }
return values.join(name.toLowerCase() === 'set-cookie' ? '\n' : ', ');
}
@@ -932,8 +970,9 @@ export class RawHeaders {
headers(): Headers {
const result: Headers = {};
- for (const name of this._headersMap.keys())
+ for (const name of this._headersMap.keys()) {
result[name] = this.get(name)!;
+ }
return result;
}
diff --git a/packages/playwright-core/src/client/page.ts b/packages/playwright-core/src/client/page.ts
index f1d90fece2..0f0cd18b09 100644
--- a/packages/playwright-core/src/client/page.ts
+++ b/packages/playwright-core/src/client/page.ts
@@ -166,16 +166,18 @@ export class Page extends ChannelOwner implements api.Page
private _onFrameAttached(frame: Frame) {
frame._page = this;
this._frames.add(frame);
- if (frame._parentFrame)
+ if (frame._parentFrame) {
frame._parentFrame._childFrames.add(frame);
+ }
this.emit(Events.Page.FrameAttached, frame);
}
private _onFrameDetached(frame: Frame) {
this._frames.delete(frame);
frame._detached = true;
- if (frame._parentFrame)
+ if (frame._parentFrame) {
frame._parentFrame._childFrames.delete(frame);
+ }
this.emit(Events.Page.FrameDetached, frame);
}
@@ -184,20 +186,26 @@ export class Page extends ChannelOwner implements api.Page
const routeHandlers = this._routes.slice();
for (const routeHandler of routeHandlers) {
// If the page was closed we stall all requests right away.
- if (this._closeWasCalled || this._browserContext._closeWasCalled)
+ if (this._closeWasCalled || this._browserContext._closeWasCalled) {
return;
- if (!routeHandler.matches(route.request().url()))
+ }
+ if (!routeHandler.matches(route.request().url())) {
continue;
+ }
const index = this._routes.indexOf(routeHandler);
- if (index === -1)
+ if (index === -1) {
continue;
- if (routeHandler.willExpire())
+ }
+ if (routeHandler.willExpire()) {
this._routes.splice(index, 1);
+ }
const handled = await routeHandler.handle(route);
- if (!this._routes.length)
+ if (!this._routes.length) {
this._wrapApiCall(() => this._updateInterceptionPatterns(), true).catch(() => {});
- if (handled)
+ }
+ if (handled) {
return;
+ }
}
await this._browserContext._onRoute(route);
@@ -205,10 +213,11 @@ export class Page extends ChannelOwner implements api.Page
private async _onWebSocketRoute(webSocketRoute: WebSocketRoute) {
const routeHandler = this._webSocketRoutes.find(route => route.matches(webSocketRoute.url()));
- if (routeHandler)
+ if (routeHandler) {
await routeHandler.handle(webSocketRoute);
- else
+ } else {
await this._browserContext._onWebSocketRoute(webSocketRoute);
+ }
}
async _onBinding(bindingCall: BindingCall) {
@@ -243,8 +252,9 @@ export class Page extends ChannelOwner implements api.Page
}
async opener(): Promise {
- if (!this._opener || this._opener.isClosed())
+ if (!this._opener || this._opener.isClosed()) {
return null;
+ }
return this._opener;
}
@@ -257,8 +267,9 @@ export class Page extends ChannelOwner implements api.Page
const url = isObject(frameSelector) ? frameSelector.url : undefined;
assert(name || url, 'Either name or url matcher should be specified');
return this.frames().find(f => {
- if (name)
+ if (name) {
return f.name() === name;
+ }
return urlMatches(this._browserContext._options.baseURL, f.url(), url);
}) || null;
}
@@ -282,8 +293,9 @@ export class Page extends ChannelOwner implements api.Page
}
private _forceVideo(): Video {
- if (!this._video)
+ if (!this._video) {
this._video = new Video(this, this._connection);
+ }
return this._video;
}
@@ -291,8 +303,9 @@ export class Page extends ChannelOwner implements api.Page
// Note: we are creating Video object lazily, because we do not know
// BrowserContextOptions when constructing the page - it is assigned
// too late during launchPersistentContext.
- if (!this._browserContext._options.recordVideo)
+ if (!this._browserContext._options.recordVideo) {
return null;
+ }
return this._forceVideo();
}
@@ -375,10 +388,12 @@ export class Page extends ChannelOwner implements api.Page
}
async addLocatorHandler(locator: Locator, handler: (locator: Locator) => any, options: { times?: number, noWaitAfter?: boolean } = {}): Promise {
- if (locator._frame !== this._mainFrame)
+ if (locator._frame !== this._mainFrame) {
throw new Error(`Locator must belong to the main frame of this page`);
- if (options.times === 0)
+ }
+ if (options.times === 0) {
return;
+ }
const { uid } = await this._channel.registerLocatorHandler({ selector: locator._selector, noWaitAfter: options.noWaitAfter });
this._locatorHandlers.set(uid, { locator, handler, times: options.times });
}
@@ -388,14 +403,16 @@ export class Page extends ChannelOwner implements api.Page
try {
const handler = this._locatorHandlers.get(uid);
if (handler && handler.times !== 0) {
- if (handler.times !== undefined)
+ if (handler.times !== undefined) {
handler.times--;
+ }
await handler.handler(handler.locator);
}
remove = handler?.times === 0;
} finally {
- if (remove)
+ if (remove) {
this._locatorHandlers.delete(uid);
+ }
this._wrapApiCall(() => this._channel.resolveLocatorHandlerNoReply({ uid, remove }), true).catch(() => {});
}
}
@@ -423,8 +440,9 @@ export class Page extends ChannelOwner implements api.Page
async waitForRequest(urlOrPredicate: string | RegExp | ((r: Request) => boolean | Promise), options: { timeout?: number } = {}): Promise {
const predicate = async (request: Request) => {
- if (isString(urlOrPredicate) || isRegExp(urlOrPredicate))
+ if (isString(urlOrPredicate) || isRegExp(urlOrPredicate)) {
return urlMatches(this._browserContext._options.baseURL, request.url(), urlOrPredicate);
+ }
return await urlOrPredicate(request);
};
const trimmedUrl = trimUrl(urlOrPredicate);
@@ -434,8 +452,9 @@ export class Page extends ChannelOwner implements api.Page
async waitForResponse(urlOrPredicate: string | RegExp | ((r: Response) => boolean | Promise), options: { timeout?: number } = {}): Promise {
const predicate = async (response: Response) => {
- if (isString(urlOrPredicate) || isRegExp(urlOrPredicate))
+ if (isString(urlOrPredicate) || isRegExp(urlOrPredicate)) {
return urlMatches(this._browserContext._options.baseURL, response.url(), urlOrPredicate);
+ }
return await urlOrPredicate(response);
};
const trimmedUrl = trimUrl(urlOrPredicate);
@@ -456,13 +475,16 @@ export class Page extends ChannelOwner implements api.Page
const timeout = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);
const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;
const waiter = Waiter.createForEvent(this, event);
- if (logLine)
+ if (logLine) {
waiter.log(logLine);
+ }
waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);
- if (event !== Events.Page.Crash)
+ if (event !== Events.Page.Crash) {
waiter.rejectOnEvent(this, Events.Page.Crash, new Error('Page crashed'));
- if (event !== Events.Page.Close)
+ }
+ if (event !== Events.Page.Close) {
waiter.rejectOnEvent(this, Events.Page.Close, () => this._closeErrorWithReason());
+ }
const result = await waiter.waitForEvent(this, event, predicate as any);
waiter.dispose();
return result;
@@ -545,10 +567,11 @@ export class Page extends ChannelOwner implements api.Page
const removed = [];
const remaining = [];
for (const route of this._routes) {
- if (urlMatchesEqual(route.url, url) && (!handler || route.handler === handler))
+ if (urlMatchesEqual(route.url, url) && (!handler || route.handler === handler)) {
removed.push(route);
- else
+ } else {
remaining.push(route);
+ }
}
await this._unrouteInternal(removed, remaining, 'default');
}
@@ -556,8 +579,9 @@ export class Page extends ChannelOwner implements api.Page
private async _unrouteInternal(removed: RouteHandler[], remaining: RouteHandler[], behavior?: 'wait'|'ignoreErrors'|'default'): Promise {
this._routes = remaining;
await this._updateInterceptionPatterns();
- if (!behavior || behavior === 'default')
+ if (!behavior || behavior === 'default') {
return;
+ }
const promises = removed.map(routeHandler => routeHandler.stop(behavior));
await Promise.all(promises);
}
@@ -574,8 +598,9 @@ export class Page extends ChannelOwner implements api.Page
async screenshot(options: Omit & { path?: string, mask?: Locator[] } = {}): Promise {
const copy: channels.PageScreenshotOptions = { ...options, mask: undefined };
- if (!copy.type)
+ if (!copy.type) {
copy.type = determineScreenshotType(options);
+ }
if (options.mask) {
copy.mask = options.mask.map(locator => ({
frame: locator._frame._channel,
@@ -591,7 +616,7 @@ export class Page extends ChannelOwner implements api.Page
}
async _expectScreenshot(options: ExpectScreenshotOptions): Promise<{ actual?: Buffer, previous?: Buffer, diff?: Buffer, errorMessage?: string, log?: string[], timedOut?: boolean}> {
- const mask = options?.mask ? options?.mask.map(locator => ({
+ const mask = options.mask ? options.mask.map(locator => ({
frame: (locator as Locator)._frame._channel,
selector: (locator as Locator)._selector,
})) : undefined;
@@ -623,13 +648,15 @@ export class Page extends ChannelOwner implements api.Page
this._closeReason = options.reason;
this._closeWasCalled = true;
try {
- if (this._ownedContext)
+ if (this._ownedContext) {
await this._ownedContext.close();
- else
+ } else {
await this._channel.close(options);
+ }
} catch (e) {
- if (isTargetClosedError(e) && !options.runBeforeUnload)
+ if (isTargetClosedError(e) && !options.runBeforeUnload) {
return;
+ }
throw e;
}
}
@@ -787,13 +814,14 @@ export class Page extends ChannelOwner implements api.Page
}
async pause(_options?: { __testHookKeepTestTimeout: boolean }) {
- if (require('inspector').url())
+ if (require('inspector').url()) {
return;
+ }
const defaultNavigationTimeout = this._browserContext._timeoutSettings.defaultNavigationTimeout();
const defaultTimeout = this._browserContext._timeoutSettings.defaultTimeout();
this._browserContext.setDefaultNavigationTimeout(0);
this._browserContext.setDefaultTimeout(0);
- this._instrumentation?.onWillPause({ keepTestTimeout: !!_options?.__testHookKeepTestTimeout });
+ this._instrumentation.onWillPause({ keepTestTimeout: !!_options?.__testHookKeepTestTimeout });
await this._closedOrCrashedScope.safeRace(this.context()._channel.pause());
this._browserContext.setDefaultNavigationTimeout(defaultNavigationTimeout);
this._browserContext.setDefaultTimeout(defaultTimeout);
@@ -801,16 +829,20 @@ export class Page extends ChannelOwner implements api.Page
async pdf(options: PDFOptions = {}): Promise {
const transportOptions: channels.PagePdfParams = { ...options } as channels.PagePdfParams;
- if (transportOptions.margin)
+ if (transportOptions.margin) {
transportOptions.margin = { ...transportOptions.margin };
- if (typeof options.width === 'number')
+ }
+ if (typeof options.width === 'number') {
transportOptions.width = options.width + 'px';
- if (typeof options.height === 'number')
+ }
+ if (typeof options.height === 'number') {
transportOptions.height = options.height + 'px';
+ }
for (const margin of ['top', 'right', 'bottom', 'left']) {
const index = margin as 'top' | 'right' | 'bottom' | 'left';
- if (options.margin && typeof options.margin[index] === 'number')
- transportOptions.margin![index] = transportOptions.margin![index] + 'px';
+ if (options.margin && typeof options.margin[index] === 'number') {
+transportOptions.margin![index] = transportOptions.margin![index] + 'px';
+ }
}
const result = await this._channel.pdf(transportOptions);
if (options.path) {
@@ -839,10 +871,11 @@ export class BindingCall extends ChannelOwner {
frame
};
let result: any;
- if (this._initializer.handle)
+ if (this._initializer.handle) {
result = await func(source, JSHandle.from(this._initializer.handle));
- else
+ } else {
result = await func(source, ...this._initializer.args!.map(parseResult));
+ }
this._channel.resolve({ result: serializeArgument(result) }).catch(() => {});
} catch (e) {
this._channel.reject({ error: serializeError(e) }).catch(() => {});
@@ -851,8 +884,10 @@ export class BindingCall extends ChannelOwner {
}
function trimUrl(param: any): string | undefined {
- if (isRegExp(param))
+ if (isRegExp(param)) {
return `/${trimStringWithEllipsis(param.source, 50)}/${param.flags}`;
- if (isString(param))
+ }
+ if (isString(param)) {
return `"${trimStringWithEllipsis(param, 50)}"`;
+ }
}
diff --git a/packages/playwright-core/src/client/playwright.ts b/packages/playwright-core/src/client/playwright.ts
index 9933ce15de..7221a04115 100644
--- a/packages/playwright-core/src/client/playwright.ts
+++ b/packages/playwright-core/src/client/playwright.ts
@@ -51,7 +51,7 @@ export class Playwright extends ChannelOwner {
this._bidiChromium._playwright = this;
this._bidiFirefox = BrowserType.from(initializer.bidiFirefox);
this._bidiFirefox._playwright = this;
- this.devices = this._connection.localUtils()?.devices ?? {};
+ this.devices = this._connection.localUtils().devices ?? {};
this.selectors = new Selectors();
this.errors = { TimeoutError };
diff --git a/packages/playwright-core/src/client/selectors.ts b/packages/playwright-core/src/client/selectors.ts
index 2739be0e8d..989cf8d233 100644
--- a/packages/playwright-core/src/client/selectors.ts
+++ b/packages/playwright-core/src/client/selectors.ts
@@ -28,15 +28,17 @@ export class Selectors implements api.Selectors {
async register(name: string, script: string | (() => SelectorEngine) | { path?: string, content?: string }, options: { contentScript?: boolean } = {}): Promise {
const source = await evaluationScript(script, undefined, false);
const params = { ...options, name, source };
- for (const channel of this._channels)
+ for (const channel of this._channels) {
await channel._channel.register(params);
+ }
this._registrations.push(params);
}
setTestIdAttribute(attributeName: string) {
setTestIdAttribute(attributeName);
- for (const channel of this._channels)
+ for (const channel of this._channels) {
channel._channel.setTestIdAttributeName({ testIdAttributeName: attributeName }).catch(() => {});
+ }
}
_addChannel(channel: SelectorsOwner) {
diff --git a/packages/playwright-core/src/client/stream.ts b/packages/playwright-core/src/client/stream.ts
index bb202ac4ad..115d35b8be 100644
--- a/packages/playwright-core/src/client/stream.ts
+++ b/packages/playwright-core/src/client/stream.ts
@@ -42,10 +42,11 @@ class StreamImpl extends Readable {
override async _read() {
const result = await this._channel.read({ size: 1024 * 1024 });
- if (result.binary.byteLength)
+ if (result.binary.byteLength) {
this.push(result.binary);
- else
+ } else {
this.push(null);
+ }
}
override _destroy(error: Error | null, callback: (error: Error | null | undefined) => void): void {
diff --git a/packages/playwright-core/src/client/tracing.ts b/packages/playwright-core/src/client/tracing.ts
index 2481741e3e..dfb1c7be3b 100644
--- a/packages/playwright-core/src/client/tracing.ts
+++ b/packages/playwright-core/src/client/tracing.ts
@@ -87,8 +87,9 @@ export class Tracing extends ChannelOwner implements ap
if (!filePath) {
// Not interested in artifacts.
await this._channel.tracingStopChunk({ mode: 'discard' });
- if (this._stacksId)
+ if (this._stacksId) {
await this._connection.localUtils()._channel.traceDiscarded({ stacksId: this._stacksId });
+ }
return;
}
@@ -104,8 +105,9 @@ export class Tracing extends ChannelOwner implements ap
// The artifact may be missing if the browser closed while stopping tracing.
if (!result.artifact) {
- if (this._stacksId)
+ if (this._stacksId) {
await this._connection.localUtils()._channel.traceDiscarded({ stacksId: this._stacksId });
+ }
return;
}
diff --git a/packages/playwright-core/src/client/video.ts b/packages/playwright-core/src/client/video.ts
index 08c39d4247..4c010b0e16 100644
--- a/packages/playwright-core/src/client/video.ts
+++ b/packages/playwright-core/src/client/video.ts
@@ -35,24 +35,28 @@ export class Video implements api.Video {
}
async path(): Promise {
- if (this._isRemote)
+ if (this._isRemote) {
throw new Error(`Path is not available when connecting remotely. Use saveAs() to save a local copy.`);
+ }
const artifact = await this._artifact;
- if (!artifact)
+ if (!artifact) {
throw new Error('Page did not produce any video frames');
+ }
return artifact._initializer.absolutePath;
}
async saveAs(path: string): Promise {
const artifact = await this._artifact;
- if (!artifact)
+ if (!artifact) {
throw new Error('Page did not produce any video frames');
+ }
return await artifact.saveAs(path);
}
async delete(): Promise {
const artifact = await this._artifact;
- if (artifact)
+ if (artifact) {
await artifact.delete();
+ }
}
}
diff --git a/packages/playwright-core/src/client/waiter.ts b/packages/playwright-core/src/client/waiter.ts
index 7b57fe8960..05ae4e80c2 100644
--- a/packages/playwright-core/src/client/waiter.ts
+++ b/packages/playwright-core/src/client/waiter.ts
@@ -56,14 +56,19 @@ export class Waiter {
rejectOnEvent(emitter: EventEmitter, event: string, error: Error | (() => Error), predicate?: (arg: T) => boolean | Promise) {
const { promise, dispose } = waitForEvent(emitter, event, this._savedZone, predicate);
- this._rejectOn(promise.then(() => { throw (typeof error === 'function' ? error() : error); }), dispose);
+ this._rejectOn(promise.then(() => {
+ throw (typeof error === 'function' ? error() : error);
+ }), dispose);
}
rejectOnTimeout(timeout: number, message: string) {
- if (!timeout)
+ if (!timeout) {
return;
+ }
const { promise, dispose } = waitForTimeout(timeout);
- this._rejectOn(promise.then(() => { throw new TimeoutError(message); }), dispose);
+ this._rejectOn(promise.then(() => {
+ throw new TimeoutError(message);
+ }), dispose);
}
rejectImmediately(error: Error) {
@@ -71,21 +76,25 @@ export class Waiter {
}
dispose() {
- for (const dispose of this._dispose)
+ for (const dispose of this._dispose) {
dispose();
+ }
}
async waitForPromise(promise: Promise, dispose?: () => void): Promise {
try {
- if (this._immediateError)
+ if (this._immediateError) {
throw this._immediateError;
+ }
const result = await Promise.race([promise, ...this._failures]);
- if (dispose)
+ if (dispose) {
dispose();
+ }
return result;
} catch (e) {
- if (dispose)
+ if (dispose) {
dispose();
+ }
this._error = e.message;
this.dispose();
rewriteErrorMessage(e, e.message + formatLogRecording(this._logs));
@@ -102,8 +111,9 @@ export class Waiter {
private _rejectOn(promise: Promise, dispose?: () => void) {
this._failures.push(promise);
- if (dispose)
+ if (dispose) {
this._dispose.push(dispose);
+ }
}
}
@@ -113,8 +123,9 @@ function waitForEvent(emitter: EventEmitter, event: string, savedZone:
listener = async (eventArg: any) => {
await savedZone.run(async () => {
try {
- if (predicate && !(await predicate(eventArg)))
+ if (predicate && !(await predicate(eventArg))) {
return;
+ }
emitter.removeListener(event, listener);
resolve(eventArg);
} catch (e) {
@@ -137,8 +148,9 @@ function waitForTimeout(timeout: number): { promise: Promise, dispose: ()
}
function formatLogRecording(log: string[]): string {
- if (!log.length)
+ if (!log.length) {
return '';
+ }
const header = ` logs `;
const headerLength = 60;
const leftLength = (headerLength - header.length) / 2;
diff --git a/packages/playwright-core/src/client/worker.ts b/packages/playwright-core/src/client/worker.ts
index 31d5d3057f..71145ad408 100644
--- a/packages/playwright-core/src/client/worker.ts
+++ b/packages/playwright-core/src/client/worker.ts
@@ -37,10 +37,12 @@ export class Worker extends ChannelOwner implements api.
constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.WorkerInitializer) {
super(parent, type, guid, initializer);
this._channel.on('close', () => {
- if (this._page)
+ if (this._page) {
this._page._workers.delete(this);
- if (this._context)
+ }
+ if (this._context) {
this._context._serviceWorkers.delete(this);
+ }
this.emit(Events.Worker.Close, this);
});
this.once(Events.Worker.Close, () => this._closedScope.close(this._page?._closeErrorWithReason() || new TargetClosedError()));
diff --git a/packages/playwright-core/src/common/socksProxy.ts b/packages/playwright-core/src/common/socksProxy.ts
index 6566262d64..615d47eb11 100644
--- a/packages/playwright-core/src/common/socksProxy.ts
+++ b/packages/playwright-core/src/common/socksProxy.ts
@@ -174,8 +174,9 @@ class SocksConnection {
case SocksAddressType.IPv6:
const bytes = await this._readBytes(16);
const tokens: string[] = [];
- for (let i = 0; i < 8; ++i)
+ for (let i = 0; i < 8; ++i) {
tokens.push(bytes.readUInt16BE(i * 2).toString(16));
+ }
host = tokens.join(':');
break;
}
@@ -199,15 +200,17 @@ class SocksConnection {
private async _readBytes(length: number): Promise {
this._fence = this._offset + length;
- if (!this._buffer || this._buffer.length < this._fence)
+ if (!this._buffer || this._buffer.length < this._fence) {
await new Promise(f => this._fenceCallback = f);
+ }
this._offset += length;
return this._buffer.slice(this._offset - length, this._offset);
}
private _writeBytes(buffer: Buffer) {
- if (this._socket.writable)
+ if (this._socket.writable) {
this._socket.write(buffer);
+ }
}
private _onClose() {
@@ -280,12 +283,18 @@ function hexToNumber(hex: string): number {
// Note: parseInt has a few issues including ignoring trailing characters and allowing leading 0x.
return [...hex].reduce((value, digit) => {
const code = digit.charCodeAt(0);
- if (code >= 48 && code <= 57) // 0..9
+ if (code >= 48 && code <= 57) {
+ // 0..9
return value + code;
- if (code >= 97 && code <= 102) // a..f
+ }
+ if (code >= 97 && code <= 102) {
+ // a..f
return value + (code - 97) + 10;
- if (code >= 65 && code <= 70) // A..F
+ }
+ if (code >= 65 && code <= 70) {
+ // A..F
return value + (code - 65) + 10;
+ }
throw new Error('Invalid IPv6 token ' + hex);
}, 0);
}
@@ -300,8 +309,9 @@ function ipToSocksAddress(address: string): number[] {
if (net.isIPv6(address)) {
const result = [0x04]; // IPv6
const tokens = address.split(':', 8);
- while (tokens.length < 8)
+ while (tokens.length < 8) {
tokens.unshift('');
+ }
for (const token of tokens) {
const value = hexToNumber(token);
result.push((value >> 8) & 0xFF, value & 0xFF); // Big-endian
@@ -324,21 +334,24 @@ function starMatchToRegex(pattern: string) {
// This follows "Proxy bypass rules" syntax without implicit and negative rules.
// https://source.chromium.org/chromium/chromium/src/+/main:net/docs/proxy.md;l=331
export function parsePattern(pattern: string | undefined): PatternMatcher {
- if (!pattern)
+ if (!pattern) {
return () => false;
+ }
const matchers: PatternMatcher[] = pattern.split(',').map(token => {
const match = token.match(/^(.*?)(?::(\d+))?$/);
- if (!match)
+ if (!match) {
throw new Error(`Unsupported token "${token}" in pattern "${pattern}"`);
+ }
const tokenPort = match[2] ? +match[2] : undefined;
const portMatches = (port: number) => tokenPort === undefined || tokenPort === port;
let tokenHost = match[1];
if (tokenHost === '') {
return (host, port) => {
- if (!portMatches(port))
+ if (!portMatches(port)) {
return false;
+ }
return host === 'localhost'
|| host.endsWith('.localhost')
|| host === '127.0.0.1'
@@ -346,20 +359,25 @@ export function parsePattern(pattern: string | undefined): PatternMatcher {
};
}
- if (tokenHost === '*')
+ if (tokenHost === '*') {
return (host, port) => portMatches(port);
+ }
- if (net.isIPv4(tokenHost) || net.isIPv6(tokenHost))
+ if (net.isIPv4(tokenHost) || net.isIPv6(tokenHost)) {
return (host, port) => host === tokenHost && portMatches(port);
+ }
- if (tokenHost[0] === '.')
+ if (tokenHost[0] === '.') {
tokenHost = '*' + tokenHost;
+ }
const tokenRegex = starMatchToRegex(tokenHost);
return (host, port) => {
- if (!portMatches(port))
+ if (!portMatches(port)) {
return false;
- if (net.isIPv4(host) || net.isIPv6(host))
+ }
+ if (net.isIPv4(host) || net.isIPv6(host)) {
return false;
+ }
return !!host.match(tokenRegex);
};
});
@@ -442,11 +460,13 @@ export class SocksProxy extends EventEmitter implements SocksConnectionClient {
}
async close() {
- if (this._closed)
+ if (this._closed) {
return;
+ }
this._closed = true;
- for (const socket of this._sockets)
+ for (const socket of this._sockets) {
socket.destroy();
+ }
this._sockets.clear();
await new Promise(f => this._server.close(f));
}
@@ -519,8 +539,9 @@ export class SocksProxyHandler extends EventEmitter {
}
cleanup() {
- for (const uid of this._sockets.keys())
+ for (const uid of this._sockets.keys()) {
this.socketClosed({ uid });
+ }
}
async socketRequested({ uid, host, port }: SocksSocketRequestedPayload): Promise {
@@ -532,11 +553,13 @@ export class SocksProxyHandler extends EventEmitter {
return;
}
- if (host === 'local.playwright')
+ if (host === 'local.playwright') {
host = 'localhost';
+ }
try {
- if (this._redirectPortForTest)
+ if (this._redirectPortForTest) {
port = this._redirectPortForTest;
+ }
const socket = await createSocket(host, port);
socket.on('data', data => {
const payload: SocksSocketDataPayload = { uid, data };
diff --git a/packages/playwright-core/src/common/timeoutSettings.ts b/packages/playwright-core/src/common/timeoutSettings.ts
index 65c8be1ecf..0a0a6f581a 100644
--- a/packages/playwright-core/src/common/timeoutSettings.ts
+++ b/packages/playwright-core/src/common/timeoutSettings.ts
@@ -46,44 +46,57 @@ export class TimeoutSettings {
}
navigationTimeout(options: { timeout?: number }): number {
- if (typeof options.timeout === 'number')
+ if (typeof options.timeout === 'number') {
return options.timeout;
- if (this._defaultNavigationTimeout !== undefined)
+ }
+ if (this._defaultNavigationTimeout !== undefined) {
return this._defaultNavigationTimeout;
- if (debugMode())
+ }
+ if (debugMode()) {
return 0;
- if (this._defaultTimeout !== undefined)
+ }
+ if (this._defaultTimeout !== undefined) {
return this._defaultTimeout;
- if (this._parent)
+ }
+ if (this._parent) {
return this._parent.navigationTimeout(options);
+ }
return DEFAULT_TIMEOUT;
}
timeout(options: { timeout?: number }): number {
- if (typeof options.timeout === 'number')
+ if (typeof options.timeout === 'number') {
return options.timeout;
- if (debugMode())
+ }
+ if (debugMode()) {
return 0;
- if (this._defaultTimeout !== undefined)
+ }
+ if (this._defaultTimeout !== undefined) {
return this._defaultTimeout;
- if (this._parent)
+ }
+ if (this._parent) {
return this._parent.timeout(options);
+ }
return DEFAULT_TIMEOUT;
}
static timeout(options: { timeout?: number }): number {
- if (typeof options.timeout === 'number')
+ if (typeof options.timeout === 'number') {
return options.timeout;
- if (debugMode())
+ }
+ if (debugMode()) {
return 0;
+ }
return DEFAULT_TIMEOUT;
}
static launchTimeout(options: { timeout?: number }): number {
- if (typeof options.timeout === 'number')
+ if (typeof options.timeout === 'number') {
return options.timeout;
- if (debugMode())
+ }
+ if (debugMode()) {
return 0;
+ }
return DEFAULT_LAUNCH_TIMEOUT;
}
}
diff --git a/packages/playwright-core/src/image_tools/stats.ts b/packages/playwright-core/src/image_tools/stats.ts
index b35371b4a1..fb16f1d2f2 100644
--- a/packages/playwright-core/src/image_tools/stats.ts
+++ b/packages/playwright-core/src/image_tools/stats.ts
@@ -67,12 +67,15 @@ export class FastStats implements Stats {
const recalc = (mx: number[], idx: number, initial: number, x: number, y: number) => {
mx[idx] = initial;
- if (y > 0)
+ if (y > 0) {
mx[idx] += mx[(y - 1) * width + x];
- if (x > 0)
+ }
+ if (x > 0) {
mx[idx] += mx[y * width + x - 1];
- if (x > 0 && y > 0)
+ }
+ if (x > 0 && y > 0) {
mx[idx] -= mx[(y - 1) * width + x - 1];
+ }
};
for (let y = 0; y < height; ++y) {
@@ -90,12 +93,15 @@ export class FastStats implements Stats {
_sum(partialSum: number[], x1: number, y1: number, x2: number, y2: number): number {
const width = this.c1.width;
let result = partialSum[y2 * width + x2];
- if (y1 > 0)
+ if (y1 > 0) {
result -= partialSum[(y1 - 1) * width + x2];
- if (x1 > 0)
+ }
+ if (x1 > 0) {
result -= partialSum[y2 * width + x1 - 1];
- if (x1 > 0 && y1 > 0)
+ }
+ if (x1 > 0 && y1 > 0) {
result += partialSum[(y1 - 1) * width + x1 - 1];
+ }
return result;
}
diff --git a/packages/playwright-core/src/protocol/serializers.ts b/packages/playwright-core/src/protocol/serializers.ts
index 559d4a062e..6794d20797 100644
--- a/packages/playwright-core/src/protocol/serializers.ts
+++ b/packages/playwright-core/src/protocol/serializers.ts
@@ -21,60 +21,77 @@ export function parseSerializedValue(value: SerializedValue, handles: any[] | un
}
function innerParseSerializedValue(value: SerializedValue, handles: any[] | undefined, refs: Map): any {
- if (value.ref !== undefined)
+ if (value.ref !== undefined) {
return refs.get(value.ref);
- if (value.n !== undefined)
- return value.n;
- if (value.s !== undefined)
- return value.s;
- if (value.b !== undefined)
- return value.b;
- if (value.v !== undefined) {
- if (value.v === 'undefined')
- return undefined;
- if (value.v === 'null')
- return null;
- if (value.v === 'NaN')
- return NaN;
- if (value.v === 'Infinity')
- return Infinity;
- if (value.v === '-Infinity')
- return -Infinity;
- if (value.v === '-0')
- return -0;
}
- if (value.d !== undefined)
+ if (value.n !== undefined) {
+ return value.n;
+ }
+ if (value.s !== undefined) {
+ return value.s;
+ }
+ if (value.b !== undefined) {
+ return value.b;
+ }
+ if (value.v !== undefined) {
+ if (value.v === 'undefined') {
+ return undefined;
+ }
+ if (value.v === 'null') {
+ return null;
+ }
+ if (value.v === 'NaN') {
+ return NaN;
+ }
+ if (value.v === 'Infinity') {
+ return Infinity;
+ }
+ if (value.v === '-Infinity') {
+ return -Infinity;
+ }
+ if (value.v === '-0') {
+ return -0;
+ }
+ }
+ if (value.d !== undefined) {
return new Date(value.d);
- if (value.u !== undefined)
+ }
+ if (value.u !== undefined) {
return new URL(value.u);
- if (value.bi !== undefined)
+ }
+ if (value.bi !== undefined) {
return BigInt(value.bi);
+ }
if (value.e !== undefined) {
const error = new Error(value.e.m);
error.name = value.e.n;
error.stack = value.e.s;
return error;
}
- if (value.r !== undefined)
+ if (value.r !== undefined) {
return new RegExp(value.r.p, value.r.f);
+ }
if (value.a !== undefined) {
const result: any[] = [];
refs.set(value.id!, result);
- for (const v of value.a)
+ for (const v of value.a) {
result.push(innerParseSerializedValue(v, handles, refs));
+ }
return result;
}
if (value.o !== undefined) {
const result: any = {};
refs.set(value.id!, result);
- for (const { k, v } of value.o)
+ for (const { k, v } of value.o) {
result[k] = innerParseSerializedValue(v, handles, refs);
+ }
return result;
}
if (value.h !== undefined) {
- if (handles === undefined)
+ if (handles === undefined) {
throw new Error('Unexpected handle');
+ }
return handles[value.h];
}
throw new Error('Unexpected value');
@@ -92,60 +109,79 @@ export function serializeValue(value: any, handleSerializer: (value: any) => Han
function innerSerializeValue(value: any, handleSerializer: (value: any) => HandleOrValue, visitorInfo: VisitorInfo): SerializedValue {
const handle = handleSerializer(value);
- if ('fallThrough' in handle)
+ if ('fallThrough' in handle) {
value = handle.fallThrough;
- else
+ } else {
return handle;
+ }
- if (typeof value === 'symbol')
+ if (typeof value === 'symbol') {
return { v: 'undefined' };
- if (Object.is(value, undefined))
+ }
+ if (Object.is(value, undefined)) {
return { v: 'undefined' };
- if (Object.is(value, null))
+ }
+ if (Object.is(value, null)) {
return { v: 'null' };
- if (Object.is(value, NaN))
+ }
+ if (Object.is(value, NaN)) {
return { v: 'NaN' };
- if (Object.is(value, Infinity))
+ }
+ if (Object.is(value, Infinity)) {
return { v: 'Infinity' };
- if (Object.is(value, -Infinity))
+ }
+ if (Object.is(value, -Infinity)) {
return { v: '-Infinity' };
- if (Object.is(value, -0))
+ }
+ if (Object.is(value, -0)) {
return { v: '-0' };
- if (typeof value === 'boolean')
+ }
+ if (typeof value === 'boolean') {
return { b: value };
- if (typeof value === 'number')
+ }
+ if (typeof value === 'number') {
return { n: value };
- if (typeof value === 'string')
+ }
+ if (typeof value === 'string') {
return { s: value };
- if (typeof value === 'bigint')
+ }
+ if (typeof value === 'bigint') {
return { bi: value.toString() };
- if (isError(value))
+ }
+ if (isError(value)) {
return { e: { n: value.name, m: value.message, s: value.stack || '' } };
- if (isDate(value))
+ }
+ if (isDate(value)) {
return { d: value.toJSON() };
- if (isURL(value))
+ }
+ if (isURL(value)) {
return { u: value.toJSON() };
- if (isRegExp(value))
+ }
+ if (isRegExp(value)) {
return { r: { p: value.source, f: value.flags } };
+ }
const id = visitorInfo.visited.get(value);
- if (id)
+ if (id) {
return { ref: id };
+ }
if (Array.isArray(value)) {
const a = [];
const id = ++visitorInfo.lastId;
visitorInfo.visited.set(value, id);
- for (let i = 0; i < value.length; ++i)
+ for (let i = 0; i < value.length; ++i) {
a.push(innerSerializeValue(value[i], handleSerializer, visitorInfo));
+ }
return { a, id };
}
if (typeof value === 'object') {
const o: { k: string, v: SerializedValue }[] = [];
const id = ++visitorInfo.lastId;
visitorInfo.visited.set(value, id);
- for (const name of Object.keys(value))
+ for (const name of Object.keys(value)) {
o.push({ k: name, v: innerSerializeValue(value[name], handleSerializer, visitorInfo) });
+ }
return { o, id };
}
throw new Error('Unexpected value');
diff --git a/packages/playwright-core/src/protocol/transport.ts b/packages/playwright-core/src/protocol/transport.ts
index e647100c63..ad8fdd29d0 100644
--- a/packages/playwright-core/src/protocol/transport.ts
+++ b/packages/playwright-core/src/protocol/transport.ts
@@ -49,22 +49,25 @@ export class PipeTransport {
pipeRead.on('data', buffer => this._dispatch(buffer));
pipeRead.on('close', () => {
this._closed = true;
- if (this.onclose)
+ if (this.onclose) {
this.onclose();
+ }
});
this.onmessage = undefined;
this.onclose = undefined;
}
send(message: string) {
- if (this._closed)
+ if (this._closed) {
throw new Error('Pipe has been closed');
+ }
const data = Buffer.from(message, 'utf-8');
const dataLength = Buffer.alloc(4);
- if (this._endian === 'be')
+ if (this._endian === 'be') {
dataLength.writeUInt32BE(data.length, 0);
- else
+ } else {
dataLength.writeUInt32LE(data.length, 0);
+ }
this._pipeWrite.write(dataLength);
this._pipeWrite.write(data);
}
@@ -96,8 +99,9 @@ export class PipeTransport {
this._data = this._data.slice(this._bytesLeft);
this._bytesLeft = 0;
this._waitForNextTask(() => {
- if (this.onmessage)
+ if (this.onmessage) {
this.onmessage(message.toString('utf-8'));
+ }
});
}
}
diff --git a/packages/playwright-core/src/protocol/validatorPrimitives.ts b/packages/playwright-core/src/protocol/validatorPrimitives.ts
index 9d4614512b..6c66e153d4 100644
--- a/packages/playwright-core/src/protocol/validatorPrimitives.ts
+++ b/packages/playwright-core/src/protocol/validatorPrimitives.ts
@@ -26,8 +26,9 @@ export const scheme: { [key: string]: Validator } = {};
export function findValidator(type: string, method: string, kind: 'Initializer' | 'Event' | 'Params' | 'Result'): Validator {
const validator = maybeFindValidator(type, method, kind);
- if (!validator)
+ if (!validator) {
throw new ValidationError(`Unknown scheme for ${kind}: ${type}.${method}`);
+ }
return validator;
}
export function maybeFindValidator(type: string, method: string, kind: 'Initializer' | 'Event' | 'Params' | 'Result'): Validator | undefined {
@@ -39,49 +40,60 @@ export function createMetadataValidator(): Validator {
}
export const tNumber: Validator = (arg: any, path: string, context: ValidatorContext) => {
- if (arg instanceof Number)
+ if (arg instanceof Number) {
return arg.valueOf();
- if (typeof arg === 'number')
+ }
+ if (typeof arg === 'number') {
return arg;
+ }
throw new ValidationError(`${path}: expected number, got ${typeof arg}`);
};
export const tBoolean: Validator = (arg: any, path: string, context: ValidatorContext) => {
- if (arg instanceof Boolean)
+ if (arg instanceof Boolean) {
return arg.valueOf();
- if (typeof arg === 'boolean')
+ }
+ if (typeof arg === 'boolean') {
return arg;
+ }
throw new ValidationError(`${path}: expected boolean, got ${typeof arg}`);
};
export const tString: Validator = (arg: any, path: string, context: ValidatorContext) => {
- if (arg instanceof String)
+ if (arg instanceof String) {
return arg.valueOf();
- if (typeof arg === 'string')
+ }
+ if (typeof arg === 'string') {
return arg;
+ }
throw new ValidationError(`${path}: expected string, got ${typeof arg}`);
};
export const tBinary: Validator = (arg: any, path: string, context: ValidatorContext) => {
if (context.binary === 'fromBase64') {
- if (arg instanceof String)
+ if (arg instanceof String) {
return Buffer.from(arg.valueOf(), 'base64');
- if (typeof arg === 'string')
+ }
+ if (typeof arg === 'string') {
return Buffer.from(arg, 'base64');
+ }
throw new ValidationError(`${path}: expected base64-encoded buffer, got ${typeof arg}`);
}
if (context.binary === 'toBase64') {
- if (!(arg instanceof Buffer))
+ if (!(arg instanceof Buffer)) {
throw new ValidationError(`${path}: expected Buffer, got ${typeof arg}`);
+ }
return (arg as Buffer).toString('base64');
}
if (context.binary === 'buffer') {
- if (!(arg instanceof Buffer))
+ if (!(arg instanceof Buffer)) {
throw new ValidationError(`${path}: expected Buffer, got ${typeof arg}`);
+ }
return arg;
}
throw new ValidationError(`Unsupported binary behavior "${context.binary}"`);
};
export const tUndefined: Validator = (arg: any, path: string, context: ValidatorContext) => {
- if (Object.is(arg, undefined))
+ if (Object.is(arg, undefined)) {
return arg;
+ }
throw new ValidationError(`${path}: expected undefined, got ${typeof arg}`);
};
export const tAny: Validator = (arg: any, path: string, context: ValidatorContext) => {
@@ -89,34 +101,40 @@ export const tAny: Validator = (arg: any, path: string, context: ValidatorContex
};
export const tOptional = (v: Validator): Validator => {
return (arg: any, path: string, context: ValidatorContext) => {
- if (Object.is(arg, undefined))
+ if (Object.is(arg, undefined)) {
return arg;
+ }
return v(arg, path, context);
};
};
export const tArray = (v: Validator): Validator => {
return (arg: any, path: string, context: ValidatorContext) => {
- if (!Array.isArray(arg))
+ if (!Array.isArray(arg)) {
throw new ValidationError(`${path}: expected array, got ${typeof arg}`);
+ }
return arg.map((x, index) => v(x, path + '[' + index + ']', context));
};
};
export const tObject = (s: { [key: string]: Validator }): Validator => {
return (arg: any, path: string, context: ValidatorContext) => {
- if (Object.is(arg, null))
+ if (Object.is(arg, null)) {
throw new ValidationError(`${path}: expected object, got null`);
- if (typeof arg !== 'object')
+ }
+ if (typeof arg !== 'object') {
throw new ValidationError(`${path}: expected object, got ${typeof arg}`);
+ }
const result: any = {};
for (const [key, v] of Object.entries(s)) {
const value = v(arg[key], path ? path + '.' + key : key, context);
- if (!Object.is(value, undefined))
+ if (!Object.is(value, undefined)) {
result[key] = value;
+ }
}
if (isUnderTest()) {
for (const [key, value] of Object.entries(arg)) {
- if (key.startsWith('__testHook'))
+ if (key.startsWith('__testHook')) {
result[key] = value;
+ }
}
}
return result;
@@ -124,8 +142,9 @@ export const tObject = (s: { [key: string]: Validator }): Validator => {
};
export const tEnum = (e: string[]): Validator => {
return (arg: any, path: string, context: ValidatorContext) => {
- if (!e.includes(arg))
+ if (!e.includes(arg)) {
throw new ValidationError(`${path}: expected one of (${e.join('|')})`);
+ }
return arg;
};
};
@@ -137,8 +156,9 @@ export const tChannel = (names: '*' | string[]): Validator => {
export const tType = (name: string): Validator => {
return (arg: any, path: string, context: ValidatorContext) => {
const v = scheme[name];
- if (!v)
+ if (!v) {
throw new ValidationError(path + ': unknown type "' + name + '"');
+ }
return v(arg, path, context);
};
};
diff --git a/packages/playwright-core/src/remote/playwrightConnection.ts b/packages/playwright-core/src/remote/playwrightConnection.ts
index cce31207a8..3b10592d9d 100644
--- a/packages/playwright-core/src/remote/playwrightConnection.ts
+++ b/packages/playwright-core/src/remote/playwrightConnection.ts
@@ -61,10 +61,12 @@ export class PlaywrightConnection {
this._preLaunched = preLaunched;
this._options = options;
options.launchOptions = filterLaunchOptions(options.launchOptions);
- if (clientType === 'reuse-browser' || clientType === 'pre-launched-browser-or-android')
+ if (clientType === 'reuse-browser' || clientType === 'pre-launched-browser-or-android') {
assert(preLaunched.playwright);
- if (clientType === 'pre-launched-browser-or-android')
+ }
+ if (clientType === 'pre-launched-browser-or-android') {
assert(preLaunched.browser || preLaunched.androidDevice);
+ }
this._onClose = onClose;
this._id = id;
this._profileName = `${new Date().toISOString()}-${clientType}`;
@@ -74,10 +76,12 @@ export class PlaywrightConnection {
await lock;
if (ws.readyState !== ws.CLOSING) {
const messageString = JSON.stringify(message);
- if (debugLogger.isEnabled('server:channel'))
+ if (debugLogger.isEnabled('server:channel')) {
debugLogger.log('server:channel', `[${this._id}] ${monotonicTime() * 1000} SEND ► ${messageString}`);
- if (debugLogger.isEnabled('server:metadata'))
+ }
+ if (debugLogger.isEnabled('server:metadata')) {
this.logServerMetadata(message, messageString, 'SEND');
+ }
ws.send(messageString);
}
};
@@ -85,10 +89,12 @@ export class PlaywrightConnection {
await lock;
const messageString = Buffer.from(message).toString();
const jsonMessage = JSON.parse(messageString);
- if (debugLogger.isEnabled('server:channel'))
+ if (debugLogger.isEnabled('server:channel')) {
debugLogger.log('server:channel', `[${this._id}] ${monotonicTime() * 1000} ◀ RECV ${messageString}`);
- if (debugLogger.isEnabled('server:metadata'))
+ }
+ if (debugLogger.isEnabled('server:metadata')) {
this.logServerMetadata(jsonMessage, messageString, 'RECV');
+ }
this._dispatcherConnection.dispatch(jsonMessage);
});
@@ -102,12 +108,15 @@ export class PlaywrightConnection {
this._root = new RootDispatcher(this._dispatcherConnection, async (scope, options) => {
await startProfiling();
- if (clientType === 'reuse-browser')
+ if (clientType === 'reuse-browser') {
return await this._initReuseBrowsersMode(scope);
- if (clientType === 'pre-launched-browser-or-android')
+ }
+ if (clientType === 'pre-launched-browser-or-android') {
return this._preLaunched.browser ? await this._initPreLaunchedBrowserMode(scope) : await this._initPreLaunchedAndroidMode(scope);
- if (clientType === 'launch-browser')
+ }
+ if (clientType === 'launch-browser') {
return await this._initLaunchBrowserMode(scope, options);
+ }
throw new Error('Unsupported client type: ' + clientType);
});
}
@@ -120,8 +129,9 @@ export class PlaywrightConnection {
const browser = await playwright[this._options.browserName as 'chromium'].launch(serverSideCallMetadata(), this._options.launchOptions);
this._cleanups.push(async () => {
- for (const browser of playwright.allBrowsers())
+ for (const browser of playwright.allBrowsers()) {
await browser.close({ reason: 'Connection terminated' });
+ }
});
browser.on(Browser.Events.Disconnected, () => {
// Underlying browser did close for some reason - force disconnect the client.
@@ -147,8 +157,9 @@ export class PlaywrightConnection {
const playwrightDispatcher = new PlaywrightDispatcher(scope, playwright, this._preLaunched.socksProxy, browser);
// In pre-launched mode, keep only the pre-launched browser.
for (const b of playwright.allBrowsers()) {
- if (b !== browser)
+ if (b !== browser) {
await b.close({ reason: 'Connection terminated' });
+ }
}
this._cleanups.push(() => playwrightDispatcher.cleanup());
return playwrightDispatcher;
@@ -183,18 +194,21 @@ export class PlaywrightConnection {
const requestedOptions = launchOptionsHash(this._options.launchOptions);
let browser = playwright.allBrowsers().find(b => {
- if (b.options.name !== this._options.browserName)
+ if (b.options.name !== this._options.browserName) {
return false;
+ }
const existingOptions = launchOptionsHash(b.options.originalLaunchOptions);
return existingOptions === requestedOptions;
});
// Close remaining browsers of this type+channel. Keep different browser types for the speed.
for (const b of playwright.allBrowsers()) {
- if (b === browser)
+ if (b === browser) {
continue;
- if (b.options.name === this._options.browserName && b.options.channel === this._options.launchOptions.channel)
+ }
+ if (b.options.name === this._options.browserName && b.options.channel === this._options.launchOptions.channel) {
await b.close({ reason: 'Connection terminated' });
+ }
}
if (!browser) {
@@ -213,13 +227,15 @@ export class PlaywrightConnection {
// but close all the empty browsers and contexts to clean up.
for (const browser of playwright.allBrowsers()) {
for (const context of browser.contexts()) {
- if (!context.pages().length)
+ if (!context.pages().length) {
await context.close({ reason: 'Connection terminated' });
- else
+ } else {
await context.stopPendingOperations('Connection closed');
+ }
}
- if (!browser.contexts())
+ if (!browser.contexts()) {
await browser.close({ reason: 'Connection terminated' });
+ }
}
});
@@ -228,8 +244,9 @@ export class PlaywrightConnection {
}
private async _createOwnedSocksProxy(playwright: Playwright): Promise {
- if (!this._options.socksProxyPattern)
+ if (!this._options.socksProxyPattern) {
return;
+ }
const socksProxy = new SocksProxy();
socksProxy.setPattern(this._options.socksProxyPattern);
playwright.options.socksProxyPort = await socksProxy.listen(0);
@@ -243,8 +260,9 @@ export class PlaywrightConnection {
debugLogger.log('server', `[${this._id}] disconnected. error: ${error}`);
this._root._dispose();
debugLogger.log('server', `[${this._id}] starting cleanup`);
- for (const cleanup of this._cleanups)
+ for (const cleanup of this._cleanups) {
await cleanup().catch(() => {});
+ }
await stopProfiling(this._profileName);
this._onClose();
debugLogger.log('server', `[${this._id}] finished cleanup`);
@@ -262,8 +280,9 @@ export class PlaywrightConnection {
}
async close(reason?: { code: number, reason: string }) {
- if (this._disconnected)
+ if (this._disconnected) {
return;
+ }
debugLogger.log('server', `[${this._id}] force closing connection: ${reason?.reason || ''} (${reason?.code || 0})`);
try {
this._ws.close(reason?.code, reason?.reason);
@@ -276,11 +295,13 @@ function launchOptionsHash(options: LaunchOptions) {
const copy = { ...options };
for (const k of Object.keys(copy)) {
const key = k as keyof LaunchOptions;
- if (copy[key] === defaultLaunchOptions[key])
+ if (copy[key] === defaultLaunchOptions[key]) {
delete copy[key];
+ }
}
- for (const key of optionsThatAllowBrowserReuse)
+ for (const key of optionsThatAllowBrowserReuse) {
delete copy[key];
+ }
return JSON.stringify(copy);
}
diff --git a/packages/playwright-core/src/remote/playwrightServer.ts b/packages/playwright-core/src/remote/playwrightServer.ts
index 121cc2d83a..298827d57c 100644
--- a/packages/playwright-core/src/remote/playwrightServer.ts
+++ b/packages/playwright-core/src/remote/playwrightServer.ts
@@ -43,10 +43,12 @@ export class PlaywrightServer {
constructor(options: ServerOptions) {
this._options = options;
- if (options.preLaunchedBrowser)
+ if (options.preLaunchedBrowser) {
this._preLaunchedPlaywright = options.preLaunchedBrowser.attribution.playwright;
- if (options.preLaunchedAndroidDevice)
+ }
+ if (options.preLaunchedAndroidDevice) {
this._preLaunchedPlaywright = options.preLaunchedAndroidDevice._android.attribution.playwright;
+ }
const browserSemaphore = new Semaphore(this._options.maxConnections);
const controllerSemaphore = new Semaphore(1);
@@ -55,13 +57,15 @@ export class PlaywrightServer {
this._wsServer = new WSServer({
onUpgrade: (request, socket) => {
const uaError = userAgentVersionMatchesErrorMessage(request.headers['user-agent'] || '');
- if (uaError)
+ if (uaError) {
return { error: `HTTP/${request.httpVersion} 428 Precondition Required\r\n\r\n${uaError}` };
+ }
},
onHeaders: headers => {
- if (process.env.PWTEST_SERVER_WS_HEADERS)
+ if (process.env.PWTEST_SERVER_WS_HEADERS) {
headers.push(process.env.PWTEST_SERVER_WS_HEADERS!);
+ }
},
onConnection: (request, url, ws, id) => {
@@ -82,8 +86,9 @@ export class PlaywrightServer {
// Instantiate playwright for the extension modes.
const isExtension = this._options.mode === 'extension';
if (isExtension) {
- if (!this._preLaunchedPlaywright)
+ if (!this._preLaunchedPlaywright) {
this._preLaunchedPlaywright = createPlaywright({ sdkLanguage: 'javascript', isServer: true });
+ }
}
let clientType: ClientType = 'launch-browser';
@@ -114,8 +119,9 @@ export class PlaywrightServer {
onClose: async () => {
debugLogger.log('server', 'closing browsers');
- if (this._preLaunchedPlaywright)
+ if (this._preLaunchedPlaywright) {
await Promise.all(this._preLaunchedPlaywright.allBrowsers().map(browser => browser.close({ reason: 'Playwright Server stopped' })));
+ }
debugLogger.log('server', 'closed browsers');
}
});
diff --git a/packages/playwright-core/src/server/accessibility.ts b/packages/playwright-core/src/server/accessibility.ts
index b92c5411f5..000045d7bf 100644
--- a/packages/playwright-core/src/server/accessibility.ts
+++ b/packages/playwright-core/src/server/accessibility.ts
@@ -42,39 +42,47 @@ export class Accessibility {
} = options;
const { tree, needle } = await this._getAXTree(root || undefined);
if (!interestingOnly) {
- if (root)
+ if (root) {
return needle && serializeTree(needle)[0];
+ }
return serializeTree(tree)[0];
}
const interestingNodes: Set = new Set();
collectInterestingNodes(interestingNodes, tree, false);
- if (root && (!needle || !interestingNodes.has(needle)))
+ if (root && (!needle || !interestingNodes.has(needle))) {
return null;
+ }
return serializeTree(needle || tree, interestingNodes)[0];
}
}
function collectInterestingNodes(collection: Set, node: AXNode, insideControl: boolean) {
- if (node.isInteresting(insideControl))
+ if (node.isInteresting(insideControl)) {
collection.add(node);
- if (node.isLeafNode())
+ }
+ if (node.isLeafNode()) {
return;
+ }
insideControl = insideControl || node.isControl();
- for (const child of node.children())
+ for (const child of node.children()) {
collectInterestingNodes(collection, child, insideControl);
+ }
}
function serializeTree(node: AXNode, whitelistedNodes?: Set): channels.AXNode[] {
const children: channels.AXNode[] = [];
- for (const child of node.children())
+ for (const child of node.children()) {
children.push(...serializeTree(child, whitelistedNodes));
+ }
- if (whitelistedNodes && !whitelistedNodes.has(node))
+ if (whitelistedNodes && !whitelistedNodes.has(node)) {
return children;
+ }
const serializedNode = node.serialize();
- if (children.length)
+ if (children.length) {
serializedNode.children = children;
+ }
return [serializedNode];
}
diff --git a/packages/playwright-core/src/server/android/android.ts b/packages/playwright-core/src/server/android/android.ts
index 1af083916c..e0e437ab26 100644
--- a/packages/playwright-core/src/server/android/android.ts
+++ b/packages/playwright-core/src/server/android/android.ts
@@ -80,14 +80,16 @@ export class Android extends SdkObject {
const newSerials = new Set();
for (const d of devices) {
newSerials.add(d.serial);
- if (this._devices.has(d.serial))
+ if (this._devices.has(d.serial)) {
continue;
+ }
const device = await AndroidDevice.create(this, d, options);
this._devices.set(d.serial, device);
}
for (const d of this._devices.keys()) {
- if (!newSerials.has(d))
+ if (!newSerials.has(d)) {
this._devices.delete(d);
+ }
}
return [...this._devices.values()];
}
@@ -168,10 +170,12 @@ export class AndroidDevice extends SdkObject {
}
private async _driver(): Promise {
- if (this._isClosed)
+ if (this._isClosed) {
return;
- if (!this._driverPromise)
+ }
+ if (!this._driverPromise) {
this._driverPromise = this._installDriver();
+ }
return this._driverPromise;
}
@@ -190,8 +194,9 @@ export class AndroidDevice extends SdkObject {
const packageManagerCommand = getPackageManagerExecCommand();
for (const file of ['android-driver.apk', 'android-driver-target.apk']) {
const fullName = path.join(executable.directory!, file);
- if (!fs.existsSync(fullName))
+ if (!fs.existsSync(fullName)) {
throw new Error(`Please install Android driver apk using '${packageManagerCommand} playwright install android'`);
+ }
await this.installApk(await fs.promises.readFile(fullName));
}
} else {
@@ -206,12 +211,14 @@ export class AndroidDevice extends SdkObject {
const response = JSON.parse(message);
const { id, result, error } = response;
const callback = this._callbacks.get(id);
- if (!callback)
+ if (!callback) {
return;
- if (error)
+ }
+ if (error) {
callback.reject(new Error(error));
- else
+ } else {
callback.fulfill(result);
+ }
this._callbacks.delete(id);
};
return transport;
@@ -235,8 +242,9 @@ export class AndroidDevice extends SdkObject {
// Patch the timeout in!
params.timeout = this._timeoutSettings.timeout(params);
const driver = await this._driver();
- if (!driver)
+ if (!driver) {
throw new Error('Device is closed');
+ }
const id = ++this._lastId;
const result = new Promise((fulfill, reject) => this._callbacks.set(id, { fulfill, reject }));
driver.send(JSON.stringify({ id, method, params }));
@@ -244,13 +252,16 @@ export class AndroidDevice extends SdkObject {
}
async close() {
- if (this._isClosed)
+ if (this._isClosed) {
return;
+ }
this._isClosed = true;
- if (this._pollingWebViews)
+ if (this._pollingWebViews) {
clearTimeout(this._pollingWebViews);
- for (const connection of this._browserConnections)
+ }
+ for (const connection of this._browserConnections) {
await connection.close();
+ }
if (this._driverPromise) {
const driver = await this._driver();
driver?.close();
@@ -292,12 +303,15 @@ export class AndroidDevice extends SdkObject {
if (proxy) {
chromeArguments.push(`--proxy-server=${proxy.server}`);
const proxyBypassRules = [];
- if (proxy.bypass)
+ if (proxy.bypass) {
proxyBypassRules.push(...proxy.bypass.split(',').map(t => t.trim()).map(t => t.startsWith('.') ? '*' + t : t));
- if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !proxyBypassRules.includes('<-loopback>'))
+ }
+ if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !proxyBypassRules.includes('<-loopback>')) {
proxyBypassRules.push('<-loopback>');
- if (proxyBypassRules.length > 0)
+ }
+ if (proxyBypassRules.length > 0) {
chromeArguments.push(`--proxy-bypass-list=${proxyBypassRules.join(';')}`);
+ }
}
chromeArguments.push(...args);
return chromeArguments;
@@ -305,8 +319,9 @@ export class AndroidDevice extends SdkObject {
async connectToWebView(socketName: string): Promise {
const webView = this._webViews.get(socketName);
- if (!webView)
+ if (!webView) {
throw new Error('WebView has been closed');
+ }
return await this._connectToBrowser(socketName);
}
@@ -319,8 +334,9 @@ export class AndroidDevice extends SdkObject {
const artifactsDir = await fs.promises.mkdtemp(ARTIFACTS_FOLDER);
const cleanupArtifactsDir = async () => {
const errors = await removeFolders([artifactsDir]);
- for (let i = 0; i < (errors || []).length; ++i)
+ for (let i = 0; i < (errors || []).length; ++i) {
debug('pw:android')(`exception while removing ${artifactsDir}: ${errors[i]}`);
+ }
};
gracefullyCloseSet.add(cleanupArtifactsDir);
socket.on('close', async () => {
@@ -381,43 +397,50 @@ export class AndroidDevice extends SdkObject {
};
await send('SEND', Buffer.from(`${path},${mode}`));
const maxChunk = 65535;
- for (let i = 0; i < content.length; i += maxChunk)
+ for (let i = 0; i < content.length; i += maxChunk) {
await send('DATA', content.slice(i, i + maxChunk));
+ }
await sendHeader('DONE', (Date.now() / 1000) | 0);
const result = await new Promise(f => socket.once('data', f));
const code = result.slice(0, 4).toString();
- if (code !== 'OKAY')
+ if (code !== 'OKAY') {
throw new Error('Could not push: ' + code);
+ }
socket.close();
}
private async _refreshWebViews() {
// possible socketName, eg: webview_devtools_remote_32327, webview_devtools_remote_32327_zeus, webview_devtools_remote_zeus
const sockets = (await this._backend.runCommand(`shell:cat /proc/net/unix | grep webview_devtools_remote`)).toString().split('\n');
- if (this._isClosed)
+ if (this._isClosed) {
return;
+ }
const socketNames = new Set();
for (const line of sockets) {
const matchSocketName = line.match(/[^@]+@(.*?webview_devtools_remote_?.*)/);
- if (!matchSocketName)
+ if (!matchSocketName) {
continue;
+ }
const socketName = matchSocketName[1];
socketNames.add(socketName);
- if (this._webViews.has(socketName))
+ if (this._webViews.has(socketName)) {
continue;
+ }
// possible line: 0000000000000000: 00000002 00000000 00010000 0001 01 5841881 @webview_devtools_remote_zeus
// the result: match[1] = ''
const match = line.match(/[^@]+@.*?webview_devtools_remote_?(\d*)/);
let pid = -1;
- if (match && match[1])
+ if (match && match[1]) {
pid = +match[1];
+ }
const pkg = await this._extractPkg(pid);
- if (this._isClosed)
+ if (this._isClosed) {
return;
+ }
const webView = { pid, pkg, socketName };
this._webViews.set(socketName, webView);
@@ -433,14 +456,16 @@ export class AndroidDevice extends SdkObject {
private async _extractPkg(pid: number) {
let pkg = '';
- if (pid === -1)
+ if (pid === -1) {
return pkg;
+ }
const procs = (await this._backend.runCommand(`shell:ps -A | grep ${pid}`)).toString().split('\n');
for (const proc of procs) {
const match = proc.match(/[^\s]+\s+(\d+).*$/);
- if (!match)
+ if (!match) {
continue;
+ }
pkg = proc.substring(proc.lastIndexOf(' ') + 1);
}
return pkg;
@@ -462,15 +487,17 @@ class AndroidBrowser extends EventEmitter {
this._socket = socket;
this._socket.on('close', () => {
this._waitForNextTask(() => {
- if (this.onclose)
+ if (this.onclose) {
this.onclose();
+ }
});
});
this._receiver = new wsReceiver() as stream.Writable;
this._receiver.on('message', message => {
this._waitForNextTask(() => {
- if (this.onmessage)
+ if (this.onmessage) {
this.onmessage(JSON.parse(message));
+ }
});
});
}
diff --git a/packages/playwright-core/src/server/android/backendAdb.ts b/packages/playwright-core/src/server/android/backendAdb.ts
index cd718b9d95..3cca53b07a 100644
--- a/packages/playwright-core/src/server/android/backendAdb.ts
+++ b/packages/playwright-core/src/server/android/backendAdb.ts
@@ -54,14 +54,16 @@ class AdbDevice implements DeviceBackend {
}
runCommand(command: string): Promise {
- if (this._closed)
+ if (this._closed) {
throw new Error('Device is closed');
+ }
return runCommand(command, this.host, this.port, this.serial);
}
async open(command: string): Promise {
- if (this._closed)
+ if (this._closed) {
throw new Error('Device is closed');
+ }
const result = await open(command, this.host, this.port, this.serial);
result.becomeSocket();
return result;
@@ -134,13 +136,15 @@ class BufferedSocketWrapper extends EventEmitter implements SocketBackend {
return;
}
this._buffer = Buffer.concat([this._buffer, data]);
- if (this._notifyReader)
+ if (this._notifyReader) {
this._notifyReader();
+ }
});
this._socket.on('close', () => {
this._isClosed = true;
- if (this._notifyReader)
+ if (this._notifyReader) {
this._notifyReader();
+ }
this.close();
this.emit('close');
});
@@ -154,8 +158,9 @@ class BufferedSocketWrapper extends EventEmitter implements SocketBackend {
}
close() {
- if (this._isClosed)
+ if (this._isClosed) {
return;
+ }
debug('pw:adb')('Close ' + this._command);
this._socket.destroy();
}
@@ -163,8 +168,9 @@ class BufferedSocketWrapper extends EventEmitter implements SocketBackend {
async read(length: number): Promise {
await this._connectPromise;
assert(!this._isSocket, 'Can not read by length in socket mode');
- while (this._buffer.length < length)
+ while (this._buffer.length < length) {
await new Promise(f => this._notifyReader = f);
+ }
const result = this._buffer.slice(0, length);
this._buffer = this._buffer.slice(length);
debug('pw:adb:recv')(result.toString().substring(0, 100) + '...');
@@ -172,8 +178,9 @@ class BufferedSocketWrapper extends EventEmitter implements SocketBackend {
}
async readAll(): Promise {
- while (!this._isClosed)
+ while (!this._isClosed) {
await new Promise(f => this._notifyReader = f);
+ }
return this._buffer;
}
diff --git a/packages/playwright-core/src/server/ariaSnapshot.ts b/packages/playwright-core/src/server/ariaSnapshot.ts
index 516688fef3..bfeecdf2cf 100644
--- a/packages/playwright-core/src/server/ariaSnapshot.ts
+++ b/packages/playwright-core/src/server/ariaSnapshot.ts
@@ -24,7 +24,8 @@ export function parseAriaSnapshot(text: string): AriaTemplateNode {
export function parseYamlForAriaSnapshot(text: string): ParsedYaml {
const parsed = yaml.parse(text);
- if (!Array.isArray(parsed))
+ if (!Array.isArray(parsed)) {
throw new Error('Expected object key starting with "- ":\n\n' + text + '\n');
+ }
return parsed;
}
diff --git a/packages/playwright-core/src/server/artifact.ts b/packages/playwright-core/src/server/artifact.ts
index 8824365b80..940d646fb6 100644
--- a/packages/playwright-core/src/server/artifact.ts
+++ b/packages/playwright-core/src/server/artifact.ts
@@ -49,21 +49,26 @@ export class Artifact extends SdkObject {
}
async localPathAfterFinished(): Promise {
- if (this._unaccessibleErrorMessage)
+ if (this._unaccessibleErrorMessage) {
throw new Error(this._unaccessibleErrorMessage);
+ }
await this._finishedPromise;
- if (this._failureError)
+ if (this._failureError) {
throw this._failureError;
+ }
return this._localPath;
}
saveAs(saveCallback: SaveCallback) {
- if (this._unaccessibleErrorMessage)
+ if (this._unaccessibleErrorMessage) {
throw new Error(this._unaccessibleErrorMessage);
- if (this._deleted)
+ }
+ if (this._deleted) {
throw new Error(`File already deleted. Save before deleting.`);
- if (this._failureError)
+ }
+ if (this._failureError) {
throw this._failureError;
+ }
if (this._finished) {
saveCallback(this._localPath).catch(() => {});
@@ -73,8 +78,9 @@ export class Artifact extends SdkObject {
}
async failureError(): Promise {
- if (this._unaccessibleErrorMessage)
+ if (this._unaccessibleErrorMessage) {
return this._unaccessibleErrorMessage;
+ }
await this._finishedPromise;
return this._failureError?.message || null;
}
@@ -85,39 +91,47 @@ export class Artifact extends SdkObject {
}
async delete(): Promise {
- if (this._unaccessibleErrorMessage)
+ if (this._unaccessibleErrorMessage) {
return;
+ }
const fileName = await this.localPathAfterFinished();
- if (this._deleted)
+ if (this._deleted) {
return;
+ }
this._deleted = true;
- if (fileName)
+ if (fileName) {
await fs.promises.unlink(fileName).catch(e => {});
+ }
}
async deleteOnContextClose(): Promise {
// Compared to "delete", this method does not wait for the artifact to finish.
// We use it when closing the context to avoid stalling.
- if (this._deleted)
+ if (this._deleted) {
return;
+ }
this._deleted = true;
- if (!this._unaccessibleErrorMessage)
+ if (!this._unaccessibleErrorMessage) {
await fs.promises.unlink(this._localPath).catch(e => {});
+ }
await this.reportFinished(new TargetClosedError());
}
async reportFinished(error?: Error) {
- if (this._finished)
+ if (this._finished) {
return;
+ }
this._finished = true;
this._failureError = error;
if (error) {
- for (const callback of this._saveCallbacks)
+ for (const callback of this._saveCallbacks) {
await callback('', error);
+ }
} else {
- for (const callback of this._saveCallbacks)
+ for (const callback of this._saveCallbacks) {
await callback(this._localPath);
+ }
}
this._saveCallbacks = [];
diff --git a/packages/playwright-core/src/server/bidi/bidiBrowser.ts b/packages/playwright-core/src/server/bidi/bidiBrowser.ts
index 955f6274a3..569998b115 100644
--- a/packages/playwright-core/src/server/bidi/bidiBrowser.ts
+++ b/packages/playwright-core/src/server/bidi/bidiBrowser.ts
@@ -41,8 +41,9 @@ export class BidiBrowser extends Browser {
static async connect(parent: SdkObject, transport: ConnectionTransport, options: BrowserOptions): Promise {
const browser = new BidiBrowser(parent, transport, options);
- if ((options as any).__testHookOnConnectToBrowser)
+ if ((options as any).__testHookOnConnectToBrowser) {
await (options as any).__testHookOnConnectToBrowser();
+ }
let proxy: bidi.Session.ManualProxyConfiguration | undefined;
if (options.proxy) {
@@ -68,8 +69,9 @@ export class BidiBrowser extends Browser {
default:
throw new Error('Invalid proxy server protocol: ' + options.proxy.server);
}
- if (options.proxy.bypass)
+ if (options.proxy.bypass) {
proxy.noProxy = options.proxy.bypass.split(',');
+ }
// TODO: support authentication.
}
@@ -148,8 +150,9 @@ export class BidiBrowser extends Browser {
const parentFrameId = event.parent;
for (const page of this._bidiPages.values()) {
const parentFrame = page._page._frameManager.frame(parentFrameId);
- if (!parentFrame)
+ if (!parentFrame) {
continue;
+ }
page._session.addFrameBrowsingContext(event.context);
page._page._frameManager.frameAttached(event.context, parentFrameId);
return;
@@ -157,10 +160,12 @@ export class BidiBrowser extends Browser {
return;
}
let context = this._contexts.get(event.userContext);
- if (!context)
+ if (!context) {
context = this._defaultContext as BidiBrowserContext;
- if (!context)
+ }
+ if (!context) {
return;
+ }
const session = this._connection.createMainFrameBrowsingContextSession(event.context);
const opener = event.originalOpener && this._bidiPages.get(event.originalOpener);
const page = new BidiPage(context, session, opener || null);
@@ -173,24 +178,27 @@ export class BidiBrowser extends Browser {
const parentFrameId = event.parent;
for (const page of this._bidiPages.values()) {
const parentFrame = page._page._frameManager.frame(parentFrameId);
- if (!parentFrame)
+ if (!parentFrame) {
continue;
+ }
page._page._frameManager.frameDetached(event.context);
return;
}
return;
}
const bidiPage = this._bidiPages.get(event.context);
- if (!bidiPage)
+ if (!bidiPage) {
return;
+ }
bidiPage.didClose();
this._bidiPages.delete(event.context);
}
private _onScriptRealmDestroyed(event: bidi.Script.RealmDestroyedParameters) {
for (const page of this._bidiPages.values()) {
- if (page._onRealmDestroyed(event))
+ if (page._onRealmDestroyed(event)) {
return;
+ }
}
}
}
@@ -282,8 +290,9 @@ export class BidiBrowserContext extends BrowserContext {
async doSetHTTPCredentials(httpCredentials?: types.Credentials): Promise {
this._options.httpCredentials = httpCredentials;
- for (const page of this.pages())
+ for (const page of this.pages()) {
await (page._delegate as BidiPage).updateHttpCredentials();
+ }
}
async doAddInitScript(initScript: InitScript) {
diff --git a/packages/playwright-core/src/server/bidi/bidiChromium.ts b/packages/playwright-core/src/server/bidi/bidiChromium.ts
index 9572ac71ed..35c8ccf140 100644
--- a/packages/playwright-core/src/server/bidi/bidiChromium.ts
+++ b/packages/playwright-core/src/server/bidi/bidiChromium.ts
@@ -43,14 +43,17 @@ export class BidiChromium extends BrowserType {
}
override doRewriteStartupLog(error: ProtocolError): ProtocolError {
- if (!error.logs)
+ if (!error.logs) {
return error;
- if (error.logs.includes('Missing X server'))
+ }
+ if (error.logs.includes('Missing X server')) {
error.logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);
+ }
// These error messages are taken from Chromium source code as of July, 2020:
// https://github.com/chromium/chromium/blob/70565f67e79f79e17663ad1337dc6e63ee207ce9/content/browser/zygote_host/zygote_host_impl_linux.cc
- if (!error.logs.includes('crbug.com/357670') && !error.logs.includes('No usable sandbox!') && !error.logs.includes('crbug.com/638180'))
+ if (!error.logs.includes('crbug.com/357670') && !error.logs.includes('No usable sandbox!') && !error.logs.includes('crbug.com/638180')) {
return error;
+ }
error.logs = [
`Chromium sandboxing failed!`,
`================================`,
@@ -69,8 +72,9 @@ export class BidiChromium extends BrowserType {
override attemptToGracefullyCloseBrowser(transport: ConnectionTransport): void {
const bidiTransport = (transport as any)[kBidiOverCdpWrapper];
- if (bidiTransport)
+ if (bidiTransport) {
transport = bidiTransport;
+ }
transport.send({ method: 'browser.close', params: {}, id: kBrowserCloseMessageId });
}
@@ -78,10 +82,11 @@ export class BidiChromium extends BrowserType {
const chromeArguments = this._innerDefaultArgs(options);
chromeArguments.push(`--user-data-dir=${userDataDir}`);
chromeArguments.push('--remote-debugging-port=0');
- if (isPersistent)
+ if (isPersistent) {
chromeArguments.push('about:blank');
- else
+ } else {
chromeArguments.push('--no-startup-window');
+ }
return chromeArguments;
}
@@ -93,24 +98,29 @@ export class BidiChromium extends BrowserType {
private _innerDefaultArgs(options: types.LaunchOptions): string[] {
const { args = [] } = options;
const userDataDirArg = args.find(arg => arg.startsWith('--user-data-dir'));
- if (userDataDirArg)
+ if (userDataDirArg) {
throw this._createUserDataDirArgMisuseError('--user-data-dir');
- if (args.find(arg => arg.startsWith('--remote-debugging-pipe')))
+ }
+ if (args.find(arg => arg.startsWith('--remote-debugging-pipe'))) {
throw new Error('Playwright manages remote debugging connection itself.');
- if (args.find(arg => !arg.startsWith('-')))
+ }
+ if (args.find(arg => !arg.startsWith('-'))) {
throw new Error('Arguments can not specify page to be opened');
+ }
const chromeArguments = [...chromiumSwitches];
if (os.platform() === 'darwin') {
// See https://github.com/microsoft/playwright/issues/7362
chromeArguments.push('--enable-use-zoom-for-dsf=false');
// See https://bugs.chromium.org/p/chromium/issues/detail?id=1407025.
- if (options.headless)
+ if (options.headless) {
chromeArguments.push('--use-angle');
+ }
}
- if (options.devtools)
+ if (options.devtools) {
chromeArguments.push('--auto-open-devtools-for-tabs');
+ }
if (options.headless) {
chromeArguments.push('--headless');
@@ -120,8 +130,9 @@ export class BidiChromium extends BrowserType {
'--blink-settings=primaryHoverType=2,availableHoverTypes=2,primaryPointerType=4,availablePointerTypes=4',
);
}
- if (options.chromiumSandbox !== true)
+ if (options.chromiumSandbox !== true) {
chromeArguments.push('--no-sandbox');
+ }
const proxy = options.proxyOverride || options.proxy;
if (proxy) {
const proxyURL = new URL(proxy.server);
@@ -134,14 +145,18 @@ export class BidiChromium extends BrowserType {
chromeArguments.push(`--proxy-server=${proxy.server}`);
const proxyBypassRules = [];
// https://source.chromium.org/chromium/chromium/src/+/master:net/docs/proxy.md;l=548;drc=71698e610121078e0d1a811054dcf9fd89b49578
- if (this.attribution.playwright.options.socksProxyPort)
+ if (this.attribution.playwright.options.socksProxyPort) {
proxyBypassRules.push('<-loopback>');
- if (proxy.bypass)
+ }
+ if (proxy.bypass) {
proxyBypassRules.push(...proxy.bypass.split(',').map(t => t.trim()).map(t => t.startsWith('.') ? '*' + t : t));
- if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !proxyBypassRules.includes('<-loopback>'))
+ }
+ if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !proxyBypassRules.includes('<-loopback>')) {
proxyBypassRules.push('<-loopback>');
- if (proxyBypassRules.length > 0)
+ }
+ if (proxyBypassRules.length > 0) {
chromeArguments.push(`--proxy-bypass-list=${proxyBypassRules.join(';')}`);
+ }
}
chromeArguments.push(...args);
return chromeArguments;
@@ -151,8 +166,9 @@ export class BidiChromium extends BrowserType {
class ChromiumReadyState extends BrowserReadyState {
override onBrowserOutput(message: string): void {
const match = message.match(/DevTools listening on (.*)/);
- if (match)
+ if (match) {
this._wsEndpoint.resolve(match[1]);
+ }
}
}
diff --git a/packages/playwright-core/src/server/bidi/bidiConnection.ts b/packages/playwright-core/src/server/bidi/bidiConnection.ts
index 48472bf748..6456302a9e 100644
--- a/packages/playwright-core/src/server/bidi/bidiConnection.ts
+++ b/packages/playwright-core/src/server/bidi/bidiConnection.ts
@@ -69,10 +69,11 @@ export class BidiConnection {
if (object.type === 'event') {
// Route page events to the right session.
let context;
- if ('context' in object.params)
+ if ('context' in object.params) {
context = object.params.context;
- else if (object.method === 'log.entryAdded' || object.method === 'script.message')
- context = object.params.source?.context;
+ } else if (object.method === 'log.entryAdded' || object.method === 'script.message') {
+ context = object.params.source.context;
+ }
if (context) {
const session = this._browsingContextToSession.get(context);
if (session) {
@@ -106,8 +107,9 @@ export class BidiConnection {
}
close() {
- if (!this._closed)
+ if (!this._closed) {
this._transport.close();
+ }
}
createMainFrameBrowsingContextSession(bowsingContextId: bidi.BrowsingContext.BrowsingContext): BidiSession {
@@ -165,8 +167,9 @@ export class BidiSession extends EventEmitter {
method: T,
params?: bidiCommands.Commands[T]['params']
): Promise {
- if (this._crashed || this._disposed || this.connection._browserDisconnectedLogs)
+ if (this._crashed || this._disposed || this.connection._browserDisconnectedLogs) {
throw new ProtocolError(this._crashed ? 'crashed' : 'closed', undefined, this.connection._browserDisconnectedLogs);
+ }
const id = this.connection.nextMessageId();
const messageObj = { id, method, params };
this._rawSend(messageObj);
@@ -190,8 +193,9 @@ export class BidiSession extends EventEmitter {
dispose() {
this._disposed = true;
this.connection._browsingContextToSession.delete(this.sessionId);
- for (const context of this._browsingContexts)
+ for (const context of this._browsingContexts) {
this.connection._browsingContextToSession.delete(context);
+ }
this._browsingContexts.clear();
for (const callback of this._callbacks.values()) {
callback.error.type = this._crashed ? 'crashed' : 'closed';
@@ -207,8 +211,9 @@ export class BidiSession extends EventEmitter {
dispatchMessage(message: any) {
const object = message as bidi.Message;
- if (object.id === kBrowserCloseMessageId)
+ if (object.id === kBrowserCloseMessageId) {
return;
+ }
if (object.id && this._callbacks.has(object.id)) {
const callback = this._callbacks.get(object.id)!;
this._callbacks.delete(object.id);
diff --git a/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts b/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts
index f53b160ccf..cfc691f52e 100644
--- a/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts
+++ b/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts
@@ -51,10 +51,12 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {
awaitPromise: true,
userActivation: true,
});
- if (response.type === 'success')
+ if (response.type === 'success') {
return BidiDeserializer.deserialize(response.result);
- if (response.type === 'exception')
+ }
+ if (response.type === 'exception') {
throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text + '\nFull val: ' + JSON.stringify(response.exceptionDetails));
+ }
throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));
}
@@ -68,12 +70,14 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {
userActivation: true,
});
if (response.type === 'success') {
- if ('handle' in response.result)
+ if ('handle' in response.result) {
return response.result.handle!;
+ }
throw new js.JavaScriptErrorInEvaluate('Cannot get handle: ' + JSON.stringify(response.result));
}
- if (response.type === 'exception')
+ if (response.type === 'exception') {
throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text + '\nFull val: ' + JSON.stringify(response.exceptionDetails));
+ }
throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));
}
@@ -91,11 +95,13 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {
awaitPromise: true,
userActivation: true,
});
- if (response.type === 'exception')
+ if (response.type === 'exception') {
throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text + '\nFull val: ' + JSON.stringify(response.exceptionDetails));
+ }
if (response.type === 'success') {
- if (returnByValue)
+ if (returnByValue) {
return parseEvaluationResultValue(BidiDeserializer.deserialize(response.result));
+ }
const objectId = 'handle' in response.result ? response.result.handle : undefined ;
return utilityScript._context.createHandle({ objectId, ...response.result });
}
@@ -128,32 +134,41 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {
awaitPromise: true,
userActivation: true,
});
- if (response.type === 'exception')
+ if (response.type === 'exception') {
throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text + '\nFull val: ' + JSON.stringify(response.exceptionDetails));
- if (response.type === 'success')
+ }
+ if (response.type === 'success') {
return response.result;
+ }
throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));
}
}
function renderPreview(remoteObject: bidi.Script.RemoteValue): string | undefined {
- if (remoteObject.type === 'undefined')
+ if (remoteObject.type === 'undefined') {
return 'undefined';
- if (remoteObject.type === 'null')
+ }
+ if (remoteObject.type === 'null') {
return 'null';
- if ('value' in remoteObject)
+ }
+ if ('value' in remoteObject) {
return String(remoteObject.value);
+ }
return `<${remoteObject.type}>`;
}
function remoteObjectValue(remoteObject: bidi.Script.RemoteValue): any {
- if (remoteObject.type === 'undefined')
+ if (remoteObject.type === 'undefined') {
return undefined;
- if (remoteObject.type === 'null')
+ }
+ if (remoteObject.type === 'null') {
return null;
- if (remoteObject.type === 'number' && typeof remoteObject.value === 'string')
+ }
+ if (remoteObject.type === 'number' && typeof remoteObject.value === 'string') {
return js.parseUnserializableValue(remoteObject.value);
- if ('value' in remoteObject)
+ }
+ if ('value' in remoteObject) {
return remoteObject.value;
+ }
return undefined;
}
diff --git a/packages/playwright-core/src/server/bidi/bidiFirefox.ts b/packages/playwright-core/src/server/bidi/bidiFirefox.ts
index 204cabdef7..2bb2f69269 100644
--- a/packages/playwright-core/src/server/bidi/bidiFirefox.ts
+++ b/packages/playwright-core/src/server/bidi/bidiFirefox.ts
@@ -39,19 +39,23 @@ export class BidiFirefox extends BrowserType {
}
override doRewriteStartupLog(error: ProtocolError): ProtocolError {
- if (!error.logs)
+ if (!error.logs) {
return error;
+ }
// https://github.com/microsoft/playwright/issues/6500
- if (error.logs.includes(`as root in a regular user's session is not supported.`))
+ if (error.logs.includes(`as root in a regular user's session is not supported.`)) {
error.logs = '\n' + wrapInASCIIBox(`Firefox is unable to launch if the $HOME folder isn't owned by the current user.\nWorkaround: Set the HOME=/root environment variable${process.env.GITHUB_ACTION ? ' in your GitHub Actions workflow file' : ''} when running Playwright.`, 1);
- if (error.logs.includes('no DISPLAY environment variable specified'))
+ }
+ if (error.logs.includes('no DISPLAY environment variable specified')) {
error.logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);
+ }
return error;
}
override amendEnvironment(env: Env, userDataDir: string, executable: string, browserArguments: string[]): Env {
- if (!path.isAbsolute(os.homedir()))
+ if (!path.isAbsolute(os.homedir())) {
throw new Error(`Cannot launch Firefox with relative home directory. Did you set ${os.platform() === 'win32' ? 'USERPROFILE' : 'HOME'} to a relative path?`);
+ }
env = {
...env,
@@ -83,13 +87,15 @@ export class BidiFirefox extends BrowserType {
override defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): string[] {
const { args = [], headless } = options;
const userDataDirArg = args.find(arg => arg.startsWith('-profile') || arg.startsWith('--profile'));
- if (userDataDirArg)
+ if (userDataDirArg) {
throw this._createUserDataDirArgMisuseError('--profile');
+ }
const firefoxArguments = ['--remote-debugging-port=0'];
- if (headless)
+ if (headless) {
firefoxArguments.push('--headless');
- else
+ } else {
firefoxArguments.push('--foreground');
+ }
firefoxArguments.push(`--profile`, userDataDir);
firefoxArguments.push(...args);
return firefoxArguments;
@@ -105,7 +111,8 @@ class FirefoxReadyState extends BrowserReadyState {
override onBrowserOutput(message: string): void {
// Bidi WebSocket in Firefox.
const match = message.match(/WebDriver BiDi listening on (ws:\/\/.*)$/);
- if (match)
+ if (match) {
this._wsEndpoint.resolve(match[1] + '/session');
+ }
}
}
diff --git a/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts b/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts
index b7c314bd10..465e51e081 100644
--- a/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts
+++ b/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts
@@ -55,14 +55,17 @@ export class BidiNetworkManager {
}
private _onBeforeRequestSent(param: bidi.Network.BeforeRequestSentParameters) {
- if (param.request.url.startsWith('data:'))
+ if (param.request.url.startsWith('data:')) {
return;
+ }
const redirectedFrom = param.redirectCount ? (this._requests.get(param.request.request) || null) : null;
const frame = redirectedFrom ? redirectedFrom.request.frame() : (param.context ? this._page._frameManager.frame(param.context) : null);
- if (!frame)
+ if (!frame) {
return;
- if (redirectedFrom)
+ }
+ if (redirectedFrom) {
this._requests.delete(redirectedFrom._id);
+ }
let route;
if (param.intercepts) {
// We do not support intercepting redirects.
@@ -82,16 +85,18 @@ export class BidiNetworkManager {
private _onResponseStarted(params: bidi.Network.ResponseStartedParameters) {
const request = this._requests.get(params.request.request);
- if (!request)
+ if (!request) {
return;
+ }
const getResponseBody = async () => {
throw new Error(`Response body is not available for requests in Bidi`);
};
const timings = params.request.timings;
const startTime = timings.requestTime;
function relativeToStart(time: number): number {
- if (!time)
+ if (!time) {
return -1;
+ }
return (time - startTime) / 1000;
}
const timing: network.ResourceTiming = {
@@ -111,14 +116,16 @@ export class BidiNetworkManager {
response.setRawResponseHeaders(null);
response.setResponseHeadersSize(params.response.headersSize);
this._page._frameManager.requestReceivedResponse(response);
- if (params.navigation)
+ if (params.navigation) {
this._onNavigationResponseStarted(params);
+ }
}
private _onResponseCompleted(params: bidi.Network.ResponseCompletedParameters) {
const request = this._requests.get(params.request.request);
- if (!request)
+ if (!request) {
return;
+ }
const response = request.request._existingResponse()!;
// TODO: body size is the encoded size
response.setTransferSize(params.response.bodySize);
@@ -140,8 +147,9 @@ export class BidiNetworkManager {
private _onFetchError(params: bidi.Network.FetchErrorParameters) {
const request = this._requests.get(params.request.request);
- if (!request)
+ if (!request) {
return;
+ }
this._requests.delete(request._id);
const response = request.request._existingResponse();
if (response) {
@@ -187,11 +195,13 @@ export class BidiNetworkManager {
async _updateProtocolRequestInterception(initial?: boolean) {
const enabled = this._userRequestInterceptionEnabled || !!this._credentials;
- if (enabled === this._protocolRequestInterceptionEnabled)
+ if (enabled === this._protocolRequestInterceptionEnabled) {
return;
+ }
this._protocolRequestInterceptionEnabled = enabled;
- if (initial && !enabled)
+ if (initial && !enabled) {
return;
+ }
const cachePromise = this._session.send('network.setCacheBehavior', { cacheBehavior: enabled ? 'bypass' : 'default' });
let interceptPromise = Promise.resolve(undefined);
if (enabled) {
@@ -221,8 +231,9 @@ class BidiRequest {
constructor(frame: frames.Frame, redirectedFrom: BidiRequest | null, payload: bidi.Network.BeforeRequestSentParameters, route: BidiRouteImpl | undefined) {
this._id = payload.request.request;
- if (redirectedFrom)
+ if (redirectedFrom) {
redirectedFrom._redirectedTo = this;
+ }
// TODO: missing in the spec?
const postDataBuffer = null;
this.request = new network.Request(frame._page._browserContext, frame, null, redirectedFrom ? redirectedFrom.request : null, payload.navigation ?? undefined,
@@ -236,8 +247,9 @@ class BidiRequest {
_finalRequest(): BidiRequest {
let request: BidiRequest = this;
- while (request._redirectedTo)
+ while (request._redirectedTo) {
request = request._redirectedTo;
+ }
return request;
}
}
@@ -262,8 +274,9 @@ class BidiRouteImpl implements network.RouteDelegate {
let headers = overrides.headers || this._request.headers();
if (overrides.postData && headers) {
headers = headers.map(header => {
- if (header.name.toLowerCase() === 'content-length')
+ if (header.name.toLowerCase() === 'content-length') {
return { name: header.name, value: overrides.postData!.byteLength.toString() };
+ }
return header;
});
}
@@ -297,8 +310,9 @@ class BidiRouteImpl implements network.RouteDelegate {
function fromBidiHeaders(bidiHeaders: bidi.Network.Header[]): types.HeadersArray {
const result: types.HeadersArray = [];
- for (const { name, value } of bidiHeaders)
+ for (const { name, value } of bidiHeaders) {
result.push({ name, value: bidiBytesValueToString(value) });
+ }
return result;
}
@@ -328,20 +342,25 @@ function toBidiHeaders(headers: types.HeadersArray): bidi.Network.Header[] {
}
export function bidiBytesValueToString(value: bidi.Network.BytesValue): string {
- if (value.type === 'string')
+ if (value.type === 'string') {
return value.value;
- if (value.type === 'base64')
+ }
+ if (value.type === 'base64') {
return Buffer.from(value.type, 'base64').toString('binary');
+ }
return 'unknown value type: ' + (value as any).type;
}
function toBidiSameSite(sameSite?: 'Strict' | 'Lax' | 'None'): bidi.Network.SameSite | undefined {
- if (!sameSite)
+ if (!sameSite) {
return undefined;
- if (sameSite === 'Strict')
+ }
+ if (sameSite === 'Strict') {
return bidi.Network.SameSite.Strict;
- if (sameSite === 'Lax')
+ }
+ if (sameSite === 'Lax') {
return bidi.Network.SameSite.Lax;
+ }
return bidi.Network.SameSite.None;
}
diff --git a/packages/playwright-core/src/server/bidi/bidiPage.ts b/packages/playwright-core/src/server/bidi/bidiPage.ts
index 9b501c5484..b25a4711ff 100644
--- a/packages/playwright-core/src/server/bidi/bidiPage.ts
+++ b/packages/playwright-core/src/server/bidi/bidiPage.ts
@@ -115,20 +115,24 @@ export class BidiPage implements PageDelegate {
for (const [contextId, context] of this._realmToContext) {
if (context.frame === frame) {
this._realmToContext.delete(contextId);
- if (notifyFrame)
+ if (notifyFrame) {
frame._contextDestroyed(context);
+ }
}
}
}
private _onRealmCreated(realmInfo: bidi.Script.RealmInfo) {
- if (this._realmToContext.has(realmInfo.realm))
+ if (this._realmToContext.has(realmInfo.realm)) {
return;
- if (realmInfo.type !== 'window')
+ }
+ if (realmInfo.type !== 'window') {
return;
+ }
const frame = this._page._frameManager.frame(realmInfo.context);
- if (!frame)
+ if (!frame) {
return;
+ }
const delegate = new BidiExecutionContext(this._session, realmInfo);
let worldName: types.World;
if (!realmInfo.sandbox) {
@@ -164,8 +168,9 @@ export class BidiPage implements PageDelegate {
_onRealmDestroyed(params: bidi.Script.RealmDestroyedParameters): boolean {
const context = this._realmToContext.get(params.realm);
- if (!context)
+ if (!context) {
return false;
+ }
this._realmToContext.delete(params.realm);
context.frame._contextDestroyed(context);
return true;
@@ -185,8 +190,9 @@ export class BidiPage implements PageDelegate {
// Navigation to file urls doesn't emit network events, so we fire 'commit' event right when navigation is started.
// Doing it in domcontentload would be too late as we'd clear frame tree.
const frame = this._page._frameManager.frame(frameId)!;
- if (frame)
+ if (frame) {
this._page._frameManager.frameCommittedNewDocumentNavigation(frameId, params.url, '', params.navigation!, /* initial */ false);
+ }
}
}
@@ -233,12 +239,14 @@ export class BidiPage implements PageDelegate {
}
private _onLogEntryAdded(params: bidi.Log.Entry) {
- if (params.type !== 'console')
+ if (params.type !== 'console') {
return;
+ }
const entry: bidi.Log.ConsoleLogEntry = params as bidi.Log.ConsoleLogEntry;
const context = this._realmToContext.get(params.source.realm);
- if (!context)
+ if (!context) {
return;
+ }
const callFrame = params.stackTrace?.callFrames[0];
const location = callFrame ?? { url: '', lineNumber: 1, columnNumber: 1 };
this._page._addConsoleMessage(entry.method, entry.args.map(arg => context.createHandle({ objectId: (arg as any).handle, ...arg })), location, params.text || undefined);
@@ -274,8 +282,9 @@ export class BidiPage implements PageDelegate {
private async _updateViewport(): Promise {
const options = this._browserContext._options;
const deviceSize = this._page.emulatedSize();
- if (deviceSize === null)
+ if (deviceSize === null) {
return;
+ }
const viewportSize = deviceSize.viewport;
await this._session.send('browsingContext.setViewport', {
context: this._session.sessionId,
@@ -353,16 +362,20 @@ export class BidiPage implements PageDelegate {
}
private async _onScriptMessage(event: bidi.Script.MessageParameters) {
- if (event.channel !== kPlaywrightBindingChannel)
+ if (event.channel !== kPlaywrightBindingChannel) {
return;
+ }
const pageOrError = await this._page.waitForInitializedOrError();
- if (pageOrError instanceof Error)
+ if (pageOrError instanceof Error) {
return;
+ }
const context = this._realmToContext.get(event.source.realm);
- if (!context)
+ if (!context) {
return;
- if (event.data.type !== 'string')
+ }
+ if (event.data.type !== 'string') {
return;
+ }
await this._page._onBindingCalled(event.data.value, context);
}
@@ -373,8 +386,9 @@ export class BidiPage implements PageDelegate {
// TODO: push to iframes?
contexts: [this._session.sessionId],
});
- if (!initScript.internal)
+ if (!initScript.internal) {
this._initScriptIds.push(script);
+ }
}
async removeNonInternalInitScripts() {
@@ -431,16 +445,19 @@ export class BidiPage implements PageDelegate {
async getBoundingBox(handle: dom.ElementHandle): Promise {
const box = await handle.evaluate(element => {
- if (!(element instanceof Element))
+ if (!(element instanceof Element)) {
return null;
+ }
const rect = element.getBoundingClientRect();
return { x: rect.x, y: rect.y, width: rect.width, height: rect.height };
});
- if (!box)
+ if (!box) {
return null;
+ }
const position = await this._framePosition(handle._frame);
- if (!position)
+ if (!position) {
return null;
+ }
box.x += position.x;
box.y += position.y;
return box;
@@ -448,15 +465,18 @@ export class BidiPage implements PageDelegate {
// TODO: move to Frame.
private async _framePosition(frame: frames.Frame): Promise {
- if (frame === this._page.mainFrame())
+ if (frame === this._page.mainFrame()) {
return { x: 0, y: 0 };
+ }
const element = await frame.frameElement();
const box = await element.boundingBox();
- if (!box)
+ if (!box) {
return null;
+ }
const style = await element.evaluateInUtility(([injected, iframe]) => injected.describeIFrameStyle(iframe as Element), {}).catch(e => 'error:notconnected' as const);
- if (style === 'error:notconnected' || style === 'transformed')
+ if (style === 'error:notconnected' || style === 'transformed') {
return null;
+ }
// Content box is offset by border and padding widths.
box.x += style.left;
box.y += style.top;
@@ -471,10 +491,12 @@ export class BidiPage implements PageDelegate {
behavior: 'instant',
});
}, null).then(() => 'done' as const).catch(e => {
- if (e instanceof Error && e.message.includes('Node is detached from document'))
+ if (e instanceof Error && e.message.includes('Node is detached from document')) {
return 'error:notconnected';
- if (e instanceof Error && e.message.includes('Node does not have a layout object'))
+ }
+ if (e instanceof Error && e.message.includes('Node does not have a layout object')) {
return 'error:notvisible';
+ }
throw e;
});
}
@@ -488,11 +510,13 @@ export class BidiPage implements PageDelegate {
async getContentQuads(handle: dom.ElementHandle): Promise {
const quads = await handle.evaluateInUtility(([injected, node]) => {
- if (!node.isConnected)
+ if (!node.isConnected) {
return 'error:notconnected';
+ }
const rects = node.getClientRects();
- if (!rects)
+ if (!rects) {
return null;
+ }
return [...rects].map(rect => [
{ x: rect.left, y: rect.top },
{ x: rect.right, y: rect.top },
@@ -500,12 +524,14 @@ export class BidiPage implements PageDelegate {
{ x: rect.left, y: rect.bottom },
]);
}, null);
- if (!quads || quads === 'error:notconnected')
+ if (!quads || quads === 'error:notconnected') {
return quads;
+ }
// TODO: consider transforming quads to support clicks in iframes.
const position = await this._framePosition(handle._frame);
- if (!position)
+ if (!position) {
return null;
+ }
quads.forEach(quad => quad.forEach(point => {
point.x += position.x;
point.y += position.y;
@@ -525,13 +551,15 @@ export class BidiPage implements PageDelegate {
const fromContext = toBidiExecutionContext(handle._context);
const shared = await fromContext.rawCallFunction('x => x', { handle: handle._objectId });
// TODO: store sharedId in the handle.
- if (!('sharedId' in shared))
+ if (!('sharedId' in shared)) {
throw new Error('Element is not a node');
+ }
const sharedId = shared.sharedId!;
const executionContext = toBidiExecutionContext(to);
const result = await executionContext.rawCallFunction('x => x', { sharedId });
- if ('handle' in result)
+ if ('handle' in result) {
return to.createHandle({ objectId: result.handle!, ...result }) as dom.ElementHandle;
+ }
throw new Error('Failed to adopt element handle.');
}
@@ -551,10 +579,13 @@ export class BidiPage implements PageDelegate {
async getFrameElement(frame: frames.Frame): Promise {
const parent = frame.parentFrame();
- if (!parent)
+ if (!parent) {
throw new Error('Frame has been detached.');
+ }
const parentContext = await parent._mainContext();
- const list = await parentContext.evaluateHandle(() => { return [...document.querySelectorAll('iframe,frame')]; });
+ const list = await parentContext.evaluateHandle(() => {
+ return [...document.querySelectorAll('iframe,frame')];
+ });
const length = await list.evaluate(list => list.length);
let foundElement = null;
for (let i = 0; i < length; i++) {
@@ -568,8 +599,9 @@ export class BidiPage implements PageDelegate {
}
}
list.dispose();
- if (!foundElement)
+ if (!foundElement) {
throw new Error('Frame has been detached.');
+ }
return foundElement;
}
diff --git a/packages/playwright-core/src/server/bidi/bidiPdf.ts b/packages/playwright-core/src/server/bidi/bidiPdf.ts
index 89fefb5260..b773e6b6f7 100644
--- a/packages/playwright-core/src/server/bidi/bidiPdf.ts
+++ b/packages/playwright-core/src/server/bidi/bidiPdf.ts
@@ -41,8 +41,9 @@ const unitToPixels: { [key: string]: number } = {
};
function convertPrintParameterToInches(text: string | undefined): number | undefined {
- if (text === undefined)
+ if (text === undefined) {
return undefined;
+ }
let unit = text.substring(text.length - 2).toLowerCase();
let valueText = '';
if (unitToPixels.hasOwnProperty(unit)) {
diff --git a/packages/playwright-core/src/server/bidi/third_party/bidiDeserializer.ts b/packages/playwright-core/src/server/bidi/third_party/bidiDeserializer.ts
index 3637b4af36..4bdb3d081c 100644
--- a/packages/playwright-core/src/server/bidi/third_party/bidiDeserializer.ts
+++ b/packages/playwright-core/src/server/bidi/third_party/bidiDeserializer.ts
@@ -15,8 +15,9 @@ import type * as Bidi from './bidiProtocol';
*/
export class BidiDeserializer {
static deserialize(result: Bidi.Script.RemoteValue): any {
- if (!result)
+ if (!result) {
return undefined;
+ }
switch (result.type) {
case 'array':
diff --git a/packages/playwright-core/src/server/bidi/third_party/bidiKeyboard.ts b/packages/playwright-core/src/server/bidi/third_party/bidiKeyboard.ts
index 307d83fb87..e9819d0c8c 100644
--- a/packages/playwright-core/src/server/bidi/third_party/bidiKeyboard.ts
+++ b/packages/playwright-core/src/server/bidi/third_party/bidiKeyboard.ts
@@ -5,7 +5,6 @@
* SPDX-License-Identifier: Apache-2.0
*/
-/* eslint-disable curly */
export const getBidiKeyValue = (key: string) => {
switch (key) {
diff --git a/packages/playwright-core/src/server/bidi/third_party/bidiSerializer.ts b/packages/playwright-core/src/server/bidi/third_party/bidiSerializer.ts
index 97e8381328..727336b5ad 100644
--- a/packages/playwright-core/src/server/bidi/third_party/bidiSerializer.ts
+++ b/packages/playwright-core/src/server/bidi/third_party/bidiSerializer.ts
@@ -7,7 +7,7 @@
import type * as Bidi from './bidiProtocol';
-/* eslint-disable curly, indent */
+/* eslint-disable indent */
/**
* @internal
diff --git a/packages/playwright-core/src/server/bidi/third_party/firefoxPrefs.ts b/packages/playwright-core/src/server/bidi/third_party/firefoxPrefs.ts
index 7c08bebe6d..2bbc6d0418 100644
--- a/packages/playwright-core/src/server/bidi/third_party/firefoxPrefs.ts
+++ b/packages/playwright-core/src/server/bidi/third_party/firefoxPrefs.ts
@@ -7,7 +7,7 @@
import fs from 'fs';
import path from 'path';
-/* eslint-disable curly, indent */
+/* eslint-disable indent */
interface ProfileOptions {
preferences: Record;
diff --git a/packages/playwright-core/src/server/browser.ts b/packages/playwright-core/src/server/browser.ts
index 252443bc44..1dc04a18c2 100644
--- a/packages/playwright-core/src/server/browser.ts
+++ b/packages/playwright-core/src/server/browser.ts
@@ -98,16 +98,18 @@ export abstract class Browser extends SdkObject {
throw error;
}
context._clientCertificatesProxy = clientCertificatesProxy;
- if (options.storageState)
+ if (options.storageState) {
await context.setStorageState(metadata, options.storageState);
+ }
return context;
}
async newContextForReuse(params: channels.BrowserNewContextForReuseParams, metadata: CallMetadata): Promise<{ context: BrowserContext, needsReset: boolean }> {
const hash = BrowserContext.reusableContextHash(params);
if (!this._contextForReuse || hash !== this._contextForReuse.hash || !this._contextForReuse.context.canResetForReuse()) {
- if (this._contextForReuse)
+ if (this._contextForReuse) {
await this._contextForReuse.context.close({ reason: 'Context reused' });
+ }
this._contextForReuse = { context: await this.newContext(metadata, params), hash };
return { context: this._contextForReuse.context, needsReset: false };
}
@@ -116,7 +118,7 @@ export abstract class Browser extends SdkObject {
}
async stopPendingOperations(reason: string) {
- await this._contextForReuse?.context?.stopPendingOperations(reason);
+ await this._contextForReuse?.context.stopPendingOperations(reason);
}
_downloadCreated(page: Page, uuid: string, url: string, suggestedFilename?: string) {
@@ -126,15 +128,17 @@ export abstract class Browser extends SdkObject {
_downloadFilenameSuggested(uuid: string, suggestedFilename: string) {
const download = this._downloads.get(uuid);
- if (!download)
+ if (!download) {
return;
+ }
download._filenameSuggested(suggestedFilename);
}
_downloadFinished(uuid: string, error?: string) {
const download = this._downloads.get(uuid);
- if (!download)
+ if (!download) {
return;
+ }
download.artifact.reportFinished(error ? new Error(error) : undefined);
this._downloads.delete(uuid);
}
@@ -158,23 +162,27 @@ export abstract class Browser extends SdkObject {
}
_didClose() {
- for (const context of this.contexts())
+ for (const context of this.contexts()) {
context._browserClosed();
- if (this._defaultContext)
+ }
+ if (this._defaultContext) {
this._defaultContext._browserClosed();
+ }
this.emit(Browser.Events.Disconnected);
this.instrumentation.onBrowserClose(this);
}
async close(options: { reason?: string }) {
if (!this._startedClosing) {
- if (options.reason)
+ if (options.reason) {
this._closeReason = options.reason;
+ }
this._startedClosing = true;
await this.options.browserProcess.close();
}
- if (this.isConnected())
+ if (this.isConnected()) {
await new Promise(x => this.once(Browser.Events.Disconnected, x));
+ }
}
async killForTests() {
diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.ts
index fc20c52bb5..32f4efaa99 100644
--- a/packages/playwright-core/src/server/browserContext.ts
+++ b/packages/playwright-core/src/server/browserContext.ts
@@ -103,8 +103,9 @@ export abstract class BrowserContext extends SdkObject {
this.fetchRequest = new BrowserContextAPIRequestContext(this);
- if (this._options.recordHar)
+ if (this._options.recordHar) {
this._harRecorders.set('', new HarRecorder(this, null, this._options.recordHar));
+ }
this.tracing = new Tracing(this, browser.options.tracesDir);
this.clock = new Clock(this);
@@ -123,31 +124,38 @@ export abstract class BrowserContext extends SdkObject {
}
async _initialize() {
- if (this.attribution.playwright.options.isInternalPlaywright)
+ if (this.attribution.playwright.options.isInternalPlaywright) {
return;
+ }
// Debugger will pause execution upon page.pause in headed mode.
this._debugger = new Debugger(this);
// When PWDEBUG=1, show inspector for each context.
- if (debugMode() === 'inspector')
+ if (debugMode() === 'inspector') {
await Recorder.show('actions', this, RecorderApp.factory(this), { pauseOnNextStatement: true });
+ }
// When paused, show inspector.
- if (this._debugger.isPaused())
+ if (this._debugger.isPaused()) {
Recorder.showInspectorNoReply(this, RecorderApp.factory(this));
+ }
this._debugger.on(Debugger.Events.PausedStateChanged, () => {
- if (this._debugger.isPaused())
+ if (this._debugger.isPaused()) {
Recorder.showInspectorNoReply(this, RecorderApp.factory(this));
+ }
});
- if (debugMode() === 'console')
+ if (debugMode() === 'console') {
await this.extendInjectedScript(consoleApiSource.source);
- if (this._options.serviceWorkers === 'block')
+ }
+ if (this._options.serviceWorkers === 'block') {
await this.addInitScript(`\nif (navigator.serviceWorker) navigator.serviceWorker.register = async () => { console.warn('Service Worker registration blocked by Playwright'); };\n`);
+ }
- if (this._options.permissions)
+ if (this._options.permissions) {
await this.grantPermissions(this._options.permissions);
+ }
}
debugger(): Debugger {
@@ -155,21 +163,24 @@ export abstract class BrowserContext extends SdkObject {
}
async _ensureVideosPath() {
- if (this._options.recordVideo)
+ if (this._options.recordVideo) {
await mkdirIfNeeded(path.join(this._options.recordVideo.dir, 'dummy'));
+ }
}
canResetForReuse(): boolean {
- if (this._closedStatus !== 'open')
+ if (this._closedStatus !== 'open') {
return false;
+ }
return true;
}
async stopPendingOperations(reason: string) {
// When using context reuse, stop pending operations to gracefully terminate all the actions
// with a user-friendly error message containing operation log.
- for (const controller of this._activeProgressControllers)
+ for (const controller of this._activeProgressControllers) {
controller.abort(new Error(reason));
+ }
// Let rejections in microtask generate events before returning.
await new Promise(f => setTimeout(f, 0));
}
@@ -179,12 +190,14 @@ export abstract class BrowserContext extends SdkObject {
for (const k of Object.keys(paramsCopy)) {
const key = k as keyof channels.BrowserNewContextForReuseParams;
- if (paramsCopy[key] === defaultNewContextParamValues[key])
+ if (paramsCopy[key] === defaultNewContextParamValues[key]) {
delete paramsCopy[key];
+ }
}
- for (const key of paramsThatAllowContextReuse)
+ for (const key of paramsThatAllowContextReuse) {
delete paramsCopy[key];
+ }
return JSON.stringify(paramsCopy);
}
@@ -194,8 +207,9 @@ export abstract class BrowserContext extends SdkObject {
this.tracing.resetForReuse();
if (params) {
- for (const key of paramsThatAllowContextReuse)
+ for (const key of paramsThatAllowContextReuse) {
(this._options as any)[key] = params[key];
+ }
}
await this._cancelAllRoutesInFlight();
@@ -203,8 +217,9 @@ export abstract class BrowserContext extends SdkObject {
// Close extra pages early.
let page: Page | undefined = this.pages()[0];
const [, ...otherPages] = this.pages();
- for (const p of otherPages)
+ for (const p of otherPages) {
await p.close(metadata);
+ }
if (page && page.hasCrashed()) {
await page.close(metadata);
page = undefined;
@@ -222,10 +237,11 @@ export abstract class BrowserContext extends SdkObject {
await this._removeInitScripts();
this.clock.markAsUninstalled();
// TODO: following can be optimized to not perform noops.
- if (this._options.permissions)
+ if (this._options.permissions) {
await this.grantPermissions(this._options.permissions);
- else
+ } else {
await this.clearPermissions();
+ }
await this.setExtraHTTPHeaders(this._options.extraHTTPHeaders || []);
await this.setGeolocation(this._options.geolocation);
await this.setOffline(!!this._options.offline);
@@ -237,8 +253,9 @@ export abstract class BrowserContext extends SdkObject {
}
_browserClosed() {
- for (const page of this.pages())
+ for (const page of this.pages()) {
page._didClose();
+ }
this._didCloseInternal();
}
@@ -250,8 +267,9 @@ export abstract class BrowserContext extends SdkObject {
}
this._clientCertificatesProxy?.close().catch(() => {});
this.tracing.abort();
- if (this._isPersistentContext)
+ if (this._isPersistentContext) {
this.onClosePersistent();
+ }
this._closePromiseFulfill!(new Error('Context closed'));
this.emit(BrowserContext.Events.Close);
}
@@ -282,8 +300,9 @@ export abstract class BrowserContext extends SdkObject {
protected abstract onClosePersistent(): void;
async cookies(urls: string | string[] | undefined = []): Promise {
- if (urls && !Array.isArray(urls))
+ if (urls && !Array.isArray(urls)) {
urls = [urls];
+ }
return await this.doGetCookies(urls as string[]);
}
@@ -292,8 +311,9 @@ export abstract class BrowserContext extends SdkObject {
await this.doClearCookies();
const matches = (cookie: channels.NetworkCookie, prop: 'name' | 'domain' | 'path', value: string | RegExp | undefined) => {
- if (!value)
+ if (!value) {
return true;
+ }
if (value instanceof RegExp) {
value.lastIndex = 0;
return value.test(cookie[prop]);
@@ -315,11 +335,13 @@ export abstract class BrowserContext extends SdkObject {
}
async exposeBinding(name: string, needsHandle: boolean, playwrightBinding: frames.FunctionWithSource): Promise {
- if (this._pageBindings.has(name))
+ if (this._pageBindings.has(name)) {
throw new Error(`Function "${name}" has been already registered`);
+ }
for (const page of this.pages()) {
- if (page.getBinding(name))
+ if (page.getBinding(name)) {
throw new Error(`Function "${name}" has been already registered in one of the pages`);
+ }
}
const binding = new PageBinding(name, playwrightBinding, needsHandle);
this._pageBindings.set(name, binding);
@@ -330,8 +352,9 @@ export abstract class BrowserContext extends SdkObject {
async _removeExposedBindings() {
for (const [key, binding] of this._pageBindings) {
- if (!binding.internal)
+ if (!binding.internal) {
this._pageBindings.delete(key);
+ }
}
}
@@ -369,19 +392,22 @@ export abstract class BrowserContext extends SdkObject {
await Promise.race([waitForEvent.promise, this._closePromise]);
}
const page = this.possiblyUninitializedPages()[0];
- if (!page)
+ if (!page) {
return;
+ }
const pageOrError = await page.waitForInitializedOrError();
- if (pageOrError instanceof Error)
+ if (pageOrError instanceof Error) {
throw pageOrError;
+ }
await page.mainFrame()._waitForLoadState(progress, 'load');
return page;
}
async _loadDefaultContext(progress: Progress) {
const defaultPage = await this._loadDefaultContextAsIs(progress);
- if (!defaultPage)
+ if (!defaultPage) {
return;
+ }
const browserName = this._browser.options.name;
if ((this._options.isMobile && browserName === 'chromium') || (this._options.locale && browserName === 'webkit')) {
// Workaround for:
@@ -407,11 +433,13 @@ export abstract class BrowserContext extends SdkObject {
protected _authenticateProxyViaCredentials() {
const proxy = this._options.proxy || this._browser.options.proxy;
- if (!proxy)
+ if (!proxy) {
return;
+ }
const { username, password } = proxy;
- if (username)
+ if (username) {
this._options.httpCredentials = { username, password: password || '' };
+ }
}
async addInitScript(source: string) {
@@ -448,21 +476,24 @@ export abstract class BrowserContext extends SdkObject {
async close(options: { reason?: string }) {
if (this._closedStatus === 'open') {
- if (options.reason)
+ if (options.reason) {
this._closeReason = options.reason;
+ }
this.emit(BrowserContext.Events.BeforeClose);
this._closedStatus = 'closing';
- for (const harRecorder of this._harRecorders.values())
+ for (const harRecorder of this._harRecorders.values()) {
await harRecorder.flush();
+ }
await this.tracing.flush();
// Cleanup.
const promises: Promise[] = [];
for (const { context, artifact } of this._browser._idToVideo.values()) {
// Wait for the videos to finish.
- if (context === this)
+ if (context === this) {
promises.push(artifact.finishedPromise());
+ }
}
if (this._customCloseHandler) {
@@ -479,20 +510,23 @@ export abstract class BrowserContext extends SdkObject {
await Promise.all(promises);
// Custom handler should trigger didCloseInternal itself.
- if (!this._customCloseHandler)
+ if (!this._customCloseHandler) {
this._didCloseInternal();
+ }
}
await this._closePromise;
}
async newPage(metadata: CallMetadata): Promise {
const page = await this.doCreateNewPage();
- if (metadata.isServerSide)
+ if (metadata.isServerSide) {
page.markAsServerSideOnly();
+ }
const pageOrError = await page.waitForInitializedOrError();
if (pageOrError instanceof Page) {
- if (pageOrError.isClosed())
+ if (pageOrError.isClosed()) {
throw new Error('Page has been closed.');
+ }
return pageOrError;
}
throw pageOrError;
@@ -512,14 +546,16 @@ export abstract class BrowserContext extends SdkObject {
// First try collecting storage stage from existing pages.
for (const page of this.pages()) {
const origin = page.mainFrame().origin();
- if (!origin || !originsToSave.has(origin))
+ if (!origin || !originsToSave.has(origin)) {
continue;
+ }
try {
const storage = await page.mainFrame().nonStallingEvaluateInExistingContext(`({
localStorage: Object.keys(localStorage).map(name => ({ name, value: localStorage.getItem(name) })),
})`, 'utility');
- if (storage.localStorage.length)
+ if (storage.localStorage.length) {
result.origins.push({ origin, localStorage: storage.localStorage } as channels.OriginStorage);
+ }
originsToSave.delete(origin);
} catch {
// When failed on the live page, we'll retry on the blank page below.
@@ -542,8 +578,9 @@ export abstract class BrowserContext extends SdkObject {
localStorage: Object.keys(localStorage).map(name => ({ name, value: localStorage.getItem(name) })),
})`, { world: 'utility' });
originStorage.localStorage = storage.localStorage;
- if (storage.localStorage.length)
+ if (storage.localStorage.length) {
result.origins.push(originStorage);
+ }
}
await page.close(internalMetadata);
}
@@ -553,8 +590,9 @@ export abstract class BrowserContext extends SdkObject {
async _resetStorage() {
const oldOrigins = this._origins;
const newOrigins = new Map(this._options.storageState?.origins?.map(p => [p.origin, p]) || []);
- if (!oldOrigins.size && !newOrigins.size)
+ if (!oldOrigins.size && !newOrigins.size) {
return;
+ }
let page = this.pages()[0];
const internalMetadata = serverSideCallMetadata();
@@ -583,8 +621,9 @@ export abstract class BrowserContext extends SdkObject {
async _resetCookies() {
await this.doClearCookies();
- if (this._options.storageState?.cookies)
- await this.addCookies(this._options.storageState?.cookies);
+ if (this._options.storageState?.cookies) {
+ await this.addCookies(this._options.storageState.cookies);
+ }
}
isSettingStorageState(): boolean {
@@ -594,8 +633,9 @@ export abstract class BrowserContext extends SdkObject {
async setStorageState(metadata: CallMetadata, state: NonNullable) {
this._settingStorageState = true;
try {
- if (state.cookies)
+ if (state.cookies) {
await this.addCookies(state.cookies);
+ }
if (state.origins && state.origins.length) {
const internalMetadata = serverSideCallMetadata();
const page = await this.newPage(internalMetadata);
@@ -660,25 +700,30 @@ export abstract class BrowserContext extends SdkObject {
export function assertBrowserContextIsNotOwned(context: BrowserContext) {
for (const page of context.pages()) {
- if (page._ownedContext)
+ if (page._ownedContext) {
throw new Error('Please use browser.newContext() for multi-page scripts that share the context.');
+ }
}
}
export function validateBrowserContextOptions(options: types.BrowserContextOptions, browserOptions: BrowserOptions) {
- if (options.noDefaultViewport && options.deviceScaleFactor !== undefined)
+ if (options.noDefaultViewport && options.deviceScaleFactor !== undefined) {
throw new Error(`"deviceScaleFactor" option is not supported with null "viewport"`);
- if (options.noDefaultViewport && !!options.isMobile)
+ }
+ if (options.noDefaultViewport && !!options.isMobile) {
throw new Error(`"isMobile" option is not supported with null "viewport"`);
- if (options.acceptDownloads === undefined && browserOptions.name !== 'electron')
+ }
+ if (options.acceptDownloads === undefined && browserOptions.name !== 'electron') {
options.acceptDownloads = 'accept';
- // Electron requires explicit acceptDownloads: true since we wait for
- // https://github.com/electron/electron/pull/41718 to be widely shipped.
- // In 6-12 months, we can remove this check.
- else if (options.acceptDownloads === undefined && browserOptions.name === 'electron')
+ } else if (options.acceptDownloads === undefined && browserOptions.name === 'electron') {
+ // Electron requires explicit acceptDownloads: true since we wait for
+ // https://github.com/electron/electron/pull/41718 to be widely shipped.
+ // In 6-12 months, we can remove this check.
options.acceptDownloads = 'internal-browser-default';
- if (!options.viewport && !options.noDefaultViewport)
+ }
+ if (!options.viewport && !options.noDefaultViewport) {
options.viewport = { width: 1280, height: 720 };
+ }
if (options.recordVideo) {
if (!options.recordVideo.size) {
if (options.noDefaultViewport) {
@@ -696,38 +741,49 @@ export function validateBrowserContextOptions(options: types.BrowserContextOptio
options.recordVideo.size!.width &= ~1;
options.recordVideo.size!.height &= ~1;
}
- if (options.proxy)
+ if (options.proxy) {
options.proxy = normalizeProxySettings(options.proxy);
+ }
verifyGeolocation(options.geolocation);
}
export function verifyGeolocation(geolocation?: types.Geolocation) {
- if (!geolocation)
+ if (!geolocation) {
return;
+ }
geolocation.accuracy = geolocation.accuracy || 0;
const { longitude, latitude, accuracy } = geolocation;
- if (longitude < -180 || longitude > 180)
+ if (longitude < -180 || longitude > 180) {
throw new Error(`geolocation.longitude: precondition -180 <= LONGITUDE <= 180 failed.`);
- if (latitude < -90 || latitude > 90)
+ }
+ if (latitude < -90 || latitude > 90) {
throw new Error(`geolocation.latitude: precondition -90 <= LATITUDE <= 90 failed.`);
- if (accuracy < 0)
+ }
+ if (accuracy < 0) {
throw new Error(`geolocation.accuracy: precondition 0 <= ACCURACY failed.`);
+ }
}
export function verifyClientCertificates(clientCertificates?: types.BrowserContextOptions['clientCertificates']) {
- if (!clientCertificates)
+ if (!clientCertificates) {
return;
+ }
for (const cert of clientCertificates) {
- if (!cert.origin)
+ if (!cert.origin) {
throw new Error(`clientCertificates.origin is required`);
- if (!cert.cert && !cert.key && !cert.passphrase && !cert.pfx)
+ }
+ if (!cert.cert && !cert.key && !cert.passphrase && !cert.pfx) {
throw new Error('None of cert, key, passphrase or pfx is specified');
- if (cert.cert && !cert.key)
+ }
+ if (cert.cert && !cert.key) {
throw new Error('cert is specified without key');
- if (!cert.cert && cert.key)
+ }
+ if (!cert.cert && cert.key) {
throw new Error('key is specified without cert');
- if (cert.pfx && (cert.cert || cert.key))
+ }
+ if (cert.pfx && (cert.cert || cert.key)) {
throw new Error('pfx is specified together with cert, key or passphrase');
+ }
}
}
@@ -739,18 +795,22 @@ export function normalizeProxySettings(proxy: types.ProxySettings): types.ProxyS
// new URL('localhost:8080') fails to parse host or protocol
// In both of these cases, we need to try re-parse URL with `http://` prefix.
url = new URL(server);
- if (!url.host || !url.protocol)
+ if (!url.host || !url.protocol) {
url = new URL('http://' + server);
+ }
} catch (e) {
url = new URL('http://' + server);
}
- if (url.protocol === 'socks4:' && (proxy.username || proxy.password))
+ if (url.protocol === 'socks4:' && (proxy.username || proxy.password)) {
throw new Error(`Socks4 proxy protocol does not support authentication`);
- if (url.protocol === 'socks5:' && (proxy.username || proxy.password))
+ }
+ if (url.protocol === 'socks5:' && (proxy.username || proxy.password)) {
throw new Error(`Browser does not support socks5 proxy authentication`);
+ }
server = url.protocol + '//' + url.host;
- if (bypass)
+ if (bypass) {
bypass = bypass.split(',').map(t => t.trim()).join(',');
+ }
return { ...proxy, server, bypass };
}
diff --git a/packages/playwright-core/src/server/browserType.ts b/packages/playwright-core/src/server/browserType.ts
index 128b80a352..6272f2a05b 100644
--- a/packages/playwright-core/src/server/browserType.ts
+++ b/packages/playwright-core/src/server/browserType.ts
@@ -80,23 +80,28 @@ export abstract class BrowserType extends SdkObject {
async launch(metadata: CallMetadata, options: types.LaunchOptions, protocolLogger?: types.ProtocolLogger): Promise {
options = this._validateLaunchOptions(options);
- if (this._useBidi)
+ if (this._useBidi) {
options.useWebSocket = true;
+ }
const controller = new ProgressController(metadata, this);
controller.setLogName('browser');
const browser = await controller.run(progress => {
const seleniumHubUrl = (options as any).__testHookSeleniumRemoteURL || process.env.SELENIUM_REMOTE_URL;
- if (seleniumHubUrl)
+ if (seleniumHubUrl) {
return this._launchWithSeleniumHub(progress, seleniumHubUrl, options);
- return this._innerLaunchWithRetries(progress, options, undefined, helper.debugProtocolLogger(protocolLogger)).catch(e => { throw this._rewriteStartupLog(e); });
+ }
+ return this._innerLaunchWithRetries(progress, options, undefined, helper.debugProtocolLogger(protocolLogger)).catch(e => {
+ throw this._rewriteStartupLog(e);
+ });
}, TimeoutSettings.launchTimeout(options));
return browser;
}
async launchPersistentContext(metadata: CallMetadata, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { useWebSocket?: boolean, internalIgnoreHTTPSErrors?: boolean }): Promise {
const launchOptions = this._validateLaunchOptions(options);
- if (this._useBidi)
+ if (this._useBidi) {
launchOptions.useWebSocket = true;
+ }
const controller = new ProgressController(metadata, this);
controller.setLogName('browser');
const browser = await controller.run(async progress => {
@@ -104,12 +109,14 @@ export abstract class BrowserType extends SdkObject {
let clientCertificatesProxy: ClientCertificatesProxy | undefined;
if (options.clientCertificates?.length) {
clientCertificatesProxy = new ClientCertificatesProxy(options);
- launchOptions.proxyOverride = await clientCertificatesProxy?.listen();
+ launchOptions.proxyOverride = await clientCertificatesProxy.listen();
options = { ...options };
options.internalIgnoreHTTPSErrors = true;
}
progress.cleanupWhenAborted(() => clientCertificatesProxy?.close());
- const browser = await this._innerLaunchWithRetries(progress, launchOptions, options, helper.debugProtocolLogger(), userDataDir).catch(e => { throw this._rewriteStartupLog(e); });
+ const browser = await this._innerLaunchWithRetries(progress, launchOptions, options, helper.debugProtocolLogger(), userDataDir).catch(e => {
+ throw this._rewriteStartupLog(e);
+ });
browser._defaultContext!._clientCertificatesProxy = clientCertificatesProxy;
return browser;
}, TimeoutSettings.launchTimeout(launchOptions));
@@ -134,8 +141,9 @@ export abstract class BrowserType extends SdkObject {
options.proxy = options.proxy ? normalizeProxySettings(options.proxy) : undefined;
const browserLogsCollector = new RecentLogsCollector();
const { browserProcess, userDataDir, artifactsDir, transport } = await this._launchProcess(progress, options, !!persistent, browserLogsCollector, maybeUserDataDir);
- if ((options as any).__testHookBeforeCreateBrowser)
+ if ((options as any).__testHookBeforeCreateBrowser) {
await (options as any).__testHookBeforeCreateBrowser();
+ }
const browserOptions: BrowserOptions = {
name: this._name,
isChromium: this._name === 'chromium',
@@ -154,14 +162,16 @@ export abstract class BrowserType extends SdkObject {
wsEndpoint: options.useWebSocket ? (transport as WebSocketTransport).wsEndpoint : undefined,
originalLaunchOptions: options,
};
- if (persistent)
+ if (persistent) {
validateBrowserContextOptions(persistent, browserOptions);
+ }
copyTestHooks(options, browserOptions);
const browser = await this.connectToTransport(transport, browserOptions);
(browser as any)._userDataDirForTest = userDataDir;
// We assume no control when using custom arguments, and do not prepare the default context in that case.
- if (persistent && !options.ignoreAllDefaultArgs)
+ if (persistent && !options.ignoreAllDefaultArgs) {
await browser._defaultContext!._loadDefaultContext(progress);
+ }
return browser;
}
@@ -186,8 +196,9 @@ export abstract class BrowserType extends SdkObject {
if (userDataDir) {
// Firefox bails if the profile directory does not exist, Chrome creates it. We ensure consistent behavior here.
- if (!await existsAsync(userDataDir))
+ if (!await existsAsync(userDataDir)) {
await fs.promises.mkdir(userDataDir, { recursive: true, mode: 0o700 });
+ }
} else {
userDataDir = await fs.promises.mkdtemp(path.join(os.tmpdir(), `playwright_${this._name}dev_profile-`));
tempDirectories.push(userDataDir);
@@ -195,22 +206,25 @@ export abstract class BrowserType extends SdkObject {
await this.prepareUserDataDir(options, userDataDir);
const browserArguments = [];
- if (ignoreAllDefaultArgs)
+ if (ignoreAllDefaultArgs) {
browserArguments.push(...args);
- else if (ignoreDefaultArgs)
+ } else if (ignoreDefaultArgs) {
browserArguments.push(...this.defaultArgs(options, isPersistent, userDataDir).filter(arg => ignoreDefaultArgs.indexOf(arg) === -1));
- else
+ } else {
browserArguments.push(...this.defaultArgs(options, isPersistent, userDataDir));
+ }
let executable: string;
if (executablePath) {
- if (!(await existsAsync(executablePath)))
+ if (!(await existsAsync(executablePath))) {
throw new Error(`Failed to launch ${this._name} because executable doesn't exist at ${executablePath}`);
+ }
executable = executablePath;
} else {
const registryExecutable = registry.findExecutable(this.getExecutableName(options));
- if (!registryExecutable || registryExecutable.browserName !== this._name)
+ if (!registryExecutable || registryExecutable.browserName !== this._name) {
throw new Error(`Unsupported ${this._name} channel "${options.channel}"`);
+ }
executable = registryExecutable.executablePathOrDie(this.attribution.playwright.options.sdkLanguage);
await registry.validateHostRequirementsForExecutablesIfNeeded([registryExecutable], this.attribution.playwright.options.sdkLanguage);
}
@@ -235,8 +249,9 @@ export abstract class BrowserType extends SdkObject {
stdio: 'pipe',
tempDirectories,
attemptToGracefullyClose: async () => {
- if ((options as any).__testHookGracefullyClose)
+ if ((options as any).__testHookGracefullyClose) {
await (options as any).__testHookGracefullyClose();
+ }
// We try to gracefully close to prevent crash reporting and core dumps.
// Note that it's fine to reuse the pipe transport, since
// our connection ignores kBrowserCloseMessageId.
@@ -245,8 +260,9 @@ export abstract class BrowserType extends SdkObject {
onExit: (exitCode, signal) => {
// Unblock launch when browser prematurely exits.
readyState?.onBrowserExit();
- if (browserProcess && browserProcess.onclose)
+ if (browserProcess && browserProcess.onclose) {
browserProcess.onclose(exitCode, signal);
+ }
},
});
async function closeOrKill(timeout: number): Promise {
@@ -280,10 +296,12 @@ export abstract class BrowserType extends SdkObject {
}
async _createArtifactDirs(options: types.LaunchOptions): Promise {
- if (options.downloadsPath)
+ if (options.downloadsPath) {
await fs.promises.mkdir(options.downloadsPath, { recursive: true });
- if (options.tracesDir)
+ }
+ if (options.tracesDir) {
await fs.promises.mkdir(options.tracesDir, { recursive: true });
+ }
}
async connectOverCDP(metadata: CallMetadata, endpointURL: string, options: { slowMo?: number }, timeout?: number): Promise {
@@ -297,12 +315,15 @@ export abstract class BrowserType extends SdkObject {
private _validateLaunchOptions(options: types.LaunchOptions): types.LaunchOptions {
const { devtools = false } = options;
let { headless = !devtools, downloadsPath, proxy } = options;
- if (debugMode())
+ if (debugMode()) {
headless = false;
- if (downloadsPath && !path.isAbsolute(downloadsPath))
+ }
+ if (downloadsPath && !path.isAbsolute(downloadsPath)) {
downloadsPath = path.join(process.cwd(), downloadsPath);
- if (this.attribution.playwright.options.socksProxyPort)
+ }
+ if (this.attribution.playwright.options.socksProxyPort) {
proxy = { server: `socks5://127.0.0.1:${this.attribution.playwright.options.socksProxyPort}` };
+ }
return { ...options, devtools, headless, downloadsPath, proxy };
}
@@ -320,8 +341,9 @@ export abstract class BrowserType extends SdkObject {
}
_rewriteStartupLog(error: Error): Error {
- if (!isProtocolError(error))
+ if (!isProtocolError(error)) {
return error;
+ }
return this.doRewriteStartupLog(error);
}
@@ -345,7 +367,8 @@ export abstract class BrowserType extends SdkObject {
function copyTestHooks(from: object, to: object) {
for (const [key, value] of Object.entries(from)) {
- if (key.startsWith('__testHook'))
+ if (key.startsWith('__testHook')) {
(to as any)[key] = value;
+ }
}
}
diff --git a/packages/playwright-core/src/server/chromium/chromium.ts b/packages/playwright-core/src/server/chromium/chromium.ts
index 8fce8f51ca..7ac9c6f8be 100644
--- a/packages/playwright-core/src/server/chromium/chromium.ts
+++ b/packages/playwright-core/src/server/chromium/chromium.ts
@@ -58,8 +58,9 @@ export class Chromium extends BrowserType {
constructor(parent: SdkObject) {
super(parent, 'chromium');
- if (debugMode())
+ if (debugMode()) {
this._devtools = this._createDevTools();
+ }
}
override async connectOverCDP(metadata: CallMetadata, endpointURL: string, options: { slowMo?: number, headers?: types.HeadersArray }, timeout?: number) {
@@ -72,13 +73,15 @@ export class Chromium extends BrowserType {
async _connectOverCDPInternal(progress: Progress, endpointURL: string, options: types.LaunchOptions & { headers?: types.HeadersArray }, onClose?: () => Promise) {
let headersMap: { [key: string]: string; } | undefined;
- if (options.headers)
+ if (options.headers) {
headersMap = headersArrayToObject(options.headers, false);
+ }
- if (!headersMap)
+ if (!headersMap) {
headersMap = { 'User-Agent': getUserAgent() };
- else if (headersMap && !Object.keys(headersMap).some(key => key.toLowerCase() === 'user-agent'))
+ } else if (headersMap && !Object.keys(headersMap).some(key => key.toLowerCase() === 'user-agent')) {
headersMap['User-Agent'] = getUserAgent();
+ }
const artifactsDir = await fs.promises.mkdtemp(ARTIFACTS_FOLDER);
@@ -135,14 +138,17 @@ export class Chromium extends BrowserType {
}
override doRewriteStartupLog(error: ProtocolError): ProtocolError {
- if (!error.logs)
+ if (!error.logs) {
return error;
- if (error.logs.includes('Missing X server'))
+ }
+ if (error.logs.includes('Missing X server')) {
error.logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);
+ }
// These error messages are taken from Chromium source code as of July, 2020:
// https://github.com/chromium/chromium/blob/70565f67e79f79e17663ad1337dc6e63ee207ce9/content/browser/zygote_host/zygote_host_impl_linux.cc
- if (!error.logs.includes('crbug.com/357670') && !error.logs.includes('No usable sandbox!') && !error.logs.includes('crbug.com/638180'))
+ if (!error.logs.includes('crbug.com/357670') && !error.logs.includes('No usable sandbox!') && !error.logs.includes('crbug.com/638180')) {
return error;
+ }
error.logs = [
`Chromium sandboxing failed!`,
`================================`,
@@ -167,8 +173,9 @@ export class Chromium extends BrowserType {
override async _launchWithSeleniumHub(progress: Progress, hubUrl: string, options: types.LaunchOptions): Promise {
await this._createArtifactDirs(options);
- if (!hubUrl.endsWith('/'))
+ if (!hubUrl.endsWith('/')) {
hubUrl = hubUrl + '/';
+ }
const args = this._innerDefaultArgs(options);
args.push('--remote-debugging-port=0');
@@ -180,15 +187,17 @@ export class Chromium extends BrowserType {
if (process.env.SELENIUM_REMOTE_CAPABILITIES) {
const remoteCapabilities = parseSeleniumRemoteParams({ name: 'capabilities', value: process.env.SELENIUM_REMOTE_CAPABILITIES }, progress);
- if (remoteCapabilities)
+ if (remoteCapabilities) {
desiredCapabilities = { ...desiredCapabilities, ...remoteCapabilities };
+ }
}
let headers: { [key: string]: string } = {};
if (process.env.SELENIUM_REMOTE_HEADERS) {
const remoteHeaders = parseSeleniumRemoteParams({ name: 'headers', value: process.env.SELENIUM_REMOTE_HEADERS }, progress);
- if (remoteHeaders)
+ if (remoteHeaders) {
headers = remoteHeaders;
+ }
}
progress.log(` connecting to ${hubUrl}`);
@@ -229,8 +238,9 @@ export class Chromium extends BrowserType {
progress.log(` using selenium v4`);
const endpointURLString = addProtocol(capabilities['se:cdp']);
endpointURL = new URL(endpointURLString);
- if (endpointURL.hostname === 'localhost' || endpointURL.hostname === '127.0.0.1')
+ if (endpointURL.hostname === 'localhost' || endpointURL.hostname === '127.0.0.1') {
endpointURL.hostname = new URL(hubUrl).hostname;
+ }
progress.log(` retrieved endpoint ${endpointURL.toString()} for sessionId=${sessionId}`);
} else {
// Selenium 3 - resolve target node IP to use instead of localhost ws url.
@@ -274,38 +284,45 @@ export class Chromium extends BrowserType {
override defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): string[] {
const chromeArguments = this._innerDefaultArgs(options);
chromeArguments.push(`--user-data-dir=${userDataDir}`);
- if (options.useWebSocket)
+ if (options.useWebSocket) {
chromeArguments.push('--remote-debugging-port=0');
- else
+ } else {
chromeArguments.push('--remote-debugging-pipe');
- if (isPersistent)
+ }
+ if (isPersistent) {
chromeArguments.push('about:blank');
- else
+ } else {
chromeArguments.push('--no-startup-window');
+ }
return chromeArguments;
}
private _innerDefaultArgs(options: types.LaunchOptions): string[] {
const { args = [] } = options;
const userDataDirArg = args.find(arg => arg.startsWith('--user-data-dir'));
- if (userDataDirArg)
+ if (userDataDirArg) {
throw this._createUserDataDirArgMisuseError('--user-data-dir');
- if (args.find(arg => arg.startsWith('--remote-debugging-pipe')))
+ }
+ if (args.find(arg => arg.startsWith('--remote-debugging-pipe'))) {
throw new Error('Playwright manages remote debugging connection itself.');
- if (args.find(arg => !arg.startsWith('-')))
+ }
+ if (args.find(arg => !arg.startsWith('-'))) {
throw new Error('Arguments can not specify page to be opened');
+ }
const chromeArguments = [...chromiumSwitches];
if (os.platform() === 'darwin') {
// See https://github.com/microsoft/playwright/issues/7362
chromeArguments.push('--enable-use-zoom-for-dsf=false');
// See https://bugs.chromium.org/p/chromium/issues/detail?id=1407025.
- if (options.headless && (!options.channel || options.channel === 'chromium-headless-shell'))
+ if (options.headless && (!options.channel || options.channel === 'chromium-headless-shell')) {
chromeArguments.push('--use-angle');
+ }
}
- if (options.devtools)
+ if (options.devtools) {
chromeArguments.push('--auto-open-devtools-for-tabs');
+ }
if (options.headless) {
chromeArguments.push('--headless');
@@ -315,8 +332,9 @@ export class Chromium extends BrowserType {
'--blink-settings=primaryHoverType=2,availableHoverTypes=2,primaryPointerType=4,availablePointerTypes=4',
);
}
- if (options.chromiumSandbox !== true)
+ if (options.chromiumSandbox !== true) {
chromeArguments.push('--no-sandbox');
+ }
const proxy = options.proxyOverride || options.proxy;
if (proxy) {
const proxyURL = new URL(proxy.server);
@@ -329,28 +347,34 @@ export class Chromium extends BrowserType {
chromeArguments.push(`--proxy-server=${proxy.server}`);
const proxyBypassRules = [];
// https://source.chromium.org/chromium/chromium/src/+/master:net/docs/proxy.md;l=548;drc=71698e610121078e0d1a811054dcf9fd89b49578
- if (this.attribution.playwright.options.socksProxyPort)
+ if (this.attribution.playwright.options.socksProxyPort) {
proxyBypassRules.push('<-loopback>');
- if (proxy.bypass)
+ }
+ if (proxy.bypass) {
proxyBypassRules.push(...proxy.bypass.split(',').map(t => t.trim()).map(t => t.startsWith('.') ? '*' + t : t));
- if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !proxyBypassRules.includes('<-loopback>'))
+ }
+ if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !proxyBypassRules.includes('<-loopback>')) {
proxyBypassRules.push('<-loopback>');
- if (proxyBypassRules.length > 0)
+ }
+ if (proxyBypassRules.length > 0) {
chromeArguments.push(`--proxy-bypass-list=${proxyBypassRules.join(';')}`);
+ }
}
chromeArguments.push(...args);
return chromeArguments;
}
override readyState(options: types.LaunchOptions): BrowserReadyState | undefined {
- if (options.useWebSocket || options.args?.some(a => a.startsWith('--remote-debugging-port')))
+ if (options.useWebSocket || options.args?.some(a => a.startsWith('--remote-debugging-port'))) {
return new ChromiumReadyState();
+ }
return undefined;
}
override getExecutableName(options: types.LaunchOptions): string {
- if (options.channel)
+ if (options.channel) {
return options.channel;
+ }
return options.headless ? 'chromium-headless-shell' : 'chromium';
}
}
@@ -358,14 +382,16 @@ export class Chromium extends BrowserType {
class ChromiumReadyState extends BrowserReadyState {
override onBrowserOutput(message: string): void {
const match = message.match(/DevTools listening on (.*)/);
- if (match)
+ if (match) {
this._wsEndpoint.resolve(match[1]);
+ }
}
}
async function urlToWSEndpoint(progress: Progress, endpointURL: string, headers: { [key: string]: string; }) {
- if (endpointURL.startsWith('ws'))
+ if (endpointURL.startsWith('ws')) {
return endpointURL;
+ }
progress.log(` retrieving websocket url from ${endpointURL}`);
const httpURL = endpointURL.endsWith('/') ? `${endpointURL}json/version/` : `${endpointURL}/json/version/`;
const json = await fetchData({
@@ -389,8 +415,9 @@ async function seleniumErrorHandler(params: HTTPRequestParams, response: http.In
}
function addProtocol(url: string) {
- if (!['ws://', 'wss://', 'http://', 'https://'].some(protocol => url.startsWith(protocol)))
+ if (!['ws://', 'wss://', 'http://', 'https://'].some(protocol => url.startsWith(protocol))) {
return 'http://' + url;
+ }
return url;
}
diff --git a/packages/playwright-core/src/server/chromium/crAccessibility.ts b/packages/playwright-core/src/server/chromium/crAccessibility.ts
index 4114663a0e..c81866d734 100644
--- a/packages/playwright-core/src/server/chromium/crAccessibility.ts
+++ b/packages/playwright-core/src/server/chromium/crAccessibility.ts
@@ -55,20 +55,25 @@ class CRAXNode implements accessibility.AXNode {
this._richlyEditable = property.value.value === 'richtext';
this._editable = true;
}
- if (property.name === 'focusable')
+ if (property.name === 'focusable') {
this._focusable = property.value.value;
- if (property.name === 'expanded')
+ }
+ if (property.name === 'expanded') {
this._expanded = property.value.value;
- if (property.name === 'hidden')
+ }
+ if (property.name === 'hidden') {
this._hidden = property.value.value;
+ }
}
}
private _isPlainTextField(): boolean {
- if (this._richlyEditable)
+ if (this._richlyEditable) {
return false;
- if (this._editable)
+ }
+ if (this._editable) {
return true;
+ }
return this._role === 'textbox' || this._role === 'ComboBox' || this._role === 'searchbox';
}
@@ -103,26 +108,30 @@ class CRAXNode implements accessibility.AXNode {
}
find(predicate: (arg0: CRAXNode) => boolean): CRAXNode | null {
- if (predicate(this))
+ if (predicate(this)) {
return this;
+ }
for (const child of this._children) {
const result = child.find(predicate);
- if (result)
+ if (result) {
return result;
+ }
}
return null;
}
isLeafNode(): boolean {
- if (!this._children.length)
+ if (!this._children.length) {
return true;
+ }
// These types of objects may have children that we use as internal
// implementation details, but we want to expose them as leaves to platform
// accessibility APIs because screen readers might be confused if they find
// any children.
- if (this._isPlainTextField() || this._isTextOnlyObject())
+ if (this._isPlainTextField() || this._isTextOnlyObject()) {
return true;
+ }
// Roles whose children are only presentational according to the ARIA and
// HTML5 Specs should be hidden from screen readers.
@@ -143,12 +152,15 @@ class CRAXNode implements accessibility.AXNode {
}
// Here and below: Android heuristics
- if (this._hasFocusableChild())
+ if (this._hasFocusableChild()) {
return false;
- if (this._focusable && this._role !== 'WebArea' && this._role !== 'RootWebArea' && this._name)
+ }
+ if (this._focusable && this._role !== 'WebArea' && this._role !== 'RootWebArea' && this._name) {
return true;
- if (this._role === 'heading' && this._name)
+ }
+ if (this._role === 'heading' && this._name) {
return true;
+ }
return false;
}
@@ -182,19 +194,23 @@ class CRAXNode implements accessibility.AXNode {
isInteresting(insideControl: boolean): boolean {
const role = this._role;
- if (role === 'Ignored' || this._hidden)
+ if (role === 'Ignored' || this._hidden) {
return false;
+ }
- if (this._focusable || this._richlyEditable)
+ if (this._focusable || this._richlyEditable) {
return true;
+ }
// If it's not focusable but has a control role, then it's interesting.
- if (this.isControl())
+ if (this.isControl()) {
return true;
+ }
// A non focusable child of a control is not interesting
- if (insideControl)
+ if (insideControl) {
return false;
+ }
return this.isLeafNode() && !!this._name;
}
@@ -212,10 +228,12 @@ class CRAXNode implements accessibility.AXNode {
serialize(): channels.AXNode {
const properties: Map