Cypressのテストが遅い?Cypressを高速化する方法
最終更新
Cypressのテストが遅い場合は、プログラムからログインする、固定の待機を削除する、ビルド済みのアプリを実行する、スペックを並列ジョブに分割する、といった方法で高速化できることがほとんどです。このガイドでは各対策を解説し、Cypress Cloudを使う場合と使わない場合のGitHub ActionsでのCypressの並列テストも紹介します。遅いe2eテストのガイドの一部です。
Cypressが遅い理由
Cypressは、プロセスごとに1つのブラウザで一度に1つのスペックを実行し、スペックファイルのテストごとにアプリを再読み込みします。beforeEachでの長いログインや準備処理と、固定のcy.wait(ms)の呼び出しが重なると、遅さが積み重なります。変更を加える前に、最も遅いスペックを記録してください。Cypressの実行サマリーにはスペックごとの所要時間が表示されるので、それで並べ替えます。
対策1: UIを使わずにログインする
cy.sessionを使うと、スペックの実行ごとに一度だけログインし、後でCookieとストレージを復元できます。ログイン処理自体はフォームに入力するのではなくcy.requestを使います。
Cypress.Commands.add("login", (email: string, password: string) => {
cy.session([email], () => {
cy.request("POST", "/api/login", { email, password });
});
});
テストデータも同様に作成します。フォームをクリックして操作するのではなく、APIエンドポイントへのcy.request、またはデータベースにシードデータを投入するcy.taskを使います。
対策2: 固定の待機を削除する
cy.wait(5000)は毎回5秒かかります。Cypressはアサーションを自動的に再試行するので、結果に対してアサートしてください。ネットワーク呼び出しを待つ必要がある場合は、cy.interceptで別名を付けて、その別名を待機します。
cy.intercept("GET", "/api/orders*").as("orders");
cy.visit("/orders");
cy.wait("@orders");
cy.get("[data-cy=order-row]").should("have.length.at.least", 1);
遅いサードパーティの呼び出し(地図、アナリティクス、決済のサンドボックスなど)は、テストがそれに依存しないようにcy.interceptでスタブ化してください。
対策3: 本番ビルドに対して実行する
開発サーバーはオンデマンドでコンパイルするため、各ルートへの初回アクセスが遅くなります。CIでは一度ビルドし、そのビルドを配信してCypressを実行します。公式アクションを使えば、buildとstartのステップが自動で実行されます。
- uses: cypress-io/github-action@v6
with:
build: npm run build
start: npm run start
wait-on: "http://localhost:3000"
対策4: 大きなスペックを分割し、適切な対象をテストする
40個のテストを含む長いスペックは並列化しにくくなります。スペックは小さく焦点を絞り、ロジックの確認はユニットテストやコンポーネントテストに移してください。Cypressのコンポーネントテストはアプリ全体を読み込まずにコンポーネントを実行できるため、UIの状態の確認にはずっと高速です。ユニットテストとe2eテストの違いを参照してください。
GitHub ActionsでのCypressの並列テスト
方法A: Cypress Cloud
Cypress Cloudは過去の所要時間の記録をもとに、スペックを複数のマシンに振り分けます。各マシンで同じレコードキーとビルドIDが必要ですが、公式アクションがそれを処理します。
jobs:
cypress:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
containers: [1, 2, 3, 4]
steps:
- uses: actions/checkout@v4
- uses: cypress-io/github-action@v6
with:
build: npm run build
start: npm run start
record: true
parallel: true
group: e2e
env:
CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Cypress Cloudは無料枠のある有料サービスです。現在の上限は、Cypress Cloud自身の料金ページで確認してください。
方法B: Cypress Cloudを使わずにスペックを自分で分割する
オープンソースのcypress-splitプラグインは、環境変数を使ってスペックファイルをマトリクスに分割します。cypress.config.tsで設定し、ジョブのインデックスと合計数を渡します。
strategy:
fail-fast: false
matrix:
index: [0, 1, 2, 3]
steps:
- uses: cypress-io/github-action@v6
with:
build: npm run build
start: npm run start
env:
SPLIT: 4
SPLIT_INDEX: ${{ matrix.index }}
お使いのCypressのバージョンでの正確な設定は、プラグインのREADMEで確認してください。ファイル数で分割しても所要時間は均等になりません。そのため、最も遅いスペックは別々のファイルに分けてください。テスト分割のガイドでは負荷の均等化を説明しており、プランナーではシャード数とコストを見積もれます。
インストールとキャッシュを正しく行う
npmのキャッシュとCypressのバイナリ(~/.cache/Cypress)をキャッシュしてください。公式アクションは両方を自動で行います。npm installではなくnpm ciを使います。ジョブが実行のたびにCypressのバイナリをダウンロードしている場合は、ログに表示されるので、まずそれを直してください。
より多くのCPUを使う
Cypressはブラウザとアプリを1台のマシンで動かすため、2 vCPUのランナーがボトルネックになることがあり、不安定なテストのように見えるタイムアウトが発生します。より多くのコアを比較するにはより高速なGitHub Actionsランナーを参照してください。compiler.devは、測定した18のスタックにおいて、GitHubの2コアランナーと比べて中央値で1.5倍高速でした(15件は高速、2件は同等、1件は低速)。比較モードでは、ご自身のジョブを測定できます。関連ページ: Playwrightのテストが遅い、不安定なe2eテスト、遅いCIのハブ。
よくある質問
Cypressを高速化するにはどうすればよいですか?
cy.sessionとcy.requestでログインし、固定の待機を削除して、本番ビルドをテストし、複数のジョブでスペックを並列実行してください。
Cypress Cloudなしで、Cypressのテストを並列実行できますか?
はい。cypress-splitなどのプラグインを使ってスペックファイルをマトリクスに分割するか、スペックファイルをジョブのインデックスに割り当てる独自のスクリプトを書けます。所要時間に基づく自動的な負荷の均等化は利用できなくなります。
CIではCypressのテストが遅くなるのはなぜですか?
CIのランナーは小さく、コールドスタートします。CPUの使用率、バイナリのダウンロード、開発サーバーに対して実行していないかを確認してください。
CypressはPlaywrightより遅いですか?
スイートによります。どちらも適切に設定すれば高速です。ご自身のテストで比較してください。Playwrightの同等の対策はPlaywrightのテストが遅いを参照してください。
関連記事
- CIでDockerビルドが遅い?原因を特定して解決CIでDockerビルドが遅いですか?ビルドコンテキストのサイズ、.dockerignore、レイヤーの順序、キャッシュミス、BuildKitの設定を診断し、最も影響の大きい問題から修正しましょう。
- 不安定なE2Eテスト: 原因と持続する修正方法不安定なe2eテストと不安定なエンドツーエンドテスト: 不適切な待機、テストの独立性、共有データベースの状態を修正し、バグを隠さずに再試行と隔離を使ってください。
- Jestが遅い? Jestテストを高速化する:ワーカーと--shardJestテストが遅いですか? 高速なTypeScript変換、適切なワーカー数、CIでの--shardの利用で高速化できます。まず最も遅いテストを特定してください。設定例も掲載しています。
- CIでPlaywrightのテストが遅い?ワーカーとシャーディングで解決CIでPlaywrightのテストが遅いですか?ワーカー数の増加、storageStateの再利用、ブラウザのキャッシュ、--shardによるテストのシャーディングで高速化できます。Pythonにも対応しています。