chrome.devtools.recorder

説明

対象

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

概要

devtools.recorder API は、Chrome DevTools の [Recorder パネル] を拡張できるプレビュー機能です。 Chrome M105 以降では、エクスポート機能を拡張できます。Chrome M112 以降では、リプレイボタンを拡張できます。

エクスポート機能のカスタマイズ

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

拡張機能によって提供される name は、[Recorder] パネルの [Export] メニューに表示されます。

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

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

mediaType パラメータを使用すると、拡張機能が stringify 関数と stringifyStep 関数。たとえば、結果が JavaScript の場合は application/javascript 。

エクスポート プラグインの例

次のコードは、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'
);

リプレイボタンをカスタマイズする

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

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

リプレイ プラグインの例

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

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,
)

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