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
fix(bidi): authenticate against proxies in Chromium (#43232)
Pavel Feldman401d33cf6fca
diff --git a/packages/playwright-core/src/server/bidi/bidiBrowser.ts b/packages/playwright-core/src/server/bidi/bidiBrowser.tsindex c4f2280baf..c7f09fd9aa 100644--- a/packages/playwright-core/src/server/bidi/bidiBrowser.ts+++ b/packages/playwright-core/src/server/bidi/bidiBrowser.ts@@ -36,8 +36,15 @@ import type { BidiSession } from './bidiConnection';import type * as channels from '../channels';+export type BidiBrowserOptions = {+ // Authenticate against a proxy with a Proxy-Authorization header on every request,+ // or by answering the proxy's auth challenge with the credentials.+ proxyAuthentication: 'header' | 'credentials',+};+export class BidiBrowser extends Browser {private readonly _connection: BidiConnection;+ readonly _bidiOptions: BidiBrowserOptions;readonly _browserSession: BidiSession;private _bidiSessionInfo!: bidi.Session.NewResult;readonly _contexts = new Map<string, BidiBrowserContext>();@@ -45,8 +52,8 @@ export class BidiBrowser extends Browser {private readonly _eventListeners: RegisteredListener[];private _cacheBehavior: bidi.Network.SetCacheBehaviorParameters['cacheBehavior'] = 'default';- static async connect(parent: SdkObject, transport: ConnectionTransport, options: BrowserOptions): Promise<BidiBrowser> {- const browser = new BidiBrowser(parent, transport, options);+ static async connect(parent: SdkObject, transport: ConnectionTransport, options: BrowserOptions, bidiOptions: BidiBrowserOptions): Promise<BidiBrowser> {+ const browser = new BidiBrowser(parent, transport, options, bidiOptions);if ((options as any).__testHookOnConnectToBrowser)await (options as any).__testHookOnConnectToBrowser();@@ -95,8 +102,9 @@ export class BidiBrowser extends Browser {return browser;}- constructor(parent: SdkObject, transport: ConnectionTransport, options: BrowserOptions) {+ constructor(parent: SdkObject, transport: ConnectionTransport, options: BrowserOptions, bidiOptions: BidiBrowserOptions) {super(parent, options);+ this._bidiOptions = bidiOptions;this._connection = new BidiConnection(transport, this._onDisconnect.bind(this), options.protocolLogger, options.browserLogsCollector);this._browserSession = this._connection.browserSession;this._eventListeners = [@@ -217,7 +225,10 @@ export class BidiBrowserContext extends BrowserContext {constructor(browser: BidiBrowser, browserContextId: string | undefined, options: types.BrowserContextOptions) {super(browser, options, browserContextId);- this.authenticateProxyViaHeader();+ if (browser._bidiOptions.proxyAuthentication === 'credentials')+ this.authenticateProxyViaCredentials();+ else+ this.authenticateProxyViaHeader();}private _bidiPages() {@@ -591,7 +602,6 @@ function getProxyConfiguration(proxySettings?: types.ProxySettings): bidi.Sessioconst bypass = proxySettings.bypass ?? process.env.PLAYWRIGHT_PROXY_BYPASS_FOR_TESTING;if (bypass)proxy.noProxy = bypass.split(',');- // TODO: support authentication.return proxy;}diff --git a/packages/playwright-core/src/server/bidi/bidiChromium.ts b/packages/playwright-core/src/server/bidi/bidiChromium.tsindex 9af2f80d28..f3a8148c85 100644--- a/packages/playwright-core/src/server/bidi/bidiChromium.ts+++ b/packages/playwright-core/src/server/bidi/bidiChromium.ts@@ -44,7 +44,9 @@ export class BidiChromium extends BrowserType {const bidiTransport = await bidiOverCdp.connectBidiOverCdp(transport);(transport as any)[kBidiOverCdpWrapper] = bidiTransport;try {- return BidiBrowser.connect(this.attribution.playwright, bidiTransport, options);+ // Chromium rejects Proxy-Authorization as an unsafe header, so answer the proxy's+ // auth challenge with the credentials instead, like the CDP-based Chromium does.+ return BidiBrowser.connect(this.attribution.playwright, bidiTransport, options, { proxyAuthentication: 'credentials' });} catch (e) {const error = profileInUseError(browserLogsCollector.recentLogs());if (error)diff --git a/packages/playwright-core/src/server/bidi/bidiFirefox.ts b/packages/playwright-core/src/server/bidi/bidiFirefox.tsindex a33d88dd34..6a38e65fff 100644--- a/packages/playwright-core/src/server/bidi/bidiFirefox.ts+++ b/packages/playwright-core/src/server/bidi/bidiFirefox.ts@@ -41,7 +41,7 @@ export class BidiFirefox extends BrowserType {}override async connectToTransport(transport: ConnectionTransport, options: BrowserOptions): Promise<BidiBrowser> {- return BidiBrowser.connect(this.attribution.playwright, transport, options);+ return BidiBrowser.connect(this.attribution.playwright, transport, options, { proxyAuthentication: 'header' });}override doRewriteStartupLog(logs: string): string {diff --git a/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts b/packages/playwright-core/src/server/bidi/bidiNetworkManager.tsindex b78b485331..3076948af4 100644--- a/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts+++ b/packages/playwright-core/src/server/bidi/bidiNetworkManager.ts@@ -198,9 +198,9 @@ export class BidiNetworkManager {}private _onAuthRequired(params: bidi.Network.AuthRequiredParameters) {- const isBasic = params.response.authChallenges?.some(challenge => challenge.scheme.startsWith('Basic'));+ // Don't look at params.response.authChallenges: Chromium does not report them.const credentials = findMatchingHttpCredentials(this._page.browserContext._options.httpCredentials, params.request.url);- if (isBasic && credentials) {+ if (credentials) {if (this._attemptedAuthentications.has(params.request.request)) {this._session.sendMayFail('network.continueWithAuth', {request: params.request.request,diff --git a/tests/bidi/expectations/bidi-chromium-library.txt b/tests/bidi/expectations/bidi-chromium-library.txtindex e6ea407bba..0d104126b4 100644--- a/tests/bidi/expectations/bidi-chromium-library.txt+++ b/tests/bidi/expectations/bidi-chromium-library.txt@@ -33,10 +33,6 @@ library/browsercontext-cookies.spec.ts › should parse cookie with large Max-Aglibrary/browsercontext-credentials.spec.ts › should fail with correct credentials and mismatching hostname [fail]library/browsercontext-credentials.spec.ts › should fail with correct credentials and mismatching port [fail]library/browsercontext-credentials.spec.ts › should fail with correct credentials and mismatching scheme [fail]-library/browsercontext-credentials.spec.ts › should return resource body [fail]-library/browsercontext-credentials.spec.ts › should work with correct credentials @smoke [fail]-library/browsercontext-credentials.spec.ts › should work with correct credentials and matching origin [fail]-library/browsercontext-credentials.spec.ts › should work with correct credentials and matching origin case insensitive [fail]library/browsercontext-credentials.spec.ts › should work with setHTTPCredentials [fail]library/browsercontext-csp.spec.ts › should bypass after cross-process navigation [fail]library/browsercontext-csp.spec.ts › should bypass CSP header [fail]@@ -67,10 +63,6 @@ library/browsercontext-page-event.spec.ts › should have an opener [fail]library/browsercontext-page-event.spec.ts › should have url [fail]library/browsercontext-page-event.spec.ts › should not hang on ctrl-click during provisional load [timeout]library/browsercontext-page-event.spec.ts › should report when a new page is created and closed [fail]-library/browsercontext-proxy.spec.ts › should authenticate [timeout]-library/browsercontext-proxy.spec.ts › should authenticate with empty password [timeout]-library/browsercontext-proxy.spec.ts › should isolate proxy credentials between contexts [timeout]-library/browsercontext-proxy.spec.ts › should isolate proxy credentials between contexts on navigation [timeout]library/browsercontext-proxy.spec.ts › should proxy local network requests › by default › link-local [timeout]library/browsercontext-proxy.spec.ts › should proxy local network requests › with other bypasses › link-local [timeout]library/browsercontext-proxy.spec.ts › should proxy local network requests › with other bypasses › localhost [fail]@@ -277,7 +269,6 @@ library/defaultbrowsercontext-1.spec.ts › context.cookies() should work @smokelibrary/defaultbrowsercontext-1.spec.ts › should support acceptDownloads option [timeout]library/defaultbrowsercontext-1.spec.ts › should support bypassCSP option [timeout]library/defaultbrowsercontext-1.spec.ts › should support deviceScaleFactor option [timeout]-library/defaultbrowsercontext-1.spec.ts › should support httpCredentials option [timeout]library/defaultbrowsercontext-1.spec.ts › should support javascriptEnabled option [timeout]library/defaultbrowsercontext-1.spec.ts › should support offline option [timeout]library/defaultbrowsercontext-1.spec.ts › should support userAgent option [timeout]@@ -504,9 +495,7 @@ library/popup.spec.ts › should not throttle rAF in the opener page [timeout]library/popup.spec.ts › should respect routes from browser context [fail]library/popup.spec.ts › should respect routes from browser context when using window.open [fail]library/popup.spec.ts › should use viewport size from window features [timeout]-library/proxy.spec.ts › should authenticate [timeout]library/proxy.spec.ts › should proxy local network requests › by default › link-local [flaky]-library/proxy.spec.ts › should work with authenticate followed by redirect [timeout]library/resource-timing.spec.ts › should work when serving from memory cache [fail]library/role-utils.spec.ts › wpt accname #0 [flaky]library/role-utils.spec.ts › wpt accname #1 [flaky]