summaryrefslogtreecommitdiffstats
path: root/devtools/client/shared/redux/create-store.js
blob: b523b7674783bf58774a19abf564439813d5554d (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/* 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 {
  combineReducers,
  createStore,
  applyMiddleware,
} = require("devtools/client/shared/vendor/redux");
const { thunk } = require("devtools/client/shared/redux/middleware/thunk");
const {
  waitUntilService,
} = require("devtools/client/shared/redux/middleware/wait-service");
const { task } = require("devtools/client/shared/redux/middleware/task");
const { promise } = require("devtools/client/shared/redux/middleware/promise");
const flags = require("devtools/shared/flags");

loader.lazyRequireGetter(
  this,
  "history",
  "devtools/client/shared/redux/middleware/history",
  true
);
loader.lazyRequireGetter(
  this,
  "log",
  "devtools/client/shared/redux/middleware/log",
  true
);

/**
 * This creates a dispatcher with all the standard middleware in place
 * that all code requires. It can also be optionally configured in
 * various ways, such as logging and recording.
 *
 * @param {object} opts:
 *        - enableTaskMiddleware: if true, include the task middleware
 *        - log: log all dispatched actions to console
 *        - history: an array to store every action in. Should only be used in tests.
 *        - middleware: array of middleware to be included in the redux store
 *        - thunkOptions: object that will be spread within a {dispatch, getState} object,
 *                        that will be passed in each thunk action.
 */
const createStoreWithMiddleware = (opts = {}) => {
  const middleware = [];
  if (opts.enableTaskMiddleware) {
    middleware.push(task);
  }
  middleware.push(
    thunk(opts.thunkOptions),
    promise,

    // Order is important: services must go last as they always
    // operate on "already transformed" actions. Actions going through
    // them shouldn't have any special fields like promises, they
    // should just be normal JSON objects.
    waitUntilService
  );

  if (opts.history) {
    middleware.push(history(opts.history));
  }

  if (opts.middleware) {
    opts.middleware.forEach(fn => middleware.push(fn));
  }

  if (opts.log) {
    middleware.push(log);
  }

  return applyMiddleware(...middleware)(createStore);
};

module.exports = (
  reducers,
  {
    shouldLog = false,
    initialState = undefined,
    thunkOptions,
    enableTaskMiddleware = false,
  } = {}
) => {
  const reducer =
    typeof reducers === "function" ? reducers : combineReducers(reducers);

  let historyEntries;

  // If testing, store the action history in an array
  // we'll later attach to the store
  if (flags.testing) {
    historyEntries = [];
  }

  const store = createStoreWithMiddleware({
    enableTaskMiddleware,
    log: flags.testing && shouldLog,
    history: historyEntries,
    thunkOptions,
  })(reducer, initialState);

  if (history) {
    store.history = historyEntries;
  }

  return store;
};