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
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
/* globals getBackgroundServiceWorkerRegistration, waitForServiceWorkerTerminated */
Services.scriptloader.loadSubScript(
new URL("head_serviceworker.js", gTestPath).href,
this
);
add_task(assert_background_serviceworker_pref_enabled);
add_task(async function test_serviceWorker_register_guarded_by_pref() {
// Test with backgroundServiceWorkeEnable set to true and the
// extensions.serviceWorkerRegist.allowed pref set to false.
// NOTE: the scenario with backgroundServiceWorkeEnable set to false
// is part of "browser_ext_background_serviceworker_pref_disabled.js".
await SpecialPowers.pushPrefEnv({
set: [["extensions.serviceWorkerRegister.allowed", false]],
});
let extensionData = {
files: {
"page.html": "<!DOCTYPE html><script src='page.js'></script>",
"page.js": async function () {
browser.test.assertEq(
undefined,
navigator.serviceWorker,
"navigator.serviceWorker should be undefined"
);
browser.test.sendMessage("test-serviceWorker-register-disallowed");
},
"sw.js": "",
},
};
let extension = ExtensionTestUtils.loadExtension(extensionData);
await extension.startup();
// Verify that an extension page can't register a moz-extension url
// as a service worker.
await BrowserTestUtils.withNewTab(
{
gBrowser,
url: `moz-extension://${extension.uuid}/page.html`,
},
async () => {
await extension.awaitMessage("test-serviceWorker-register-disallowed");
}
);
await extension.unload();
await SpecialPowers.popPrefEnv();
// Test again with the pref set to true.
await SpecialPowers.pushPrefEnv({
set: [["extensions.serviceWorkerRegister.allowed", true]],
});
extension = ExtensionTestUtils.loadExtension({
files: {
...extensionData.files,
"page.js": async function () {
try {
await navigator.serviceWorker.register("sw.js");
} catch (err) {
browser.test.fail(
`Unexpected error on registering a service worker: ${err}`
);
throw err;
} finally {
browser.test.sendMessage("test-serviceworker-register-allowed");
}
},
},
});
await extension.startup();
// Verify that an extension page can register a moz-extension url
// as a service worker if enabled by the related pref.
await BrowserTestUtils.withNewTab(
{
gBrowser,
url: `moz-extension://${extension.uuid}/page.html`,
},
async () => {
await extension.awaitMessage("test-serviceworker-register-allowed");
}
);
await extension.unload();
await SpecialPowers.popPrefEnv();
});
add_task(async function test_cache_api_allowed() {
// Verify that Cache API support for moz-extension url availability is
// conditioned only by the extensions.backgroundServiceWorker.enabled pref.
// NOTE: the scenario with backgroundServiceWorkeEnable set to false
// is part of "browser_ext_background_serviceworker_pref_disabled.js".
const extension = ExtensionTestUtils.loadExtension({
async background() {
try {
let cache = await window.caches.open("test-cache-api");
browser.test.assertTrue(
await window.caches.has("test-cache-api"),
"CacheStorage.has should resolve to true"
);
// Test that adding and requesting cached moz-extension urls
// works as well.
let url = browser.runtime.getURL("file.txt");
await cache.add(url);
const content = await cache.match(url).then(res => res.text());
browser.test.assertEq(
"file content",
content,
"Got the expected content from the cached moz-extension url"
);
// Test that deleting the cache storage works as expected.
browser.test.assertTrue(
await window.caches.delete("test-cache-api"),
"Cache deleted successfully"
);
browser.test.assertTrue(
!(await window.caches.has("test-cache-api")),
"CacheStorage.has should resolve to false"
);
} catch (err) {
browser.test.fail(`Unexpected error on using Cache API: ${err}`);
throw err;
} finally {
browser.test.sendMessage("test-cache-api-allowed");
}
},
files: {
"file.txt": "file content",
},
});
await extension.startup();
await extension.awaitMessage("test-cache-api-allowed");
await extension.unload();
});
function createTestSWScript({ postMessageReply }) {
return `
self.onmessage = msg => {
dump("Background ServiceWorker - onmessage handler\\n");
msg.ports[0].postMessage("${postMessageReply}");
dump("Background ServiceWorker - postMessage\\n");
};
dump("Background ServiceWorker - executed\\n");
`;
}
async function testServiceWorker({ extension, expectMessageReply }) {
// Verify that the WebExtensions framework has successfully registered the
// background service worker declared in the extension manifest.
const swRegInfo = getBackgroundServiceWorkerRegistration(extension);
// Activate the background service worker by exchanging a message
// with it.
await BrowserTestUtils.withNewTab(
{
gBrowser,
url: `moz-extension://${extension.uuid}/page.html`,
},
async browser => {
let msgFromV1 = await SpecialPowers.spawn(
browser,
[swRegInfo.scriptURL],
async url => {
const { active } = await content.navigator.serviceWorker.ready;
const { port1, port2 } = new content.MessageChannel();
return new Promise(resolve => {
port1.onmessage = msg => resolve(msg.data);
active.postMessage("test", [port2]);
});
}
);
Assert.deepEqual(
msgFromV1,
expectMessageReply,
"Got the expected reply from the extension service worker"
);
}
);
}
function loadTestExtension({ version }) {
const postMessageReply = `reply:sw-v${version}`;
return ExtensionTestUtils.loadExtension({
useAddonManager: "temporary",
manifest: {
version,
background: {
service_worker: "sw.js",
},
browser_specific_settings: { gecko: { id: "test-bg-sw@mochi.test" } },
},
files: {
"page.html": "<!DOCTYPE html><body></body>",
"sw.js": createTestSWScript({ postMessageReply }),
},
});
}
async function assertWorkerIsRunningInExtensionProcess(extension) {
// Activate the background service worker by exchanging a message
// with it.
await BrowserTestUtils.withNewTab(
{
gBrowser,
url: `moz-extension://${extension.uuid}/page.html`,
},
async browser => {
const workerScriptURL = `moz-extension://${extension.uuid}/sw.js`;
const workerDebuggerURLs = await SpecialPowers.spawn(
browser,
[workerScriptURL],
async url => {
await content.navigator.serviceWorker.ready;
const wdm = Cc[
"@mozilla.org/dom/workers/workerdebuggermanager;1"
].getService(Ci.nsIWorkerDebuggerManager);
return Array.from(wdm.getWorkerDebuggerEnumerator())
.map(wd => {
return wd.url;
})
.filter(swURL => swURL == url);
}
);
Assert.deepEqual(
workerDebuggerURLs,
[workerScriptURL],
"The worker should be running in the extension child process"
);
}
);
}
add_task(async function test_background_serviceworker_with_no_ext_apis() {
const extensionV1 = loadTestExtension({ version: "1" });
await extensionV1.startup();
const swRegInfo = getBackgroundServiceWorkerRegistration(extensionV1);
const { uuid } = extensionV1;
await assertWorkerIsRunningInExtensionProcess(extensionV1);
await testServiceWorker({
extension: extensionV1,
expectMessageReply: "reply:sw-v1",
});
// Load a new version of the same addon and verify that the
// expected worker script is being executed.
const extensionV2 = loadTestExtension({ version: "2" });
await extensionV2.startup();
is(extensionV2.uuid, uuid, "The extension uuid did not change as expected");
await testServiceWorker({
extension: extensionV2,
expectMessageReply: "reply:sw-v2",
});
await Promise.all([
extensionV2.unload(),
// test extension v1 wrapper has to be unloaded explicitly, otherwise
// will be detected as a failure by the test harness.
extensionV1.unload(),
]);
await waitForServiceWorkerTerminated(swRegInfo);
await waitForServiceWorkerRegistrationsRemoved(extensionV2);
});
|
