developer tools の拡張

このページでは、Firefox 55に存在するdevtools APIについて説明しています。このAPIはChrome devtools APIsに基づいていますが、まだFirefoxでは実装されていないため、ここでは説明していません。現在欠けている機能を確認するには、devtools APIの制限を参照してください。

WebExtensions API を使用して、ブラウザの組み込み開発者ツールを拡張できます。 devtools 拡張機能を作成するには、manifest.json に "devtools_page" キーを含めます:

"devtools_page": "devtools/devtools-page.html"

このキーの値は、拡張機能にバンドルされている HTML ファイルを指す URL です。URL は manifest.json ファイル自体に関連する必要があります。

HTML ファイルは、devtools ページと呼ばれる特別なページを拡張機能で定義します。

devtools ページ

devtools ページはブラウザの devtools を開くとロードされ、閉じるとアンロードされます。devtools ウィンドウは単一のタブに関連付けられているため、複数の devtools ウィンドウ、つまり複数の devtools ページが同時に存在する可能性が非常に高いことに注意してください。

devtools ページには目に見える DOM はありませんが、<script> タグを使用して JavaScript ソースを含めることができます。ソースは拡張機能自体にバンドルする必要があります。ソースは以下にアクセスできます:

devtools ページは他の WebExtension API にアクセスできず、バックグラウンドページは devtools API にアクセスできないことに注意してください。代わりに、devtools ページとバックグラウンドページは runtime メッセージング API を使用して通信する必要があります。ここに例があります:

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
  </head>
  <body>
    <script src="devtools.js"></script>
  </body>
</html>

devtools.js ファイルには、開発ツール拡張機能を作成する実際のコードが保持されます。

パネルの作成

devtools ウィンドウは、JavaScript デバッガ、ネットワークモニターなどの多数の個別ツールをホストします。上部にあるタブの行により、ユーザーはさまざまなツールを切り替えることができます。各ツールのユーザーインターフェイスをホストするウィンドウは「パネル」と呼ばれます。

devtools.panels.create() API を使用して、devtools ウィンドウに独自のパネルを作成できます:

browser.devtools.panels.create(
  "My Panel",                      // title
  "icons/star.png",                // icon
  "devtools/panel/panel.html"      // content
).then((newPanel) => {
  newPanel.onShown.addListener(initialisePanel);
  newPanel.onHidden.addListener(unInitialisePanel);
});

これにはパネルのタイトル、アイコン、コンテンツの3つの引数が必要です。新しいパネルを表す devtools.panels.ExtensionPanel オブジェクトに解決される Promise を返します。

ターゲットウィンドウとのインタラクション

開発者ツールは常に特定のブラウザタブに添付されます。これは開発者ツールの「ターゲット」または「検出済みウィンドウ」と呼ばれます。devtools.inspectedWindow を使用して、検出されたウィンドウとインタラクションできます。

ターゲットウィンドウでコードを実行する

devtools.inspectedWindow.eval() は、検出されたウィンドウでコードを実行する1つの方法を提供します。

これは tabs.executeScript() を使用してコンテンツスクリプトを挿入することに似ていますが、1つの重要な違いがあります:

  • コンテンツスクリプトとは異なり、devtools.inspectedWindow.eval() を使用してロードされたスクリプトは「DOM のクリーンビュー」を取得しません。つまり、ページスクリプトによって行われたページの変更を確認できます。

DOM のクリーンビューはセキュリティ機能であり、ネイティブ DOM 関数の動作を再定義することにより、悪意のあるページが拡張機能をだますことを防ぐのに役立つことに注意してください。これは eval() を使用する際に非常に注意する必要があることを意味し、可能であれば通常のコンテンツスクリプトを使用する必要があります。

devtools.inspectedWindow.eval() を使用してロードされたスクリプトも、コンテンツスクリプトで定義された JavaScript 変数を認識しません。

コンテンツスクリプトの使用

devtoolsドキュメントは tabs.executeScript() に直接アクセスできません。したがって、コンテンツスクリプトを挿入する必要がある場合、devtools ドキュメントはバックグラウンドスクリプトにメッセージを送信してスクリプトの挿入を要求する必要があります。devtools.inspectedWindow.tabId はターゲットタブの ID を提供します。devtools ドキュメントはこれをバックグラウンドスクリプトに渡すことができ、バックグラウンドスクリプトはそれを tabs.executeScript() に渡すことができます:

// devtools-panel.js

const scriptToAttach = "document.body.innerHTML = 'Hi from the devtools';";

window.addEventListener("click", () => {
  browser.runtime.sendMessage({
    tabId: browser.devtools.inspectedWindow.tabId,
    script: scriptToAttach
  });
});
// background.js

function handleMessage(request, sender, sendResponse) {
  browser.tabs.executeScript(request.tabId, {
    code: request.script
  });
}

browser.runtime.onMessage.addListener(handleMessage);

ターゲットウィンドウで実行されているコンテンツスクリプトとdevtoolsドキュメントの間でメッセージを交換する必要がある場合は、runtime.connect() および runtime.onConnect を使用してバックグラウンドページと devtools ドキュメント間の接続を設定することをお勧めします。バックグラウンドページはタブ ID と runtime.Port オブジェクト間のマッピングを維持し、これを使用して2つのスコープ間でメッセージをルーティングできます。

devtools APIs の制限

これらの API は Chrome devtools API に基づいていますが、Chrome と比較して多くの機能がまだありません。このセクションでは、Firefox 54 の時点でまだ実装されていない機能をリストします。devtools API は活発に開発中であり、将来のリリースでそれらのほとんどのサポートを追加する予定です。

devtools.inspectedWindow

以下はサポートされていません:

  • inspectedWindow.getResources()
  • inspectedWindow.onResourceAdded
  • inspectedWindow.onResourceContentCommitted

inspectedWindow.eval() のオプションはいずれもサポートされていません。

inspectedWindow.eval() を使用して挿入されたスクリプトは、コンソールのすべてのコマンドラインヘルパー関数を使用できませんが、 $0inspect(...) の両方がサポートされています (Firefox 55 以降)。

devtools.panels

以下はサポートされていません:

  • panels.elements
  • panels.sources
  • panels.setOpenResourceHandler()
  • panels.openResource()
  • panels.ExtensionPanel.createStatusBarButton()
  • panels.Button
  • panels.ElementsPanel
  • panels.SourcesPanel

GitHub の webextensions-examples リポジトリには、devtools パネルを使用する拡張機能のいくつかの例が含まれています。