このページは Cloud Translation API によって翻訳されました。

Chrome DevTools のレコーダー以外でユーザーフローをカスタマイズ、自動化する

Ergün Erdogmus

Jecelyn Yeen

自動テストの作成は、開発者の人生において最も楽しいことではありません。Google はデベロッパーとして、機能の開発、バグの修正、世界の改善を目指しています。しかし、ワークフローに自動テストを行わないと、長期的にはかなり「バグ」が発生する可能性があります。そのため、自動テストを作成することも重要であると考えています。

Chrome DevTools の [Recorder] パネルで、ユーザーフローを記録して再生したり、さまざまなサードパーティの拡張機能やライブラリを介してさまざまな形式（テストスクリプトなど）にエクスポートしたり、Puppeteer Replay ライブラリでユーザーフローをカスタマイズしたり、既存のワークフローに統合したりできます。

このブログ投稿では、以下について説明します。

ユーザーフローをプログラムでエクスポートして再生する方法。
Puppeteer Replay を利用してユーザーフローをカスタマイズする方法。
CI/CD ワークフローと統合する方法。

このブログ投稿は、レコーダーの基本を理解していることを前提としています。レコーダーを初めて使用する場合は、こちらの短い紹介チュートリアルと動画ガイドをご覧ください。

ユーザーフローをエクスポートしてプログラムでリプレイする

デフォルトでは、レコーダーで録音を Puppeteer または Puppeteer Replay スクリプトとして、またはプレーン JSON ファイルとしてエクスポートできます。

エクスポートオプション。

ユーザーフローを JSON ファイルとしてエクスポートしたら、[Recorder] パネルにインポートして再生したり、外部ライブラリを使用して再生したりできます。Puppeteer Replay ライブラリは、利用可能なライブラリの一つです。

Puppeteer でもう一度プレイ

リポジトリの手順に沿って、Puppeteer Replay をインストールします。

JSON ユーザーフローを recordings フォルダ（demo プロジェクトなど）に保存すると、次のコマンドを使用して 1 つ以上のユーザーフローを実行できます。

# replay one user flow
npx @puppeteer/replay ./recordings/order-a-coffee.json

# replay all user flows under recordings folder
npx @puppeteer/replay ./recordings/*.json

必要に応じて、録音を実行するための npm スクリプトを追加できます。以下の行を package.json の scripts フィールドに追加します。

"replay-all": "replay recordings"

これにより、コマンドラインで npm run replay-all を実行すると、すべての録音を再生できます。

デフォルトでは、ユーザーフローは UI なしでリプレイされます（ヘッドレスモードとも呼ばれます）。UI を表示するには、コマンドを実行する前に PUPPETEER_HEADLESS 環境変数を false に設定します。

PUPPETEER_HEADLESS=false npm run replay-all

サードパーティライブラリで再現する

Chrome ブラウザ以外で再生するために使用できるサードパーティライブラリもあります。ライブラリの一覧をご覧ください。

たとえば、TestCafe はエンドツーエンドのテストフレームワークです。Safari などでの JSON ユーザーフローのリプレイをサポートします。

npm install -g testcafe

# replay with selected browsers
testcafe safari ./recordings/order-one-coffee.json
testcafe firefox ./recordings/order-one-coffee.json
testcafe chrome ./recordings/order-one-coffee.json

# replay with all browsers
testcafe all ./recordings/order-one-coffee.json

一方、Saucelabs はクラウドベースのテストプラットフォームです。クラウド上のさまざまなブラウザやバージョンでの JSON ユーザーフローの再生をサポートします。

Saucelabs の構成ファイルの例を示します。デモリポジトリをご確認ください。

apiVersion: v1alpha
kind: puppeteer-replay
suites:
  - name: "order a coffee"
    recordings: [ "recordings/order-a-coffee.json" ]
…

さまざまな拡張機能を使用してユーザーフローをエクスポートする

デフォルトのオプションとは別に、拡張機能をインストールして、ユーザーフローをさまざまな形式でエクスポートすることもできます。

さまざまな拡張機能を使用してユーザーフローをエクスポートします。

たとえば、ユーザーフローを WebPageTest カスタムスクリプトとして記録してエクスポートできます。スクリプトを使用して、アプリケーション内での複数ステップのユーザーフローのパフォーマンスをテストできます。しかし、こうしたスクリプトの記述は困難な場合があります。

さらに、すでにテストツールを導入している場合は、Cypress、Nightwatch、WebdriverIO、Testing Library などのさまざまなテストスクリプトにユーザーフローをエクスポートするための拡張機能があります。こちらの一覧をご覧ください。そうすることで、チームでより迅速にテストの作成を開始できます。

プログラムでさまざまなテストスクリプトに変換する

これらのテストプロバイダの多くは、拡張機能に加えて、複数の JSON ユーザーフローをプログラムによって変換するためのライブラリを公開しています。

たとえば、@cypress/chrome-recorder ライブラリを使用して、ユーザーフローを Cypress テストにエクスポートします。

npm install -g @cypress/chrome-recorder
npx @cypress/chrome-recorder ./recordings/*.json

拡張機能によるユーザーフローの再現

Chrome 112 以降では、拡張機能を使用して録画を再生することでエクスペリエンスを向上できます。これらの拡張機能を使用すると、DevTools を離れることなく録音を再生するために、サードパーティのサービスとインフラストラクチャをシームレスに統合できます。

リプレイ拡張機能を使用すると、リプレイを構成してリプレイ結果を表示するためのパネルを DevTools に追加できます。

まず、利用可能な拡張機能のリストをご覧になるか、独自のカスタム拡張機能を作成する方法をご確認ください。

独自の拡張機能やライブラリを作成する

すべての拡張機能とライブラリは、バックグラウンドで Puppeteer Replay ライブラリ上に構築されています。Puppeteer Replay には、ユーザーフローのリプレイを可能にする API のほかに、ユーザーフローのリプレイをカスタマイズまたは変換できる API が用意されています。

ユーザーフローのリプレイをカスタマイズする

スクリーンショットプラグインを作成します。ユーザーフローごとに、以下が必要です。

各手順の最後でスクリーンショットを撮って、_screenshots フォルダに保存します。
ユーザーフローの実行が完了したときにメッセージを出力する場合。

コードスニペットを以下に示します。こちらのデモをダウンロードして、試してみることもできます。

/* screenshot-plugin.mjs */

import { mkdirSync } from "fs";
import { PuppeteerRunnerExtension } from "@puppeteer/replay";

// create folder if not exist
let screenshotFolder = "_screenshots";
mkdirSync(screenshotFolder, { recursive: true });

export default class ScreenshotPlugin extends PuppeteerRunnerExtension {
  count = 0;

  async afterEachStep(step, flow) {
    await super.afterEachStep(step, flow);
    this.count = this.count + 1;

    const path = `${screenshotFolder}/${flow.title}-${this.count}.png`;
    await this.page.screenshot({ path });

    console.log(`Saved screenshot as ${path}`);
  }

  async afterAllSteps(step, flow) {
    await super.afterAllSteps(step, flow);
    console.log("Operation completed successfully.");
  }
}

コード自体がかなり充実しています。ここでは、PuppeteerRunnerExtension API を拡張して、各ステップの後にスクリーンショットを保存し、すべてのステップの後にメッセージをログに記録します。

ファイルを保存します。この拡張機能を使用すると、次のコマンドを使用してユーザーフローを実行できます。

# replay one user flow with plugin 
npx @puppeteer/replay --extension ./screenshot-plugin.mjs  ./recordings/order-a-coffee.json

# replay all user flows with plugin under recordings folder
npx @puppeteer/replay --extension ./screenshot-plugin.mjs ./recordings/*.json

出力は次のとおりです。

Saved screenshot as _screenshots/order-a-coffee-1.png
Saved screenshot as _screenshots/order-a-coffee-2.png
Saved screenshot as _screenshots/order-a-coffee-3.png
…

Operation completed successfully.

ユーザーフローを変換する

ユーザーフローをカスタマイズする別の方法として、さまざまな形式（Cypress や Nightwatch テストスクリプトなど）に変換することもできます。

たとえば、ユーザーフローに URL に移動するステップが含まれているとします。JSON ファイルは次のようになります。

{
  "title": "order-a-coffee",
  "steps": [
    {
      "type": "navigate",
      "url": "https://coffee-cart.netlify.app/"
    },
    …
  ]
}

ステップを JavaScript に変換するための stringify プラグインを作成できます。他の既存のライブラリを表示して方法を確認することもできます。

たとえば、次のコードスニペットは、WebdriverIO がナビゲーションステップを変換する仕組みを示しています。


export class StringifyPlugin extends PuppeteerStringifyExtension {

  #appendStepType(out: LineWriter, step: Step, flow: UserFlow) {
        switch (step.type) {
        case 'navigate':
    return out.appendLine(`await browser.url(${formatAsJSLiteral(step.url)})`)
        …
  }

ユーザーフローでプラグインを実行すると、ナビゲーション行が await browser.url(‘https://coffee-cart.netlify.app/’) に変換されます。

DevTools のリプレイエクスペリエンスをカスタマイズする

リプレイ拡張機能は、サードパーティのサービスとインフラストラクチャを使用して、DevTools のレコーダーから離れることなく録音をリプレイする方法を提供します。

ブラウザ拡張機能でリプレイエクスペリエンスを向上させます。

独自のリプレイ拡張機能を作成するには、リプレイ拡張機能のドキュメントと拡張機能の例をご覧ください。

Chrome 拡張機能を公開する

ユーザーフローをカスタマイズして変換したら、Chrome 拡張機能としてパッケージ化して Chrome ウェブストアに公開できます。

ローカルでデバッグして Chrome 拡張機能を公開する方法について、デモと手順をご確認ください。

CI/CD パイプラインと統合する

これを行う方法は複数あり、世の中には多くのツールがあります。GitHub Actions でこのプロセスを自動化する例を次に示します。

# .github/node.js.yml

name: Replay recordings

on:
  push:
    branches: [ "main" ]
  schedule:
    - cron: '30 12 * * *' # daily 12:30pm

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js
      uses: actions/setup-node@v3
      with:
        node-version: 18.x
        cache: 'npm'
    - run: npm install puppeteer
    - run: npm run replay-all
    - run: npm run start

この例では、次の場合にユーザーフローを再生します。

新しい変更が main ブランチに push される
毎日午後 12 時 30 分

GitHub Actions とは別に、お気に入りのクラウドプロバイダと統合することもできます。こちらのデモで、Google Cloud Run ジョブを使用して最大 10,000 個のユーザーフローを並行して実行する方法をご確認ください。

おわりに

このブログ投稿では、ユーザーフローを JSON ファイルとしてエクスポートする方法、PuppeteerReplayExtension でリプレイをカスタマイズする方法、PuppeteerStringifyExtension でユーザーフローを変換する方法、CI ワークフローに統合する方法について説明しました。

このブログ投稿で、レコーダーパネルと提供されているツールを使用して、プロジェクトにテストワークフローを簡単に統合する方法についてのアイデアをご紹介いただけたら幸いです。皆様が開発されるのを楽しみにしております。

プレビューチャンネルをダウンロードする

デフォルトの開発ブラウザとして Chrome の Canary、Dev、または Beta を使用することを検討してください。これらのプレビューチャンネルを使用すると、DevTools の最新機能にアクセスしたり、最先端のウェブプラットフォーム API をテストしたり、ユーザーに先駆けてサイトの問題を検出したりできます。

Chrome DevTools チームへのお問い合わせ

以下のオプションを使用して、投稿の新機能や変更点、または DevTools に関連するその他のことについて話し合います。

ご提案やフィードバックは、crbug.com からお送りください。
DevTools の [More options] > [Help] > [Report a DevTools issues] を使用して、DevTools の問題を報告します。
@ChromeDevTools でツイートしてください。
DevTools の新機能に関する YouTube 動画または DevTools のヒントの YouTube 動画にコメントを残してください。