chrome.devtools.recorder

説明

devtools.recorder API は、Chrome DevTools の [Recorder] パネルを拡張できるプレビュー機能です。

デベロッパー ツール API の使用方法の概要については、デベロッパー ツール API の概要をご覧ください。

対象

コンセプトと使用方法

エクスポート機能をカスタマイズする

拡張機能プラグインを登録するには、registerRecorderExtensionPlugin 関数を使用します。この関数には、プラグイン インスタンス、name、mediaType をパラメータとして指定する必要があります。プラグイン インスタンスは、stringify と stringifyStep の 2 つのメソッドを実装する必要があります。

拡張機能で指定された name は、[Recorder] パネルの [Export] メニューに表示されます。

エクスポートのコンテキストに応じて、ユーザーが拡張機能で提供されるエクスポート オプションをクリックすると、[Recorder] パネルは次のいずれかの関数を呼び出します。

• stringify ユーザーフローの記録全体を受け取る
• stringifyStep 記録された 1 つのステップ を受け取る

mediaType パラメータを使用すると、拡張機能は stringify 関数と stringifyStep 関数で生成する出力の種類を指定できます。たとえば、結果が JavaScript プログラムの場合は application/javascript です。

再生ボタンをカスタマイズする

[Recorder] の再生ボタンをカスタマイズするには、registerRecorderExtensionPlugin 関数を使用します。カスタマイズを有効にするには、プラグインで replay メソッドを実装する必要があります。メソッドが検出されると、[Recorder] に再生ボタンが表示されます。 ボタンをクリックすると、現在の記録オブジェクトが最初の引数として replay メソッドに渡されます。

この時点で、拡張機能は再生を処理する RecorderView を表示するか、他の拡張機能 API を使用して再生リクエストを処理できます。新しい RecorderView を作成するには、chrome.devtools.recorder.createView を呼び出します。

例

エクスポート プラグイン

次のコードは、JSON.stringify を使用して記録を文字列化する拡張機能プラグインを実装します。

class MyPlugin {
  stringify(recording) {
    return Promise.resolve(JSON.stringify(recording));
  }
  stringifyStep(step) {
    return Promise.resolve(JSON.stringify(step));
  }
}

chrome.devtools.recorder.registerRecorderExtensionPlugin(
  new MyPlugin(),
  /*name=*/'MyPlugin',
  /*mediaType=*/'application/json'
);

再生プラグイン

次のコードは、ダミーの Recorder ビューを作成し、再生リクエスト時に表示する拡張機能プラグインを実装します。

const view = await chrome.devtools.recorder.createView(
  /* name= */ 'ExtensionName',
  /* pagePath= */ 'Replay.html'
);

let latestRecording;

view.onShown.addListener(() => {
  // Recorder has shown the view. Send additional data to the view if needed.
  chrome.runtime.sendMessage(JSON.stringify(latestRecording));
});

view.onHidden.addListener(() => {
  // Recorder has hidden the view.
});

export class RecorderPlugin {
  replay(recording) {
    // Share the data with the view.
    latestRecording = recording;
    // Request to show the view.
    view.show();
  }
}

chrome.devtools.recorder.registerRecorderExtensionPlugin(
  new RecorderPlugin(),
  /* name=*/ 'CoffeeTest'
);

完全な拡張機能の例については、GitHub をご覧ください。

chrome.devtools.recorder.createView(
  title: string,
  pagePath: string,
): RecorderView

chrome.devtools.recorder.registerRecorderExtensionPlugin(
  plugin: RecorderExtensionPlugin,
  name: string,
  mediaType: string,
): void