Bug 1291737 - implements devtools.inspectedWindow.tabId. r=kmag
authorLuca Greco <lgreco@mozilla.com>
Fri, 18 Nov 2016 19:05:27 +0100
changeset 377493 bec15541257362494110093bdbb8d29d585cf56f
parent 377492 72d47e72ed1a9b995b8c3dd1a2ada4f7039e46eb
child 377494 e4d9a133fb582623d244caa5084338a0d798fdf7
push id1419
push userjlund@mozilla.com
push dateMon, 10 Apr 2017 20:44:07 +0000
treeherdermozilla-release@5e6801b73ef6 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerskmag
bugs1291737
milestone53.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1291737 - implements devtools.inspectedWindow.tabId. r=kmag MozReview-Commit-ID: L60Ivfl8dVG
browser/components/extensions/ext-c-devtools-inspectedWindow.js
browser/components/extensions/extensions-browser.manifest
browser/components/extensions/jar.mn
browser/components/extensions/schemas/devtools_inspected_window.json
browser/components/extensions/schemas/jar.mn
browser/components/extensions/test/browser/browser-common.ini
browser/components/extensions/test/browser/browser_ext_devtools_inspectedWindow.js
new file mode 100644
--- /dev/null
+++ b/browser/components/extensions/ext-c-devtools-inspectedWindow.js
@@ -0,0 +1,22 @@
+/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
+/* vim: set sts=2 sw=2 et tw=80: */
+"use strict";
+
+extensions.registerSchemaAPI("devtools.inspectedWindow", "devtools_child", context => {
+  // `devtoolsToolboxInfo` is received from the child process when the root devtools view
+  // has been created, and every sub-frame of that top level devtools frame will
+  // receive the same information when the context has been created from the
+  // `ExtensionChild.createExtensionContext` method.
+  let tabId = (context.devtoolsToolboxInfo &&
+               context.devtoolsToolboxInfo.inspectedWindowTabId);
+
+  return {
+    devtools: {
+      inspectedWindow: {
+        get tabId() {
+          return tabId;
+        },
+      },
+    },
+  };
+});
--- a/browser/components/extensions/extensions-browser.manifest
+++ b/browser/components/extensions/extensions-browser.manifest
@@ -10,28 +10,32 @@ category webextension-scripts history ch
 category webextension-scripts omnibox chrome://browser/content/ext-omnibox.js
 category webextension-scripts pageAction chrome://browser/content/ext-pageAction.js
 category webextension-scripts sessions chrome://browser/content/ext-sessions.js
 category webextension-scripts tabs chrome://browser/content/ext-tabs.js
 category webextension-scripts theme chrome://browser/content/ext-theme.js
 category webextension-scripts utils chrome://browser/content/ext-utils.js
 category webextension-scripts windows chrome://browser/content/ext-windows.js
 
+# scripts specific for devtools extension contexts.
+category webextension-scripts-devtools devtools-inspectedWindow chrome://browser/content/ext-c-devtools-inspectedWindow.js
+
 # scripts that must run in the same process as addon code.
 category webextension-scripts-addon contextMenus chrome://browser/content/ext-c-contextMenus.js
 category webextension-scripts-addon omnibox chrome://browser/content/ext-c-omnibox.js
 category webextension-scripts-addon tabs chrome://browser/content/ext-c-tabs.js
 
 # schemas
 category webextension-schemas bookmarks chrome://browser/content/schemas/bookmarks.json
 category webextension-schemas browser_action chrome://browser/content/schemas/browser_action.json
 category webextension-schemas browsing_data chrome://browser/content/schemas/browsing_data.json
 category webextension-schemas commands chrome://browser/content/schemas/commands.json
 category webextension-schemas context_menus chrome://browser/content/schemas/context_menus.json
 category webextension-schemas context_menus_internal chrome://browser/content/schemas/context_menus_internal.json
 category webextension-schemas devtools chrome://browser/content/schemas/devtools.json
+category webextension-schemas devtools_inspected_window chrome://browser/content/schemas/devtools_inspected_window.json
 category webextension-schemas history chrome://browser/content/schemas/history.json
 category webextension-schemas omnibox chrome://browser/content/schemas/omnibox.json
 category webextension-schemas page_action chrome://browser/content/schemas/page_action.json
 category webextension-schemas sessions chrome://browser/content/schemas/sessions.json
 category webextension-schemas tabs chrome://browser/content/schemas/tabs.json
 category webextension-schemas theme chrome://browser/content/schemas/theme.json
 category webextension-schemas windows chrome://browser/content/schemas/windows.json
--- a/browser/components/extensions/jar.mn
+++ b/browser/components/extensions/jar.mn
@@ -23,10 +23,11 @@ browser.jar:
     content/browser/ext-omnibox.js
     content/browser/ext-pageAction.js
     content/browser/ext-sessions.js
     content/browser/ext-tabs.js
     content/browser/ext-theme.js
     content/browser/ext-utils.js
     content/browser/ext-windows.js
     content/browser/ext-c-contextMenus.js
+    content/browser/ext-c-devtools-inspectedWindow.js
     content/browser/ext-c-omnibox.js
     content/browser/ext-c-tabs.js
new file mode 100644
--- /dev/null
+++ b/browser/components/extensions/schemas/devtools_inspected_window.json
@@ -0,0 +1,273 @@
+// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+[
+  {
+    "namespace": "devtools.inspectedWindow",
+    "allowedContexts": ["devtools", "devtools_only"],
+    "defaultContexts": ["devtools", "devtools_only"],
+    "description": "Use the <code>chrome.devtools.inspectedWindow</code> API to interact with the inspected window: obtain the tab ID for the inspected page, evaluate the code in the context of the inspected window, reload the page, or obtain the list of resources within the page.",
+    "nocompile": true,
+    "types": [
+      {
+        "id": "Resource",
+        "type": "object",
+        "description": "A resource within the inspected page, such as a document, a script, or an image.",
+        "properties": {
+          "url": {
+            "type": "string",
+            "description": "The URL of the resource."
+          }
+        },
+        "functions": [
+          {
+            "name": "getContent",
+            "unsupported": true,
+            "type": "function",
+            "async": "callback",
+            "description": "Gets the content of the resource.",
+            "parameters": [
+              {
+                "name": "callback",
+                "type": "function",
+                "description": "A function that receives resource content when the request completes.",
+                "parameters": [
+                  {
+                    "name": "content",
+                    "type": "string",
+                    "description": "Content of the resource (potentially encoded)."
+                  },
+                  {
+                    "name": "encoding",
+                    "type": "string",
+                    "description": "Empty if content is not encoded, encoding name otherwise. Currently, only base64 is supported."
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "name": "setContent",
+            "unsupported": true,
+            "type": "function",
+            "async": "callback",
+            "description": "Sets the content of the resource.",
+            "parameters": [
+              {
+                "name": "content",
+                "type": "string",
+                "description": "New content of the resource. Only resources with the text type are currently supported."
+              },
+              {
+                "name": "commit",
+                "type": "boolean",
+                "description": "True if the user has finished editing the resource, and the new content of the resource should be persisted; false if this is a minor change sent in progress of the user editing the resource."
+              },
+              {
+                "name": "callback",
+                "type": "function",
+                "description": "A function called upon request completion.",
+                "optional": true,
+                "parameters": [
+                  {
+                    "name": "error",
+                    "type": "object",
+                    "additionalProperties": {"type": "any"},
+                    "optional": true,
+                    "description": "Set to undefined if the resource content was set successfully; describes error otherwise."
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "properties": {
+      "tabId": {
+        "description": "The ID of the tab being inspected. This ID may be used with chrome.tabs.* API.",
+        "type": "integer"
+      }
+    },
+    "functions": [
+      {
+        "name": "eval",
+        "unsupported": true,
+        "type": "function",
+        "description": "Evaluates a JavaScript expression in the context of the main frame of the inspected page. The expression must evaluate to a JSON-compliant object, otherwise an exception is thrown. The eval function can report either a DevTools-side error or a JavaScript exception that occurs during evaluation. In either case, the <code>result</code> parameter of the callback is <code>undefined</code>. In the case of a DevTools-side error, the <code>isException</code> parameter is non-null and has <code>isError</code> set to true and <code>code</code> set to an error code. In the case of a JavaScript error, <code>isException</code> is set to true and <code>value</code> is set to the string value of thrown object.",
+        "async": "callback",
+        "parameters": [
+          {
+            "name": "expression",
+            "type": "string",
+            "description": "An expression to evaluate."
+          },
+          {
+            "name": "options",
+            "type": "object",
+            "optional": true,
+            "description": "The options parameter can contain one or more options.",
+            "properties": {
+              "frameURL": {
+                "type": "string",
+                "unsupported": true,
+                "optional": true,
+                "description": "If specified, the expression is evaluated on the iframe whose URL matches the one specified. By default, the expression is evaluated in the top frame of the inspected page."
+              },
+              "useContentScriptContext": {
+                "type": "boolean",
+                "unsupported": true,
+                "optional": true,
+                "description": "Evaluate the expression in the context of the content script of the calling extension, provided that the content script is already injected into the inspected page. If not, the expression is not evaluated and the callback is invoked with the exception parameter set to an object that has the <code>isError</code> field set to true and the <code>code</code> field set to <code>E_NOTFOUND</code>."
+              },
+              "contextSecurityOrigin": {
+                "type": "string",
+                "unsupported": true,
+                "optional": true,
+                "description": "Evaluate the expression in the context of a content script of an extension that matches the specified origin. If given, contextSecurityOrigin overrides the 'true' setting on userContentScriptContext."
+              }
+            }
+          },
+          {
+            "name": "callback",
+            "type": "function",
+            "description": "A function called when evaluation completes.",
+            "optional": true,
+            "parameters": [
+              {
+                "name": "result",
+                "type": "object",
+                "additionalProperties": {"type": "any"},
+                "description": "The result of evaluation."
+              },
+              {
+                "name": "exceptionInfo",
+                "type": "object",
+                "description": "An object providing details if an exception occurred while evaluating the expression.",
+                "properties": {
+                  "isError": {
+                    "type": "boolean",
+                    "description": "Set if the error occurred on the DevTools side before the expression is evaluated."
+                  },
+                  "code": {
+                    "type": "string",
+                    "description": "Set if the error occurred on the DevTools side before the expression is evaluated."
+                  },
+                  "description": {
+                    "type": "string",
+                    "description": "Set if the error occurred on the DevTools side before the expression is evaluated."
+                  },
+                  "details": {
+                    "type": "array",
+                    "items": { "type": "any" },
+                    "description": "Set if the error occurred on the DevTools side before the expression is evaluated, contains the array of the values that may be substituted into the description string to provide more information about the cause of the error."
+                  },
+                  "isException": {
+                    "type": "boolean",
+                    "description": "Set if the evaluated code produces an unhandled exception."
+                  },
+                  "value": {
+                    "type": "string",
+                    "description": "Set if the evaluated code produces an unhandled exception."
+                  }
+                }
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "name": "reload",
+        "unsupported": true,
+        "type": "function",
+        "description": "Reloads the inspected page.",
+        "parameters": [
+          {
+            "type": "object",
+            "name": "reloadOptions",
+            "optional": true,
+            "properties": {
+              "ignoreCache": {
+                "type": "boolean",
+                "optional": true,
+                "description": "When true, the loader will bypass the cache for all inspected page resources loaded before the <code>load</code> event is fired. The effect is similar to pressing Ctrl+Shift+R in the inspected window or within the Developer Tools window."
+              },
+              "userAgent": {
+                "type": "string",
+                "optional": true,
+                "description": "If specified, the string will override the value of the <code>User-Agent</code> HTTP header that's sent while loading the resources of the inspected page. The string will also override the value of the <code>navigator.userAgent</code> property that's returned to any scripts that are running within the inspected page."
+              },
+              "injectedScript": {
+                "type": "string",
+                "optional": true,
+                "description": "If specified, the script will be injected into every frame of the inspected page immediately upon load, before any of the frame's scripts. The script will not be injected after subsequent reloads&mdash;for example, if the user presses Ctrl+R."
+              },
+              "preprocessorScript": {
+                "unsupported": true,
+                "type": "string",
+                "deprecated": "Please avoid using this parameter, it will be removed soon.",
+                "optional": true,
+                "description": "If specified, this script evaluates into a function that accepts three string arguments: the source to preprocess, the URL of the source, and a function name if the source is an DOM event handler. The preprocessorerScript function should return a string to be compiled by Chrome in place of the input source. In the case that the source is a DOM event handler, the returned source must compile to a single JS function."
+              }
+            }
+          }
+        ]
+      },
+      {
+        "name": "getResources",
+        "unsupported": true,
+        "type": "function",
+        "description": "Retrieves the list of resources from the inspected page.",
+        "unsupported": true,
+        "async": "callback",
+        "parameters": [
+          {
+            "name": "callback",
+            "type": "function",
+            "description": "A function that receives the list of resources when the request completes.",
+            "parameters": [
+              {
+                "name": "resources",
+                "type": "array",
+                "items": { "$ref": "Resource" },
+                "description": "The resources within the page."
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "events": [
+      {
+        "name": "onResourceAdded",
+        "unsupported": true,
+        "type": "function",
+        "description": "Fired when a new resource is added to the inspected page.",
+        "parameters": [
+          {
+            "name": "resource",
+            "$ref": "Resource"
+          }
+        ]
+      },
+      {
+        "name": "onResourceContentCommitted",
+        "unsupported": true,
+        "type": "function",
+        "description": "Fired when a new revision of the resource is committed (e.g. user saves an edited version of the resource in the Developer Tools).",
+        "parameters": [
+          {
+            "name": "resource",
+            "$ref": "Resource"
+          },
+          {
+            "name": "content",
+            "type": "string",
+            "description": "New content of the resource."
+          }
+        ]
+      }
+    ]
+  }
+]
--- a/browser/components/extensions/schemas/jar.mn
+++ b/browser/components/extensions/schemas/jar.mn
@@ -5,15 +5,16 @@
 browser.jar:
     content/browser/schemas/bookmarks.json
     content/browser/schemas/browser_action.json
     content/browser/schemas/browsing_data.json
     content/browser/schemas/commands.json
     content/browser/schemas/context_menus.json
     content/browser/schemas/context_menus_internal.json
     content/browser/schemas/devtools.json
+    content/browser/schemas/devtools_inspected_window.json
     content/browser/schemas/history.json
     content/browser/schemas/omnibox.json
     content/browser/schemas/page_action.json
     content/browser/schemas/sessions.json
     content/browser/schemas/tabs.json
     content/browser/schemas/theme.json
     content/browser/schemas/windows.json
--- a/browser/components/extensions/test/browser/browser-common.ini
+++ b/browser/components/extensions/test/browser/browser-common.ini
@@ -37,16 +37,17 @@ support-files =
 [browser_ext_contextMenus_checkboxes.js]
 [browser_ext_contextMenus_chrome.js]
 [browser_ext_contextMenus_icons.js]
 [browser_ext_contextMenus_onclick.js]
 [browser_ext_contextMenus_radioGroups.js]
 [browser_ext_contextMenus_uninstall.js]
 [browser_ext_contextMenus_urlPatterns.js]
 [browser_ext_currentWindow.js]
+[browser_ext_devtools_inspectedWindow.js]
 [browser_ext_devtools_page.js]
 [browser_ext_getViews.js]
 [browser_ext_incognito_views.js]
 [browser_ext_incognito_popup.js]
 [browser_ext_lastError.js]
 [browser_ext_omnibox.js]
 [browser_ext_optionsPage_privileges.js]
 [browser_ext_pageAction_context.js]
new file mode 100644
--- /dev/null
+++ b/browser/components/extensions/test/browser/browser_ext_devtools_inspectedWindow.js
@@ -0,0 +1,110 @@
+/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
+/* vim: set sts=2 sw=2 et tw=80: */
+"use strict";
+
+XPCOMUtils.defineLazyModuleGetter(this, "gDevTools",
+                                  "resource://devtools/client/framework/gDevTools.jsm");
+XPCOMUtils.defineLazyModuleGetter(this, "devtools",
+                                  "resource://devtools/shared/Loader.jsm");
+
+/**
+ * this test file ensures that:
+ *
+ * - the devtools page gets only a subset of the runtime API namespace.
+ * - devtools.inspectedWindow.tabId is the same tabId that we can retrieve
+ *   in the background page using the tabs API namespace.
+ * - devtools API is available in the devtools page sub-frames when a valid
+ *   extension URL has been loaded.
+ */
+add_task(function* test_devtools_inspectedWindow_tabId() {
+  let tab = yield BrowserTestUtils.openNewForegroundTab(gBrowser, "http://mochi.test:8888/");
+
+  async function background() {
+    browser.test.assertEq(undefined, browser.devtools,
+                          "No devtools APIs should be available in the background page");
+
+    const tabs = await browser.tabs.query({active: true, lastFocusedWindow: true});
+    browser.test.sendMessage("current-tab-id", tabs[0].id);
+  }
+
+  function devtools_page() {
+    browser.test.assertEq(undefined, browser.runtime.getBackgroundPage,
+      "The `runtime.getBackgroundPage` API method should be missing in a devtools_page context"
+    );
+
+    try {
+      let tabId = browser.devtools.inspectedWindow.tabId;
+      browser.test.sendMessage("inspectedWindow-tab-id", tabId);
+    } catch (err) {
+      browser.test.sendMessage("inspectedWindow-tab-id", undefined);
+      throw err;
+    }
+  }
+
+  function devtools_page_iframe() {
+    try {
+      let tabId = browser.devtools.inspectedWindow.tabId;
+      browser.test.sendMessage("devtools_page_iframe.inspectedWindow-tab-id", tabId);
+    } catch (err) {
+      browser.test.fail(`Error: ${err} :: ${err.stack}`);
+      browser.test.sendMessage("devtools_page_iframe.inspectedWindow-tab-id", undefined);
+    }
+  }
+
+  let extension = ExtensionTestUtils.loadExtension({
+    background,
+    manifest: {
+      devtools_page: "devtools_page.html",
+    },
+    files: {
+      "devtools_page.html": `<!DOCTYPE html>
+      <html>
+       <head>
+         <meta charset="utf-8">
+       </head>
+       <body>
+         <iframe src="/devtools_page_iframe.html"></iframe>
+         <script src="devtools_page.js"></script>
+       </body>
+      </html>`,
+      "devtools_page.js": devtools_page,
+      "devtools_page_iframe.html": `<!DOCTYPE html>
+      <html>
+       <head>
+         <meta charset="utf-8">
+       </head>
+       <body>
+         <script src="devtools_page_iframe.js"></script>
+       </body>
+      </html>`,
+      "devtools_page_iframe.js": devtools_page_iframe,
+    },
+  });
+
+  yield extension.startup();
+
+  let backgroundPageCurrentTabId = yield extension.awaitMessage("current-tab-id");
+
+  let target = devtools.TargetFactory.forTab(tab);
+
+  yield gDevTools.showToolbox(target, "webconsole");
+  info("developer toolbox opened");
+
+  let devtoolsInspectedWindowTabId = yield extension.awaitMessage("inspectedWindow-tab-id");
+
+  is(devtoolsInspectedWindowTabId, backgroundPageCurrentTabId,
+     "Got the expected tabId from devtool.inspectedWindow.tabId");
+
+  let devtoolsPageIframeTabId = yield extension.awaitMessage("devtools_page_iframe.inspectedWindow-tab-id");
+
+  is(devtoolsPageIframeTabId, backgroundPageCurrentTabId,
+     "Got the expected tabId from devtool.inspectedWindow.tabId called in a devtool_page iframe");
+
+  yield gDevTools.closeToolbox(target);
+
+  yield target.destroy();
+
+  yield extension.unload();
+
+  yield BrowserTestUtils.removeTab(tab);
+});