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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
|
"use strict";
const server = createHttpServer({ hosts: ["example.com"] });
server.registerPathHandler("/", (request, response) => {
response.setStatusLine(request.httpVersion, 200, "OK");
response.setHeader("Content-Type", "text/html; charset=utf-8", false);
response.write("<!DOCTYPE html><html></html>");
});
ChromeUtils.defineESModuleGetters(this, {
GeckoViewConnection: "resource://gre/modules/GeckoViewWebExtension.sys.mjs",
});
// Save reference to original implementations to restore later.
const { sendMessage, onConnect } = GeckoViewConnection.prototype;
add_setup(async () => {
// This file replaces the implementation of GeckoViewConnection;
// make sure that it is restored upon test completion.
registerCleanupFunction(() => {
GeckoViewConnection.prototype.sendMessage = sendMessage;
GeckoViewConnection.prototype.onConnect = onConnect;
});
});
// Mock the embedder communication port
class EmbedderPort {
constructor(portId, messenger) {
this.id = portId;
this.messenger = messenger;
}
close() {
Assert.ok(false, "close not expected to be called");
}
onPortDisconnect() {
Assert.ok(false, "onPortDisconnect not expected to be called");
}
onPortMessage() {
Assert.ok(false, "onPortMessage not expected to be called");
}
triggerPortDisconnect() {
this.messenger.sendPortDisconnect(this.id);
}
}
function stubConnectNative() {
let port;
const firstCallPromise = new Promise(resolve => {
let callCount = 0;
GeckoViewConnection.prototype.onConnect = (portId, messenger) => {
Assert.equal(++callCount, 1, "onConnect called once");
port = new EmbedderPort(portId, messenger);
resolve();
return port;
};
});
const triggerPortDisconnect = () => {
if (!port) {
Assert.ok(false, "Undefined port, connection must be established first");
}
port.triggerPortDisconnect();
};
const restore = () => {
GeckoViewConnection.prototype.onConnect = onConnect;
};
return { firstCallPromise, triggerPortDisconnect, restore };
}
function stubSendNativeMessage() {
let sendResponse;
const returnPromise = new Promise(resolve => {
sendResponse = resolve;
});
const firstCallPromise = new Promise(resolve => {
let callCount = 0;
GeckoViewConnection.prototype.sendMessage = data => {
Assert.equal(++callCount, 1, "sendMessage called once");
resolve(data);
return returnPromise;
};
});
const restore = () => {
GeckoViewConnection.prototype.sendMessage = sendMessage;
};
return { firstCallPromise, sendResponse, restore };
}
function promiseExtensionEvent(wrapper, event) {
return new Promise(resolve => {
wrapper.extension.once(event, (...args) => resolve(args));
});
}
// verify that when background sends a native message,
// the background will not be terminated to allow native messaging
add_task(async function test_sendNativeMessage_event_page() {
const extension = ExtensionTestUtils.loadExtension({
isPrivileged: true,
manifest: {
permissions: ["geckoViewAddons", "nativeMessaging"],
background: { persistent: false },
},
async background() {
const res = await browser.runtime.sendNativeMessage("fake", "msg");
browser.test.assertEq("myResp", res, "expected response");
browser.test.sendMessage("done");
browser.runtime.onSuspend.addListener(async () => {
browser.test.assertFail("unexpected onSuspend");
});
},
});
const stub = stubSendNativeMessage();
await extension.startup();
info("Wait for sendNativeMessage to be received");
Assert.equal(
(await stub.firstCallPromise).deserialize({}),
"msg",
"expected message"
);
info("Trigger background script idle timeout and expect to be reset");
const promiseResetIdle = promiseExtensionEvent(
extension,
"background-script-reset-idle"
);
await extension.terminateBackground();
info("Wait for 'background-script-reset-idle' event to be emitted");
await promiseResetIdle;
stub.sendResponse("myResp");
info("Wait for extension to verify sendNativeMessage response");
await extension.awaitMessage("done");
await extension.unload();
stub.restore();
});
// verify that when an extension tab sends a native message,
// the background will terminate as expected
add_task(async function test_sendNativeMessage_tab() {
const extension = ExtensionTestUtils.loadExtension({
isPrivileged: true,
manifest: {
permissions: ["geckoViewAddons", "nativeMessaging"],
background: { persistent: false },
},
async background() {
browser.runtime.onSuspend.addListener(async () => {
browser.test.sendMessage("onSuspend_called");
});
},
files: {
"tab.html": `
<!DOCTYPE html><meta charset="utf-8">
<script src="tab.js"></script>
`,
"tab.js": async () => {
const res = await browser.runtime.sendNativeMessage("fake", "msg");
browser.test.assertEq("myResp", res, "expected response");
browser.test.sendMessage("content_done");
},
},
});
const stub = stubSendNativeMessage();
await extension.startup();
const tab = await ExtensionTestUtils.loadContentPage(
`moz-extension://${extension.uuid}/tab.html?tab`,
{ extension }
);
info("Wait for sendNativeMessage to be received");
Assert.equal(
(await stub.firstCallPromise).deserialize({}),
"msg",
"expected message"
);
info("Terminate extension");
await extension.terminateBackground();
await extension.awaitMessage("onSuspend_called");
stub.sendResponse("myResp");
info("Wait for extension to verify sendNativeMessage response");
await extension.awaitMessage("content_done");
await tab.close();
await extension.unload();
stub.restore();
});
// verify that when a content script sends a native message,
// the background will terminate as expected
add_task(async function test_sendNativeMessage_content_script() {
const extension = ExtensionTestUtils.loadExtension({
isPrivileged: true,
manifest: {
permissions: [
"geckoViewAddons",
"nativeMessaging",
"nativeMessagingFromContent",
],
background: { persistent: false },
content_scripts: [
{
run_at: "document_end",
js: ["test.js"],
matches: ["http://example.com/"],
},
],
},
files: {
"test.js": async () => {
const res = await browser.runtime.sendNativeMessage("fake", "msg");
browser.test.assertEq("myResp", res, "expected response");
browser.test.sendMessage("content_done");
},
},
async background() {
browser.runtime.onSuspend.addListener(async () => {
browser.test.sendMessage("onSuspend_called");
});
},
});
const stub = stubSendNativeMessage();
await extension.startup();
info("Load content page");
const page = await ExtensionTestUtils.loadContentPage("http://example.com/");
info("Wait for message from extension");
Assert.equal(
(await stub.firstCallPromise).deserialize({}),
"msg",
"expected message"
);
info("Terminate extension");
await extension.terminateBackground();
await extension.awaitMessage("onSuspend_called");
stub.sendResponse("myResp");
info("Wait for extension to verify sendNativeMessage response");
await extension.awaitMessage("content_done");
await page.close();
await extension.unload();
stub.restore();
});
// verify that when native messaging ports are open, the background will not be terminated
// and once the ports disconnect, onSuspend can be called
add_task(async function test_connectNative_event_page() {
const extension = ExtensionTestUtils.loadExtension({
isPrivileged: true,
manifest: {
permissions: ["geckoViewAddons", "nativeMessaging"],
background: { persistent: false },
},
async background() {
const port = browser.runtime.connectNative("test");
port.onDisconnect.addListener(() => {
browser.test.assertEq(
null,
port.error,
"port should be disconnected without errors"
);
browser.test.sendMessage("port_disconnected");
});
browser.runtime.onSuspend.addListener(async () => {
browser.test.sendMessage("onSuspend_called");
});
},
});
const stub = stubConnectNative();
await extension.startup();
info("Waiting for connectNative request");
await stub.firstCallPromise;
info("Trigger background script idle timeout and expect to be reset");
const promiseResetIdle = promiseExtensionEvent(
extension,
"background-script-reset-idle"
);
await extension.terminateBackground();
info("Wait for 'background-script-reset-idle' event to be emitted");
await promiseResetIdle;
info("Trigger port disconnect, terminate background, and expect onSuspend()");
stub.triggerPortDisconnect();
await extension.awaitMessage("port_disconnected");
info("Terminate extension");
await extension.terminateBackground();
await extension.awaitMessage("onSuspend_called");
await extension.unload();
stub.restore();
});
// verify that when an extension tab opens native messaging ports,
// the background will terminate as expected
add_task(async function test_connectNative_tab() {
const extension = ExtensionTestUtils.loadExtension({
isPrivileged: true,
manifest: {
permissions: ["geckoViewAddons", "nativeMessaging"],
background: { persistent: false },
},
async background() {
browser.runtime.onSuspend.addListener(async () => {
browser.test.sendMessage("onSuspend_called");
});
},
files: {
"tab.html": `
<!DOCTYPE html><meta charset="utf-8">
<script src="tab.js"></script>
`,
"tab.js": async () => {
const port = browser.runtime.connectNative("test");
port.onDisconnect.addListener(() => {
browser.test.assertEq(
null,
port.error,
"port should be disconnected without errors"
);
browser.test.sendMessage("port_disconnected");
});
browser.test.sendMessage("content_done");
},
},
});
const stub = stubConnectNative();
await extension.startup();
const tab = await ExtensionTestUtils.loadContentPage(
`moz-extension://${extension.uuid}/tab.html?tab`,
{ extension }
);
await extension.awaitMessage("content_done");
await stub.firstCallPromise;
info("Terminate extension");
await extension.terminateBackground();
await extension.awaitMessage("onSuspend_called");
stub.triggerPortDisconnect();
await extension.awaitMessage("port_disconnected");
await tab.close();
await extension.unload();
stub.restore();
});
// verify that when a content script opens native messaging ports,
// the background will terminate as expected
add_task(async function test_connectNative_content_script() {
const extension = ExtensionTestUtils.loadExtension({
isPrivileged: true,
manifest: {
permissions: [
"geckoViewAddons",
"nativeMessaging",
"nativeMessagingFromContent",
],
background: { persistent: false },
content_scripts: [
{
run_at: "document_end",
js: ["test.js"],
matches: ["http://example.com/"],
},
],
},
files: {
"test.js": async () => {
const port = browser.runtime.connectNative("test");
port.onDisconnect.addListener(() => {
browser.test.assertEq(
null,
port.error,
"port should be disconnected without errors"
);
browser.test.sendMessage("port_disconnected");
});
browser.test.sendMessage("content_done");
},
},
async background() {
browser.runtime.onSuspend.addListener(async () => {
browser.test.sendMessage("onSuspend_called");
});
},
});
const stub = stubConnectNative();
await extension.startup();
info("Load content page");
const page = await ExtensionTestUtils.loadContentPage("http://example.com/");
await extension.awaitMessage("content_done");
await stub.firstCallPromise;
info("Terminate extension");
await extension.terminateBackground();
await extension.awaitMessage("onSuspend_called");
stub.triggerPortDisconnect();
await extension.awaitMessage("port_disconnected");
await page.close();
await extension.unload();
stub.restore();
});
|
