Playwrightで、alertやconfirmのダイアログを扱う方法

​​Playwright​E2Eテスト,TypeScript

Playwright のテストで alert や confirm のダイアログを扱うには、ダイアログを出す操作の前に page.on('dialog') でリスナーを登録し、その中で accept() か dismiss() を呼びます。削除ボタンを押したときの「本当に削除しますか?」の確認や、保存したときの「保存しました」のお知らせを、テストの中で OK にしたりキャンセルにしたりできます。

リスナーを登録しないと、Playwright はダイアログを自動で閉じます。このとき confirm はキャンセル扱いになるので、削除ボタンを押すテストで、メモがなぜか削除されないことが起きます。反対に、リスナーを登録したのに閉じ忘れると、クリックが終わらずにテストが時間切れになります。この2つの動きを、検証環境で実際に確かめました。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4、@playwright/test 1.63.0、TypeScript 5.9.3 です。ブラウザは Playwright 用の Chromium だけで、ヘッドレスで動かしました。Firefox・WebKit、画面を表示するモード(headed)で人がダイアログを操作する場合、window.print() の印刷ダイアログは試していません。

試したページ

Node.js の http モジュールで小さなサーバーを書き、次のボタンを置いたページを配信しました。押した結果は role="status" の段落に出します。

js
const status = document.getElementById('status');
document.getElementById('alert').onclick = () => {
  alert('保存しました');
  status.textContent = 'alert を閉じました';
};
document.getElementById('confirm').onclick = () => {
  const ok = confirm('メモ「' + document.getElementById('name').textContent + '」を削除しますか?');
  status.textContent = ok ? '削除しました' : '削除をやめました';
};
document.getElementById('prompt').onclick = () => {
  const name = document.getElementById('name');
  const value = prompt('新しい名前', name.textContent);
  if (value === null) { status.textContent = '名前の変更をやめました'; return; }
  name.textContent = value;
  status.textContent = '名前を「' + value + '」にしました';
};

「保存」は alert、「削除」は confirm、「名前を変える」は今の名前(買い物)を初期値にした prompt を出します。このほかに「本文」の入力欄があり、書き換えると beforeunload でページを離れる前の確認を出すようにしました。playwright.config.ts では、テスト1件の制限時間を 5 秒にしています。

何もしないと、ダイアログは閉じられる

まず、リスナーを登録せずに3つのボタンを押しました。

ts
import { test, expect } from '@playwright/test';

test('何もしないと、ダイアログは閉じられる', async ({ page }) => {
  await page.goto('/');
  const status = page.getByRole('status');

  await page.getByRole('button', { name: '保存' }).click();
  await expect(status).toHaveText('alert を閉じました');

  await page.getByRole('button', { name: '削除' }).click();
  await expect(status).toHaveText('削除をやめました');

  await page.getByRole('button', { name: '名前を変える' }).click();
  await expect(status).toHaveText('名前の変更をやめました');
});

このテストは通りました。クリックは止まらずに進み、confirm は false、prompt は null を返しています。MDN の confirm() の説明とprompt() の説明によると、どちらも、人がキャンセルを押したときに返る値です。

公式ドキュメントのダイアログの説明にも、ダイアログは Playwright が自動で閉じる(dismiss する)と書かれています。alert を出すだけのボタンなら、テストで何も書かなくても困りません。困るのは、confirm で OK を押した先の動きを確かめたいときです。

confirm で OK を押す

OK を押したことにするには、ボタンを押す前に page.once('dialog') でリスナーを登録し、dialog.accept() を呼びます。once で登録したリスナーは、1回呼ばれたあとで外れます。

ts
test('confirm で OK を押す', async ({ page }) => {
  await page.goto('/');
  page.once('dialog', async (dialog) => {
    console.log('type:', dialog.type(), '/ message:', dialog.message());
    await dialog.accept();
  });
  await page.getByRole('button', { name: '削除' }).click();
  await expect(page.getByRole('status')).toHaveText('削除しました');
});
text
type: confirm / message: メモ「買い物」を削除しますか?

テストは通り、画面に「削除しました」と出ました。Dialog の API リファレンスのとおり、type() はダイアログの種類(alert、confirm、prompt、beforeunload のどれか)を、message() はダイアログに出た文言を返します。キャンセルを押したことにするなら、accept() の代わりに dialog.dismiss() を呼びます。こちらも、画面に「削除をやめました」と出てテストが通りました。

prompt に文字を入れる

prompt には、accept() の引数で入れる文字を渡します。defaultValue() で、ページが用意した初期値も読めます。

ts
test('prompt に文字を入れる', async ({ page }) => {
  await page.goto('/');
  page.once('dialog', async (dialog) => {
    console.log('type:', dialog.type(), '/ message:', dialog.message(), '/ defaultValue:', dialog.defaultValue());
    await dialog.accept('夕飯の材料');
  });
  await page.getByRole('button', { name: '名前を変える' }).click();
  await expect(page.getByRole('status')).toHaveText('名前を「夕飯の材料」にしました');
});
text
type: prompt / message: 新しい名前 / defaultValue: 買い物
メモの名前が「夕飯の材料」に変わり、その下に「名前を「夕飯の材料」にしました」と出ている画面
prompt に「夕飯の材料」を渡したあとの画面

気をつけたいのは、引数なしで dialog.accept() を呼んだときです。初期値(買い物)のまま OK を押したことにはならず、空の文字が返りました。

text
名前を「」にしました

初期値のまま OK を押したことにしたいなら、初期値を自分で渡します。

ts
page.once('dialog', (dialog) => dialog.accept(dialog.defaultValue()));
text
名前を「買い物」にしました

出たダイアログの文言を確かめる

ダイアログの文言そのものをテストしたいときは、page.on('dialog') の中で文言を配列にためておき、操作のあとで expect で比べます。on で登録したリスナーは、page.removeListener() で外すまで残ります。

ts
test('alert の文言を確かめる', async ({ page }) => {
  await page.goto('/');
  const messages: string[] = [];
  page.on('dialog', async (dialog) => {
    messages.push(`${dialog.type()}: ${dialog.message()}`);
    await dialog.accept();
  });
  await page.getByRole('button', { name: '保存' }).click();
  await page.getByRole('button', { name: '削除' }).click();
  expect(messages).toEqual(['alert: 保存しました', 'confirm: メモ「買い物」を削除しますか?']);
  await expect(page.getByRole('status')).toHaveText('削除しました');
});

このテストは通りました。alert も confirm も、同じリスナーで受け取れます。

リスナーで閉じ忘れると、クリックが終わらない

リスナーの中で accept() も dismiss() も呼ばないと、Playwright はダイアログを閉じません。次のテストは、文言を表示するだけのリスナーを登録しています。

ts
test('リスナーで accept も dismiss も呼ばない', async ({ page }) => {
  await page.goto('/');
  page.on('dialog', (dialog) => console.log('message:', dialog.message()));
  await page.getByRole('button', { name: '削除' }).click();
  await expect(page.getByRole('status')).toHaveText('削除しました');
});

文言は表示されましたが、クリックが終わらず、テストは時間切れで失敗しました(出力の一部を省略しています)。

text
message: メモ「買い物」を削除しますか?
  ✘  1 tests/forget.spec.ts:3:5 › リスナーで accept も dismiss も呼ばない (10.0s)
    Test timeout of 5000ms exceeded.
    Tearing down "context" exceeded the test timeout of 5000ms.
    Error: locator.click: Test timeout of 5000ms exceeded.
    Call log:
      ...
        - performing click action

呼び出しの記録は「performing click action」で止まっていて、ダイアログのことは何も出ません。テストの後片付け(context を閉じる処理)も時間切れになり、制限時間 5 秒のテストが 10.0 秒かかりました。

page.on('dialog') の API リファレンスには、リスナーは必ず accept() か dismiss() を呼ぶこと、呼ばないとページがダイアログを待ったまま固まり、クリックなどの操作が終わらないことが書かれています。クリックが「performing click action」のまま時間切れになったら、dialog のリスナーで閉じ忘れていないかを見直します。

waitForEvent で受け取るときは、クリックを先に await しない

page.waitForEvent('dialog') でもダイアログを受け取れます。ただし、クリックを await してからダイアログを待つと、上と同じ形で止まりました。

ts
test('waitForEvent の前に click を await する', async ({ page }) => {
  await page.goto('/');
  const dialogPromise = page.waitForEvent('dialog');
  await page.getByRole('button', { name: '削除' }).click(); // ここで止まった
  const dialog = await dialogPromise;
  await dialog.accept();
});

waitForEvent もリスナーなので、ダイアログは自動では閉じられません。クリックはダイアログが閉じるまで終わらず、ダイアログを閉じる accept() はクリックが終わるまで実行されないので、お互いを待ち続けます。

クリックを await せずに Promise のまま持っておき、ダイアログを閉じてから await すると、テストは通りました。

ts
test('waitForEvent でダイアログを受け取る', async ({ page }) => {
  await page.goto('/');
  const dialogPromise = page.waitForEvent('dialog');
  const clickPromise = page.getByRole('button', { name: '削除' }).click();
  const dialog = await dialogPromise;
  console.log('message:', dialog.message());
  await dialog.accept();
  await clickPromise;
  await expect(page.getByRole('status')).toHaveText('削除しました');
});

ダイアログを受け取ったあとで、文言に応じて OK かキャンセルかを決めたいときは、この形が使えます。決まっているなら、page.once('dialog') で先に登録しておくほうが短く書けます。

ページを離れる前の確認(beforeunload)

入力したまま保存していないときに出す「このサイトを離れますか?」の確認は、beforeunload の種類のダイアログとして届きます。ページを閉じるときに確認を出させるには、公式ドキュメントのとおり、page.close({ runBeforeUnload: true }) を使います。

ts
test('beforeunload の確認を受け取る', async ({ page }) => {
  await page.goto('/');
  await page.getByLabel('本文').fill('牛乳');
  const dialogPromise = page.waitForEvent('dialog');
  await page.close({ runBeforeUnload: true });
  const dialog = await dialogPromise;
  console.log('type:', dialog.type(), '/ message:', JSON.stringify(dialog.message()));
  await dialog.accept();
  await page.waitForEvent('close');
  console.log('isClosed:', page.isClosed());
});
text
type: beforeunload / message: ""
isClosed: true

type() は beforeunload で、message() は空の文字でした。accept() を呼ぶとページが閉じ、dismiss() を呼ぶとページは閉じずに、入力欄に「牛乳」が残っていました(isClosed: false)。runBeforeUnload を付けずに page.close() を呼んだときは、ダイアログは1回も出ずにページが閉じました。

page.goto() でほかの URL に移るときも、dialog のリスナーを登録していれば beforeunload のダイアログが届きました。一方、リスナーを登録せずに page.goto() を呼ぶと、ダイアログに止められずにそのまま移りました。

text
url: http://localhost:4173/?next

公式ドキュメントには、リスナーがないとダイアログは自動で dismiss されると書かれています。しかし beforeunload では、OK を押したのと同じ扱いになってページが移りました。Playwright 1.63.0 の本体のコードを見ると、リスナーがないときにダイアログを閉じる処理は、beforeunload のときだけ accept、それ以外は dismiss になっていました。

js
async _close() {
  if (this._type === "beforeunload")
    await this._accept();
  else
    await this._dismiss();
}

閉じたあとで知らせる dialogclosed イベント

Playwright 1.63 で、ダイアログが閉じたときに届く dialogclosed イベントが加わりました(Page の API リファレンスにある dialogclosed イベントの説明)。dialogclosed のリスナーでは、ダイアログを閉じる必要はありません。

ts
test('dialogclosed だけを聞く', async ({ page }) => {
  await page.goto('/');
  const closed: string[] = [];
  page.on('dialogclosed', (dialog) => closed.push(`${dialog.type()}: ${dialog.message()}`));
  await page.getByRole('button', { name: '削除' }).click();
  await expect(page.getByRole('status')).toHaveText('削除をやめました');
  console.log(closed);
});
text
[ 'confirm: メモ「買い物」を削除しますか?' ]

dialogclosed だけを登録したときは、ダイアログは自動で閉じられ(confirm はキャンセル扱い)、そのあとで文言を受け取れました。ダイアログの動きは変えずに、どんなダイアログが出たかだけを記録したいときに使えます。

​Posted by 86