summaryrefslogtreecommitdiffstats
path: root/toolkit/components/webextensions/test/mochitest/test_ext_i18n.html
blob: 1f7330bbb15f32302068872288210a7ee1d8ce4d (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
<!DOCTYPE HTML>
<html>
<head>
  <meta charset="utf-8">
  <title>Test for WebExtension localization APIs</title>
  <script type="text/javascript" src="/tests/SimpleTest/SimpleTest.js"></script>
  <script type="text/javascript" src="/tests/SimpleTest/SpawnTask.js"></script>
  <script type="text/javascript" src="/tests/SimpleTest/ExtensionTestUtils.js"></script>
  <script type="text/javascript" src="head.js"></script>
  <link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css"/>
</head>
<body>

<script type="text/javascript">
"use strict";

SimpleTest.registerCleanupFunction(() => { SpecialPowers.clearUserPref("intl.accept_languages"); });
SimpleTest.registerCleanupFunction(() => { SpecialPowers.clearUserPref("general.useragent.locale"); });

add_task(function* test_i18n() {
  function runTests(assertEq) {
    let _ = browser.i18n.getMessage.bind(browser.i18n);

    let url = browser.runtime.getURL("/");
    assertEq(url, `moz-extension://${_("@@extension_id")}/`, "@@extension_id builtin message");

    assertEq("Foo.", _("Foo"), "Simple message in selected locale.");

    assertEq("(bar)", _("bar"), "Simple message fallback in default locale.");

    assertEq("", _("some-unknown-locale-string"), "Unknown locale string.");

    assertEq("", _("@@unknown_builtin_string"), "Unknown built-in string.");
    assertEq("", _("@@bidi_unknown_builtin_string"), "Unknown built-in bidi string.");

    assertEq("Føo.", _("Föo"), "Multi-byte message in selected locale.");

    let substitutions = [];
    substitutions[4] = "5";
    substitutions[13] = "14";

    assertEq("'$0' '14' '' '5' '$$$$' '$'.", _("basic_substitutions", substitutions),
             "Basic numeric substitutions");

    assertEq("'$0' '' 'just a string' '' '$$$$' '$'.", _("basic_substitutions", "just a string"),
             "Basic numeric substitutions, with non-array value");

    let values = _("named_placeholder_substitutions", ["(subst $1 $2)", "(2 $1 $2)"]).split("\n");

    assertEq("_foo_ (subst $1 $2) _bar_", values[0], "Named and numeric substitution");

    assertEq("(2 $1 $2)", values[1], "Numeric substitution amid named placeholders");

    assertEq("$bad name$", values[2], "Named placeholder with invalid key");

    assertEq("", values[3], "Named placeholder with an invalid value");

    assertEq("Accepted, but shouldn't break.", values[4], "Named placeholder with a strange content value");

    assertEq("$foo", values[5], "Non-placeholder token that should be ignored");
  }

  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      "default_locale": "jp",

      content_scripts: [
        {"matches": ["http://mochi.test/*/file_sample.html"],
         "js": ["content.js"]},
      ],
    },


    files: {
      "_locales/en_US/messages.json": {
        "foo": {
          "message": "Foo.",
          "description": "foo",
        },

        "föo": {
          "message": "Føo.",
          "description": "foo",
        },

        "basic_substitutions": {
          "message": "'$0' '$14' '$1' '$5' '$$$$$' '$$'.",
          "description": "foo",
        },

        "Named_placeholder_substitutions": {
          "message": "$Foo$\n$2\n$bad name$\n$bad_value$\n$bad_content_value$\n$foo",
          "description": "foo",
          "placeholders": {
            "foO": {
              "content": "_foo_ $1 _bar_",
              "description": "foo",
            },

            "bad name": {
              "content": "Nope.",
              "description": "bad name",
            },

            "bad_value": "Nope.",

            "bad_content_value": {
              "content": ["Accepted, but shouldn't break."],
              "description": "bad value",
            },
          },
        },

        "broken_placeholders": {
          "message": "$broken$",
          "description": "broken placeholders",
          "placeholders": "foo.",
        },
      },

      "_locales/jp/messages.json": {
        "foo": {
          "message": "(foo)",
          "description": "foo",
        },

        "bar": {
          "message": "(bar)",
          "description": "bar",
        },
      },

      "content.js": "new " + function(runTestsFn) {
        runTestsFn((...args) => {
          browser.runtime.sendMessage(["assertEq", ...args]);
        });

        browser.runtime.sendMessage(["content-script-finished"]);
      } + `(${runTests})`,
    },

    background: "new " + function(runTestsFn) {
      browser.runtime.onMessage.addListener(([msg, ...args]) => {
        if (msg == "assertEq") {
          browser.test.assertEq(...args);
        } else {
          browser.test.sendMessage(msg, ...args);
        }
      });

      runTestsFn(browser.test.assertEq.bind(browser.test));
    } + `(${runTests})`,
  });

  yield extension.startup();

  let win = window.open("file_sample.html");
  yield extension.awaitMessage("content-script-finished");
  win.close();

  yield extension.unload();
});

add_task(function* test_get_accept_languages() {
  function background() {
    function checkResults(source, results, expected) {
      browser.test.assertEq(
        expected.length,
        results.length,
        `got expected number of languages in ${source}`);
      results.forEach((lang, index) => {
        browser.test.assertEq(
          expected[index],
          lang,
          `got expected language in ${source}`);
      });
    }

    let tabId;

    browser.tabs.query({currentWindow: true, active: true}, tabs => {
      tabId = tabs[0].id;
      browser.test.sendMessage("ready");
    });

    browser.test.onMessage.addListener(async ([msg, expected]) => {
      let contentResults = await browser.tabs.sendMessage(tabId, "get-results");
      let backgroundResults = await browser.i18n.getAcceptLanguages();

      checkResults("contentScript", contentResults, expected);
      checkResults("background", backgroundResults, expected);

      browser.test.sendMessage("done");
    });
  }

  function content() {
    browser.runtime.onMessage.addListener((msg, sender, respond) => {
      browser.i18n.getAcceptLanguages(respond);
      return true;
    });
  }

  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      "content_scripts": [{
        "matches": ["http://mochi.test/*/file_sample.html"],
        "run_at": "document_start",
        "js": ["content_script.js"],
      }],
    },

    background,

    files: {
      "content_script.js": content,
    },
  });

  let win = window.open("file_sample.html");

  yield extension.startup();
  yield extension.awaitMessage("ready");

  let expectedLangs = ["en-US", "en"];
  extension.sendMessage(["expect-results", expectedLangs]);
  yield extension.awaitMessage("done");

  expectedLangs = ["en-US", "en", "fr-CA", "fr"];
  SpecialPowers.setCharPref("intl.accept_languages", expectedLangs.toString());
  extension.sendMessage(["expect-results", expectedLangs]);
  yield extension.awaitMessage("done");
  SpecialPowers.clearUserPref("intl.accept_languages");

  win.close();

  yield extension.unload();
});

add_task(function* test_get_ui_language() {
  function getResults() {
    return {
      getUILanguage: browser.i18n.getUILanguage(),
      getMessage: browser.i18n.getMessage("@@ui_locale"),
    };
  }

  function background(getResultsFn) {
    function checkResults(source, results, expected) {
      browser.test.assertEq(
        expected,
        results.getUILanguage,
        `Got expected getUILanguage result in ${source}`
      );
      browser.test.assertEq(
        expected,
        results.getMessage,
        `Got expected getMessage result in ${source}`
      );
    }

    let tabId;

    browser.test.onMessage.addListener(([msg, expected]) => {
      browser.tabs.sendMessage(tabId, "get-results", result => {
        checkResults("contentScript", result, expected);
        checkResults("background", getResultsFn(), expected);

        browser.test.sendMessage("done");
      });
    });

    browser.tabs.query({currentWindow: true, active: true}, tabs => {
      tabId = tabs[0].id;
      browser.test.sendMessage("ready");
    });
  }

  function content(getResultsFn) {
    browser.runtime.onMessage.addListener((msg, sender, respond) => {
      respond(getResultsFn());
    });
  }

  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      "content_scripts": [{
        "matches": ["http://mochi.test/*/file_sample.html"],
        "run_at": "document_start",
        "js": ["content_script.js"],
      }],
    },

    background: `(${background})(${getResults})`,

    files: {
      "content_script.js": `(${content})(${getResults})`,
    },
  });

  let win = window.open("file_sample.html");

  yield extension.startup();
  yield extension.awaitMessage("ready");

  extension.sendMessage(["expect-results", "en_US"]);
  yield extension.awaitMessage("done");

  SpecialPowers.setCharPref("general.useragent.locale", "he");

  extension.sendMessage(["expect-results", "he"]);
  yield extension.awaitMessage("done");

  win.close();

  yield extension.unload();
});


add_task(function* test_detect_language() {
  const af_string = " aam skukuza die naam beteken hy wat skoonvee of hy wat alles onderstebo keer wysig " +
    "bosveldkampe boskampe is kleiner afgeleë ruskampe wat oor min fasiliteite beskik daar is geen restaurante " +
    "of winkels nie en slegs oornagbesoekers word toegelaat bateleur";
  // String with intermixed French/English text
  const fr_en_string = "France is the largest country in Western Europe and the third-largest in Europe as a whole. " +
    "A accès aux chiens et aux frontaux qui lui ont été il peut consulter et modifier ses collections et exporter " +
    "Cet article concerne le pays européen aujourd’hui appelé République française. Pour d’autres usages du nom France, " +
    "Pour une aide rapide et effective, veuiller trouver votre aide dans le menu ci-dessus." +
    "Motoring events began soon after the construction of the first successful gasoline-fueled automobiles. The quick brown fox jumped over the lazy dog";

  function background() {
    function checkResult(source, result, expected) {
      browser.test.assertEq(expected.isReliable, result.isReliable, "result.confident is true");
      browser.test.assertEq(
        expected.languages.length,
        result.languages.length,
        `result.languages contains the expected number of languages in ${source}`);
      expected.languages.forEach((lang, index) => {
        browser.test.assertEq(
          lang.percentage,
          result.languages[index].percentage,
          `element ${index} of result.languages array has the expected percentage in ${source}`);
        browser.test.assertEq(
          lang.language,
          result.languages[index].language,
          `element ${index} of result.languages array has the expected language in ${source}`);
      });
    }

    let tabId;

    browser.tabs.query({currentWindow: true, active: true}, tabs => {
      tabId = tabs[0].id;
      browser.test.sendMessage("ready");
    });

    browser.test.onMessage.addListener(async ([msg, expected]) => {
      let backgroundResults = await browser.i18n.detectLanguage(msg);
      let contentResults = await browser.tabs.sendMessage(tabId, msg);

      checkResult("background", backgroundResults, expected);
      checkResult("contentScript", contentResults, expected);

      browser.test.sendMessage("done");
    });
  }

  function content() {
    browser.runtime.onMessage.addListener((msg, sender, respond) => {
      browser.i18n.detectLanguage(msg, respond);
      return true;
    });
  }

  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      "content_scripts": [{
        "matches": ["http://mochi.test/*/file_sample.html"],
        "run_at": "document_start",
        "js": ["content_script.js"],
      }],
    },

    background,

    files: {
      "content_script.js": content,
    },
  });

  let win = window.open("file_sample.html");

  yield extension.startup();
  yield extension.awaitMessage("ready");

  let expected = {
    isReliable: true,
    languages: [
      {
        language: "fr",
        percentage: 67,
      },
      {
        language: "en",
        percentage: 32,
      },
    ],
  };
  extension.sendMessage([fr_en_string, expected]);
  yield extension.awaitMessage("done");

  expected = {
    isReliable: true,
    languages: [
      {
        language: "af",
        percentage: 99,
      },
    ],
  };
  extension.sendMessage([af_string, expected]);
  yield extension.awaitMessage("done");

  win.close();

  yield extension.unload();
});

</script>

</body>
</html>