Bug 1308912 - Simplify tool-unregistered by only accepting a string toolId. r=ochameau

MozReview-Commit-ID: 3QjWIAwol6A

--HG--
extra : rebase_source : d5e8ac0d23d8105b15d01f38860ac854d6300558
extra : source : 0d9e3e91230730f4a513cad98a5758c56cf473e8

devtools/client/framework/devtools-browser.js

@@ -730,9 +730,6 @@ gDevTools.on("tool-registered", function (ev, toolId) {
 });
 
 gDevTools.on("tool-unregistered", function (ev, toolId) {
-  if (typeof toolId != "string") {
-    toolId = toolId.id;
-  }
   gDevToolsBrowser._removeToolFromWindows(toolId);
 });
 

devtools/client/framework/devtools.js

@@ -140,12 +140,16 @@ DevTools.prototype = {
       tool = this._tools.get(tool);
     }
     else {
+      let {Deprecated} = Cu.import("resource://gre/modules/Deprecated.jsm", {});
+      Deprecated.warning("Deprecation WARNING: gDevTools.unregisterTool(tool) is deprecated. " +
+                         "You should unregister a tool using its toolId: " +
+                         "gDevTools.unregisterTool(toolId).");
       toolId = tool.id;
     }
     this._tools.delete(toolId);
 
     if (!isQuitApplication) {
-      this.emit("tool-unregistered", tool);
+      this.emit("tool-unregistered", toolId);
     }
   },
 

devtools/client/framework/test/browser_toolbox_dynamic_registration.js

@@ -71,9 +71,8 @@ function testUnregister()
   gDevTools.unregisterTool("test-tool");
 }
 
-function toolUnregistered(event, toolDefinition)
+function toolUnregistered(event, toolId)
 {
-  let toolId = toolDefinition.id;
   is(toolId, "test-tool", "tool-unregistered event handler sent tool id");
 
   ok(!gDevTools.getToolDefinitionMap().has(toolId), "tool removed from map");

devtools/client/framework/test/browser_toolbox_options.js

@@ -235,7 +235,7 @@ function* toggleTool(node) {
 }
 
 function checkUnregistered(toolId, deferred, event, data) {
-  if (data.id == toolId) {
+  if (data == toolId) {
     ok(true, "Correct tool removed");
     // checking tab on the toolbox
     ok(!doc.getElementById("toolbox-tab-" + toolId),

devtools/client/framework/toolbox-options.js

@@ -190,11 +190,7 @@ OptionsPanel.prototype = {
       let toolDefinition = gDevTools._tools.get(id);
       // Set the kill switch pref boolean to true
       Services.prefs.setBoolPref(toolDefinition.visibilityswitch, this.checked);
-      if (this.checked) {
-        gDevTools.emit("tool-registered", id);
-      } else {
-        gDevTools.emit("tool-unregistered", toolDefinition);
-      }
+      gDevTools.emit(this.checked ? "tool-registered" : "tool-unregistered", id);
     };
 
     let createToolCheckbox = tool => {

devtools/client/framework/toolbox.js

@@ -1935,15 +1935,10 @@ Toolbox.prototype = {
    * Handler for the tool-unregistered event.
    * @param  {string} event
    *         Name of the event ("tool-unregistered")
-   * @param  {string|object} toolId
-   *         Definition or id of the tool that was unregistered. Passing the
-   *         tool id should be avoided as it is a temporary measure.
+   * @param  {string} toolId
+   *         id of the tool that was unregistered.
    */
   _toolUnregistered: function (event, toolId) {
-    if (typeof toolId != "string") {
-      toolId = toolId.id;
-    }
-
     if (this._toolPanels.has(toolId)) {
       let instance = this._toolPanels.get(toolId);
       instance.destroy();