Playwrightで、新しいタブで開くリンクをテストする方法
Playwright では、クリックの前に page.waitForEvent('popup') で待ち始めておくと、新しく開いたタブを Page として受け取り、元のページと同じようにテストできます。ヘルプや利用規約、外部サイトへのリンクを target="_blank" で開くページや、領収書を window.open で別ウィンドウに出す画面のテストに使います。
私は検証環境で、新しいタブを開くリンクとボタンを並べたページを作り、待ち始める位置や、外部サイトの差し替え方、開いたウィンドウを閉じるボタンの押し方を変えて、何回通るかを数えました。
検証環境は Ubuntu 24.04、Node.js 22.23.4、@playwright/test 1.63.0 です。ブラウザは Playwright 用の Chromium だけで、ページは Node.js の http モジュールで書いた小さなサーバーから配信しました。Firefox・WebKit、Windows・macOS、CI サービス上での実行は試していません。
試したページ
注文の詳細のページに、新しいタブで開くリンクを2つと、別ウィンドウを開くボタンを1つ置きました。比べるために、同じタブで開くリンクも置いています。
<p><a href="/help" target="_blank" rel="noopener noreferrer">ヘルプを見る</a></p>
<p><a href="https://docs.example.com/guide" target="_blank" rel="noopener">外部の説明書</a></p>
<p><button id="receipt">領収書を表示</button></p>
<p><a href="/help">同じタブでヘルプを見る</a></p>
<script>
document.getElementById('receipt').addEventListener('click', () => {
window.open('/receipt?order=42', 'receipt', 'width=480,height=600');
});
</script>
開いた先の領収書のページは、window.opener があるかどうかを「あり」「なし」で画面に表示します。window.close() を呼ぶ「閉じる」ボタンもあります。playwright.config.ts では、webServer でこのサーバーを起動し、baseURL を http://localhost:4173 にしています。
popup イベントで新しいタブを受け取る
基本の形は、公式ドキュメントの、ポップアップを扱う節にあるとおりです。クリックの前に waitForEvent('popup') の Promise を受け取っておき、クリックのあとで await します。
import { test, expect } from '@playwright/test';
test('target="_blank" のリンクで開いたタブ', async ({ page }) => {
await page.goto('/');
const popupPromise = page.waitForEvent('popup');
await page.getByRole('link', { name: 'ヘルプを見る', exact: true }).click();
const popup = await popupPromise;
console.log('event 直後の url()', popup.url());
await expect(popup).toHaveURL('/help');
await expect(popup).toHaveTitle('ヘルプ');
await expect(popup.getByRole('heading', { level: 1 })).toHaveText('ヘルプ');
console.log('タブの数', page.context().pages().length);
});
リンクの名前には exact: true を付けています。付けないと「同じタブでヘルプを見る」にも当てはまり、strict mode の違反で落ちました。
受け取った popup は、ふつうの Page と同じように getByRole() や expect() が使えます。toHaveURL() に渡した /help は、toHaveURL() の API リファレンスにあるとおり、baseURL と合わせて比べられます。実行すると、イベントを受け取った直後の url() は、もう開いた先の URL でした。
event 直後の url() http://localhost:4173/help
タブの数 2
✓ 1 [chromium] › tests/popup.spec.ts:3:1 › target="_blank" のリンクで開いたタブ (217ms)
popup イベントの API リファレンスによると、このイベントは、新しいタブが最初の URL への移動を済ませ、レスポンスの読み込みが始まった時点で出ます。そのため url() は about:blank ではありませんでした。ただし、読み込みが終わったとは限らないので、中身は、条件を満たすまで自動で待つ expect() で確かめます。
window.open の別ウィンドウも同じ書き方
ボタンから window.open で開くウィンドウも、同じ popup イベントで受け取れました。
test('window.open で開いたウィンドウ', async ({ page }) => {
await page.goto('/');
const popupPromise = page.waitForEvent('popup');
await page.getByRole('button', { name: '領収書を表示' }).click();
const popup = await popupPromise;
await expect(popup).toHaveURL(/\/receipt\?order=42$/);
await expect(popup.getByRole('heading')).toHaveText('領収書(注文番号 42)');
console.log('viewport', popup.viewportSize());
});
viewport { width: 480, height: 600 }
✓ 2 [chromium] › tests/popup.spec.ts:16:1 › window.open で開いたウィンドウ (154ms)
viewportSize() は、window.open の3つ目の引数で指定した width=480,height=600 になっていました。
context の page イベントでも受け取れる
page.waitForEvent('popup') の代わりに、ブラウザのコンテキストで context.waitForEvent('page') を待っても、同じタブを受け取れました。page イベントの API リファレンスによると、こちらはコンテキストの中で新しいページができたときに出て、ポップアップでも出ます。popup イベントのほうは、そのページから開いたものに限られます。
test('context の page イベントでも受け取れる', async ({ page, context }) => {
await page.goto('/');
const pagePromise = context.waitForEvent('page');
await page.getByRole('link', { name: 'ヘルプを見る', exact: true }).click();
const newPage = await pagePromise;
await expect(newPage).toHaveTitle('ヘルプ');
});
待ち始めるのはクリックより前
順番を逆にして、クリックしてから waitForEvent('popup') を呼ぶとどうなるかを試しました。待つ時間の上限は3秒にして、リンクとボタンのそれぞれを --repeat-each=20 --workers=1 で20回ずつ実行しています。
// 間違った順番:クリックのあとで待ち始める
await page.getByRole('button', { name: '領収書を表示' }).click();
const popup = await page.waitForEvent('popup', { timeout: 3000 });
| 開き方 | クリックの前に待つ | クリックのあとで待つ |
|---|---|---|
target="_blank" のリンク |
20回とも通った | 20回とも通った |
window.open のボタン |
20回とも通った | 9回通り、11回落ちた |
落ちた11回は、どれも TimeoutError: page.waitForEvent: Timeout 3000ms exceeded while waiting for event "popup" でした。別のテストで、クリックのあと1秒おいてからタブの数を出すと、領収書のタブはもう開いていて、タブの数は2でした。それでも、そのあとで待ち始めた waitForEvent('popup') は3秒待って同じエラーで落ちます。開いたあとで待ち始めても、そのタブのイベントは受け取れません。
注意したいのは、リンクのほうでは逆の順番でも20回とも通ったことです。リンクで何度か通ったからといって、書き方が正しいとは限りません。同じ書き方のまま window.open のボタンで試すと、20回のうち11回落ちました。公式ドキュメントの例にも、クリックの前に待ち始めるようにとコメントがあります。
同じタブで開くリンクで waitForEvent('popup') を待つと、同じ TimeoutError で落ちました。target="_blank" が外れて同じタブで開くようになったことも、このテストで見つけられます。
opener() では noopener かどうかは分からない
rel="noopener" が効いているかを、popup.opener() で確かめようとすると、うまくいきません。noopener の付いたリンクと window.open のボタンで、opener() の値と、開いた先のページの window.opener を並べて出しました。
const p1 = page.waitForEvent('popup');
await page.getByRole('link', { name: 'ヘルプを見る', exact: true }).click();
const help = await p1;
console.log('noopener のリンク: opener() === page', (await help.opener()) === page,
'/ window.opener', await help.evaluate(() => window.opener === null ? 'null' : 'あり'));
const p2 = page.waitForEvent('popup');
await page.getByRole('button', { name: '領収書を表示' }).click();
const receipt = await p2;
console.log('window.open: opener() === page', (await receipt.opener()) === page,
'/ 画面の表示', await receipt.locator('#opener span').textContent());
noopener のリンク: opener() === page true / window.opener null
window.open: opener() === page true / 画面の表示 あり
opener() の API リファレンスにあるとおり、opener() はポップアップを開いた元のページを返します。noopener のリンクでも、元の page が返りました。一方、noopener のリンクで開いたページの中では window.opener が null です。window.open で開いた領収書のページでは、画面の表示が「あり」でした。開いた先から元のページを操作できないことを確かめたいなら、popup.evaluate() で window.opener を見ます。
外部サイトへのリンクは context.route で差し替える
外部の説明書のリンクを、テストのたびに本物のサイトへつながないように、テスト用の HTML に差し替えてみました。page.route() と context.route() の両方で、差し替えの関数が呼ばれた回数を数えています。
import { test, expect, type Route } from '@playwright/test';
const fake = (route: Route) =>
route.fulfill({
contentType: 'text/html; charset=utf-8',
body: '<title>説明書</title><h1>外部の説明書(テスト用の偽物)</h1>',
});
test('context.route で外部のページを差し替える', async ({ page, context }) => {
let calls = 0;
await context.route('https://docs.example.com/**', (route) => { calls++; return fake(route); });
await page.goto('/');
const popupPromise = page.waitForEvent('popup');
await page.getByRole('link', { name: '外部の説明書' }).click();
const popup = await popupPromise;
await expect(popup).toHaveURL('https://docs.example.com/guide');
await expect(popup.getByRole('heading')).toHaveText('外部の説明書(テスト用の偽物)');
console.log('context.route: 呼ばれた回数', calls);
});
page.route: 呼ばれた回数 0 / url chrome-error://chromewebdata/ / title ""
context.route: 呼ばれた回数 1
page.route() で登録した差し替えは、元のページにしか効きません。新しいタブの読み込みでは一度も呼ばれず、タブは Chromium のエラーページ(chrome-error://chromewebdata/)になりました。context.route() で登録すると、新しいタブの読み込みも差し替わりました。popup イベントの API リファレンスにも、ポップアップの最初の読み込みを差し替えたいときは context.route() を使うようにと書かれています。
タブを開かずに、リンクの属性だけを確かめる方法もあります。開いた先の中身まで見る必要がなければ、こちらのほうが短く書けます。
const link = page.getByRole('link', { name: '外部の説明書' });
await expect(link).toHaveAttribute('href', 'https://docs.example.com/guide');
await expect(link).toHaveAttribute('target', '_blank');
await expect(link).toHaveAttribute('rel', /\bnoopener\b/);
window.close() で閉じるボタンのテストがときどき落ちる
領収書のウィンドウの「閉じる」ボタンを押して、ウィンドウが閉じたことを確かめるテストを書きました。閉じたことは、popup.waitForEvent('close') と isClosed() で分かります。
const closePromise = popup.waitForEvent('close');
await popup.getByRole('button', { name: '閉じる' }).click();
await closePromise;
expect(popup.isClosed()).toBe(true);
このテストは、1回だけ実行すると通ります。ところが100回くり返すと、3回は click() が次のエラーで落ちました。
Error: locator.click: Target page, context or browser has been closed
エラーの記録では、クリックの操作を始めたところまでは進んでいて、その途中でページが閉じたことで click() が失敗していました。押し方を4通りにして、それぞれ100回ずつ実行しました。

click() の noWaitAfter は、クリックで始まった画面の移動を待たないための設定ですが、付けても100回のうち4回落ちました。100回とも通ったのは、dispatchEvent('click') と、次の書き方です。
await popup.getByRole('button', { name: '閉じる' }).click().catch((e) => {
if (!popup.isClosed()) throw e;
});
ウィンドウが閉じたあとのエラーだけを無視し、閉じていないのに落ちたときは、そのままテストを落とします。dispatchEvent() の API リファレンスによると、dispatchEvent('click') は要素が見えているかどうかに関係なく click イベントを送ります。ボタンが隠れていても通ってしまうので、利用者と同じように押せるかまで確かめたいときは、click() に catch を付けた書き方を選びます。





