summaryrefslogtreecommitdiffstats
path: root/devtools/client/webconsole/enhancers/actor-releaser.js
blob: 30232c232aeaeff40fd629047a46a06802e2229d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

const {
  MESSAGES_ADD,
  MESSAGES_CLEAR,
  PRIVATE_MESSAGES_CLEAR,
  FRONTS_TO_RELEASE_CLEAR,
} = require("resource://devtools/client/webconsole/constants.js");

/**
 * This enhancer is responsible for releasing actors on the backend.
 * When messages with arguments are removed from the store we should also
 * clean up the backend.
 */
function enableActorReleaser(webConsoleUI) {
  return next => (reducer, initialState, enhancer) => {
    function releaseActorsEnhancer(state, action) {
      state = reducer(state, action);

      const { type } = action;
      if (
        webConsoleUI &&
        [MESSAGES_ADD, MESSAGES_CLEAR, PRIVATE_MESSAGES_CLEAR].includes(type)
      ) {
        const promises = [];
        state.messages.frontsToRelease.forEach(front => {
          // We only release the front if it actually has a release method, if it isn't
          // already destroyed, and if it's not in the sidebar (where we might still need it).
          if (
            front &&
            typeof front.release === "function" &&
            !front.isDestroyed() &&
            (!state.ui.frontInSidebar ||
              state.ui.frontInSidebar.actorID !== front.actorID)
          ) {
            promises.push(front.release());
          }
        });

        // Emit an event we can listen to to make sure all the fronts were released.
        Promise.all(promises).then(() =>
          webConsoleUI.emitForTests("fronts-released")
        );

        // Reset `frontsToRelease` in message reducer.
        state = reducer(state, {
          type: FRONTS_TO_RELEASE_CLEAR,
        });
      }

      return state;
    }

    return next(releaseActorsEnhancer, initialState, enhancer);
  };
}

module.exports = enableActorReleaser;