summaryrefslogtreecommitdiffstats
path: root/devtools/shared/indexed-db.js
blob: a4ea57c76f5c88e6ddf27e8624348566a93bdc45 (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
/* 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";

/**
 * This indexedDB helper is a simplified version of sdk/indexed-db. It creates a DB with
 * a principal dedicated to DevTools.
 */

// When running in jest, we can't use Cu.Sandbox and only expose the native indexedDB object
if (globalThis.indexedDB) {
  module.exports = globalThis.indexedDB;
} else {
  const PSEUDOURI = "indexeddb://fx-devtools";
  const principaluri = Services.io.newURI(PSEUDOURI);
  const principal = Services.scriptSecurityManager.createContentPrincipal(
    principaluri,
    {}
  );

  // indexedDB is only exposed to document globals.
  // We are retrieving an instance from a Sandbox, which has to be loaded
  // from the system principal in order to avoid having wrappers around
  // all indexed DB objects.
  const systemPrincipal = Services.scriptSecurityManager.getSystemPrincipal();
  const sandbox = Cu.Sandbox(systemPrincipal, {
    wantGlobalProperties: ["indexedDB"],
  });
  const { indexedDB } = sandbox;

  module.exports = Object.freeze({
    /**
     * Only the standard version of indexedDB.open is supported.
     */
    open(name, version) {
      const options = {};
      if (typeof version === "number") {
        options.version = version;
      }
      return indexedDB.openForPrincipal(principal, name, options);
    },

    /**
     * Only the standard version of indexedDB.deleteDatabase is supported.
     */
    deleteDatabase(name) {
      return indexedDB.deleteForPrincipal(principal, name);
    },

    cmp: indexedDB.cmp.bind(indexedDB),
  });
}