Bug 1227978 - Convert all DebuggerClient request methods to return promises. r=jlongster

devtools/client/debugger/debugger-view.js

@@ -482,8 +482,7 @@ var DebuggerView = {
       return;
     }
     else if (textInfo.error) {
-      let url = textInfo.error;
-      let msg = L10N.getFormatStr("errorLoadingText2", url);
+      let msg = L10N.getFormatStr("errorLoadingText2", textInfo.error);
       this._setEditorText(msg);
       Cu.reportError(msg);
       dumpn(msg);

devtools/client/debugger/test/mochitest/browser_dbg_interrupts.js

@@ -55,7 +55,7 @@ function test() {
   function testResumeButton() {
     info ("Pressing the resume button, expecting a thread-paused");
 
-    ok (!gResumeButton.hasAttribute("disabled"), "Resume button is not disabled");
+    ok (!gResumeButton.hasAttribute("disabled"), "Resume button is not disabled 1");
     ok (!gResumeButton.hasAttribute("break-on-next"), "Resume button isn't waiting for next execution");
     ok (!gResumeButton.hasAttribute("checked"), "Resume button is not checked");
     let oncePaused = gTarget.once("thread-paused");
@@ -75,17 +75,20 @@ function test() {
       .then(() => {
         ok (!gResumeButton.hasAttribute("break-on-next"), "Resume button isn't waiting for next execution");
         is (gResumeButton.getAttribute("checked"), "true", "Resume button is checked");
-        ok (!gResumeButton.hasAttribute("disabled"), "Resume button is not disabled");
+        ok (!gResumeButton.hasAttribute("disabled"), "Resume button is not disabled 2");
+      })
+      .then(() => {
+        let p = ensureThreadClientState(gPanel, "resumed");
+        gThreadClient.resume();
+        return p;
       })
-      .then(() => gThreadClient.resume())
-      .then(() => ensureThreadClientState(gPanel, "resumed"))
   }
 
   function testResumeKeyboard() {
     let key = gResumeKey.getAttribute("keycode");
     info ("Triggering a pause with keyboard (" + key +  "), expecting a thread-paused");
 
-    ok (!gResumeButton.hasAttribute("disabled"), "Resume button is not disabled");
+    ok (!gResumeButton.hasAttribute("disabled"), "Resume button is not disabled 3");
     ok (!gResumeButton.hasAttribute("break-on-next"), "Resume button isn't waiting for next execution");
     ok (!gResumeButton.hasAttribute("checked"), "Resume button is not checked");
 
@@ -104,9 +107,12 @@ function test() {
       .then(() => {
         ok (!gResumeButton.hasAttribute("break-on-next"), "Resume button isn't waiting for next execution");
         is (gResumeButton.getAttribute("checked"), "true", "Resume button is checked");
-        ok (!gResumeButton.hasAttribute("disabled"), "Resume button is not disabled");
+        ok (!gResumeButton.hasAttribute("disabled"), "Resume button is not disabled 4");
+      })
+      .then(() => {
+        let p = ensureThreadClientState(gPanel, "resumed");
+        gThreadClient.resume();
+        return p;
       })
-      .then(() => gThreadClient.resume())
-      .then(() => ensureThreadClientState(gPanel, "resumed"))
   }
 }

devtools/client/debugger/test/mochitest/browser_dbg_pretty-print-06.js

@@ -30,7 +30,7 @@ function test() {
       return function (aPacket, aCallback) {
         if (aPacket.type == "prettyPrint") {
           gPrettyPrinted = true;
-          return executeSoon(() => aCallback({ error: "prettyPrintError" }));
+          return promise.reject({ error: "prettyPrintError" });
         }
         return aOriginalRequestMethod(aPacket, aCallback);
       };

devtools/client/debugger/test/mochitest/browser_dbg_scripts-switching-03.js

@@ -25,7 +25,7 @@ function test() {
     }
 
     function testDebuggerLoadingError() {
-      ok(gEditor.getText().includes(gL10N.getFormatStr("errorLoadingText2", "noSuchActor")),
+      ok(gEditor.getText().includes(gL10N.getFormatStr("errorLoadingText2", "No such actor for ID: fake.actor")),
          "The valid error loading message is displayed.");
     }
 

devtools/client/performance/test/browser_perf-legacy-front-05.js

@@ -25,7 +25,7 @@ function* spawnTest() {
     // Copy so we don't destructively change the request object, as we use
     // the startTime on this object for filtering in the callback
     let newData = merge({}, data, { startTime: void 0 });
-    request.call(target.client, newData, res);
+    return request.call(target.client, newData, res);
   };
 
   // Perform the first recording...

devtools/shared/client/main.js

@@ -447,13 +447,14 @@ DebuggerClient.prototype = {
       to: aTabActor,
       type: "attach"
     };
-    this.request(packet, (aResponse) => {
+    return this.request(packet).then(aResponse => {
       let tabClient;
       if (!aResponse.error) {
         tabClient = new TabClient(this, aResponse);
         this.registerClient(tabClient);
       }
       aOnResponse(aResponse, tabClient);
+      return [aResponse, tabClient];
     });
   },
 
@@ -468,15 +469,16 @@ DebuggerClient.prototype = {
       return;
     }
 
-    this.request({ to: aWorkerActor, type: "attach" }, (aResponse) => {
+    return this.request({ to: aWorkerActor, type: "attach" }).then(aResponse => {
       if (aResponse.error) {
         aOnResponse(aResponse, null);
-        return;
+        return [aResponse, null];
       }
 
       let workerClient = new WorkerClient(this, aResponse);
       this.registerClient(workerClient);
       aOnResponse(aResponse, workerClient);
+      return [aResponse, workerClient];
     });
   },
 
@@ -494,7 +496,7 @@ DebuggerClient.prototype = {
       to: aAddonActor,
       type: "attach"
     };
-    this.request(packet, aResponse => {
+    return this.request(packet).then(aResponse => {
       let addonClient;
       if (!aResponse.error) {
         addonClient = new AddonClient(this, aAddonActor);
@@ -502,6 +504,7 @@ DebuggerClient.prototype = {
         this.activeAddon = addonClient;
       }
       aOnResponse(aResponse, addonClient);
+      return [aResponse, addonClient];
     });
   },
 
@@ -524,7 +527,7 @@ DebuggerClient.prototype = {
       listeners: aListeners,
     };
 
-    this.request(packet, (aResponse) => {
+    return this.request(packet).then(aResponse => {
       let consoleClient;
       if (!aResponse.error) {
         if (this._clients.has(aConsoleActor)) {
@@ -535,6 +538,7 @@ DebuggerClient.prototype = {
         }
       }
       aOnResponse(aResponse, consoleClient);
+      return [aResponse, consoleClient];
     });
   },
 
@@ -556,17 +560,18 @@ DebuggerClient.prototype = {
       return;
     }
 
-   let packet = {
+    let packet = {
       to: aThreadActor,
       type: "attach",
       options: aOptions
     };
-    this.request(packet, (aResponse) => {
+    return this.request(packet).then(aResponse => {
       if (!aResponse.error) {
         var threadClient = new ThreadClient(this, aThreadActor);
         this.registerClient(threadClient);
       }
       aOnResponse(aResponse, threadClient);
+      return [aResponse, threadClient];
     });
   },
 
@@ -589,12 +594,13 @@ DebuggerClient.prototype = {
       to: aTraceActor,
       type: "attach"
     };
-    this.request(packet, (aResponse) => {
+    return this.request(packet).then(aResponse => {
       if (!aResponse.error) {
         var traceClient = new TraceClient(this, aTraceActor);
         this.registerClient(traceClient);
       }
       aOnResponse(aResponse, traceClient);
+      return [aResponse, traceClient];
     });
   },
 
@@ -1263,12 +1269,13 @@ TabClient.prototype = {
       type: "attach",
       options: aOptions
     };
-    this.request(packet, (aResponse) => {
+    return this.request(packet).then(aResponse => {
       if (!aResponse.error) {
         this.thread = new ThreadClient(this, this._threadActor);
         this.client.registerClient(this.thread);
       }
       aOnResponse(aResponse, this.thread);
+      return [aResponse, this.thread];
     });
   },
 
@@ -1397,29 +1404,30 @@ WorkerClient.prototype = {
 
   attachThread: function(aOptions = {}, aOnResponse = noop) {
     if (this.thread) {
-      DevToolsUtils.executeSoon(() => aOnResponse({
+      let response = [{
         type: "connected",
         threadActor: this.thread._actor,
         consoleActor: this.consoleActor,
-      }, this.thread));
-      return;
+      }, this.thread];
+      DevToolsUtils.executeSoon(() => aOnResponse(response));
+      return response;
     }
 
     // The connect call on server doesn't attach the thread as of version 44.
-    this.request({
+    return this.request({
       to: this._actor,
       type: "connect",
       options: aOptions,
-    }, (connectReponse) => {
+    }).then(connectReponse => {
       if (connectReponse.error) {
         aOnResponse(connectReponse, null);
-        return;
+        return [connectResponse, null];
       }
 
-      this.request({
+      return this.request({
         to: connectReponse.threadActor,
         type: "attach"
-      }, (attachResponse) => {
+      }).then(attachResponse => {
         if (attachResponse.error) {
           aOnResponse(attachResponse, null);
         }
@@ -1429,6 +1437,7 @@ WorkerClient.prototype = {
         this.client.registerClient(this.thread);
 
         aOnResponse(connectReponse, this.thread);
+        return [connectResponse, this.thread];
       });
     });
   },
@@ -1725,7 +1734,7 @@ ThreadClient.prototype = {
    * Resume a paused thread.
    */
   resume: function (aOnResponse) {
-    this._doResume(null, aOnResponse);
+    return this._doResume(null, aOnResponse);
   },
 
   /**
@@ -1735,7 +1744,7 @@ ThreadClient.prototype = {
    *        Called with the response packet.
    */
   resumeThenPause: function (aOnResponse) {
-    this._doResume({ type: "break" }, aOnResponse);
+    return this._doResume({ type: "break" }, aOnResponse);
   },
 
   /**
@@ -1745,7 +1754,7 @@ ThreadClient.prototype = {
    *        Called with the response packet.
    */
   stepOver: function (aOnResponse) {
-    this._doResume({ type: "next" }, aOnResponse);
+    return this._doResume({ type: "next" }, aOnResponse);
   },
 
   /**
@@ -1755,7 +1764,7 @@ ThreadClient.prototype = {
    *        Called with the response packet.
    */
   stepIn: function (aOnResponse) {
-    this._doResume({ type: "step" }, aOnResponse);
+    return this._doResume({ type: "step" }, aOnResponse);
   },
 
   /**
@@ -1765,7 +1774,7 @@ ThreadClient.prototype = {
    *        Called with the response packet.
    */
   stepOut: function (aOnResponse) {
-    this._doResume({ type: "finish" }, aOnResponse);
+    return this._doResume({ type: "finish" }, aOnResponse);
   },
 
   /**
@@ -1775,7 +1784,7 @@ ThreadClient.prototype = {
    *        Called with the response packet.
    */
   interrupt: function(aOnResponse) {
-    this._doInterrupt(null, aOnResponse);
+    return this._doInterrupt(null, aOnResponse);
   },
 
   /**
@@ -1785,7 +1794,7 @@ ThreadClient.prototype = {
    *        Called with the response packet.
    */
   breakOnNext: function(aOnResponse) {
-    this._doInterrupt("onNext", aOnResponse);
+    return this._doInterrupt("onNext", aOnResponse);
   },
 
   /**
@@ -1825,13 +1834,13 @@ ThreadClient.prototype = {
       return;
     }
     // Otherwise send the flag using a standard resume request.
-    this.interrupt(aResponse => {
+    return this.interrupt(aResponse => {
       if (aResponse.error) {
         // Can't continue if pausing failed.
         aOnResponse(aResponse);
-        return;
+        return aResponse;
       }
-      this.resume(aOnResponse);
+      return this.resume(aOnResponse);
     });
   },
 
@@ -1854,15 +1863,15 @@ ThreadClient.prototype = {
     // the array.
     if (this.paused) {
       DevToolsUtils.executeSoon(() => onResponse({}));
-      return;
+      return {};
     }
-    this.interrupt(response => {
+    return this.interrupt(response => {
       // Can't continue if pausing failed.
       if (response.error) {
         onResponse(response);
-        return;
+        return response;
       }
-      this.resume(onResponse);
+      return this.resume(onResponse);
     });
   },
 
@@ -2749,90 +2758,93 @@ SourceClient.prototype = {
    * @param aCallback Function
    *        The callback function called when we receive the response from the server.
    */
-  getExecutableLines: function(cb){
+  getExecutableLines: function(cb = noop){
     let packet = {
       to: this._form.actor,
       type: "getExecutableLines"
     };
 
-    this._client.request(packet, res => {
+    return this._client.request(packet).then(res => {
       cb(res.lines);
+      return res.lines;
     });
   },
 
   /**
    * Get a long string grip for this SourceClient's source.
    */
-  source: function (aCallback) {
+  source: function (aCallback = noop) {
     let packet = {
       to: this._form.actor,
       type: "source"
     };
-    this._client.request(packet, aResponse => {
-      this._onSourceResponse(aResponse, aCallback)
+    return this._client.request(packet).then(aResponse => {
+      return this._onSourceResponse(aResponse, aCallback)
     });
   },
 
   /**
    * Pretty print this source's text.
    */
-  prettyPrint: function (aIndent, aCallback) {
+  prettyPrint: function (aIndent, aCallback = noop) {
     const packet = {
       to: this._form.actor,
       type: "prettyPrint",
       indent: aIndent
     };
-    this._client.request(packet, aResponse => {
+    return this._client.request(packet).then(aResponse => {
       if (!aResponse.error) {
         this._isPrettyPrinted = true;
         this._activeThread._clearFrames();
         this._activeThread.emit("prettyprintchange", this);
       }
-      this._onSourceResponse(aResponse, aCallback);
+      return this._onSourceResponse(aResponse, aCallback);
     });
   },
 
   /**
    * Stop pretty printing this source's text.
    */
-  disablePrettyPrint: function (aCallback) {
+  disablePrettyPrint: function (aCallback = noop) {
     const packet = {
       to: this._form.actor,
       type: "disablePrettyPrint"
     };
-    this._client.request(packet, aResponse => {
+    return this._client.request(packet).then(aResponse => {
       if (!aResponse.error) {
         this._isPrettyPrinted = false;
         this._activeThread._clearFrames();
         this._activeThread.emit("prettyprintchange", this);
       }
-      this._onSourceResponse(aResponse, aCallback);
+      return this._onSourceResponse(aResponse, aCallback);
     });
   },
 
   _onSourceResponse: function (aResponse, aCallback) {
     if (aResponse.error) {
       aCallback(aResponse);
-      return;
+      return aResponse;
     }
 
     if (typeof aResponse.source === "string") {
       aCallback(aResponse);
-      return;
+      return aResponse;
     }
 
     let { contentType, source } = aResponse;
     let longString = this._activeThread.threadLongString(source);
-    longString.substring(0, longString.length, function (aResponse) {
+    return longString.substring(0, longString.length).then(function (aResponse) {
       if (aResponse.error) {
         aCallback(aResponse);
-        return;
+        return aReponse;
       }
 
-      aCallback({
+      let response = {
         source: aResponse.substring,
         contentType: contentType
-      });
+      };
+      aCallback(response);
+      return response;
     });
   },
 
@@ -2868,7 +2880,7 @@ SourceClient.prototype = {
         packet.location.url = this.url;
       }
 
-      this._client.request(packet, aResponse => {
+      return this._client.request(packet).then(aResponse => {
         // Ignoring errors, since the user may be setting a breakpoint in a
         // dead script that will reappear on a page reload.
         let bpClient;
@@ -2885,20 +2897,20 @@ SourceClient.prototype = {
         if (aCallback) {
           aCallback();
         }
+        return [aResponse, bpClient];
       });
     };
 
     // If the debuggee is paused, just set the breakpoint.
     if (this._activeThread.paused) {
-      doSetBreakpoint();
-      return;
+      return doSetBreakpoint();
     }
     // Otherwise, force a pause in order to set the breakpoint.
-    this._activeThread.interrupt(aResponse => {
+    return this._activeThread.interrupt().then(aResponse => {
       if (aResponse.error) {
         // Can't set the breakpoint if pausing failed.
         aOnResponse(aResponse);
-        return;
+        return aResponse;
       }
 
       const { type, why } = aResponse;
@@ -2906,8 +2918,8 @@ SourceClient.prototype = {
             ? () => this._activeThread.resume()
             : noop;
 
-      doSetBreakpoint(cleanUp);
-    })
+      return doSetBreakpoint(cleanUp);
+    });
   }
 };