summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/mochitest/test_ext_async_clipboard.html
blob: 708b5522c38522d09fbba110252dd46330a579e8 (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
<!DOCTYPE HTML>
<html>
<head>
  <title>Async Clipboard permissions tests</title>
  <script src="/tests/SimpleTest/SimpleTest.js"></script>
  <script src="/tests/SimpleTest/ExtensionTestUtils.js"></script>
  <script src="head.js"></script>
  <link rel="stylesheet" href="/tests/SimpleTest/test.css">
</head>
<body>

<script>
"use strict";

// Bug 1479956 - On android-debug verify this test times out
SimpleTest.requestLongerTimeout(2);

/* globals ClipboardItem, clipboardWriteText, clipboardWrite, clipboardReadText, clipboardRead */
function shared() {
  this.clipboardWriteText = function(txt) {
    return navigator.clipboard.writeText(txt);
  };

  this.clipboardWrite = function(items) {
    return navigator.clipboard.write(items);
  };

  this.clipboardReadText = function() {
    return navigator.clipboard.readText();
  };

  this.clipboardRead = function() {
    return navigator.clipboard.read();
  };
}

/**
 * Clear the clipboard.
 *
 * This is needed because Services.clipboard.emptyClipboard() does not clear the actual system clipboard.
 */
function clearClipboard() {
  if (AppConstants.platform == "android") {
    // On android, this clears the actual system clipboard
    SpecialPowers.Services.clipboard.emptyClipboard(SpecialPowers.Services.clipboard.kGlobalClipboard);
    return;
  }
  // Need to do this hack on other platforms to clear the actual system clipboard
  let transf = SpecialPowers.Cc["@mozilla.org/widget/transferable;1"]
    .createInstance(SpecialPowers.Ci.nsITransferable);
  transf.init(null);
  // Empty transferables may cause crashes, so just add an unknown type.
  const TYPE = "text/x-moz-place-empty";
  transf.addDataFlavor(TYPE);
  transf.setTransferData(TYPE, {});
  SpecialPowers.Services.clipboard.setData(transf, null, SpecialPowers.Services.clipboard.kGlobalClipboard);
}

add_task(async function setup() {
  await SpecialPowers.pushPrefEnv({"set": [
    ["dom.events.asyncClipboard.clipboardItem", true],
  ]});
});

// Test that without enough permissions, we are NOT allowed to use writeText, write, read or readText in background script
add_task(async function test_background_async_clipboard_no_permissions() {
  function backgroundScript() {
    const item = new ClipboardItem({
      "text/plain": new Blob(["HI"], {type: "text/plain"})
    });
    browser.test.assertRejects(
      clipboardRead(),
      "Clipboard read request was blocked due to lack of user activation.",
      "Read should be denied without permission"
    );
    browser.test.assertRejects(
      clipboardWrite([item]),
      "Clipboard write was blocked due to lack of user activation.",
      "Write should be denied without permission"
    );
    browser.test.assertRejects(
      clipboardWriteText("blabla"),
      "Clipboard write was blocked due to lack of user activation.",
      "WriteText should be denied without permission"
    );
    browser.test.assertRejects(
      clipboardReadText(),
      "Clipboard read request was blocked due to lack of user activation.",
      "ReadText should be denied without permission"
    );
    browser.test.sendMessage("ready");
  }
  let extensionData = {
    background: [shared, backgroundScript],
  };
  let extension = ExtensionTestUtils.loadExtension(extensionData);
  await extension.startup();
  await extension.awaitMessage("ready");
  await extension.unload();
});

// Test that without enough permissions, we are NOT allowed to use writeText, write, read or readText in content script
add_task(async function test_contentscript_async_clipboard_no_permission() {
  function contentScript() {
    const item = new ClipboardItem({
      "text/plain": new Blob(["HI"], {type: "text/plain"})
    });
    browser.test.assertRejects(
      clipboardRead(),
      "Clipboard read request was blocked due to lack of user activation.",
      "Read should be denied without permission"
    );
    browser.test.assertRejects(
      clipboardWrite([item]),
      "Clipboard write was blocked due to lack of user activation.",
      "Write should be denied without permission"
    );
    browser.test.assertRejects(
      clipboardWriteText("blabla"),
      "Clipboard write was blocked due to lack of user activation.",
      "WriteText should be denied without permission"
    );
    browser.test.assertRejects(
      clipboardReadText(),
      "Clipboard read request was blocked due to lack of user activation.",
      "ReadText should be denied without permission"
    );
    browser.test.sendMessage("ready");
  }
  let extensionData = {
    manifest: {
      content_scripts: [{
        js: ["shared.js", "contentscript.js"],
        matches: ["https://example.com/*/file_sample.html"],
      }],
    },
    files: {
      "shared.js": shared,
      "contentscript.js": contentScript,
    },
  };
  let extension = ExtensionTestUtils.loadExtension(extensionData);
  await extension.startup();
  let win = window.open("https://example.com/tests/toolkit/components/extensions/test/mochitest/file_sample.html");
  await extension.awaitMessage("ready");
  win.close();
  await extension.unload();
});

// Test that with enough permissions, we are allowed to use writeText  in content script
add_task(async function test_contentscript_clipboard_permission_writetext() {
  function contentScript() {
    let str = "HI";
    clipboardWriteText(str).then(function() {
      // nothing here
      browser.test.sendMessage("ready");
    }, function() {
      browser.test.fail("WriteText promise rejected");
      browser.test.sendMessage("ready");
    }); // clipboardWriteText
  }
  let extensionData = {
    manifest: {
      content_scripts: [{
        js: ["shared.js", "contentscript.js"],
        matches: ["https://example.com/*/file_sample.html"],
      }],
      permissions: [
        "clipboardWrite",
        "clipboardRead",
      ],
    },
    files: {
      "shared.js": shared,
      "contentscript.js": contentScript,
    },
  };
  let extension = ExtensionTestUtils.loadExtension(extensionData);
  await extension.startup();
  let win = window.open("https://example.com/tests/toolkit/components/extensions/test/mochitest/file_sample.html");
  await extension.awaitMessage("ready");
  const actual = SpecialPowers.getClipboardData("text/plain");
  is(actual, "HI", "right string copied by write");
  win.close();
  await extension.unload();
});

// Test that with enough permissions, we are allowed to use readText in content script
add_task(async function test_contentscript_clipboard_permission_readtext() {
  function contentScript() {
    let str = "HI";
    clipboardReadText().then(function(strData) {
      if (strData == str) {
        browser.test.succeed("Successfully read from clipboard");
      } else {
        browser.test.fail("ReadText read the wrong thing from clipboard:" + strData);
      }
      browser.test.sendMessage("ready");
    }, function() {
      browser.test.fail("ReadText promise rejected");
      browser.test.sendMessage("ready");
    }); // clipboardReadText
  }
  let extensionData = {
    manifest: {
      content_scripts: [{
        js: ["shared.js", "contentscript.js"],
        matches: ["https://example.com/*/file_sample.html"],
      }],
      permissions: [
        "clipboardWrite",
        "clipboardRead",
      ],
    },
    files: {
      "shared.js": shared,
      "contentscript.js": contentScript,
    },
  };
  await SimpleTest.promiseClipboardChange("HI", () => {
    SpecialPowers.clipboardCopyString("HI");
  }, "text/plain");
  let extension = ExtensionTestUtils.loadExtension(extensionData);
  await extension.startup();
  let win = window.open("https://example.com/tests/toolkit/components/extensions/test/mochitest/file_sample.html");
  await extension.awaitMessage("ready");
  win.close();
  await extension.unload();
});

// Test that with enough permissions, we are allowed to use write in content script
add_task(async function test_contentscript_clipboard_permission_write() {
  function contentScript() {
    const item = new ClipboardItem({
      "text/plain": new Blob(["HI"], {type: "text/plain"})
    });
    clipboardWrite([item]).then(function() {
      // nothing here
      browser.test.sendMessage("ready");
    }, function() { // clipboardWrite promise error function
      browser.test.fail("Write promise rejected");
      browser.test.sendMessage("ready");
    }); // clipboard write
  }
  let extensionData = {
    manifest: {
      content_scripts: [{
        js: ["shared.js", "contentscript.js"],
        matches: ["https://example.com/*/file_sample.html"],
      }],
      permissions: [
        "clipboardWrite",
        "clipboardRead",
      ],
    },
    files: {
      "shared.js": shared,
      "contentscript.js": contentScript,
    },
  };
  let extension = ExtensionTestUtils.loadExtension(extensionData);
  await extension.startup();
  let win = window.open("https://example.com/tests/toolkit/components/extensions/test/mochitest/file_sample.html");
  await extension.awaitMessage("ready");
  const actual = SpecialPowers.getClipboardData("text/plain");
  is(actual, "HI", "right string copied by write");
  win.close();
  await extension.unload();
});

// Test that with enough permissions, we are allowed to use read in content script
add_task(async function test_contentscript_clipboard_permission_read() {
  function contentScript() {
    clipboardRead().then(async function(items) {
      let blob = await items[0].getType("text/plain");
      let s = await blob.text();
      if (s == "HELLO") {
        browser.test.succeed("Read promise successfully read the right thing");
      } else {
        browser.test.fail("Read read the wrong string from clipboard:" + s);
      }
      browser.test.sendMessage("ready");
    }, function() { // clipboardRead promise error function
      browser.test.fail("Read promise rejected");
      browser.test.sendMessage("ready");
    }); // clipboard read
  }
  let extensionData = {
    manifest: {
      content_scripts: [{
        js: ["shared.js", "contentscript.js"],
        matches: ["https://example.com/*/file_sample.html"],
      }],
      permissions: [
        "clipboardWrite",
        "clipboardRead",
      ],
    },
    files: {
      "shared.js": shared,
      "contentscript.js": contentScript,
    },
  };
  await SimpleTest.promiseClipboardChange("HELLO", () => {
    SpecialPowers.clipboardCopyString("HELLO");
  }, "text/plain");
  let extension = ExtensionTestUtils.loadExtension(extensionData);
  await extension.startup();
  let win = window.open("https://example.com/tests/toolkit/components/extensions/test/mochitest/file_sample.html");
  await extension.awaitMessage("ready");
  win.close();
  await extension.unload();
});

// Test that performing readText(...) when the clipboard is empty returns an empty string
add_task(async function test_contentscript_clipboard_nocontents_readtext() {
  function contentScript() {
    clipboardReadText().then(function(strData) {
      if (strData == "") {
        browser.test.succeed("ReadText successfully read correct thing from an empty clipboard");
      } else {
        browser.test.fail("ReadText should have read an empty string, but read:" + strData);
      }
      browser.test.sendMessage("ready");
    }, function(err) {
      browser.test.fail("ReadText promise rejected: " + err);
      browser.test.sendMessage("ready");
    });
  }
  let extensionData = {
    manifest: {
      content_scripts: [{
        js: ["shared.js", "contentscript.js"],
        matches: ["https://example.com/*/file_sample.html"],
      }],
      permissions: [
        "clipboardRead",
      ],
    },
    files: {
      "shared.js": shared,
      "contentscript.js": contentScript,
    },
  };

  await SimpleTest.promiseClipboardChange("", () => {
    clearClipboard();
  }, "text/x-moz-place-empty");
  let extension = ExtensionTestUtils.loadExtension(extensionData);
  await extension.startup();
  let win = window.open("https://example.com/tests/toolkit/components/extensions/test/mochitest/file_sample.html");
  await extension.awaitMessage("ready");
  win.close();
  await extension.unload();
});

// Test that performing read(...) when the clipboard is empty returns an empty ClipboardItem
add_task(async function test_contentscript_clipboard_nocontents_read() {
  function contentScript() {
    clipboardRead().then(function(items) {
      if (items[0].types.length) {
        browser.test.fail("Read read the wrong thing from clipboard, " +
          "ClipboardItem has this many entries: " + items[0].types.length);
      } else {
        browser.test.succeed("Read promise successfully resolved");
      }
      browser.test.sendMessage("ready");
    }, function(err) {
      browser.test.fail("Read promise rejected: " + err);
      browser.test.sendMessage("ready");
    });
  }
  let extensionData = {
    manifest: {
      content_scripts: [{
        js: ["shared.js", "contentscript.js"],
        matches: ["https://example.com/*/file_sample.html"],
      }],
      permissions: [
        "clipboardRead",
      ],
    },
    files: {
      "shared.js": shared,
      "contentscript.js": contentScript,
    },
  };

  await SimpleTest.promiseClipboardChange("", () => {
    clearClipboard();
  }, "text/x-moz-place-empty");
  let extension = ExtensionTestUtils.loadExtension(extensionData);
  await extension.startup();
  let win = window.open("https://example.com/tests/toolkit/components/extensions/test/mochitest/file_sample.html");
  await extension.awaitMessage("ready");
  win.close();
  await extension.unload();
});
</script>
</body>
</html>