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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
"use strict";
/* eslint-disable mozilla/balanced-listeners */
const server = createHttpServer({ hosts: ["example.com", "example.org"] });
server.registerPathHandler("/dummy", (request, response) => {
response.setStatusLine(request.httpVersion, 200, "OK");
response.setHeader("Content-Type", "text/html", false);
response.write("<!DOCTYPE html><html></html>");
});
function loadExtension() {
function contentScript() {
browser.test.sendMessage("content-script-ready");
window.addEventListener(
"pagehide",
() => {
browser.test.sendMessage("content-script-hide");
},
true
);
window.addEventListener("pageshow", () => {
browser.test.sendMessage("content-script-show");
});
}
return ExtensionTestUtils.loadExtension({
manifest: {
content_scripts: [
{
matches: ["http://example.com/dummy*"],
js: ["content_script.js"],
run_at: "document_start",
},
],
},
files: {
"content_script.js": contentScript,
},
});
}
add_task(async function test_contentscript_context() {
let extension = loadExtension();
await extension.startup();
let contentPage = await ExtensionTestUtils.loadContentPage(
"http://example.com/dummy"
);
await extension.awaitMessage("content-script-ready");
await extension.awaitMessage("content-script-show");
// Get the content script context and check that it points to the correct window.
await contentPage.legacySpawn(extension.id, async extensionId => {
const { ExtensionContent } = ChromeUtils.importESModule(
"resource://gre/modules/ExtensionContent.sys.mjs"
);
this.context = ExtensionContent.getContextByExtensionId(
extensionId,
this.content
);
Assert.ok(this.context, "Got content script context");
Assert.equal(
this.context.contentWindow,
this.content,
"Context's contentWindow property is correct"
);
// Navigate so that the content page is hidden in the bfcache.
this.content.location = "http://example.org/dummy";
});
await extension.awaitMessage("content-script-hide");
await contentPage.legacySpawn(null, async () => {
Assert.equal(
this.context.contentWindow,
null,
"Context's contentWindow property is null"
);
// Navigate back so the content page is resurrected from the bfcache.
this.content.history.back();
});
await extension.awaitMessage("content-script-show");
await contentPage.legacySpawn(null, async () => {
Assert.equal(
this.context.contentWindow,
this.content,
"Context's contentWindow property is correct"
);
});
await contentPage.close();
await extension.awaitMessage("content-script-hide");
await extension.unload();
});
add_task(async function test_contentscript_context_incognito_not_allowed() {
async function background() {
await browser.contentScripts.register({
js: [{ file: "registered_script.js" }],
matches: ["http://example.com/dummy"],
runAt: "document_start",
});
browser.test.sendMessage("background-ready");
}
let extension = ExtensionTestUtils.loadExtension({
manifest: {
content_scripts: [
{
matches: ["http://example.com/dummy"],
js: ["content_script.js"],
run_at: "document_start",
},
],
permissions: ["http://example.com/*"],
},
background,
files: {
"content_script.js": () => {
browser.test.notifyFail("content_script_loaded");
},
"registered_script.js": () => {
browser.test.notifyFail("registered_script_loaded");
},
},
});
// Bug 1715801: Re-enable pbm portion on GeckoView
if (AppConstants.platform == "android") {
Services.prefs.setBoolPref("dom.security.https_first_pbm", false);
}
await extension.startup();
await extension.awaitMessage("background-ready");
let contentPage = await ExtensionTestUtils.loadContentPage(
"http://example.com/dummy",
{ privateBrowsing: true }
);
await contentPage.legacySpawn(extension.id, async extensionId => {
const { ExtensionContent } = ChromeUtils.importESModule(
"resource://gre/modules/ExtensionContent.sys.mjs"
);
let context = ExtensionContent.getContextByExtensionId(
extensionId,
this.content
);
Assert.equal(
context,
null,
"Extension unable to use content_script in private browsing window"
);
});
await contentPage.close();
await extension.unload();
// Bug 1715801: Re-enable pbm portion on GeckoView
if (AppConstants.platform == "android") {
Services.prefs.clearUserPref("dom.security.https_first_pbm");
}
});
add_task(async function test_contentscript_context_unload_while_in_bfcache() {
let contentPage = await ExtensionTestUtils.loadContentPage(
"http://example.com/dummy?first"
);
let extension = loadExtension();
await extension.startup();
await extension.awaitMessage("content-script-ready");
// Get the content script context and check that it points to the correct window.
await contentPage.legacySpawn(extension.id, async extensionId => {
const { ExtensionContent } = ChromeUtils.importESModule(
"resource://gre/modules/ExtensionContent.sys.mjs"
);
// Save context so we can verify that contentWindow is nulled after unload.
this.context = ExtensionContent.getContextByExtensionId(
extensionId,
this.content
);
Assert.equal(
this.context.contentWindow,
this.content,
"Context's contentWindow property is correct"
);
this.contextUnloadedPromise = new Promise(resolve => {
this.context.callOnClose({ close: resolve });
});
this.pageshownPromise = new Promise(resolve => {
this.content.addEventListener(
"pageshow",
() => {
// Yield to the event loop once more to ensure that all pageshow event
// handlers have been dispatched before fulfilling the promise.
let { setTimeout } = ChromeUtils.importESModule(
"resource://gre/modules/Timer.sys.mjs"
);
setTimeout(resolve, 0);
},
{ once: true, mozSystemGroup: true }
);
});
// Navigate so that the content page is hidden in the bfcache.
this.content.location = "http://example.org/dummy?second";
});
await extension.awaitMessage("content-script-hide");
await extension.unload();
await contentPage.legacySpawn(null, async () => {
await this.contextUnloadedPromise;
Assert.equal(this.context.unloaded, true, "Context has been unloaded");
// Normally, when a page is not in the bfcache, context.contentWindow is
// not null when the callOnClose handler is invoked (this is checked by the
// previous subtest).
// Now wait a little bit and check again to ensure that the contentWindow
// property is not somehow restored.
await new Promise(resolve => this.content.setTimeout(resolve, 0));
Assert.equal(
this.context.contentWindow,
null,
"Context's contentWindow property is null"
);
// Navigate back so the content page is resurrected from the bfcache.
this.content.history.back();
await this.pageshownPromise;
Assert.equal(
this.context.contentWindow,
null,
"Context's contentWindow property is null after restore from bfcache"
);
});
await contentPage.close();
});
add_task(async function test_contentscript_context_valid_during_execution() {
// This test does the following:
// - Load page
// - Load extension; inject content script.
// - Navigate page; pagehide triggered.
// - Navigate back; pageshow triggered.
// - Close page; pagehide, unload triggered.
// At each of these last four events, the validity of the context is checked.
function contentScript() {
browser.test.sendMessage("content-script-ready");
window.wrappedJSObject.checkContextIsValid("Context is valid on execution");
window.addEventListener(
"pagehide",
() => {
window.wrappedJSObject.checkContextIsValid(
"Context is valid on pagehide"
);
browser.test.sendMessage("content-script-hide");
},
true
);
window.addEventListener("pageshow", () => {
window.wrappedJSObject.checkContextIsValid(
"Context is valid on pageshow"
);
// This unload listener is registered after pageshow, to ensure that the
// page can be stored in the bfcache at the previous pagehide.
window.addEventListener("unload", () => {
window.wrappedJSObject.checkContextIsValid(
"Context is valid on unload"
);
browser.test.sendMessage("content-script-unload");
});
browser.test.sendMessage("content-script-show");
});
}
let extension = ExtensionTestUtils.loadExtension({
manifest: {
content_scripts: [
{
matches: ["http://example.com/dummy*"],
js: ["content_script.js"],
},
],
},
files: {
"content_script.js": contentScript,
},
});
let contentPage = await ExtensionTestUtils.loadContentPage(
"http://example.com/dummy?first"
);
await contentPage.legacySpawn(extension.id, async extensionId => {
let context;
let checkContextIsValid = description => {
if (!context) {
const { ExtensionContent } = ChromeUtils.importESModule(
"resource://gre/modules/ExtensionContent.sys.mjs"
);
context = ExtensionContent.getContextByExtensionId(
extensionId,
this.content
);
}
Assert.equal(
context.contentWindow,
this.content,
`${description}: contentWindow`
);
Assert.equal(context.active, true, `${description}: active`);
};
Cu.exportFunction(checkContextIsValid, this.content, {
defineAs: "checkContextIsValid",
});
});
await extension.startup();
await extension.awaitMessage("content-script-ready");
await contentPage.legacySpawn(extension.id, async extensionId => {
// Navigate so that the content page is frozen in the bfcache.
this.content.location = "http://example.org/dummy?second";
});
await extension.awaitMessage("content-script-hide");
await contentPage.legacySpawn(null, async () => {
// Navigate back so the content page is resurrected from the bfcache.
this.content.history.back();
});
await extension.awaitMessage("content-script-show");
await contentPage.close();
await extension.awaitMessage("content-script-hide");
await extension.awaitMessage("content-script-unload");
await extension.unload();
});
|
