コンテンツにスキップ

FAQ

並列の再生テストが時々実際のバックエンドを呼ぶのはなぜ?

Section titled “並列の再生テストが時々実際のバックエンドを呼ぶのはなぜ?”

おそらくテストごとのフックで playwrightProxy.teardown() を呼んでいます。これはプロキシのグローバルモードを transparent に設定し、fullyParallel: true では各 Playwright ワーカーが自身の test.afterAll を実行します。速いテストが終わって teardown() を呼ぶ一方で遅いテストがまだ実行中だと、プロキシはテストの途中で transparent に切り替わり、残りのリクエストは再生されずに実際のバックエンドへ転送されます。記録の実行では、teardown() がすべての記録セッションを保存して終了するため、遅いテストの残りのリクエストは記録されません。

// ❌ breaks parallel replay — teardown() affects all sessions globally
test.afterAll(async () => {
await playwrightProxy.teardown();
});

対処: test.afterAll を省いてください。セッションのクリーンアップは context.on('close') → cleanupSession() で自動的に行われます。実行全体の後にプロキシをリセットする必要がある場合にのみ global teardown を使ってください。

再生中の実行が実際のバックエンドに到達するもう 1 つの経路は、セッションのタイムアウトです。タイムアウトは playwrightProxy.before() を呼ぶたびにリセットされますが、プロキシを通るリクエストではリセットされません。次の before() の呼び出しより前にタイムアウト(デフォルトは 120000 ms)が切れると、プロキシは transparent に切り替わります。その時点でまだ実行中のテストは、残りのリクエストを実際のバックエンドへ送ります。1 つのテストがそれほど長く実行されうる場合は、CLI の --timeout か設定の timeout でタイムアウトを延ばしてください。

再生したリクエストが “with this request body” で失敗するのはなぜ?

Section titled “再生したリクエストが “with this request body” で失敗するのはなぜ?”

プロキシはサーバーサイドのリクエストを、メソッド、パス、クエリに加えてボディでも照合します。このエラーは、どの記録にもないボディをリクエストが送ったことを意味します。多くの場合、ボディには現在の日付やランダムな id のように実行ごとに変わる値が含まれています。テスト中はその値を固定し(固定の時計、シード付きの id ジェネレーター)、記録し直してください。アプリのリクエストを意図して変更した場合は、そのテストを記録し直してください。GET と HEAD のリクエストはボディで比較されません。

並列ワーカーで記録できますか?

Section titled “並列ワーカーで記録できますか?”

はい、2.0.1 より後のバージョンでは可能です。プロキシは、再生と同様に記録モードでも、各リクエストを x-test-rcrd-id ヘッダーで指定されたセッションに振り分けます。playwrightProxy.before() がページのリクエストにこのヘッダーを設定し、registerProxyFetch() がサーバーサイドのリクエストにコピーします。テストが終わると、プロキシはそのテストの .mock.json を保存し、他のテストの記録はそのまま続けます。

それでも並列の記録を妨げうるのは、テスト対象のアプリです。1 つのデータベースをリセットしたり、1 つのアカウントにサインインしたりするテストは、プロキシとは関係なく互いの状態を上書きします。そうしたテストはワーカー 1 つで記録するか、ワーカーごとに、それぞれ専用のポートとデータディレクトリを持つアプリサーバーを 1 つずつ起動してください。各テストが上流への呼び出しに 2 〜 8 分かかり、ワーカーごとにアプリサーバーを 1 つ動かす 11 テストのスイートは、5 ワーカーで 11.5 分で記録でき、1 ワーカーでは 49 分かかりました。

Terminal window
RECORD_MODE=1 npx playwright test --workers 1

init が追加する test:e2e:record スクリプトとサンプルアプリは --workers 1 を指定しています。テストがアプリの状態を共有しない場合は外してください。

バージョン 2.0.1 までは、すべてのリクエストに対して 1 つの記録セッションを保持します。それらのバージョンでは、2 つ目のテストが記録を始めると、プロキシは 1 つ目のテストのファイルを保存して 2 つ目のテストに切り替えるため、1 つ目のテストの残りのリクエストは 2 つ目のテストの .mock.json に入ってしまいます。それらのバージョンでは --workers 1 で記録してください。再生はどのバージョンでも並列ワーカーで実行できます。

記録は git にコミットすべきですか?

Section titled “記録は git にコミットすべきですか?”

はい。CI がネットワークなしで再生できるよう、記録は git に入っている必要があります — e2e/recordings を .gitignore に追加しないでください。大きな記録ファイルが PR のレビューの妨げにならないよう、.gitattributes で生成ファイルとしてマークしてください。GitHub はその差分をデフォルトで折りたたみつつ、クリック 1 回で表示できるようにするため、API で名前が変わったフィールドもレビューで確認できます。binary としてマークすると、その変更は完全に見えなくなります。

/e2e/recordings/** linguist-generated=true

ブラウザのみ(HAR)の記録でプロキシの <target-url> は重要ですか?

Section titled “ブラウザのみ(HAR)の記録でプロキシの <target-url> は重要ですか?”

いいえ。ブラウザのみの記録ではターゲットは無関係です — プロキシのプロセスは、セッション管理のために /__control エンドポイントが利用可能になるよう実行されている必要があるだけです。ターゲットが重要なのは、サーバーサイド(SSR)リクエストもプロキシ経由でルーティングする場合だけです。

url パターンに一致しないブラウザのリクエストはどうなりますか?

Section titled “url パターンに一致しないブラウザのリクエストはどうなりますか?”

Playwright はそれらをインターセプトしないため、記録時も再生時も実際のネットワークに送られます。それらについては何も保存されません。プロキシ(localhost:8100)へのリクエストは例外です。playwrightProxy.before() はそれらを常にプロキシへ転送し、プロキシ自身が記録・再生します。

テストをネットワークから切り離すには、HAR がそのドメインも対象にするよう url を広げるか、page.route() と route.abort() でそのドメインをブロックしてください:

import { test } from '@playwright/test';
import { playwrightProxy } from 'test-proxy-recorder';
const MODE = process.env.RECORD_MODE ? 'record' : 'replay';
test.beforeEach(async ({ page }, testInfo) => {
// The HAR also records and replays the CDN.
await playwrightProxy.before(page, testInfo, MODE, {
url: /localhost:8100|cdn\.example\.com/,
});
// Analytics calls fail instead of reaching the network.
await page.route(/analytics\.example\.com/, (route) => route.abort());
});

詳しくは再生時のリクエストの照合を参照してください。

Next.js の開発サーバーに対して記録できますか?

Section titled “Next.js の開発サーバーに対して記録できますか?”

記録・再生には next dev より next build + next start を推奨します。開発サーバーは遅く、タイムアウトや不安定な記録を引き起こすことがあります。

record モードで再実行し(RECORD_MODE=1、つまり test:e2e:record スクリプト)実際の API に対して記録してから、e2e/recordings/ の更新されたファイルをコミットしてください。

再生するテストでエラー、空のリスト、遅いレスポンスを強制できますか?

Section titled “再生するテストでエラー、空のリスト、遅いレスポンスを強制できますか?”

ブラウザのリクエストについては可能です。Playwright はルートハンドラーを登録とは逆の順序で実行するため、playwrightProxy.before() の後に追加した page.route() が各リクエストを最初に受け取ります。そのハンドラーは自分でリクエストに応答することも、route.fallback() を呼んで記録に引き渡すこともできます。

e2e/todos-error.test.ts
import { test, expect } from '@playwright/test';
import { playwrightProxy } from 'test-proxy-recorder';
const CLIENT_SIDE_URL = /localhost:8100/;
test.beforeEach(async ({ page }, testInfo) => {
await playwrightProxy.before(page, testInfo, 'replay', { url: CLIENT_SIDE_URL });
});
test('shows an error when todos fail to load', async ({ page }) => {
// Added after before(), so Playwright runs this handler first.
await page.route(CLIENT_SIDE_URL, async (route) => {
if (new URL(route.request().url()).pathname === '/todos') {
await route.fulfill({ status: 500, json: { error: 'Internal Server Error' } });
return;
}
await route.fallback(); // every other request is replayed as recorded
});
await page.goto('/');
await expect(page.getByText('Could not load todos')).toBeVisible();
});

空のリストにするには、代わりに json: [] で応答します。遅いレスポンスにするには、route.fallback() を呼ぶ前に待機します。たとえば await new Promise((resolve) => setTimeout(resolve, 3000)) で待つと、記録されたレスポンスが 3 秒遅れて届きます。

サーバーサイドのリクエストはブラウザを通らないため、page.route() では変更できません。その場合は .mock.json の記録を手で編集するか、必要な状態にある API に対して記録してください。ファイル内では、各記録の response が statusCode、headers、body を持っています。ボディの長さを変えた場合は、content-length ヘッダーも削除してください。

デプロイ済みの環境をテストするスイートでも使えますか?

Section titled “デプロイ済みの環境をテストするスイートでも使えますか?”

ブラウザのリクエストについては使えます。Playwright はブラウザ内でそれらをインターセプトするため、デプロイ済みのアプリを変更せずに HAR で記録・再生できます。url はブラウザが呼び出す API のドメインに向けてください。ただし、playwrightProxy.before() はプロキシの /__control エンドポイント経由で各テストのモードを設定するため、プロキシはテストと並べて実行しておく必要があります。

サーバーサイドのリクエストはアプリのサーバーが行うため、デプロイ済みのサーバーが行うリクエストを CI 上のプロキシが目にすることはありません。それらを記録・再生するには、CI でプロキシと並べてアプリのサーバーを実行してください。テスト実行用にビルドして起動し、API のベース URL をプロキシに向け、TEST_PROXY_RECORDER_ENABLED=true を設定します。この構成は Next.js と TanStack Start のページで説明しています。