Bug 1319928 - Prevent gDevTools.showToolbox from racing when called multiple times in a row. r=jryans

MozReview-Commit-ID: ZQrecrTwb5

--HG--
extra : rebase_source : a421a1c7b14493dbcf6ae2d1671a5e8cec700dfa

devtools/client/framework/devtools.js

@@ -32,6 +32,8 @@ this.DevTools = function DevTools() {
   this._tools = new Map();     // Map<toolId, tool>
   this._themes = new Map();    // Map<themeId, theme>
   this._toolboxes = new Map(); // Map<target, toolbox>
+  // List of toolboxes that are still in process of creation
+  this._creatingToolboxes = new Map(); // Map<target, toolbox Promise>
 
   // destroy() is an observer's handler so we need to preserve context.
   this.destroy = this.destroy.bind(this);
@@ -417,25 +419,41 @@ DevTools.prototype = {
 
       toolbox.raise();
     } else {
-      let manager = new ToolboxHostManager(target, hostType, hostOptions);
-
-      toolbox = yield manager.create(toolId);
-      this._toolboxes.set(target, toolbox);
-
-      this.emit("toolbox-created", toolbox);
-
-      toolbox.once("destroy", () => {
-        this.emit("toolbox-destroy", target);
-      });
-
-      toolbox.once("destroyed", () => {
-        this._toolboxes.delete(target);
-        this.emit("toolbox-destroyed", target);
-      });
-
-      yield toolbox.open();
-      this.emit("toolbox-ready", toolbox);
+      // As toolbox object creation is async, we have to be careful about races
+      // Check for possible already in process of loading toolboxes before
+      // actually trying to create a new one.
+      let promise = this._creatingToolboxes.get(target);
+      if (promise) {
+        return yield promise;
+      }
+      let toolboxPromise = this.createToolbox(target, toolId, hostType, hostOptions);
+      this._creatingToolboxes.set(target, toolboxPromise);
+      toolbox = yield toolboxPromise;
+      this._creatingToolboxes.delete(target);
     }
+    return toolbox;
+  }),
+
+  createToolbox: Task.async(function* (target, toolId, hostType, hostOptions) {
+    let manager = new ToolboxHostManager(target, hostType, hostOptions);
+
+    let toolbox = yield manager.create(toolId);
+
+    this._toolboxes.set(target, toolbox);
+
+    this.emit("toolbox-created", toolbox);
+
+    toolbox.once("destroy", () => {
+      this.emit("toolbox-destroy", target);
+    });
+
+    toolbox.once("destroyed", () => {
+      this._toolboxes.delete(target);
+      this.emit("toolbox-destroyed", target);
+    });
+
+    yield toolbox.open();
+    this.emit("toolbox-ready", toolbox);
 
     return toolbox;
   }),