CIでPlaywrightのテストが遅い?ワーカーとシャーディングで解決
最終更新 · 初回公開
Playwright のテストが遅い場合、原因は多くの場合 Playwright 自体ではありません。ワーカー数の設定が少なすぎる、すべてのテストで同じログインを繰り返している、実行のたびにブラウザをダウンロードしている、または長い直列ジョブが1つだけある、といったことが原因です。このガイドでは、実際の設定を使って Playwright のテストを高速化する方法を説明します。Playwright のテストシャーディングと、その Python 版についても扱います。このガイドは遅い E2E テストのガイドの一部です。
Playwright のテスト実行が遅くなる理由
まず計測してください。list と JSON のレポーターで実行し、所要時間で並べ替えます。
npx playwright test --reporter=list,json
CI ジョブの時間を、インストール、ブラウザのインストール、サーバーの起動、テストの実行に分けて確認してください。テストの実行時間が全体の半分未満であれば、テストより先にセットアップを修正してください。
ファイルとテストを並列に実行する
Playwright はデフォルトでテストファイルを並列に実行しますが、1つのファイル内のテストは順番に実行されます。すべてのテストを並列に実行するには fullyParallel を設定し、CI ではワーカー数を明示的に指定してください。
// playwright.config.ts
import { defineConfig } from "@playwright/test";
export default defineConfig({
fullyParallel: true,
workers: process.env.CI ? 4 : undefined,
retries: process.env.CI ? 1 : 0,
use: { trace: "on-first-retry" },
reporter: process.env.CI ? [["blob"], ["list"]] : "list",
});
デフォルトでは、Playwright は論理 CPU コア数のおよそ半分を使用します。2 vCPU のランナーでは、ワーカーが1つだけになります。小さいランナーで Playwright が遅く感じられるのはこのためです。ただし、ワーカー数をコア数より大幅に多く設定しないでください。ブラウザは負荷が重く、CPU が過負荷になるとフレーキーに見えるタイムアウトが発生します。
storageState で一度だけログインする
テストごとに UI からログインすることは、最もよくある無駄です。セットアッププロジェクトで一度だけログインし、保存した状態を再利用してください。
projects: [
{ name: "setup", testMatch: /auth\.setup\.ts/ },
{
name: "chromium",
use: { storageState: "playwright/.auth/user.json" },
dependencies: ["setup"],
},
],
テストデータは UI ではなく、API やデータベース経由で用意してください。ワーカーごとに一意のユーザーが必要な場合は、ワーカースコープのフィクスチャで作成してください。
時間による待機をやめる
page.waitForTimeout() を削除してください。代わりに、自動待機する Web ファーストのアサーションを使います。例: await expect(page.getByRole("button", { name: "Save" })).toBeEnabled()。UI が特定のリクエストに依存する場合は page.waitForResponse で、そのレスポンスを待機してください。ページの読み込み時間を減らすには、アナリティクスやフォントなど不要なものを page.route でブロックします。
アプリを一度だけ起動する
webServer オプションを使うと、Playwright は実行全体で一度だけアプリを起動します。CI では、オンデマンドでコンパイルする開発サーバーではなく、本番ビルドを実行してください。
webServer: {
command: "npm run start",
url: "http://localhost:3000",
reuseExistingServer: !process.env.CI,
},
Playwright のテストシャーディング
シャーディングはスイートを複数のジョブに分割します。Playwright には --shard=x/y として組み込まれています。後でレポートを結合できるように、blob レポーターを使用してください。
jobs:
e2e:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
shard: [1, 2, 3, 4]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with: { node-version: 22, cache: npm }
- run: npm ci
- run: npx playwright install --with-deps chromium
- run: npx playwright test --shard=${{ matrix.shard }}/4
- uses: actions/upload-artifact@v4
if: ${{ !cancelled() }}
with:
name: blob-report-${{ matrix.shard }}
path: blob-report
merge:
needs: e2e
if: ${{ !cancelled() }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with: { node-version: 22, cache: npm }
- run: npm ci
- uses: actions/download-artifact@v4
with: { path: all-blob-reports, pattern: blob-report-*, merge-multiple: true }
- run: npx playwright merge-reports --reporter html ./all-blob-reports
シャード数: 実行時間とコストについてはテストシャーディング計画ツールを使用し、分割のバランスについてはシャーディングガイドを参照してください。fullyParallel: true を指定すると、Playwright はテスト単位で分割のバランスを取るため、ファイル単位の分割よりもシャードの負荷が均等になります。
必要なブラウザだけをインストールする
npx playwright install --with-deps chromium を使うと、3 つではなく 1 つのブラウザだけをダウンロードします。Playwright の公式ドキュメントでは、大きなキャッシュの復元にはダウンロードとほぼ同じ時間がかかるため、ブラウザのダウンロードをキャッシュしても効果が小さいことがあると説明されています。キャッシュを追加する前に計測してください。または、公式の Playwright コンテナイメージで実行すると、ブラウザとシステム依存関係が最初から揃っています。
Python で Playwright を高速化する
Python パッケージは pytest を使用します。pytest-xdist で並列実行し、セッションスコープのフィクスチャで認証済みの状態を再利用してください。
pip install pytest-playwright pytest-xdist
pytest -n 4 --browser chromium
各 xdist ワーカーは独立したプロセスで、それぞれ独自のブラウザを持つため、データはワーカーごとに分離する必要があります。Python のテストを複数のジョブに分割するには、pytest の遅いテストで紹介している方法を使ってください。ログイン状態は、context.storage_state(path="state.json") で一度保存し、storage_state を browser.new_context に渡すことで再利用できます。
ブラウザにより多くの CPU を割り当てる
ワーカーが 2 コアの上で待ち行列に入っている場合、次に効果が大きいのはハードウェアです。高速な GitHub Actions ランナーを参照してください。compiler.dev を試す場合、その比較モードではご自身のジョブを実行できます。ブラウザテストの高速化の効果はスイートによって異なるため、これは重要です。18 種類の計測済みスタックで、GitHub の 2 コアランナーと比べて中央値で 1.5 倍高速でした(15 件が高速、2 件が同等、1 件が低速)。
関連記事
モノレポでは、アプリを一度だけビルドし、シャード間で共有してください: モノレポで Playwright を高速化する。不安定な E2E テストでは、リトライと遅いスイートが一緒に発生する理由を説明しています。両方のツールを使っている場合は、姉妹ガイドの 遅い Cypress テスト を参照してください。パイプラインのその他の部分については、遅い CI のハブで扱っています。
よくある質問
Playwright のテストを高速化するには?
fullyParallel を使い、ワーカー数をコア数に合わせ、storageState で一度だけログインし、固定の待機を削除し、アプリを一度だけ起動し、--shard で複数のジョブに分割してください。
CI で Playwright はいくつのワーカーを使うべきですか?
軽いアプリではコアごとに 1 つを目安にし、重いアプリではそれより少なくしてください。1、2、4 ワーカーで、合計時間と失敗率を計測してください。
Playwright のシャーディングはどのように動作しますか?
--shard=2/4 は、スイートを 4 つに分けた 2 番目のスライスを実行します。各スライスを個別のジョブで実行し、後で blob レポートを結合してください。
CI では Playwright のテストがローカルより遅いのはなぜですか?
CI マシンはコア数が少なく、キャッシュがコールドで、ブラウザも新規インストールされています。ワーカー数とセットアップ時間を、ローカルでの実行と比較してください。
関連記事
- GitHub ActionsでモノレポのPlaywrightを高速化するGitHub Actions で Node モノレポの Playwright E2E テストを高速化: アプリを一度だけビルドし、Web アプリに変更がないときは E2E をスキップし、シャーディングとレポートのマージを行います。
- CIでDockerビルドが遅い?原因を特定して解決CIでDockerビルドが遅いですか?ビルドコンテキストのサイズ、.dockerignore、レイヤーの順序、キャッシュミス、BuildKitの設定を診断し、最も影響の大きい問題から修正しましょう。
- Cypressのテストが遅い?Cypressを高速化する方法CIでCypressのテストが遅いですか?cy.session、インターセプト、固定待機の廃止でCypressを高速化する方法と、GitHub ActionsでのCypress並列テストを解説します。
- 不安定なE2Eテスト: 原因と持続する修正方法不安定なe2eテストと不安定なエンドツーエンドテスト: 不適切な待機、テストの独立性、共有データベースの状態を修正し、バグを隠さずに再試行と隔離を使ってください。