summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/xpcshell/webidl-api/test_ext_webidl_api_request_handler.js
blob: 4886db37d03a05e436eb52ce11cba86d6cf56e5e (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
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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";

AddonTestUtils.init(this);
AddonTestUtils.createAppInfo(
  "xpcshell@tests.mozilla.org",
  "XPCShell",
  "1",
  "42"
);

add_task(async function setup() {
  await AddonTestUtils.promiseStartupManager();
});

// Verify ExtensionAPIRequestHandler handling API requests for
// an ext-*.js API module running in the local process
// (toolkit/components/extensions/child/ext-test.js).
add_task(async function test_sw_api_request_handling_local_process_api() {
  const extension = ExtensionTestUtils.loadExtension({
    useAddonManager: "temporary",
    manifest: {
      background: {
        service_worker: "sw.js",
      },
      browser_specific_settings: { gecko: { id: "test-bg-sw@mochi.test" } },
    },
    files: {
      "page.html": "<!DOCTYPE html><body></body>",
      "sw.js": async function () {
        browser.test.onMessage.addListener(async () => {
          browser.test.succeed("call to test.succeed");
          browser.test.assertTrue(true, "call to test.assertTrue");
          browser.test.assertFalse(false, "call to test.assertFalse");
          // Smoke test assertEq (more complete coverage of the behavior expected
          // by the test API will be introduced in test_ext_test.html as part of
          // Bug 1723785).
          const errorObject = new Error("fake_error_message");
          browser.test.assertEq(
            errorObject,
            errorObject,
            "call to test.assertEq"
          );

          // Smoke test for assertThrows/assertRejects.
          const errorMatchingTestCases = [
            ["expected error instance", errorObject],
            ["expected error message string", "fake_error_message"],
            ["expected regexp", /fake_error/],
            ["matching function", error => errorObject === error],
            ["matching Constructor", Error],
          ];

          browser.test.log("run assertThrows smoke tests");

          const throwFn = () => {
            throw errorObject;
          };
          for (const [msg, expected] of errorMatchingTestCases) {
            browser.test.assertThrows(
              throwFn,
              expected,
              `call to assertThrow with ${msg}`
            );
          }

          browser.test.log("run assertRejects smoke tests");

          const rejectedPromise = Promise.reject(errorObject);
          for (const [msg, expected] of errorMatchingTestCases) {
            await browser.test.assertRejects(
              rejectedPromise,
              expected,
              `call to assertRejects with ${msg}`
            );
          }

          browser.test.notifyPass("test-completed");
        });
        browser.test.sendMessage("bgsw-ready");
      },
    },
  });

  await extension.startup();
  await extension.awaitMessage("bgsw-ready");
  extension.sendMessage("test-message-ok");
  await extension.awaitFinish();
  await extension.unload();
});

// Verify ExtensionAPIRequestHandler handling API requests for
// an ext-*.js API module running in the main process
// (toolkit/components/extensions/parent/ext-alarms.js).
add_task(async function test_sw_api_request_handling_main_process_api() {
  const extension = ExtensionTestUtils.loadExtension({
    useAddonManager: "temporary",
    manifest: {
      background: {
        service_worker: "sw.js",
      },
      permissions: ["alarms"],
      browser_specific_settings: { gecko: { id: "test-bg-sw@mochi.test" } },
    },
    files: {
      "page.html": "<!DOCTYPE html><body></body>",
      "sw.js": async function () {
        browser.alarms.create("test-alarm", { when: Date.now() + 2000000 });
        const all = await browser.alarms.getAll();
        if (all.length === 1 && all[0].name === "test-alarm") {
          browser.test.succeed("Got the expected alarms");
        } else {
          browser.test.fail(
            `browser.alarms.create didn't create the expected alarm: ${JSON.stringify(
              all
            )}`
          );
        }

        browser.alarms.onAlarm.addListener(alarm => {
          if (alarm.name === "test-onAlarm") {
            browser.test.succeed("Got the expected onAlarm event");
          } else {
            browser.test.fail(`Got unexpected onAlarm event: ${alarm.name}`);
          }
          browser.test.sendMessage("test-completed");
        });

        browser.alarms.create("test-onAlarm", { when: Date.now() + 1000 });
      },
    },
  });

  await extension.startup();
  await extension.awaitMessage("test-completed");
  await extension.unload();
});

add_task(async function test_sw_api_request_bgsw_runtime_onMessage() {
  const extension = ExtensionTestUtils.loadExtension({
    useAddonManager: "temporary",
    manifest: {
      background: {
        service_worker: "sw.js",
      },
      permissions: [],
      browser_specific_settings: {
        gecko: { id: "test-bg-sw-on-message@mochi.test" },
      },
    },
    files: {
      "page.html": '<!DOCTYPE html><script src="page.js"></script>',
      "page.js": async function () {
        browser.test.onMessage.addListener(msg => {
          if (msg !== "extpage-send-message") {
            browser.test.fail(`Unexpected message received: ${msg}`);
            return;
          }
          browser.runtime.sendMessage("extpage-send-message");
        });
      },
      "sw.js": async function () {
        browser.runtime.onMessage.addListener(msg => {
          browser.test.sendMessage("bgsw-on-message", msg);
        });
        const extURL = browser.runtime.getURL("/");
        browser.test.sendMessage("ext-url", extURL);
      },
    },
  });

  await extension.startup();
  const extURL = await extension.awaitMessage("ext-url");
  equal(
    extURL,
    `moz-extension://${extension.uuid}/`,
    "Got the expected extension url"
  );

  const extPage = await ExtensionTestUtils.loadContentPage(
    `${extURL}/page.html`,
    { extension }
  );
  extension.sendMessage("extpage-send-message");

  const msg = await extension.awaitMessage("bgsw-on-message");
  equal(msg, "extpage-send-message", "Got the expected message");
  await extPage.close();
  await extension.unload();
});

add_task(async function test_sw_api_request_bgsw_runtime_sendMessage() {
  const extension = ExtensionTestUtils.loadExtension({
    useAddonManager: "temporary",
    manifest: {
      background: {
        service_worker: "sw.js",
      },
      permissions: [],
      browser_specific_settings: {
        gecko: { id: "test-bg-sw-sendMessage@mochi.test" },
      },
    },
    files: {
      "page.html": '<!DOCTYPE html><script src="page.js"></script>',
      "page.js": async function () {
        browser.runtime.onMessage.addListener(msg => {
          browser.test.sendMessage("extpage-on-message", msg);
        });

        browser.test.sendMessage("extpage-ready");
      },
      "sw.js": async function () {
        browser.test.onMessage.addListener(msg => {
          if (msg !== "bgsw-send-message") {
            browser.test.fail(`Unexpected message received: ${msg}`);
            return;
          }
          browser.runtime.sendMessage("bgsw-send-message");
        });
        const extURL = browser.runtime.getURL("/");
        browser.test.sendMessage("ext-url", extURL);
      },
    },
  });

  await extension.startup();
  const extURL = await extension.awaitMessage("ext-url");
  equal(
    extURL,
    `moz-extension://${extension.uuid}/`,
    "Got the expected extension url"
  );

  const extPage = await ExtensionTestUtils.loadContentPage(
    `${extURL}/page.html`,
    { extension }
  );
  await extension.awaitMessage("extpage-ready");
  extension.sendMessage("bgsw-send-message");

  const msg = await extension.awaitMessage("extpage-on-message");
  equal(msg, "bgsw-send-message", "Got the expected message");
  await extPage.close();
  await extension.unload();
});

// Verify ExtensionAPIRequestHandler handling API requests that
// returns a runtinme.Port API object.
add_task(async function test_sw_api_request_bgsw_connnect_runtime_port() {
  const extension = ExtensionTestUtils.loadExtension({
    useAddonManager: "temporary",
    manifest: {
      background: {
        service_worker: "sw.js",
      },
      permissions: [],
      browser_specific_settings: { gecko: { id: "test-bg-sw@mochi.test" } },
    },
    files: {
      "page.html": '<!DOCTYPE html><script src="page.js"></script>',
      "page.js": async function () {
        browser.runtime.onConnect.addListener(port => {
          browser.test.sendMessage("page-got-port-from-sw");
          port.postMessage("page-to-sw");
        });
        browser.test.sendMessage("page-waiting-port");
      },
      "sw.js": async function () {
        browser.test.onMessage.addListener(msg => {
          if (msg !== "connect-port") {
            return;
          }
          const port = browser.runtime.connect();
          if (!port) {
            browser.test.fail("Got an undefined port");
          }
          port.onMessage.addListener((msg, portArgument) => {
            browser.test.assertTrue(
              port === portArgument,
              "Got the expected runtime.Port instance"
            );
            browser.test.sendMessage("test-done", msg);
          });
          browser.test.sendMessage("sw-waiting-port-message");
        });

        const portWithError = browser.runtime.connect();
        portWithError.onDisconnect.addListener(() => {
          const portError = portWithError.error;
          browser.test.sendMessage("port-error", {
            isError: portError instanceof Error,
            message: portError?.message,
          });
        });

        const extURL = browser.runtime.getURL("/");
        browser.test.sendMessage("ext-url", extURL);
        browser.test.sendMessage("ext-id", browser.runtime.id);
      },
    },
  });

  await extension.startup();
  const extURL = await extension.awaitMessage("ext-url");
  equal(
    extURL,
    `moz-extension://${extension.uuid}/`,
    "Got the expected extension url"
  );

  const extId = await extension.awaitMessage("ext-id");
  equal(extId, extension.id, "Got the expected extension id");

  const lastError = await extension.awaitMessage("port-error");
  Assert.deepEqual(
    lastError,
    {
      isError: true,
      message: "Could not establish connection. Receiving end does not exist.",
    },
    "Got the expected lastError value"
  );

  const extPage = await ExtensionTestUtils.loadContentPage(
    `${extURL}/page.html`,
    { extension }
  );
  await extension.awaitMessage("page-waiting-port");

  info("bgsw connect port");
  extension.sendMessage("connect-port");
  await extension.awaitMessage("sw-waiting-port-message");
  info("bgsw waiting port message");
  await extension.awaitMessage("page-got-port-from-sw");
  info("page got port from sw, wait to receive event");
  const msg = await extension.awaitMessage("test-done");
  equal(msg, "page-to-sw", "Got the expected message");
  await extPage.close();
  await extension.unload();
});

// Verify ExtensionAPIRequestHandler handling API events that should
// get a runtinme.Port API object as an event argument.
add_task(async function test_sw_api_request_bgsw_runtime_onConnect() {
  const extension = ExtensionTestUtils.loadExtension({
    useAddonManager: "temporary",
    manifest: {
      background: {
        service_worker: "sw.js",
      },
      permissions: [],
      browser_specific_settings: {
        gecko: { id: "test-bg-sw-onConnect@mochi.test" },
      },
    },
    files: {
      "page.html": '<!DOCTYPE html><script src="page.js"></script>',
      "page.js": async function () {
        browser.test.onMessage.addListener(msg => {
          if (msg !== "connect-port") {
            return;
          }
          const port = browser.runtime.connect();
          port.onMessage.addListener(msg => {
            browser.test.sendMessage("test-done", msg);
          });
          browser.test.sendMessage("page-waiting-port-message");
        });
      },
      "sw.js": async function () {
        try {
          const extURL = browser.runtime.getURL("/");
          browser.test.sendMessage("ext-url", extURL);

          browser.runtime.onConnect.addListener(port => {
            browser.test.sendMessage("bgsw-got-port-from-page");
            port.postMessage("sw-to-page");
          });
          browser.test.sendMessage("bgsw-waiting-port");
        } catch (err) {
          browser.test.fail(`Error on runtime.onConnect: ${err}`);
        }
      },
    },
  });

  await extension.startup();
  const extURL = await extension.awaitMessage("ext-url");
  equal(
    extURL,
    `moz-extension://${extension.uuid}/`,
    "Got the expected extension url"
  );
  await extension.awaitMessage("bgsw-waiting-port");

  const extPage = await ExtensionTestUtils.loadContentPage(
    `${extURL}/page.html`,
    { extension }
  );
  info("ext page connect port");
  extension.sendMessage("connect-port");

  await extension.awaitMessage("page-waiting-port-message");
  info("page waiting port message");
  await extension.awaitMessage("bgsw-got-port-from-page");
  info("bgsw got port from page, page wait to receive event");
  const msg = await extension.awaitMessage("test-done");
  equal(msg, "sw-to-page", "Got the expected message");
  await extPage.close();
  await extension.unload();
});

add_task(async function test_sw_runtime_lastError() {
  const extension = ExtensionTestUtils.loadExtension({
    useAddonManager: "temporary",
    manifest: {
      background: {
        service_worker: "sw.js",
      },
      browser_specific_settings: { gecko: { id: "test-bg-sw@mochi.test" } },
    },
    files: {
      "page.html": "<!DOCTYPE html><body></body>",
      "sw.js": async function () {
        browser.runtime.sendMessage(() => {
          const lastError = browser.runtime.lastError;
          if (!(lastError instanceof Error)) {
            browser.test.fail(
              `lastError isn't an Error instance: ${lastError}`
            );
          }
          browser.test.sendMessage("test-lastError-completed");
        });
      },
    },
  });

  await extension.startup();
  await extension.awaitMessage("test-lastError-completed");
  await extension.unload();
});