summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/test/browser/browser_ext_devtools_optional.js
blob: 54ca061c67fd9b98d283d43cdd60d2799266db0b (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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";

loadTestSubscript("head_devtools.js");

/**
 * This test file ensures that:
 *
 * - "devtools" permission can be used as an optional permission
 * - the extension devtools page and panels are not disabled/enabled on changes
 *   to unrelated optional permissions.
 */
add_task(async function test_devtools_optional_permission() {
  Services.prefs.setBoolPref(
    "extensions.webextOptionalPermissionPrompts",
    false
  );
  registerCleanupFunction(() => {
    Services.prefs.clearUserPref("extensions.webextOptionalPermissionPrompts");
  });

  let tab = await BrowserTestUtils.openNewForegroundTab(
    gBrowser,
    "http://mochi.test:8888/"
  );

  function background() {
    browser.test.onMessage.addListener(async (msg, perm) => {
      if (msg === "request") {
        let granted = await new Promise(resolve => {
          browser.test.withHandlingUserInput(() => {
            resolve(browser.permissions.request(perm));
          });
        });
        browser.test.assertTrue(granted, "permission request succeeded");
        browser.test.sendMessage("done");
      } else if (msg === "revoke") {
        await browser.permissions.remove(perm);
        browser.test.sendMessage("done");
      }
    });
  }

  function devtools_page() {
    browser.test.sendMessage("devtools_page_loaded");
  }

  let extension = ExtensionTestUtils.loadExtension({
    background,
    manifest: {
      optional_permissions: ["devtools", "*://mochi.test/*"],
      devtools_page: "devtools_page.html",
    },
    files: {
      "devtools_page.html": `<!DOCTYPE html>
        <html>
          <head>
            <meta charset="utf-8">
          </head>
          <body>
            <script src="devtools_page.js"></script>
          </body>
        </html>`,
      "devtools_page.js": devtools_page,
    },
  });

  await extension.startup();

  function checkEnabled(expect = false, { expectIsUserSet = true } = {}) {
    const prefName = `devtools.webextensions.${extension.id}.enabled`;
    Assert.equal(
      expect,
      Services.prefs.getBoolPref(prefName, false),
      `Got the expected value set on pref ${prefName}`
    );

    Assert.equal(
      expectIsUserSet,
      Services.prefs.prefHasUserValue(prefName),
      `pref "${prefName}" ${
        expectIsUserSet ? "should" : "should not"
      } be user set`
    );
  }

  checkEnabled(false, { expectIsUserSet: false });

  // Open the devtools first, then request permission
  info("Open the developer toolbox");
  await openToolboxForTab(tab);
  assertDevToolsExtensionEnabled(extension.uuid, false);

  info(
    "Request unrelated permission, expect devtools page and panel to be disabled"
  );
  extension.sendMessage("request", {
    permissions: [],
    origins: ["*://mochi.test/*"],
  });
  await extension.awaitMessage("done");
  checkEnabled(false, { expectIsUserSet: false });

  info(
    "Request devtools permission, expect devtools page and panel to be enabled"
  );
  extension.sendMessage("request", {
    permissions: ["devtools"],
    origins: [],
  });
  await extension.awaitMessage("done");
  checkEnabled(true);

  info("Wait the devtools page load");
  await extension.awaitMessage("devtools_page_loaded");
  assertDevToolsExtensionEnabled(extension.uuid, true);

  info(
    "Revoke unrelated permission, expect devtools page and panel to stay enabled"
  );
  extension.sendMessage("revoke", {
    permissions: [],
    origins: ["*://mochi.test/*"],
  });
  await extension.awaitMessage("done");
  checkEnabled(true);

  info(
    "Revoke devtools permission, expect devtools page and panel to be destroyed"
  );
  let policy = WebExtensionPolicy.getByID(extension.id);
  let closed = new Promise(resolve => {
    // eslint-disable-next-line mozilla/balanced-listeners
    policy.extension.on("devtools-page-shutdown", resolve);
  });

  extension.sendMessage("revoke", {
    permissions: ["devtools"],
    origins: [],
  });
  await extension.awaitMessage("done");

  await closed;
  checkEnabled(false);
  assertDevToolsExtensionEnabled(extension.uuid, false);

  info("Close the developer toolbox");
  await closeToolboxForTab(tab);

  extension.sendMessage("request", {
    permissions: ["devtools"],
    origins: [],
  });
  await extension.awaitMessage("done");

  info("Open the developer toolbox");
  openToolboxForTab(tab);

  checkEnabled(true);

  info("Wait the devtools page load");
  await extension.awaitMessage("devtools_page_loaded");
  assertDevToolsExtensionEnabled(extension.uuid, true);
  await extension.unload();

  await closeToolboxForTab(tab);
  BrowserTestUtils.removeTab(tab);
});