Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore: fix missing xserver message formatting (#38799)
Yury Semikhatskyaa65a493d01e
diff --git a/packages/playwright-core/src/server/bidi/bidiChromium.ts b/packages/playwright-core/src/server/bidi/bidiChromium.tsindex 18071378b0..7445f08269 100644--- a/packages/playwright-core/src/server/bidi/bidiChromium.ts+++ b/packages/playwright-core/src/server/bidi/bidiChromium.ts@@ -26,7 +26,6 @@ import { waitForReadyState } from '../chromium/chromium';import type { BrowserOptions } from '../browser';import type { SdkObject } from '../instrumentation';-import type { ProtocolError } from '../protocolError';import type { ConnectionTransport } from '../transport';import type * as types from '../types';@@ -55,16 +54,14 @@ export class BidiChromium extends BrowserType {}}- override doRewriteStartupLog(error: ProtocolError): ProtocolError {- if (!error.logs)- return error;- if (error.logs.includes('Missing X server'))- error.logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);+ override doRewriteStartupLog(logs: string): string {+ if (logs.includes('Missing X server'))+ 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'))- return error;- error.logs = [+ if (!logs.includes('crbug.com/357670') && !logs.includes('No usable sandbox!') && !logs.includes('crbug.com/638180'))+ return logs;+ return [`Chromium sandboxing failed!`,`================================`,`To avoid the sandboxing issue, do either of the following:`,@@ -73,7 +70,6 @@ export class BidiChromium extends BrowserType {`================================`,``,].join('\n');- return error;}override amendEnvironment(env: NodeJS.ProcessEnv): NodeJS.ProcessEnv {diff --git a/packages/playwright-core/src/server/bidi/bidiFirefox.ts b/packages/playwright-core/src/server/bidi/bidiFirefox.tsindex 09406299cb..199c9e7207 100644--- a/packages/playwright-core/src/server/bidi/bidiFirefox.ts+++ b/packages/playwright-core/src/server/bidi/bidiFirefox.ts@@ -26,7 +26,6 @@ import { ManualPromise } from '../../utils/isomorphic/manualPromise';import type { BrowserOptions } from '../browser';import type { SdkObject } from '../instrumentation';-import type { ProtocolError } from '../protocolError';import type { ConnectionTransport } from '../transport';import type * as types from '../types';import type { RecentLogsCollector } from '../utils/debugLogger';@@ -45,15 +44,12 @@ export class BidiFirefox extends BrowserType {return BidiBrowser.connect(this.attribution.playwright, transport, options);}- override doRewriteStartupLog(error: ProtocolError): ProtocolError {- 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.`))- 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'))- error.logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);- return error;+ override doRewriteStartupLog(logs: string): string {+ if (logs.includes(`as root in a regular user's session is not supported.`))+ 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 (logs.includes('no DISPLAY environment variable specified'))+ logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);+ return logs;}override amendEnvironment(env: NodeJS.ProcessEnv): NodeJS.ProcessEnv {diff --git a/packages/playwright-core/src/server/browserType.ts b/packages/playwright-core/src/server/browserType.tsindex 3182f671b9..98a2adec30 100644--- a/packages/playwright-core/src/server/browserType.ts+++ b/packages/playwright-core/src/server/browserType.ts@@ -28,7 +28,7 @@ import { helper } from './helper';import { SdkObject } from './instrumentation';import { PipeTransport } from './pipeTransport';import { envArrayToObject, launchProcess } from './utils/processLauncher';-import { isProtocolError } from './protocolError';+import { isProtocolError } from './protocolError';import { registry } from './registry';import { ClientCertificatesProxy } from './socksClientCertificatesInterceptor';import { WebSocketTransport } from './transport';@@ -37,7 +37,6 @@ import { RecentLogsCollector } from './utils/debugLogger';import type { Browser, BrowserOptions, BrowserProcess } from './browser';import type { BrowserContext } from './browserContext';import type { Progress } from './progress';-import type { ProtocolError } from './protocolError';import type { BrowserName } from './registry';import type { ConnectionTransport } from './transport';import type * as types from './types';@@ -264,8 +263,11 @@ export abstract class BrowserType extends SdkObject {this.waitForReadyState(options, browserLogsCollector),exitPromise.then(() => ({ wsEndpoint: undefined })),]);- if (exitPromise.isDone())- throw new Error(`Failed to launch the browser process.`);+ if (exitPromise.isDone()) {+ const log = helper.formatBrowserLogs(browserLogsCollector.recentLogs());+ const updatedLog = this.doRewriteStartupLog(log);+ throw new Error(`Failed to launch the browser process.\nBrowser logs:\n${updatedLog}`);+ }if (options.cdpPort !== undefined || !this.supportsPipeTransport()) {transport = await WebSocketTransport.connect(progress, wsEndpoint!);} else {@@ -321,7 +323,9 @@ export abstract class BrowserType extends SdkObject {private _rewriteStartupLog(error: Error): Error {if (!isProtocolError(error))return error;- return this.doRewriteStartupLog(error);+ if (error.logs)+ error.logs = this.doRewriteStartupLog(error.logs);+ return error;}async waitForReadyState(options: types.LaunchOptions, browserLogsCollector: RecentLogsCollector): Promise<{ wsEndpoint?: string }> {@@ -342,7 +346,7 @@ export abstract class BrowserType extends SdkObject {abstract defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): Promise<string[]>;abstract connectToTransport(transport: ConnectionTransport, options: BrowserOptions, browserLogsCollector: RecentLogsCollector): Promise<Browser>;abstract amendEnvironment(env: NodeJS.ProcessEnv, userDataDir: string, isPersistent: boolean, options: types.LaunchOptions): NodeJS.ProcessEnv;- abstract doRewriteStartupLog(error: ProtocolError): ProtocolError;+ abstract doRewriteStartupLog(logs: string): string;abstract attemptToGracefullyCloseBrowser(transport: ConnectionTransport): void;}diff --git a/packages/playwright-core/src/server/chromium/chromium.ts b/packages/playwright-core/src/server/chromium/chromium.tsindex cd442d3fdd..b7d2dd294d 100644--- a/packages/playwright-core/src/server/chromium/chromium.ts+++ b/packages/playwright-core/src/server/chromium/chromium.ts@@ -42,7 +42,6 @@ import type { HTTPRequestParams } from '../utils/network';import type { BrowserOptions, BrowserProcess } from '../browser';import type { SdkObject } from '../instrumentation';import type { Progress } from '../progress';-import type { ProtocolError } from '../protocolError';import type { ConnectionTransport, ProtocolRequest } from '../transport';import type { BrowserContext } from '../browserContext';import type * as types from '../types';@@ -155,16 +154,14 @@ export class Chromium extends BrowserType {}}- override doRewriteStartupLog(error: ProtocolError): ProtocolError {- if (!error.logs)- return error;- if (error.logs.includes('Missing X server'))- error.logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);+ override doRewriteStartupLog(logs: string): string {+ if (logs.includes('Missing X server'))+ 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'))- return error;- error.logs = [+ if (!logs.includes('crbug.com/357670') && !logs.includes('No usable sandbox!') && !logs.includes('crbug.com/638180'))+ return logs;+ return [`Chromium sandboxing failed!`,`================================`,`To avoid the sandboxing issue, do either of the following:`,@@ -173,7 +170,6 @@ export class Chromium extends BrowserType {`================================`,``,].join('\n');- return error;}override amendEnvironment(env: NodeJS.ProcessEnv): NodeJS.ProcessEnv {diff --git a/packages/playwright-core/src/server/firefox/firefox.ts b/packages/playwright-core/src/server/firefox/firefox.tsindex 1c0daef0fb..489a6119c8 100644--- a/packages/playwright-core/src/server/firefox/firefox.ts+++ b/packages/playwright-core/src/server/firefox/firefox.ts@@ -26,7 +26,6 @@ import { ManualPromise } from '../../utils/isomorphic/manualPromise';import type { Browser, BrowserOptions } from '../browser';import type { SdkObject } from '../instrumentation';-import type { ProtocolError } from '../protocolError';import type { ConnectionTransport } from '../transport';import type * as types from '../types';import type { RecentLogsCollector } from '../utils/debugLogger';@@ -58,15 +57,13 @@ export class Firefox extends BrowserType {return FFBrowser.connect(this.attribution.playwright, transport, options);}- override doRewriteStartupLog(error: ProtocolError): ProtocolError {- if (!error.logs)- return error;+ override doRewriteStartupLog(logs: string): string {// https://github.com/microsoft/playwright/issues/6500- 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'))- error.logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);- return error;+ if (logs.includes(`as root in a regular user's session is not supported.`))+ 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 (logs.includes('no DISPLAY environment variable specified'))+ logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);+ return logs;}override amendEnvironment(env: NodeJS.ProcessEnv): NodeJS.ProcessEnv {diff --git a/packages/playwright-core/src/server/webkit/webkit.ts b/packages/playwright-core/src/server/webkit/webkit.tsindex 02e59bfdaf..c2daa135c9 100644--- a/packages/playwright-core/src/server/webkit/webkit.ts+++ b/packages/playwright-core/src/server/webkit/webkit.ts@@ -25,7 +25,6 @@ import { spawnAsync } from '../utils/spawnAsync';import type { BrowserOptions } from '../browser';import type { SdkObject } from '../instrumentation';-import type { ProtocolError } from '../protocolError';import type { ConnectionTransport } from '../transport';import type * as types from '../types';@@ -45,12 +44,10 @@ export class WebKit extends BrowserType {};}- override doRewriteStartupLog(error: ProtocolError): ProtocolError {- if (!error.logs)- return error;- if (error.logs.includes('Failed to open display') || error.logs.includes('cannot open display'))- error.logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);- return error;+ override doRewriteStartupLog(logs: string): string {+ if (logs.includes('Failed to open display') || logs.includes('cannot open display'))+ logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);+ return logs;}override attemptToGracefullyCloseBrowser(transport: ConnectionTransport): void {