Playwright のインストール待ちをやめたくて、CI の検査を全部同じイメージに載せた話
GitHub Actions の E2E で、Playwright のブラウザのインストールが不定期に 20 分以上止まっていた。Playwright の公式イメージではなく、Node のイメージをもとにした自前のイメージを GitHub Container Registry (GHCR) に置き、E2E だけでなく lint・テスト・ビルドの検査も同じイメージの上で動かすことにした。決め手は「速くする」より「全部同じにする」だった。
はじめに
個人で開発しているモノレポでは、プルリクエストを出すたびに GitHub Actions で検査が走る。lint、ユニットテスト、ビルド、そして Playwright の E2E だ。
この E2E が、不定期に 20 分以上止まっていた。止まっていたのはテストではなく、テストを始める前の Playwright のブラウザのインストールだった。
本記事は、それをやめるために CI 用のコンテナイメージを自前で作った話だ。最初は E2E を速くするためのつもりだったが、振り返ると決め手は別のところにあった。
「あーいつものか」
E2E のジョブは、毎回素の Ubuntu のランナーの上で、その場で環境を組み立てていた。Node を入れ、npm ci をして、npx playwright install --with-deps webkit でブラウザとその依存パッケージを入れる。
ほとんどの回は 1 分もかからずに終わる。ところが、ときどきこのインストールが進まなくなる。止まるのは OS の依存パッケージを apt で入れるところで、webkit だと 20 分を超えても進まないことがあった。
気づくのはいつも同じ流れだった。CI がいつまでも終わらない。開いてみると、Playwright のインストールで止まっている。テストは始まってすらいない。「あーいつものか」と思いながら止めて、再実行する。
過去にも何度もあったし、外から取ってくる以上は仕方ないのだろうと、ずっと目を瞑っていた。
イメージを指定するやり方を思い出す
いつものように待たされていたある日、GitHub Actions でジョブを動かすコンテナイメージを指定するやり方を、別の場所で見たことがあるのを思い出した。ジョブに container: を書くと、ジョブ全体がそのイメージの中で動く。
ブラウザと依存パッケージを前もってイメージに入れておけば、ジョブのたびに外へ取りに行かなくて済む。もしかしたら、これで解消できるのでは、と思った。
Playwright の公式イメージにしなかった理由
真っ先に候補に挙がるのは、Playwright の公式イメージ (mcr.microsoft.com/playwright) だ。ブラウザも依存パッケージも入っていて、そのまま使える。
それでも、これは選ばなかった。公式イメージを CI の土台にすると、Node の版が Playwright のイメージに左右されることになる。
このモノレポで動いているものは、基本的にすべて Node が軸だ。Playwright はその上で使う道具の 1 つにすぎない。道具の側が土台を決め、Node がそれに引きずられる形は、本質と違う気がした。
そこで、Node の公式イメージ (node:26-slim) をもとに、自前のイメージを作ることにした。
- 土台 (
base): Node と、CI で使う最低限の道具 (git、AWS CLI など) chromium: 土台の上に、Playwright の chromium と依存パッケージwebkit: 土台の上に、Playwright の webkit と依存パッケージ
Playwright の版は、package.json の @playwright/test と揃えておく。ずれると、テストがブラウザを見つけられずに落ちる。E2E のジョブでは、テストの前に版が揃っているかを確かめるステップを置いた。
キャッシュは考えなかった
ブラウザをキャッシュする案もありうるが、ほとんど考えなかった。
止まっていたのは、外から取ってくる処理そのものだ。キャッシュは、外れたときにその処理へ戻る。重い日にちょうど外れたら、結局同じことになる。外から取ってくる構造が残る限り、運任せのままだと思った。
イメージなら、取ってくるのはイメージを作るときの 1 回だけだ。ジョブはできあがったものを pull して使う。
レジストリは ECR だと思っていた
イメージの置き場は、最初は Amazon ECR だと思い込んでいた。サービスのイメージは ECR に置いているので、CI のものもそこだろうと。
調べてみると、GitHub には GitHub Container Registry (GHCR) があり、リポジトリに紐づけてイメージを置ける。パッケージを公開にしておけば、ジョブの container: にイメージの名前を書くだけで pull できる。AWS の認証を挟まなくてよい。
CI の実行環境をコンテナで固めるのは、GitHub が公式に支えている使い方なのだと、ここで初めて知った。
イメージのタグには版の番号を付け、同じタグを上書きしないことにした。中身を変えたら番号を上げ、ワークフロー側の参照を替える。どの版の環境で検査が通ったのかを、後から追えるようにするためだ。
決め手は「全部同じにする」
ここまでは E2E の話だった。ただ、Node を軸にイメージを作ると決めた時点で、もう 1 つ気になることが出てきた。
E2E だけがこのイメージで動き、lint やユニットテスト、ビルドの検査は素のランナーの上で毎回 Node を入れて動く。これは Playwright だけを特別扱いしていることになる。軸は Node だと言いながら、E2E のためのイメージになってしまう。
それなら、Node を使う検査のジョブは全部同じイメージの上で動かせばいい。lint もテストもビルドも E2E も、同じ OS、同じ Node の上で動く。ジョブごとに環境を組み立てる手順は消え、どのジョブも同じ実行環境から始まる。
全部を同じにしておくと、この先にも効く。新しい道具を CI に足したくなったら、イメージに足せばいい。検査のワークフローが増えても、同じイメージを指定するだけで同じ環境に乗る。ジョブごとにセットアップの手順を書き足していく必要はない。
振り返ると、この記事の本題はここだったと思う。始めたきっかけは E2E の待ち時間だった。しかし決め手になったのは、速くすることより、検査の実行環境を 1 つにまとめたことのほうだった。
結果
移行の前後で、E2E のジョブの数字を拾った。移行前はおよそ 7.5 日分 (525 ジョブ)、移行後はおよそ 1 日分 (134 ジョブ) で、移行後のサンプルはまだ少ない。
比べたのは、移行前の Playwright のインストールにかかった時間と、移行後のイメージの pull (Actions の「Initialize containers」) にかかった時間だ。単位は分。
| 中央値 | 最大 | |
|---|---|---|
| 移行前 chromium (インストール) | 0.4 | 11.0 |
| 移行前 webkit (インストール) | 0.7 | 40.7 |
| 移行後 chromium (イメージの pull) | 0.3 | 1.4 |
| 移行後 webkit (イメージの pull) | 0.3 | 0.5 |
中央値はほとんど変わらない。普段の回は、もともと 1 分もかからずに終わっていたからだ。
差が出たのは、止まった回のほうだ。移行前は、インストールが 5 分を超えたジョブが chromium で 396 本中 28 本、webkit で 124 本中 9 本あった。webkit の 9 本のうち 8 本は 10 分を超えている。いちばんひどかった回は、10 分で止めて再実行し、18 分でまた止めて、3 回目で 40.7 分かけてようやく終わった。
移行後は、イメージの pull が 1.4 分を超えたジョブは 1 本もない。
体感でも、ひどく遅い run を見かけなくなった。
おわりに
外から取ってくるものが CI を止めるなら、取ってくるのを CI の外に出せばいい。やったこと自体はそれだけだ。
ただ、土台を何にするかを考えたとき、話は E2E だけでは済まなくなった。道具に合わせて土台を選ぶと、土台が道具に引きずられる。土台に合わせて道具を載せる形にすると、その土台を全部のジョブで共有できる。
CI の 1 つのジョブが遅くて困ったら、そのジョブだけを速くする前に、ほかのジョブも同じ環境に揃えられないかを考えてみるといい。