Bug 1084525 - Part 6: Add onPromiseSettled event handler to PromisesActor r=fitzgen

toolkit/devtools/server/actors/promises.js

@@ -30,6 +30,11 @@ let PromisesActor = protocol.ActorClass({
     "new-promises": {
       type: "new-promises",
       data: Arg(0, "array:ObjectActor"),
+    },
+    // Event emitted for promise settlements.
+    "promises-settled": {
+      type: "promises-settled",
+      data: Arg(0, "array:ObjectActor")
     }
   },
 
@@ -47,6 +52,7 @@ let PromisesActor = protocol.ActorClass({
     this._gripDepth = 0;
     this._navigationLifetimePool = null;
     this._newPromises = null;
+    this._promisesSettled = null;
 
     this.objectGrip = this.objectGrip.bind(this);
     this._makePromiseEventHandler = this._makePromiseEventHandler.bind(this);
@@ -78,6 +84,7 @@ let PromisesActor = protocol.ActorClass({
     this.conn.addActorPool(this._navigationLifetimePool);
 
     this._newPromises = [];
+    this._promisesSettled = [];
 
     events.on(this.parent, "window-ready", this._onWindowReady);
 
@@ -95,6 +102,7 @@ let PromisesActor = protocol.ActorClass({
     this.dbg.enabled = false;
     this._dbg = null;
     this._newPromises = null;
+    this._promisesSettled = null;
 
     if (this._navigationLifetimePool) {
       this.conn.removeActorPool(this._navigationLifetimePool);
@@ -163,8 +171,12 @@ let PromisesActor = protocol.ActorClass({
    */
   listPromises: method(function() {
     let promises = this.dbg.findObjects({ class: "Promise" });
+
     this.dbg.onNewPromise = this._makePromiseEventHandler(this._newPromises,
       "new-promises");
+    this.dbg.onPromiseSettled = this._makePromiseEventHandler(
+      this._promisesSettled, "promises-settled");
+
     return promises.map(p => this._createObjectActorForPromise(p));
   }, {
     request: {

toolkit/devtools/server/tests/unit/test_promises_actor_onpromisesettled.js

@@ -0,0 +1,83 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+/**
+ * Test that we can get the list of Promise objects that have settled from the
+ * PromisesActor onPromiseSettled event handler.
+ */
+
+"use strict";
+
+const { PromisesFront } = devtools.require("devtools/server/actors/promises");
+
+let events = devtools.require("sdk/event/core");
+
+add_task(function*() {
+  let client = yield startTestDebuggerServer("promises-actor-test");
+  let chromeActors = yield getChromeActors(client);
+
+  ok(Promise.toString().contains("native code"), "Expect native DOM Promise");
+
+  yield testPromisesSettled(client, chromeActors,
+    v => new Promise(resolve => resolve(v)),
+    v => new Promise((resolve, reject) => reject(v)));
+
+  let response = yield listTabs(client);
+  let targetTab = findTab(response.tabs, "promises-actor-test");
+  ok(targetTab, "Found our target tab.");
+
+  yield testPromisesSettled(client, targetTab, v => {
+    const debuggee = DebuggerServer.getTestGlobal("promises-actor-test");
+    return debuggee.Promise.resolve(v);
+  }, v => {
+    const debuggee = DebuggerServer.getTestGlobal("promises-actor-test");
+    return debuggee.Promise.reject(v);
+  });
+
+  yield close(client);
+});
+
+function* testPromisesSettled(client, form, makeResolvePromise,
+    makeRejectPromise) {
+  let front = PromisesFront(client, form);
+  let resolution = "MyLittleSecret" + Math.random();
+
+  yield front.attach();
+  yield front.listPromises();
+
+  let onPromiseSettled = oncePromiseSettled(front, resolution, true, false);
+  let resolvedPromise = makeResolvePromise(resolution);
+  let foundResolvedPromise = yield onPromiseSettled;
+  ok(foundResolvedPromise, "Found our resolved promise");
+
+  onPromiseSettled = oncePromiseSettled(front, resolution, false, true);
+  let rejectedPromise = makeRejectPromise(resolution);
+  let foundRejectedPromise = yield onPromiseSettled;
+  ok(foundRejectedPromise, "Found our rejected promise");
+
+  yield front.detach();
+  // Appease eslint
+  void resolvedPromise;
+  void rejectedPromise;
+}
+
+function oncePromiseSettled(front, resolution, resolveValue, rejectValue) {
+  return new Promise(resolve => {
+    events.on(front, "promises-settled", promises => {
+      for (let p of promises) {
+        equal(p.type, "object", "Expect type to be Object");
+        equal(p.class, "Promise", "Expect class to be Promise");
+
+        if (p.promiseState.state === "fulfilled" &&
+            p.promiseState.value === resolution) {
+          resolve(resolveValue);
+        } else if (p.promiseState.state === "rejected" &&
+                   p.promiseState.reason === resolution) {
+          resolve(rejectValue);
+        } else {
+          dump("Found non-target promise\n");
+        }
+      }
+    });
+  });
+}

toolkit/devtools/server/tests/unit/xpcshell.ini

@@ -84,6 +84,7 @@ support-files =
 [test_promises_actor_exist.js]
 [test_promises_actor_list_promises.js]
 [test_promises_actor_onnewpromise.js]
+[test_promises_actor_onpromisesettled.js]
 [test_protocol_abort.js]
 [test_protocol_async.js]
 [test_protocol_children.js]