Bug 1417439 - Release actors when message are pruned due to an MESSAGES_ADD action; r=Honza.

In Bug 1371721, we created a new action to batch our message addition into the store. Which means that messages can be pruned when using this action,
and implies releasing server actors.

But, at the moment, we only do that when we use the MESSAGE_ADD action.
This wasn't caught by tests because they explicitly use the MESSAGE_ADD action.

This patch makes the console release actors in reaction to a MESSAGES_ADD
action and add a test to make sure we handle this as expected.

MozReview-Commit-ID: FfgvmKi9nM9

--HG--
extra : rebase_source : a0416fd911699dac7addb37fffc42aa61d8824a5

devtools/client/webconsole/new-console-output/store.js

@@ -18,6 +18,7 @@ const {
 const {
   MESSAGE_ADD,
   MESSAGE_OPEN,
+  MESSAGES_ADD,
   MESSAGES_CLEAR,
   REMOVED_ACTORS_CLEAR,
   NETWORK_MESSAGE_UPDATE,
@@ -132,7 +133,7 @@ function enableActorReleaser(hud) {
 
       let type = action.type;
       let proxy = hud ? hud.proxy : null;
-      if (proxy && (type == MESSAGE_ADD || type == MESSAGES_CLEAR)) {
+      if (proxy && ([MESSAGE_ADD, MESSAGES_ADD, MESSAGES_CLEAR].includes(type))) {
         releaseActors(state.messages.removedActors, proxy);
 
         // Reset `removedActors` in message reducer.

devtools/client/webconsole/new-console-output/test/helpers.js

@@ -23,14 +23,11 @@ const {
 function setupActions() {
   // Some actions use dependency injection. This helps them avoid using state in
   // a hard-to-test way. We need to inject stubbed versions of these dependencies.
-  const wrappedActions = Object.assign({}, actions);
-
   const idGenerator = new IdGenerator();
-  wrappedActions.messageAdd = (packet) => {
-    return actions.messageAdd(packet, idGenerator);
-  };
-
-  return wrappedActions;
+  return Object.assign({}, actions, {
+    messageAdd: packet => actions.messageAdd(packet, idGenerator),
+    messagesAdd: packets => actions.messagesAdd(packets, idGenerator)
+  });
 }
 
 /**

devtools/client/webconsole/new-console-output/test/store/release-actors.test.js

@@ -23,7 +23,7 @@ describe("Release actor enhancer:", () => {
   });
 
   describe("Client proxy", () => {
-    it("properly releases backend actors when limit is reached", () => {
+    it("releases backend actors when limit reached adding a single message", () => {
       const logLimit = 100;
       let releasedActors = [];
       const { dispatch, getState } = setupStore([], {
@@ -63,6 +63,54 @@ describe("Release actor enhancer:", () => {
       expect(releasedActors).toInclude(thirdMessageActor);
     });
 
+    it("releases backend actors when limit reached adding multiple messages", () => {
+      const logLimit = 100;
+      let releasedActors = [];
+      const { dispatch, getState } = setupStore([], {
+        proxy: {
+          releaseActor: (actor) => {
+            releasedActors.push(actor);
+          }
+        }
+      }, { logLimit });
+
+      // Add a log message.
+      dispatch(actions.messageAdd(
+        stubPackets.get("console.log('myarray', ['red', 'green', 'blue'])")));
+
+      let messages = getAllMessagesById(getState());
+      const firstMessage = messages.first();
+      const firstMessageActor = firstMessage.parameters[1].actor;
+
+      // Add an evaluation result message (see Bug 1408321).
+      const evaluationResultPacket = stubPackets.get("new Date(0)");
+      dispatch(actions.messageAdd(evaluationResultPacket));
+      const secondMessageActor = evaluationResultPacket.result.actor;
+
+      // Add an assertion message.
+      const assertPacket = stubPackets.get("console.assert(false, {message: 'foobar'})");
+      dispatch(actions.messageAdd(assertPacket));
+      const thirdMessageActor = assertPacket.message.arguments[0].actor;
+
+      // Add ${logLimit} messages so we prune the ones we added before.
+      const packets = [];
+      // Alternate between 2 packets so we don't trigger the repeat message mechanism.
+      const oddPacket = stubPackets.get("console.log(undefined)");
+      const evenPacket = stubPackets.get("console.log('foobar', 'test')");
+      for (let i = 0; i < logLimit; i++) {
+        const packet = i % 2 === 0 ? evenPacket : oddPacket;
+        packets.push(packet);
+      }
+
+      // Add all the packets at once. This will prune the first 3 messages.
+      dispatch(actions.messagesAdd(packets));
+
+      expect(releasedActors.length).toBe(3);
+      expect(releasedActors).toInclude(firstMessageActor);
+      expect(releasedActors).toInclude(secondMessageActor);
+      expect(releasedActors).toInclude(thirdMessageActor);
+    });
+
     it("properly releases backend actors after clear", () => {
       let releasedActors = [];
       const { dispatch, getState } = setupStore([], {