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
|
"use strict";
// This test checks that the event page is awakened as expected when a
// extension messaging event is triggered.
// - onMessage / onConnect: triggered by the extension's own extension page.
// - onMessage / onConnect: triggered by the extension's own content script.
// - onMessageExternal / onConnectExternal: triggered by another extension.
//
// Note: the behavior in persistent background scripts (at browser startup) is
// covered by test_ext_messaging_startup.js.
//
// These events delay suspend of the event page, which is partially verified by
// test_ext_eventpage_messaging.js.
const { ExtensionTestCommon } = ChromeUtils.importESModule(
"resource://testing-common/ExtensionTestCommon.sys.mjs"
);
const server = createHttpServer({ hosts: ["example.com"] });
server.registerPathHandler("/dummy", (request, response) => {
response.setStatusLine(request.httpVersion, 200, "OK");
response.setHeader("Content-Type", "text/html", false);
});
async function testEventPageWakeup({
backgroundScript,
triggerScript,
triggerFromContentScript = false, // default to calling from extension page.
triggerFromOtherExtension = false, // default to calling from own extension.
skipInitialPriming = false, // default to start+suspend before starting test.
}) {
function loadExtension(id, withBackground, withTrigger) {
let extensionData = {
manifest: { browser_specific_settings: { gecko: { id } } },
};
if (withBackground) {
extensionData.manifest.background = { persistent: false };
extensionData.background = backgroundScript;
if (skipInitialPriming) {
// Delay event page startup until an explicit event.
extensionData.startupReason = "APP_STARTUP";
// APP_STARTUP is not enough, delayedStartup is needed (bug 1756225).
extensionData.delayedStartup = true;
}
}
if (withTrigger) {
extensionData.files = {
"trigger.html": `<!DOCTYPE html><script src="trigger.js"></script>`,
"trigger.js": triggerScript,
};
if (triggerFromContentScript) {
// trigger.html unused, use content script instead:
extensionData.manifest.content_scripts = [
{
js: ["trigger.js"],
run_at: "document_end",
matches: ["http://example.com/dummy"],
},
];
}
}
return ExtensionTestUtils.loadExtension(extensionData);
}
await ExtensionTestCommon.resetStartupPromises();
// Event-triggered wakeup is blocked on browserPaintedPromise, so unblock it:
await ExtensionTestCommon.notifyEarlyStartup();
let extension = loadExtension("@ext", true, !triggerFromOtherExtension);
await extension.startup();
if (!skipInitialPriming) {
// Default test behavior is ADDON_INSTALL, which starts up the background.
Assert.equal(extension.extension.backgroundState, "running", "Bg started");
// Not strictly needed because the background has already started. But to
// more closely match reality, flag as fully started.
await ExtensionTestCommon.notifyLateStartup();
// Suspend event page so we can verify that it wakes up by triggerScript.
await extension.terminateBackground();
Assert.equal(extension.extension.backgroundState, "stopped", "Bg closed");
} else {
// Event page initially suspended, waiting for event.
Assert.equal(extension.extension.backgroundState, "stopped", "Bg inactive");
}
let extension2;
if (triggerFromOtherExtension) {
extension2 = loadExtension("@other-ext", false, true);
await extension2.startup();
}
let url;
if (triggerFromContentScript) {
url = "http://example.com/dummy";
} else if (triggerFromOtherExtension) {
url = `moz-extension://${extension2.uuid}/trigger.html`;
} else {
url = `moz-extension://${extension.uuid}/trigger.html`;
}
let contentPage = await ExtensionTestUtils.loadContentPage(url);
info("Waiting for event page to be awakened by event");
await extension.awaitMessage("TRIGGER_TEST_DONE");
// Unload test extensions first to avoid an issue on Windows platforms.
await extension.unload();
if (triggerFromOtherExtension) {
await extension2.unload();
}
await contentPage.close();
}
add_task(async function test_sendMessage_without_onMessage() {
await testEventPageWakeup({
backgroundScript() {
// No runtime.onMessage listener here.
},
async triggerScript() {
browser.test.assertTrue(
!browser.extension.getBackgroundPage(),
"Event page suspended before sendMessage()"
);
await browser.test.assertRejects(
browser.runtime.sendMessage(""),
"Could not establish connection. Receiving end does not exist.",
"sendMessage without onMessage should reject"
);
browser.test.assertTrue(
// TODO bug 1852317: This should be "!" instead of "!!", i.e. the event
// page should not wake up.
!!browser.extension.getBackgroundPage(),
"Existence of event page after sendMessage()"
);
browser.test.sendMessage("TRIGGER_TEST_DONE");
},
// For completeness, start background before suspending. This makes sure
// that if the persistent listener mechanism is used for runtime.onMessage,
// that we have started the background at least once to enable the
// framework to detect (the lack of) persistent listeners, so that it can
// know that waking the event page doesn't make a difference.
// (note: persistent listeners are currently not used here: bug 1852317)
skipInitialPriming: false,
});
});
add_task(async function test_connect_without_onConnect() {
await testEventPageWakeup({
backgroundScript() {
// No runtime.onConnect listener here.
},
triggerScript() {
browser.test.assertTrue(
!browser.extension.getBackgroundPage(),
"Event page suspended before sendMessage()"
);
let port = browser.runtime.connect({});
port.onDisconnect.addListener(() => {
browser.test.assertEq(
"Could not establish connection. Receiving end does not exist.",
port.error?.message,
"connect() without onConnect should disconnect port with an error"
);
browser.test.assertTrue(
// TODO bug 1852317: This should be "!" instead of "!!", i.e. the
// event page should not wake up.
!!browser.extension.getBackgroundPage(),
"Existence of event page after connect()"
);
browser.test.sendMessage("TRIGGER_TEST_DONE");
});
},
// For completeness, start background before suspending. This makes sure
// that if the persistent listener mechanism is used for runtime.onConnect,
// that we have started the background at least once to enable the
// framework to detect (the lack of) persistent listeners, so that it can
// know that waking the event page doesn't make a difference.
// (note: persistent listeners are currently not used here: bug 1852317)
skipInitialPriming: false,
});
});
async function testEventPageWakeupWithSendMessage({
triggerFromContentScript,
triggerFromOtherExtension,
skipInitialPriming,
}) {
let backgroundScript, triggerScript;
// Note: using dump() instead of browser.test.log for logging, to rule out
// any side effects from extension API calls.
if (triggerFromOtherExtension) {
backgroundScript = () => {
dump("Event page started, listening to onMessageExternal\n");
browser.runtime.onMessageExternal.addListener(() => {
browser.test.sendMessage("TRIGGER_TEST_DONE");
});
};
triggerScript = () => {
dump("Calling sendMessage, expecting onMessageExternal\n");
browser.runtime.sendMessage("@ext", "msg");
};
} else {
backgroundScript = () => {
dump("Event page started, listening to onMessage\n");
browser.runtime.onMessage.addListener(() => {
browser.test.sendMessage("TRIGGER_TEST_DONE");
});
};
triggerScript = () => {
dump("Calling sendMessage, expecting onMessage\n");
browser.runtime.sendMessage("msg");
};
}
await testEventPageWakeup({
backgroundScript,
triggerScript,
triggerFromContentScript,
triggerFromOtherExtension,
skipInitialPriming,
});
}
add_task(async function test_wakeup_onMessage() {
await testEventPageWakeupWithSendMessage({
triggerFromContentScript: false,
triggerFromOtherExtension: false,
});
});
add_task(async function test_wakeup_onMessage_on_first_run() {
await testEventPageWakeupWithSendMessage({
triggerFromContentScript: false,
triggerFromOtherExtension: false,
skipInitialPriming: true,
});
});
add_task(async function test_wakeup_onMessage_by_content_script() {
await testEventPageWakeupWithSendMessage({
triggerFromContentScript: true,
triggerFromOtherExtension: false,
});
});
add_task(async function test_wakeup_onMessageExternal() {
await testEventPageWakeupWithSendMessage({
triggerFromContentScript: false,
triggerFromOtherExtension: true,
});
});
add_task(async function test_wakeup_onMessageExternal_by_content_script() {
await testEventPageWakeupWithSendMessage({
triggerFromContentScript: true,
triggerFromOtherExtension: true,
});
});
async function testEventPageWakeupWithConnect({
triggerFromContentScript,
triggerFromOtherExtension,
skipInitialPriming,
}) {
let backgroundScript, triggerScript;
// Note: using dump() instead of browser.test.log for logging, to rule out
// any side effects from extension API calls.
if (triggerFromOtherExtension) {
backgroundScript = () => {
dump("Event page started, listening to onConnectExternal\n");
browser.runtime.onConnectExternal.addListener(() => {
browser.test.sendMessage("TRIGGER_TEST_DONE");
});
};
triggerScript = () => {
dump("Calling connect, expecting onConnectExternal\n");
browser.runtime.connect("@ext", {});
};
} else {
backgroundScript = () => {
dump("Event page started, listening to onConnect\n");
browser.runtime.onConnect.addListener(() => {
browser.test.sendMessage("TRIGGER_TEST_DONE");
});
};
triggerScript = () => {
dump("Calling connect, expecting onConnect\n");
browser.runtime.connect({});
};
}
await testEventPageWakeup({
backgroundScript,
triggerScript,
triggerFromContentScript,
triggerFromOtherExtension,
skipInitialPriming,
});
}
add_task(async function test_wakeup_onConnect() {
await testEventPageWakeupWithConnect({
triggerFromContentScript: false,
triggerFromOtherExtension: false,
});
});
add_task(async function test_wakeup_onConnect_on_first_run() {
await testEventPageWakeupWithConnect({
triggerFromContentScript: false,
triggerFromOtherExtension: false,
skipInitialPriming: true,
});
});
add_task(async function test_wakeup_onConnect_by_content_script() {
await testEventPageWakeupWithConnect({
triggerFromContentScript: true,
triggerFromOtherExtension: false,
});
});
add_task(async function test_wakeup_onConnectExternal() {
await testEventPageWakeupWithConnect({
triggerFromContentScript: false,
triggerFromOtherExtension: true,
});
});
add_task(async function test_wakeup_onConnectExternal_by_content_script() {
await testEventPageWakeupWithConnect({
triggerFromContentScript: true,
triggerFromOtherExtension: true,
});
});
|
