summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/mochitest/test_ext_webrequest_worker.html
blob: 9fc3e00f015f6f3b25aa11f8bb3875b2ec9032fd (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<!DOCTYPE HTML>

<html>
<head>
<meta charset="utf-8">
  <script src="/tests/SimpleTest/SimpleTest.js"></script>
  <script src="/tests/SimpleTest/ExtensionTestUtils.js"></script>
  <script type="text/javascript" src="head_webrequest.js"></script>
  <script type="text/javascript" src="head.js"></script>
  <link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css"/>
<script>
"use strict";

let tabId;

let extensionData = {
  manifest: {
    permissions: ["webRequest", "webRequestBlocking", "<all_urls>", "tabs"],
  },
  background() {
    browser.webRequest.onBeforeRequest.addListener(details => {
      if (details.url.endsWith("/favicon.ico")) {
        // We don't care about favicon.ico in this test. It is hard to control
        // whether the request happens.
        browser.test.log(`Ignoring favicon request: ${details.url}`);
        return;
      }
      browser.test.sendMessage("onBeforeRequest", details);
    }, {urls: ["<all_urls>"]}, ["blocking"]);

    let tab;
    browser.tabs.onCreated.addListener(newTab => {
      tab = newTab;
      browser.test.sendMessage("tab-created", tab.id);
    });

    browser.test.onMessage.addListener(async (msg) => {
      if (msg === "close-tab") {
        await browser.tabs.remove(tab.id);
        browser.test.sendMessage("tab-closed");
      }
    });
  },
};

let expected = {
  "file_simple_webrequest_worker.html?topframe=true": {
    type: "main_frame",
    toplevel: true,
    origin: "test_ext_webrequest_worker.html",
    tabId: true,
    parentFrameId: -1,
  },
  "file_simple_iframe_worker.html": {
    type: "sub_frame",
    toplevel: false,
    origin: "file_simple_webrequest_worker.html?topframe=true",
    tabId: true,
    parentFrameId: 0,
  },
  "file_simple_toplevel.txt": {
    type: "xmlhttprequest",
    toplevel: true,
    origin: "file_simple_webrequest_worker.html?topframe=true",
    tabId: true,
    parentFrameId: -1,
  },
  "file_simple_iframe.txt": {
    type: "xmlhttprequest",
    toplevel: false,
    origin: "file_simple_iframe_worker.html",
    tabId: true,
    parentFrameId: 0,
  },
  "file_simple_worker.txt": {
    type: "xmlhttprequest",
    toplevel: true,
    origin: "file_simple_worker.js",
    tabId: true,
    parentFrameId: -1,
  },
  "file_simple_iframe_worker.txt": {
    type: "xmlhttprequest",
    toplevel: false,
    origin: "file_simple_worker.js?iniframe=true",
    tabId: true,
    parentFrameId: 0,
  },
  "file_simple_sharedworker.txt": {
    type: "xmlhttprequest",
    toplevel: undefined,
    origin: "file_simple_sharedworker.js",
    tabId: false,
    parentFrameId: -1,
  },
  "file_simple_iframe_sharedworker.txt": {
    type: "xmlhttprequest",
    toplevel: undefined,
    origin: "file_simple_sharedworker.js?iniframe=true",
    tabId: false,
    parentFrameId: -1,
  },
  "file_simple_worker.js": {
    type: "script",
    toplevel: true,
    origin: "file_simple_webrequest_worker.html?topframe=true",
    tabId: true,
    parentFrameId: -1,
  },
  "file_simple_sharedworker.js": {
    type: "script",
    toplevel: undefined,
    origin: "file_simple_webrequest_worker.html?topframe=true",
    tabId: false,
    parentFrameId: -1,
  },
  "file_simple_worker.js?iniframe=true": {
    type: "script",
    toplevel: false,
    origin: "file_simple_iframe_worker.html",
    tabId: true,
    parentFrameId: 0,
  },
  "file_simple_sharedworker.js?iniframe=true": {
    type: "script",
    toplevel: undefined,
    origin: "file_simple_iframe_worker.html",
    tabId: false,
    parentFrameId: -1,
  },


};

function checkDetails(details) {
  let filename = details.url.split("/").pop();
  ok(filename in expected, `Should be expecting a request for ${filename}`);
  let expect = expected[filename];
  is(expect.type, details.type, `${details.type} type matches`);
  const originUrlSuffix = details.originUrl?.split("/").pop();
  ok(expect.origin === originUrlSuffix || originUrlSuffix.startsWith(expect.origin), `origin url is correct`);
  is(details.parentFrameId, expect.parentFrameId, "parentFrameId matches");
  is(expect.tabId ? tabId : -1, details.tabId, "tabId matches");
  // TODO: When expect.toplevel is "undefined", the details.frameId is supposed
  // to be -1.
  // details in https://phabricator.services.mozilla.com/D182705#inline-1030548.
  if (expect.toplevel === undefined || expect.toplevel) {
    is(details.frameId, 0, "expect zero frameId");
  } else {
    ok(details.frameId > 0, "expect non-zero frameId");
  }
  return filename;
}

add_task(async function test_webRequest_worker() {
  await SpecialPowers.spawnChrome([], async () => {
    Services.cache2.clear();
  });

  let extension = ExtensionTestUtils.loadExtension(extensionData);
  await extension.startup();

  let a = addLink(`file_simple_webrequest_worker.html?topframe=true`);
  a.click();
  tabId = await extension.awaitMessage("tab-created");
  info(`Get created tab(${tabId}`);

  let remaining = new Set(Object.keys(expected));
  let totalExpectedCount = remaining.size;
  let currentExpectedCount = 0;
  while (remaining.size !== 0) {
    info(`Waiting for request ${currentExpectedCount + 1} out of ${totalExpectedCount}`);
    info(`Expecting one of: ${Array.from(remaining)}`);
    let details = await extension.awaitMessage("onBeforeRequest");
    info(`Checking details for request: ${JSON.stringify(details)}`);
    let filename = checkDetails(details);
    ok(remaining.delete(filename), `Got only one request for ${filename}`);
    currentExpectedCount = currentExpectedCount + 1;
  }

  extension.sendMessage("close-tab");
  await extension.awaitMessage("tab-closed");
  await extension.unload();
});

</script>
</head>
<body>
<div id="test">Sample text</div>

</body>
</html>