yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: only throw the proxy on launch required on win/CR (#6350)

Browse Source
This commit is contained in:
Max Schmitt 2021-04-30 00:02:48 +02:00 committed by GitHub
parent 263a0fd2e1
commit 1c40c94ed7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 44 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/api/params.md
View File

@ -447,9 +447,13 @@ Actual picture of each page will be scaled down if necessary to fit the specifie
- `username` <[string]> Optional username to use if HTTP proxy requires authentication. - `username` <[string]> Optional username to use if HTTP proxy requires authentication.
- `password` <[string]> Optional password to use if HTTP proxy requires authentication. - `password` <[string]> Optional password to use if HTTP proxy requires authentication.
Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this Network proxy settings to use with this context.
option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example
`launch({ proxy: { server: 'per-context' } })`. :::note
For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all
contexts override the proxy, global proxy will be never used and can be any string, for example
`launch({ proxy: { server: 'http://per-context' } })`.
:::
## select-options-values ## select-options-values
* langs: java, js * langs: java, js

5
src/server/browserContext.ts
View File

@ -15,6 +15,7 @@
* limitations under the License. * limitations under the License.
*/ */
import * as os from 'os';
import { TimeoutSettings } from '../utils/timeoutSettings'; import { TimeoutSettings } from '../utils/timeoutSettings';
import { debugMode, mkdirIfNeeded, createGuid } from '../utils/utils'; import { debugMode, mkdirIfNeeded, createGuid } from '../utils/utils';
import { Browser, BrowserOptions } from './browser'; import { Browser, BrowserOptions } from './browser';
@ -405,8 +406,8 @@ export function validateBrowserContextOptions(options: types.BrowserContextOptio
options.recordVideo.size!.height &= ~1; options.recordVideo.size!.height &= ~1;
} }
if (options.proxy) { if (options.proxy) {
if (!browserOptions.proxy) if (!browserOptions.proxy && browserOptions.isChromium && os.platform() === 'win32')
throw new Error(`Browser needs to be launched with the global proxy. If all contexts override the proxy, global proxy will be never used and can be any string, for example "launch({ proxy: { server: 'per-context' } })"`); throw new Error(`Browser needs to be launched with the global proxy. If all contexts override the proxy, global proxy will be never used and can be any string, for example "launch({ proxy: { server: 'http://per-context' } })"`);
options.proxy = normalizeProxySettings(options.proxy); options.proxy = normalizeProxySettings(options.proxy);
} }
if (debugMode() === 'inspector') if (debugMode() === 'inspector')

25
tests/browsercontext-proxy.spec.ts
View File

@ -26,7 +26,9 @@ it.afterAll(async () => {
await browser.close(); await browser.close();
}); });
it('should throw for missing global proxy', async ({ browserType, browserOptions, server }) => { it('should throw for missing global proxy on Chromium Windows', async ({ browserName, platform, browserType, browserOptions, server }) => {
it.skip(browserName !== 'chromium' || platform !== 'win32');
delete browserOptions.proxy; delete browserOptions.proxy;
const browser = await browserType.launch(browserOptions); const browser = await browserType.launch(browserOptions);
const error = await browser.newContext({ proxy: { server: `localhost:${server.PORT}` } }).catch(e => e); const error = await browser.newContext({ proxy: { server: `localhost:${server.PORT}` } }).catch(e => e);
@ -34,6 +36,27 @@ it('should throw for missing global proxy', async ({ browserType, browserOptions
await browser.close(); await browser.close();
}); });
it('should work when passing the proxy only on the context level', async ({browserName, platform, browserType, browserOptions, contextOptions, server}) => {
// Currently an upstream bug in the network stack of Chromium which leads that
// the wrong proxy gets used in the BrowserContext.
it.fixme(browserName === 'chromium' && platform === 'win32');
server.setRoute('/target.html', async (req, res) => {
res.end('<html><title>Served by the proxy</title></html>');
});
delete browserOptions.proxy;
const browserWithoutProxyInLaunch = await browserType.launch(browserOptions);
const context = await browserWithoutProxyInLaunch.newContext({
...contextOptions,
proxy: { server: `localhost:${server.PORT}` }
});
const page = await context.newPage();
await page.goto('http://non-existent.com/target.html');
expect(await page.title()).toBe('Served by the proxy');
await browserWithoutProxyInLaunch.close();
});
it('should throw for bad server value', async ({ contextOptions }) => { it('should throw for bad server value', async ({ contextOptions }) => {
const error = await browser.newContext({ const error = await browser.newContext({
...contextOptions, ...contextOptions,

16
types/types.d.ts vendored
View File

@ -8694,9 +8694,11 @@ export interface Browser extends EventEmitter {
permissions?: Array<string>; permissions?: Array<string>;
/** /**
* Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this * Network proxy settings to use with this context.
* option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example *
* `launch({ proxy: { server: 'per-context' } })`. * > NOTE: For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all
* contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: {
* server: 'http://per-context' } })`.
*/ */
proxy?: { proxy?: {
/** /**
@ -10545,9 +10547,11 @@ export interface BrowserContextOptions {
permissions?: Array<string>; permissions?: Array<string>;
/** /**
* Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this * Network proxy settings to use with this context.
* option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example *
* `launch({ proxy: { server: 'per-context' } })`. * > NOTE: For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all
* contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: {
* server: 'http://per-context' } })`.
*/ */
proxy?: { proxy?: {
/** /**