Skip to content

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

11.6 KB
Raw Blame
/**
 * Copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import fs from 'fs/promises';
import { pathToFileURL } from 'url';
import { test, expect } from './fixtures';

test('browser_navigate', async ({ client, server }) => {
  expect(await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.HELLO_WORLD },
  })).toHaveResponse({
    code: `await page.goto('${server.HELLO_WORLD}');`,
    page: `- Page URL: ${server.HELLO_WORLD}
- Page Title: Title`,
    snapshot: `- generic [active] [ref=e1]: Hello, world!`,
  });
});

test('browser_navigate with bare host', async ({ client, server }) => {
  const urlWithoutScheme = server.HELLO_WORLD.replace(/^https?:\/\//, '');
  expect(await client.callTool({
    name: 'browser_navigate',
    arguments: { url: urlWithoutScheme },
  })).toHaveResponse({
    code: `await page.goto('${server.HELLO_WORLD}');`,
    page: `- Page URL: ${server.HELLO_WORLD}
- Page Title: Title`,
    snapshot: `- generic [active] [ref=e1]: Hello, world!`,
  });
});

test('browser_navigate surfaces non-2xx HTTP status', async ({ client, server }) => {
  server.setRoute('/locked', (req, res) => {
    res.writeHead(402, { 'Content-Type': 'text/html' });
    res.end('<title>Payment Required</title><body>Pay up</body>');
  });

  expect(await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.PREFIX + '/locked' },
  })).toHaveResponse({
    page: expect.stringContaining(`- HTTP status: 402 Payment Required`),
  });

  // A redirect to a 2xx page must not carry a status line: the intermediate
  // 302 hop must not leak, and the final 2xx landing renders nothing.
  server.setRoute('/redirect', (req, res) => {
    res.writeHead(302, { location: server.HELLO_WORLD });
    res.end();
  });
  expect(await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.PREFIX + '/redirect' },
  })).not.toHaveResponse({
    page: expect.stringContaining('HTTP status'),
  });
});

test('browser_navigate blocks file:// URLs by default', async ({ client }) => {
  expect(await client.callTool({
    name: 'browser_navigate',
    arguments: { url: 'file:///etc/passwd' },
  })).toHaveResponse({
    error: expect.stringContaining('Error: Access to "file:" protocol is blocked. Attempted URL: "file:///etc/passwd"'),
    isError: true,
  });
});

test('browser_navigate allows about:, data: and javascript: protocols', async ({ client, server }) => {
  expect(await client.callTool({
    name: 'browser_navigate',
    arguments: { url: 'about:blank' },
  })).toHaveResponse({
    code: `await page.goto('about:blank');`,
    page: `- Page URL: about:blank`,
    snapshot: ``,
  });

  expect(await client.callTool({
    name: 'browser_navigate',
    arguments: { url: 'data:text/html,<h1>Hello</h1>' },
  })).toHaveResponse({
    code: `await page.goto('data:text/html,<h1>Hello</h1>');`,
    page: expect.stringContaining(`- Page URL: data:text/html,<h1>Hello</h1>`),
    snapshot: `- heading \"Hello\" [level=1] [ref=e2]`,
  });
});

test('browser_navigate can navigate to file:// URLs allowUnrestrictedFileAccess is true', async ({ startClient }, testInfo) => {
  const rootDir = testInfo.outputPath();
  const fileOutsideRoot = testInfo.outputPath('test.txt');
  await fs.writeFile(fileOutsideRoot, 'Test file content');
  const { client } = await startClient({
    config: {
      allowUnrestrictedFileAccess: true,
    },
    roots: [
      {
        name: 'workspace',
        uri: pathToFileURL(rootDir).href,
      }
    ],
  });

  const url = pathToFileURL(fileOutsideRoot).href;
  expect(await client.callTool({
    name: 'browser_navigate',
    arguments: { url },
  })).toHaveResponse({
    page: expect.stringContaining(`- Page URL: ${url}`),
    snapshot: `- generic [active] [ref=e1]: Test file content`,
  });
});

test('browser_navigate_back does not time out when load never fires', async ({ client, server }) => {
  // https://github.com/microsoft/playwright-mcp/issues/1635
  // Page A never fires the `load` event because the image request hangs forever.
  // Going back to it should still succeed because we wait for `commit`, not `load`.
  server.setRoute('/hang', () => {});
  server.setContent('/page-a', `<title>Page A</title><body>Page A<img src="/hang"></body>`, 'text/html');
  server.setContent('/page-b', `<title>Page B</title><body>Page B</body>`, 'text/html');

  await client.callTool({
    name: 'browser_navigate',
    arguments: { url: `${server.PREFIX}/page-a` },
  });
  await client.callTool({
    name: 'browser_navigate',
    arguments: { url: `${server.PREFIX}/page-b` },
  });

  expect(await client.callTool({
    name: 'browser_navigate_back',
    arguments: {},
  })).toHaveResponse({
    code: `await page.goBack();`,
    page: expect.stringContaining(`- Page URL: ${server.PREFIX}/page-a`),
  });
});

test('browser_select_option', async ({ client, server }) => {
  server.setContent('/', `
    <title>Title</title>
    <select>
      <option value="foo">Foo</option>
      <option value="bar">Bar</option>
    </select>
  `, 'text/html');

  await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.PREFIX },
  });

  expect(await client.callTool({
    name: 'browser_select_option',
    arguments: {
      element: 'Select',
      target: 'e2',
      values: ['bar'],
    },
  })).toHaveResponse({
    snapshot: `- combobox [ref=e2]:
  - option "Foo"
  - option "Bar" [selected]`,
  });
});

test('browser_select_option (multiple)', async ({ client, server }) => {
  server.setContent('/', `
    <title>Title</title>
    <select multiple>
      <option value="foo">Foo</option>
      <option value="bar">Bar</option>
      <option value="baz">Baz</option>
    </select>
  `, 'text/html');

  await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.PREFIX },
  });

  expect(await client.callTool({
    name: 'browser_select_option',
    arguments: {
      element: 'Select',
      target: 'e2',
      values: ['bar', 'baz'],
    },
  })).toHaveResponse({
    code: `await page.getByRole('listbox').selectOption(['bar', 'baz']);`,
    snapshot: `- listbox [ref=e2]:
  - option "Foo" [ref=e3]
  - option "Bar" [selected] [ref=e4]
  - option "Baz" [selected] [ref=e5]`,
  });
});

test('browser_resize', async ({ client, server }) => {
  server.setContent('/', `
    <title>Resize Test</title>
    <body>
      <div id="size">Waiting for resize...</div>
      <script>new ResizeObserver(() => { document.getElementById("size").textContent = \`Window size: \${window.innerWidth}x\${window.innerHeight}\`; }).observe(document.body);
      </script>
    </body>
  `, 'text/html');
  await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.PREFIX },
  });

  const response = await client.callTool({
    name: 'browser_resize',
    arguments: {
      width: 390,
      height: 780,
    },
  });
  expect(response).toHaveResponse({
    code: `await page.setViewportSize({ width: 390, height: 780 });`,
  });
  await expect.poll(() => client.callTool({ name: 'browser_snapshot' })).toHaveResponse({
    inlineSnapshot: expect.stringContaining(`Window size: 390x780`),
  });
});

test('old locator error message', async ({ client, server }) => {
  server.setContent('/', `
    <button>Button 1</button>
    <button>Button 2</button>
    <script>
      document.querySelector('button').addEventListener('click', () => {
        document.querySelectorAll('button')[1].remove();
      });
    </script>
  `, 'text/html');

  expect(await client.callTool({
    name: 'browser_navigate',
    arguments: {
      url: server.PREFIX,
    },
  })).toHaveResponse({
    snapshot: expect.stringContaining(`
  - button "Button 1" [ref=e2]
  - button "Button 2" [ref=e3]`),
  });

  await client.callTool({
    name: 'browser_click',
    arguments: {
      element: 'Button 1',
      target: 'e2',
    },
  });

  expect(await client.callTool({
    name: 'browser_click',
    arguments: {
      element: 'Button 2',
      target: 'e3',
    },
  })).toHaveResponse({
    error: expect.stringContaining(`Ref e3 not found in the current page snapshot. Try capturing new snapshot.`),
    isError: true,
  });
});

test('visibility: hidden > visible should be shown', { annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright-mcp/issues/535' } }, async ({ client, server }) => {
  server.setContent('/', `
    <div style="visibility: hidden;">
      <div style="visibility: visible;">
        <button>Button</button>
      </div>
    </div>
  `, 'text/html');

  await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.PREFIX },
  });

  expect(await client.callTool({
    name: 'browser_snapshot'
  })).toHaveResponse({
    inlineSnapshot: expect.stringContaining(`- button "Button"`),
  });
});

test('snapshot depth', async ({ client, server }) => {
  server.setContent('/', `
    <ul>
      <li>text</li>
      <li>
        <button>Button</button>
      </li>
    </ul>
  `, 'text/html');

  await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.PREFIX },
  });

  expect(await client.callTool({
    name: 'browser_snapshot',
    arguments: {
      depth: 1,
    }
  })).toHaveResponse({
    inlineSnapshot: `- list [ref=e2]:
  - listitem [ref=e3]: text
  - listitem [ref=e4]`,
  });

  expect(await client.callTool({
    name: 'browser_snapshot',
    arguments: {
      depth: 2,
    }
  })).toHaveResponse({
    inlineSnapshot: `- list [ref=e2]:
  - listitem [ref=e3]: text
  - listitem [ref=e4]:
    - button "Button" [ref=e5]`,
  });
});

test('snapshot with boxes', async ({ client, server }) => {
  server.setContent('/', `
    <style>body { margin: 0; }</style>
    <button style="position:absolute;left:100px;top:50px;width:80px;height:40px;margin:0;padding:0;border:0;">click</button>
  `, 'text/html');

  await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.PREFIX },
  });

  expect(await client.callTool({
    name: 'browser_snapshot',
    arguments: { boxes: true },
  })).toHaveResponse({
    inlineSnapshot: expect.stringContaining(`- button "click" [ref=e1] [box=100,50,80,40]`),
  });

  expect(await client.callTool({
    name: 'browser_snapshot',
  })).toHaveResponse({
    inlineSnapshot: expect.not.stringMatching(/\[box=/),
  });
});

test('snapshot by ref', { annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright-cli/issues/347' } }, async ({ client, server }) => {
  server.setContent('/', `
    <ul>
      <li>text</li>
      <li>
        <button>Button</button>
      </li>
    </ul>
  `, 'text/html');

  await client.callTool({
    name: 'browser_navigate',
    arguments: { url: server.PREFIX },
  });

  expect(await client.callTool({
    name: 'browser_snapshot',
    arguments: {
      target: 'e2',
    }
  })).toHaveResponse({
    inlineSnapshot: `- list [ref=e2]:
  - listitem [ref=e3]: text
  - listitem [ref=e4]:
    - button "Button" [ref=e5]`,
  });

  expect(await client.callTool({
    name: 'browser_snapshot',
    arguments: {
      target: 'e999',
    }
  })).toHaveResponse({
    error: expect.stringContaining(`Ref e999 not found in the current page snapshot. Try capturing new snapshot.`),
    isError: true,
  });
});