はじめに
店舗の新規登録画面のE2Eテストで、登録のリクエストが飛ばずにタイムアウトしていたのを直したら、今度は登録後に移動する店舗のトップ画面が開かずに落ちるようになりました。
page.addInitScript で sessionStorage の値を消していたのが、画面を移動するたびに動いていたことが関係していました。同じところで詰まる人がいるかもしれないので、まとめてみました。
Playwright 1.64.1 で確かめています。
最初に落ちていたところ
ログイン済みの状態を作る前準備で、選択中の店舗IDも sessionStorage の shopId に入れていました。ほかのテストではこれで困らないのですが、新規登録画面は「まだ店舗を選んでいない」状態から始める必要があって、shopId が入っていると登録処理が途中で return してしまい、登録のリクエストが飛ばずにタイムアウトしていました。
アプリは最初の描画のときに sessionStorage を読むので、page.goto のあとに page.evaluate で消しても間に合いません。ページのスクリプトより先に動かせる addInitScript で消すことにしました。
test.beforeEach(async ({ page }) => {
await page.addInitScript(() => {
sessionStorage.removeItem('shopId')
})
await page.goto('/shops/new')
})
これで登録のリクエストは飛ぶようになったのですが、今度は登録が終わったあとの店舗のトップ画面が表示されずに落ちていました。
addInitScript が動くタイミング
登録が終わるとアプリが新しい店舗IDを shopId に入れて、location.href でトップ画面へ移動するのですが、その移動のときにも addInitScript が動いて、入れたばかりの shopId を消していました。トップ画面は店舗IDがないと何も読み込めないので、そこで止まっていたわけです。
小さなページを作って試してみると、goto のときだけでなく、リンクのクリックでもリロードでも動いていて、iframe の中でも1回ずつ動いていました。addInitScript の型定義のコメントにも「ページを移動するたび」と「子フレームが追加・移動されるたび」に動くと書いてあったので、名前から想像していた「最初に1回だけ動くもの」とはそもそも違っていました。
逆に、ページを読み込み直さない移動では動きませんでした。history.pushState で URL だけ変えたときは動かず、location.href に代入したときは動いていたので、Next.js の router.push のような移動だけなら、最初の修正のままでも落ちなかったはずです。今回はアプリが location.href でページごと読み込み直していたので、そこで引っかかっていました。
フラグで最初の1回だけ消す
sessionStorage は同じタブの中なら画面を移動しても残るので、消したかどうかの目印も sessionStorage に置いておけば、2回目以降は何もしないようにできます。
await page.addInitScript(() => {
if (!sessionStorage.getItem('__first_load_done__')) {
sessionStorage.removeItem('shopId')
sessionStorage.setItem('__first_load_done__', 'true')
}
})
Playwright はテストごとに新しいブラウザコンテキストを作るので、この目印が次のテストに持ち越されることはありません。試したところ、2回目以降の移動では shopId が消されずに残っていました。
実際の修正もこの形にしました。
dispose で止める
調べている途中で気づいたのですが、1.64.1 の addInitScript は Promise<Disposable> を返していて、dispose() を呼ぶとそれ以降は動かなくなりました。
const clearShopId = await page.addInitScript(() => {
sessionStorage.removeItem('shopId')
})
await page.goto('/shops/new')
await clearShopId.dispose()
こちらも dispose() のあとの移動では shopId が残っていました。最初の画面の分は goto の時点でもう動き終わっているので、そのあとで止めても最初の1回にはきちんと効いています。
振り返り
1回目の修正で「消したら登録のリクエストが飛ぶようになった」ところで安心してしまい、そのあと移動する画面のことまで考えていなかったので、もう一度直すことになりました。addInitScript を「テストの最初に1回だけ流す準備」のつもりで使っていたのがずれていて、実際は「ページが作られるたびに毎回差し込まれるもの」として考える必要がありました。
フラグと dispose のどちらがいいかは少し迷っていて、今から書くなら「最初の1回だけ」という意図がコードから読み取りやすい dispose のほうかなと思っています。ただ、goto から dispose までの間に画面を移動する処理を挟んでしまうと、そこでもまた消えてしまうので、beforeEach の中で goto の直後に置いておくのが無難そうでした。
addInitScript で値を消したり書き換えたりしているテストがあれば、その後に画面を移動していないかを一度見ておくと、同じところで止まらずに済むはずです。
