Skip to content

feat: support ConnectOptions in remoteEndpoint for exposeNetwork #40388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ek03ansh wants to merge 10 commits into
base: main
Choose a base branch
from
+60 −4
Open

feat: support ConnectOptions in remoteEndpoint for exposeNetwork #40388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f057610
fix: pass exposeNetwork from config to connectToBrowser in createRemo…
Ek03ansh Apr 23, 2026
82428e7
feat: add exposeNetwork to Config browser type definition
Ek03ansh Apr 23, 2026
0dd8e12
refactor: use string | ConnectOptions for remoteEndpoint
EkanshMS03 Apr 29, 2026
ca9de4c
fix: use named ConnectOptions type and fix serverRegistry.find call
EkanshMS03 Apr 29, 2026
8cbe062
simplify: inline ConnectOptions type following codebase pattern
EkanshMS03 Apr 29, 2026
dc5b4a0
test: add test for remoteEndpoint ConnectOptions object with exposeNe…
EkanshMS03 Apr 29, 2026
af91be9
test: simplify remoteEndpoint ConnectOptions test
EkanshMS03 Apr 30, 2026
6e5517e
test: fix remoteEndpoint ConnectOptions test - verify connection, not…
EkanshMS03 Apr 30, 2026
5de39f3
test: fix remoteEndpoint test - add server.setContent and verify page…
EkanshMS03 Apr 30, 2026
9c14de6
test: add exposeNetwork test for remoteEndpoint ConnectOptions
EkanshMS03 Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/playwright-core/src/tools/mcp/browserFactory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,9 @@ async function createCDPBrowser(config: FullConfig): Promise<playwrightTypes.Bro

async function createRemoteBrowser(config: FullConfig): Promise<BrowserWithInfo> {
testDebug('create browser (remote)');
const descriptor = await serverRegistry.find(config.browser.remoteEndpoint!);
const remoteEndpoint = config.browser.remoteEndpoint!;
const endpoint = typeof remoteEndpoint === 'string' ? remoteEndpoint : remoteEndpoint.endpoint;
const descriptor = await serverRegistry.find(endpoint);
if (descriptor) {
const browser = await connectToBrowserAcrossVersions(descriptor);
return {
Expand All @@ -135,10 +137,10 @@ async function createRemoteBrowser(config: FullConfig): Promise<BrowserWithInfo>
};
}

const endpoint = config.browser.remoteEndpoint!;
const connectOptions = typeof remoteEndpoint === 'string' ? { endpoint: remoteEndpoint } : remoteEndpoint;
const playwrightObject = playwright as Playwright;
// Use connectToBrowser instead of playwright[browserName].connect because we don't have browserName.
const browser = await connectToBrowser(playwrightObject, { endpoint });
const browser = await connectToBrowser(playwrightObject, connectOptions);
browser._connectToBrowserType(playwrightObject[browser._browserName], {}, undefined);
return { browser, browserInfo: browserInfo(browser, config), canBind: false, ownership: 'attached' };
}
Expand Down
5 changes: 4 additions & 1 deletion packages/playwright-core/src/tools/mcp/config.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,11 @@ export type Config = {

/**
* Remote endpoint to connect to an existing Playwright server.
* Can be a URL string or a ConnectOptions object for advanced configuration
* (e.g. `exposeNetwork`, `headers`, `slowMo`, `timeout`).
* @see https://playwright.dev/docs/api/class-browsertype#browser-type-connect
*/
remoteEndpoint?: string;
remoteEndpoint?: string | playwright.ConnectOptions & { endpoint: string };

/**
* Paths to TypeScript files to add as initialization scripts for Playwright page.
Expand Down
51 changes: 51 additions & 0 deletions tests/mcp/config.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,3 +173,54 @@ test('browser_get_config returns merged config from file, env and cli', async ({
// From CLI arg (--isolated).
expect(config.browser.isolated).toBe(true);
});

test('remoteEndpoint as ConnectOptions object', async ({ startClient, server, wsEndpoint }) => {
Copy link
Copy Markdown
Collaborator

@dgozman dgozman May 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's get rid of this test, it does not really add any more coverage.

server.setContent('/', `
<title>Title</title>
<body>Hello, world!</body>
`, 'text/html');

const { client } = await startClient({
config: {
browser: {
remoteEndpoint: {
endpoint: wsEndpoint,
},
isolated: true,
},
},
});

expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
})).toHaveResponse({
snapshot: expect.stringContaining('Hello, world!'),
});
});

test('remoteEndpoint as ConnectOptions object with exposeNetwork', async ({ startClient, server, wsEndpoint }) => {
server.setContent('/', `
<title>Title</title>
<body>exposed-network-content</body>
`, 'text/html');

const { client } = await startClient({
config: {
browser: {
remoteEndpoint: {
endpoint: wsEndpoint,
exposeNetwork: '*',
},
isolated: true,
},
},
});

expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
})).toHaveResponse({
snapshot: expect.stringContaining('exposed-network-content'),
});
});
Loading