Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: follow up to loopback proxy bypass (#39579)

Dmitry Gozmanb085f91099f8
diff --git a/packages/playwright-core/src/server/android/android.ts b/packages/playwright-core/src/server/android/android.ts
index db1616bd16..c45ea10599 100644
--- a/packages/playwright-core/src/server/android/android.ts
+++ b/packages/playwright-core/src/server/android/android.ts
@@ -29,7 +29,7 @@ import { debug } from '../../utilsBundle';
import { wsReceiver, wsSender } from '../../utilsBundle';
import { validateBrowserContextOptions } from '../browserContext';
import { chromiumSwitches } from '../chromium/chromiumSwitches';
-import { CRBrowser } from '../chromium/crBrowser';
+import { shouldProxyLoopback, CRBrowser } from '../chromium/crBrowser';
import { removeFolders } from '../utils/fileUtils';
import { helper } from '../helper';
import { SdkObject } from '../instrumentation';
@@ -301,7 +301,7 @@ export class AndroidDevice extends SdkObject {
const proxyBypassRules = [];
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 (shouldProxyLoopback(proxy.bypass))
proxyBypassRules.push('<-loopback>');
if (proxyBypassRules.length > 0)
chromeArguments.push(`--proxy-bypass-list=${proxyBypassRules.join(';')}`);
diff --git a/packages/playwright-core/src/server/bidi/DEPS.list b/packages/playwright-core/src/server/bidi/DEPS.list
index ab509f181c..76fcdbab98 100644
--- a/packages/playwright-core/src/server/bidi/DEPS.list
+++ b/packages/playwright-core/src/server/bidi/DEPS.list
@@ -12,3 +12,4 @@
[bidiChromium.ts]
../chromium/chromiumSwitches.ts
../chromium/chromium.ts
+../chromium/crBrowser.ts
diff --git a/packages/playwright-core/src/server/bidi/bidiChromium.ts b/packages/playwright-core/src/server/bidi/bidiChromium.ts
index d44a2e2a38..1febca2ea2 100644
--- a/packages/playwright-core/src/server/bidi/bidiChromium.ts
+++ b/packages/playwright-core/src/server/bidi/bidiChromium.ts
@@ -23,6 +23,7 @@ import { kBrowserCloseMessageId } from './bidiConnection';
import { chromiumSwitches } from '../chromium/chromiumSwitches';
import { RecentLogsCollector } from '../utils/debugLogger';
import { waitForReadyState } from '../chromium/chromium';
+import { shouldProxyLoopback } from '../chromium/crBrowser';
import type { BrowserOptions } from '../browser';
import type { SdkObject } from '../instrumentation';
@@ -142,11 +143,9 @@ 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 (options.socksProxyPort)
- proxyBypassRules.push('<-loopback>');
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 (options.socksProxyPort || shouldProxyLoopback(proxy.bypass))
proxyBypassRules.push('<-loopback>');
if (proxyBypassRules.length > 0)
chromeArguments.push(`--proxy-bypass-list=${proxyBypassRules.join(';')}`);
diff --git a/packages/playwright-core/src/server/chromium/chromium.ts b/packages/playwright-core/src/server/chromium/chromium.ts
index f0b955c13c..ada51cd440 100644
--- a/packages/playwright-core/src/server/chromium/chromium.ts
+++ b/packages/playwright-core/src/server/chromium/chromium.ts
@@ -20,7 +20,7 @@ import os from 'os';
import path from 'path';
import { chromiumSwitches } from './chromiumSwitches';
-import { CRBrowser } from './crBrowser';
+import { shouldProxyLoopback, CRBrowser } from './crBrowser';
import { kBrowserCloseMessageId } from './crConnection';
import { debugMode, headersArrayToObject, headersObjectToArray, } from '../../utils';
import { wrapInASCIIBox } from '../utils/ascii';
@@ -345,12 +345,9 @@ 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 (options.socksProxyPort)
- proxyBypassRules.push('<-loopback>');
if (proxy.bypass)
proxyBypassRules.push(...proxy.bypass.split(',').map(t => t.trim()).map(t => t.startsWith('.') ? '*' + t : t));
- const bypassesLoopback = proxyBypassRules.some(rule => rule === '<-loopback>' || rule === 'localhost' || rule === '127.0.0.1' || rule === '::1');
- if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !bypassesLoopback)
+ if (options.socksProxyPort || shouldProxyLoopback(proxy.bypass))
proxyBypassRules.push('<-loopback>');
if (proxyBypassRules.length > 0)
chromeArguments.push(`--proxy-bypass-list=${proxyBypassRules.join(';')}`);
diff --git a/packages/playwright-core/src/server/chromium/crBrowser.ts b/packages/playwright-core/src/server/chromium/crBrowser.ts
index d4b3fa6892..e5a1df65ce 100644
--- a/packages/playwright-core/src/server/chromium/crBrowser.ts
+++ b/packages/playwright-core/src/server/chromium/crBrowser.ts
@@ -112,10 +112,10 @@ export class CRBrowser extends Browser {
const proxy = options.proxyOverride || options.proxy;
let proxyBypassList = undefined;
if (proxy) {
- if (process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK)
- proxyBypassList = proxy.bypass;
- else
+ if (shouldProxyLoopback(proxy.bypass))
proxyBypassList = '<-loopback>' + (proxy.bypass ? `,${proxy.bypass}` : '');
+ else
+ proxyBypassList = proxy.bypass;
}
const { browserContextId } = await this._session.send('Target.createBrowserContext', {
@@ -617,3 +617,11 @@ export class CRBrowserContext extends BrowserContext<CREventsMap> {
return rootSession.attachToTarget(targetId);
}
}
+
+export function shouldProxyLoopback(bypass: string | undefined) {
+ if (process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK)
+ return false;
+ const hosts = (bypass || '').split(',').map(s => s.trim());
+ const shouldBypassSomeLoopback = ['localhost', '127.0.0.1', '::1', '[::]', '[::1]', '<loopback>', '<-loopback>'].some(host => hosts.includes(host));
+ return !shouldBypassSomeLoopback;
+}
diff --git a/tests/config/proxy.ts b/tests/config/proxy.ts
index e1ac6ab5a3..6fbad1ca7f 100644
--- a/tests/config/proxy.ts
+++ b/tests/config/proxy.ts
@@ -62,7 +62,7 @@ export class TestProxy {
await new Promise(x => this._server.close(x));
}
- forwardTo(port: number, options?: { allowConnectRequests?: boolean, prefix?: string, preserveHostname?: boolean }) {
+ forwardTo(port: number, options?: { allowConnectRequests?: boolean, removePrefix?: string, preserveHostname?: boolean }) {
this._prependHandler('request', (req: IncomingMessage) => {
this.requestUrls.push(req.url);
const url = new URL(req.url, `http://${req.headers.host}`);
@@ -70,8 +70,8 @@ export class TestProxy {
url.port = '' + port;
else
url.host = `127.0.0.1:${port}`;
- if (options?.prefix)
- url.pathname = url.pathname.replace(options.prefix, '');
+ if (options?.removePrefix)
+ url.pathname = url.pathname.replace(options.removePrefix, '');
req.url = url.toString();
});
this._prependHandler('connect', (req: IncomingMessage) => {
@@ -89,8 +89,8 @@ export class TestProxy {
url.port = '' + port;
else
url.host = `127.0.0.1:${port}`;
- if (options?.prefix)
- url.pathname = url.pathname.replace(options.prefix, '');
+ if (options?.removePrefix)
+ url.pathname = url.pathname.replace(options.removePrefix, '');
if (url.protocol === 'ws:')
url.protocol = 'http:';
else if (url.protocol === 'wss:')
diff --git a/tests/library/proxy.spec.ts b/tests/library/proxy.spec.ts
index 97cfeaf5a0..05c91c7277 100644
--- a/tests/library/proxy.spec.ts
+++ b/tests/library/proxy.spec.ts
@@ -123,6 +123,28 @@ it.describe('should proxy local network requests', () => {
}
});
+for (const host of ['localhost', '127.0.0.1', '[::1]']) {
+ it(`should allow bypassing ${host} requests`, async ({ browserName, browserType, server, proxyServer }) => {
+ it.fixme(browserName === 'firefox' && host === '[::1]', 'firefox still proxies');
+
+ server.setRoute(`/proxied/target.html`, async (req, res) => {
+ res.end('<html><title>Served by the server</title></html>');
+ });
+ server.setRoute(`/target.html`, async (req, res) => {
+ res.end('<html><title>Served by the proxy</title></html>');
+ });
+ proxyServer.forwardTo(server.PORT, { removePrefix: '/proxied' });
+
+ const browser = await browserType.launch({
+ proxy: { server: `localhost:${proxyServer.PORT}`, bypass: host }
+ });
+ const page = await browser.newPage();
+ await page.goto(`http://${host}:${server.PORT}/proxied/target.html`);
+ expect(await page.title()).toBe('Served by the server');
+ await browser.close();
+ });
+}
+
it('should authenticate', async ({ browserType, server }) => {
server.setRoute('/target.html', async (req, res) => {
const auth = req.headers['proxy-authorization'];
@@ -228,21 +250,24 @@ it('should exclude patterns', async ({ browserType, server, channel }) => {
await browser.close();
});
-it('should bypass proxy for localhost when localhost is in bypass list', async ({ browserType, server, proxyServer }) => {
- proxyServer.forwardTo(server.PORT);
- server.setRoute('/target.html', async (req, res) => {
- res.end('<html><title>Served by the proxy</title></html>');
- });
- const browser = await browserType.launch({
- proxy: { server: `localhost:${proxyServer.PORT}`, bypass: 'localhost' }
+for (const host of ['localhost', '127.0.0.1']) {
+ it(`should bypass proxy for ${host} when ${host} is in bypass list`, async ({ browserType, server, proxyServer }) => {
+ proxyServer.forwardTo(server.PORT, { removePrefix: '/proxied' });
+ server.setRoute(`/proxied/target.html`, async (req, res) => {
+ res.end('<html><title>Served by the server</title></html>');
+ });
+ server.setRoute('/target.html', async (req, res) => {
+ res.end('<html><title>Served by the proxy</title></html>');
+ });
+ const browser = await browserType.launch({
+ proxy: { server: `localhost:${proxyServer.PORT}`, bypass: host }
+ });
+ const page = await browser.newPage();
+ await page.goto(`http://${host}:${server.PORT}/proxied/target.html`);
+ expect(await page.title()).toBe('Served by the server');
+ await browser.close();
});
- const page = await browser.newPage();
- // Navigate to localhost - should bypass the proxy and hit the server directly.
- await page.goto(`http://localhost:${server.PORT}/target.html`);
- expect(proxyServer.requestUrls).not.toContain(`http://localhost:${server.PORT}/target.html`);
- expect(await page.title()).toBe('Served by the proxy');
- await browser.close();
-});
+}
it('should use socks proxy', async ({ browserType, socksPort }) => {
const browser = await browserType.launch({
diff --git a/tests/playwright-test/ui-mode-trace.spec.ts b/tests/playwright-test/ui-mode-trace.spec.ts
index 9de325547a..bb89bb41dd 100644
--- a/tests/playwright-test/ui-mode-trace.spec.ts
+++ b/tests/playwright-test/ui-mode-trace.spec.ts
@@ -443,7 +443,7 @@ test('should work behind reverse proxy', { annotation: { type: 'issue', descript
});
const uiModeUrl = new URL(page.url());
- reverseProxy.forwardTo(+uiModeUrl.port, { prefix: '/subdir', preserveHostname: true });
+ reverseProxy.forwardTo(+uiModeUrl.port, { removePrefix: '/subdir', preserveHostname: true });
await page.goto(`${reverseProxy.URL}/subdir${uiModeUrl.pathname}?${uiModeUrl.searchParams}`);
await page.getByText('trace test').dblclick();