summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/xpcshell/test_webRequest_filtering.js
blob: 86b2410e33e8913f00d08830e2c5cf6ad3c90a07 (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
"use strict";

var { WebRequest } = ChromeUtils.importESModule(
  "resource://gre/modules/WebRequest.sys.mjs"
);

var { ExtensionParent } = ChromeUtils.importESModule(
  "resource://gre/modules/ExtensionParent.sys.mjs"
);

const server = createHttpServer({ hosts: ["example.com"] });
server.registerDirectory("/data/", do_get_file("data"));

const BASE = "http://example.com/data/";
const URL = BASE + "/file_WebRequest_page2.html";

var requested = [];

function onBeforeRequest(details) {
  info(`onBeforeRequest ${details.url}`);
  if (details.url.startsWith(BASE)) {
    requested.push(details.url);
  }
}

var sendHeaders = [];

function onBeforeSendHeaders(details) {
  info(`onBeforeSendHeaders ${details.url}`);
  if (details.url.startsWith(BASE)) {
    sendHeaders.push(details.url);
  }
}

var completed = [];

function onResponseStarted(details) {
  if (details.url.startsWith(BASE)) {
    completed.push(details.url);
  }
}

const expected_urls = [
  BASE + "/file_style_good.css",
  BASE + "/file_style_bad.css",
  BASE + "/file_style_redirect.css",
];

function resetExpectations() {
  requested.length = 0;
  sendHeaders.length = 0;
  completed.length = 0;
}

function removeDupes(list) {
  let j = 0;
  for (let i = 1; i < list.length; i++) {
    if (list[i] != list[j]) {
      j++;
      if (i != j) {
        list[j] = list[i];
      }
    }
  }
  list.length = j + 1;
}

function compareLists(list1, list2, kind) {
  list1.sort();
  removeDupes(list1);
  list2.sort();
  removeDupes(list2);
  equal(String(list1), String(list2), `${kind} URLs correct`);
}

async function openAndCloseContentPage() {
  let contentPage = await ExtensionTestUtils.loadContentPage(URL);
  // Clear the sheet cache so that it doesn't interact with following tests: A
  // stylesheet with the same URI loaded from the same origin doesn't otherwise
  // guarantee that onBeforeRequest and so on happen, because it may not need
  // to go through necko at all.
  await contentPage.spawn([], () =>
    content.windowUtils.clearSharedStyleSheetCache()
  );
  await contentPage.close();
}

add_task(async function setup() {
  // Disable rcwn to make cache behavior deterministic.
  Services.prefs.setBoolPref("network.http.rcwn.enabled", false);

  // When WebRequest.sys.mjs is used directly instead of through ext-webRequest.js,
  // ExtensionParent.apiManager is not automatically initialized. Do it here.
  await ExtensionParent.apiManager.lazyInit();
});

add_task(async function filter_urls() {
  let filter = { urls: new MatchPatternSet(["*://*/*_style_*"]) };

  WebRequest.onBeforeRequest.addListener(onBeforeRequest, filter, ["blocking"]);
  WebRequest.onBeforeSendHeaders.addListener(onBeforeSendHeaders, filter, [
    "blocking",
  ]);
  WebRequest.onResponseStarted.addListener(onResponseStarted, filter);

  await openAndCloseContentPage(URL);

  compareLists(requested, expected_urls, "requested");
  compareLists(sendHeaders, expected_urls, "sendHeaders");
  compareLists(completed, expected_urls, "completed");

  WebRequest.onBeforeRequest.removeListener(onBeforeRequest);
  WebRequest.onBeforeSendHeaders.removeListener(onBeforeSendHeaders);
  WebRequest.onResponseStarted.removeListener(onResponseStarted);
});

add_task(async function filter_types() {
  resetExpectations();
  let filter = { types: ["stylesheet"] };

  WebRequest.onBeforeRequest.addListener(onBeforeRequest, filter, ["blocking"]);
  WebRequest.onBeforeSendHeaders.addListener(onBeforeSendHeaders, filter, [
    "blocking",
  ]);
  WebRequest.onResponseStarted.addListener(onResponseStarted, filter);

  await openAndCloseContentPage(URL);

  compareLists(requested, expected_urls, "requested");
  compareLists(sendHeaders, expected_urls, "sendHeaders");
  compareLists(completed, expected_urls, "completed");

  WebRequest.onBeforeRequest.removeListener(onBeforeRequest);
  WebRequest.onBeforeSendHeaders.removeListener(onBeforeSendHeaders);
  WebRequest.onResponseStarted.removeListener(onResponseStarted);
});

add_task(async function filter_windowId() {
  resetExpectations();
  // Check that adding windowId will exclude non-matching requests.
  // test_ext_webrequest_filter.html provides coverage for matching requests.
  let filter = { urls: new MatchPatternSet(["*://*/*_style_*"]), windowId: 0 };

  WebRequest.onBeforeRequest.addListener(onBeforeRequest, filter, ["blocking"]);
  WebRequest.onBeforeSendHeaders.addListener(onBeforeSendHeaders, filter, [
    "blocking",
  ]);
  WebRequest.onResponseStarted.addListener(onResponseStarted, filter);

  await openAndCloseContentPage(URL);

  compareLists(requested, [], "requested");
  compareLists(sendHeaders, [], "sendHeaders");
  compareLists(completed, [], "completed");

  WebRequest.onBeforeRequest.removeListener(onBeforeRequest);
  WebRequest.onBeforeSendHeaders.removeListener(onBeforeSendHeaders);
  WebRequest.onResponseStarted.removeListener(onResponseStarted);
});

add_task(async function filter_tabId() {
  resetExpectations();
  // Check that adding tabId will exclude non-matching requests.
  // test_ext_webrequest_filter.html provides coverage for matching requests.
  let filter = { urls: new MatchPatternSet(["*://*/*_style_*"]), tabId: 0 };

  WebRequest.onBeforeRequest.addListener(onBeforeRequest, filter, ["blocking"]);
  WebRequest.onBeforeSendHeaders.addListener(onBeforeSendHeaders, filter, [
    "blocking",
  ]);
  WebRequest.onResponseStarted.addListener(onResponseStarted, filter);

  await openAndCloseContentPage(URL);

  compareLists(requested, [], "requested");
  compareLists(sendHeaders, [], "sendHeaders");
  compareLists(completed, [], "completed");

  WebRequest.onBeforeRequest.removeListener(onBeforeRequest);
  WebRequest.onBeforeSendHeaders.removeListener(onBeforeSendHeaders);
  WebRequest.onResponseStarted.removeListener(onResponseStarted);
});