beforeunloadイベントがハンドルされていると Selenium の Navigate().Back() から帰ってこない

ページを離れる前の確認メッセージボックスの表示

Webページによっては、ブラウザの「戻る」ボタンや「更新」（リロード）ボタンを押すなどして、そのページを離れてほかのページに遷移する際に、ページを離れてよいか確認するメッセージボックスを表示することがある。フォームになにか入力しかかりのまま、うっかりそのフォームのページを離れてしまう操作ミスを防ぐのに役立つ動作だ。

この動作は、その Web ページに仕掛けられた JavaScript コードによって、もともとブラウザが備えている、ページ遷移前の警告メッセージの表示機能を発動させることで実現されている。

具体的には、ブラウザ上の JavaScript における window オブジェクトの beforeunload イベントを捕捉し、任意の文字列を返す（ここで返された文字列がページ遷移の確認メッセージボックス上に表示される）ことで実装する。

window.onbeforeunload = function (event) {

  event = event || window.event;

  return event.returnValue = "Sure?";

};

Selenium WebDriver で自動化テストを実装

さて、このような Web ページに対し、
「ブラウザの [戻る] をクリックしたら、ページを離れていいかどうかの確認メッセージが表示されること」
を点検する自動化テストを実装してみることにしよう。

Selenium WebDriver を利用して、IE や Chroe、Firefox などといった実際のブラウザを自動操縦することでテストを行う。
自動化テストコードの実装は C# だ。

大体、次のようなコードで、ブラウザの [戻る] ボタンクリックを再現することだろう。

var driver = new IEDriver();

driver.Navigate().GoToUrl("http://foo/firstPage");

driver.FindElement(By.Id("gotoNextPage")).Click();

driver.Navigate().Back();

driver.SwitchTo().Alert().Accept();

ところがこれが一筋縄ではいかない。

Back() から帰ってこない!

ブラウザの種類、ないしはブラウザ種別ごとのDriver の実装によって若干挙動が変わるのだが(※1)、まず、Navigate().Back() の呼び出して InvalidOperationException が発生するケースがあった。

まぁ、このケースについては、Navigate().Back() 呼び出しを try～catch ブロックで囲って、発生した InvalidOperationException を握りつぶしてしまうことで回避は可能ではある（気持ち悪いが）。

しかし別のブラウザでは、そもそも Navigate().Back() 呼び出しの中に飛び込んだまま、帰ってこない現象となった。

どうやら、ページ遷移の確認ダイアログが閉じるまでが、Navigate().Back() の処理に含まれているようなのだ。

これはさすがに手の打ちようがない。

かといって、いくらオープンソースとはいえ、各Driverの実装を修正するのは、自分の技量と時間的に簡単とは言えない。
また、改善要望として報告し、対応されるとも限らないのを待つのもつらい。
いずれにせよ報告はしておくべきなのだが、解決がいつになるかが問題なわけだ。

JavaScript コードの活用で解決!

ということで、Navigation().Back() の使用はあきらめ、ブラウザ上の JavaScript でブラウザの [戻る] 機能を実現することにした。

Selenium WebDriver は、任意の JavaScript コード文字列を自動操縦中のブラウザに送り込んで実行する機能が用意されている。
この機能を利用するのだ。

ブラウザ上の JavaScript では、"history.back()" というコードで、[戻る] の動作を実現可能だ。

そこで、下記コードで Navigation().Back() の代わりとした。

driver.ExecuteScript("setTimeout(function(){history.back();},0);");

これで解決に至った。

なお、JavaScript の history.back() 呼び出しが、確認メッセージの終了待ちで帰ってこないブラウザがある。
WebDriver の Navigate().Back() と同じ現象だ。
よって、setTimeout による遅延実行にしないとせっかくの意味がなくなってしまうので注意。

ブラウザの [更新] についても、Navigation().Reload() では同様の現象が発生する。
同じく "location.reload()" の JavaScript をブラウザ上で（setTimeoutで包んで）実行することで回避可能だ。

2013/08/19 追記
※1 ... IE では Naviadtion().Back() から返ってこない / Chrome では InvalidOperationException 発生 / Firefox では Navigation().Back() からすんなり帰ってくる。