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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/**
* The pivot language is used to pivot between two different language translations
* when there is not a model available to translate directly between the two. In this
* case "en" is common between the various supported models.
*
* For instance given the following two models:
* "fr" -> "en"
* "en" -> "it"
*
* You can accomplish:
* "fr" -> "it"
*
* By doing:
* "fr" -> "en" -> "it"
*/
const PIVOT_LANGUAGE = "en";
const TRANSLATIONS_PERMISSION = "translations";
const ALWAYS_TRANSLATE_LANGS_PREF =
"browser.translations.alwaysTranslateLanguages";
const NEVER_TRANSLATE_LANGS_PREF =
"browser.translations.neverTranslateLanguages";
const lazy = {};
import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
ChromeUtils.defineESModuleGetters(lazy, {
RemoteSettings: "resource://services-settings/remote-settings.sys.mjs",
setTimeout: "resource://gre/modules/Timer.sys.mjs",
});
XPCOMUtils.defineLazyGetter(lazy, "console", () => {
return console.createInstance({
maxLogLevelPref: "browser.translations.logLevel",
prefix: "Translations",
});
});
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"translationsEnabledPref",
"browser.translations.enable"
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"autoTranslatePagePref",
"browser.translations.autoTranslate"
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"chaosErrorsPref",
"browser.translations.chaos.errors"
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"chaosTimeoutMSPref",
"browser.translations.chaos.timeoutMS"
);
/**
* Returns the always-translate language tags as an array.
*/
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"alwaysTranslateLangTags",
ALWAYS_TRANSLATE_LANGS_PREF,
/* aDefaultPrefValue */ "",
/* onUpdate */ null,
/* aTransform */ rawLangTags => (rawLangTags ? rawLangTags.split(",") : [])
);
/**
* Returns the never-translate language tags as an array.
*/
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"neverTranslateLangTags",
NEVER_TRANSLATE_LANGS_PREF,
/* aDefaultPrefValue */ "",
/* onUpdate */ null,
/* aTransform */ rawLangTags => (rawLangTags ? rawLangTags.split(",") : [])
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"simulateUnsupportedEnginePref",
"browser.translations.simulateUnsupportedEngine"
);
// At this time the signatures of the files are not being checked when they are being
// loaded from disk. This signature check involves hitting the network, and translations
// are explicitly an offline-capable feature. See Bug 1827265 for re-enabling this
// check.
const VERIFY_SIGNATURES_FROM_FS = false;
/**
* @typedef {import("../translations").TranslationModelRecord} TranslationModelRecord
* @typedef {import("../translations").RemoteSettingsClient} RemoteSettingsClient
* @typedef {import("../translations").LanguageIdEngineMockedPayload} LanguageIdEngineMockedPayload
* @typedef {import("../translations").LanguageTranslationModelFiles} LanguageTranslationModelFiles
* @typedef {import("../translations").WasmRecord} WasmRecord
* @typedef {import("../translations").LangTags} LangTags
* @typedef {import("../translations").LanguagePair} LanguagePair
* @typedef {import("../translations").SupportedLanguages} SupportedLanguages
* @typedef {import("../translations").LanguageIdModelRecord} LanguageIdModelRecord
* @typedef {import("../translations").TranslationErrors} TranslationErrors
*/
/**
* @typedef {Object} TranslationPair
* @prop {string} fromLanguage
* @prop {string} toLanguage
* @prop {string} [fromDisplayLanguage]
* @prop {string} [toDisplayLanguage]
*/
/**
* The translations parent is used to orchestrate translations in Firefox. It can
* download the wasm translation engines, and the machine learning language models.
*
* See Bug 971044 for more details of planned work.
*/
export class TranslationsParent extends JSWindowActorParent {
/**
* Contains the state that would affect UI. Anytime this state is changed, a dispatch
* event is sent so that UI can react to it. The actor is inside of /toolkit and
* needs a way of notifying /browser code (or other users) of when the state changes.
*
* @type {TranslationsLanguageState}
*/
languageState;
actorCreated() {
this.languageState = new TranslationsLanguageState(this);
if (TranslationsParent.#translateOnPageReload) {
// The actor was recreated after a page reload, start the translation.
const { fromLanguage, toLanguage } =
TranslationsParent.#translateOnPageReload;
TranslationsParent.#translateOnPageReload = null;
lazy.console.log(
`Translating on a page reload from "${fromLanguage}" to "${toLanguage}".`
);
this.translate(fromLanguage, toLanguage);
}
}
/**
* The remote settings client that retrieves the language-identification model binary.
*
* @type {RemoteSettingsClient | null}
*/
static #languageIdModelsRemoteClient = null;
/**
* A map of the TranslationModelRecord["id"] to the record of the model in Remote Settings.
* Used to coordinate the downloads.
*
* @type {Map<string, TranslationModelRecord>}
*/
#translationModelRecords = new Map();
/**
* The RemoteSettingsClient that downloads the translation models.
*
* @type {RemoteSettingsClient | null}
*/
static #translationModelsRemoteClient = null;
/**
* The RemoteSettingsClient that downloads the wasm binaries.
*
* @type {RemoteSettingsClient | null}
*/
static #translationsWasmRemoteClient = null;
/**
* If "browser.translations.autoTranslate" is set to "true" then the page will
* auto-translate. A user can restore the page to the original UI. This flag indicates
* that an auto-translate should be skipped.
*/
static #isPageRestoredForAutoTranslate = false;
/**
* Allows the actor's behavior to be changed when the translations engine is mocked via
* a dummy RemoteSettingsClient.
*
* @type {bool}
*/
static #isTranslationsEngineMocked = false;
/**
* The language identification engine can be mocked for testing
* by pre-defining this value.
*
* @type {string | null}
*/
static #mockedLangTag = null;
/**
* The language identification engine can be mocked for testing
* by pre-defining this value.
*
* @type {number | null}
*/
static #mockedLanguageIdConfidence = null;
/**
* @type {null | Promise<boolean>}
*/
static #isTranslationsEngineSupported = null;
/**
* When reloading the page, store the translation pair that needs translating.
*
* @type {null | TranslationPair}
*/
static #translateOnPageReload = null;
/**
* An ordered list of preferred languages based on:
* 1. App languages
* 2. Web requested languages
* 3. OS language
*
* @type {null | string[]}
*/
static #preferredLanguages = null;
static #observingLanguages = false;
// On a fast connection, 10 concurrent downloads were measured to be the fastest when
// downloading all of the language files.
static MAX_CONCURRENT_DOWNLOADS = 10;
static MAX_DOWNLOAD_RETRIES = 3;
/**
* Detect if Wasm SIMD is supported, and cache the value. It's better to check
* for support before downloading large binary blobs to a user who can't even
* use the feature. This function also respects mocks and simulating unsupported
* engines.
*
* @type {Promise<boolean>}
*/
static getIsTranslationsEngineSupported() {
if (lazy.simulateUnsupportedEnginePref) {
// Use the non-lazy console.log so that the user is always informed as to why
// the translations engine is not working.
console.log(
"Translations: The translations engine is disabled through the pref " +
'"browser.translations.simulateUnsupportedEngine".'
);
// The user is manually testing unsupported engines.
return Promise.resolve(false);
}
if (TranslationsParent.#isTranslationsEngineMocked) {
// A mocked translations engine is always supported.
return Promise.resolve(true);
}
if (TranslationsParent.#isTranslationsEngineSupported === null) {
TranslationsParent.#isTranslationsEngineSupported = detectSimdSupport();
TranslationsParent.#isTranslationsEngineSupported.then(
isSupported => () => {
// Use the non-lazy console.log so that the user is always informed as to why
// the translations engine is not working.
if (!isSupported) {
console.log(
"Translations: The translations engine is not supported on your device as " +
"it does not support Wasm SIMD operations."
);
}
}
);
}
return TranslationsParent.#isTranslationsEngineSupported;
}
/**
* Only translate pages that match certain protocols, that way internal pages like
* about:* pages will not be translated.
* @param {string} url
*/
static isRestrictedPage(url) {
// Keep this logic up to date with TranslationsChild.prototype.#isRestrictedPage.
return !(
url.startsWith("http://") ||
url.startsWith("https://") ||
url.startsWith("file:///")
);
}
static #resetPreferredLanguages() {
TranslationsParent.#preferredLanguages = null;
TranslationsParent.getPreferredLanguages();
}
static async observe(_subject, topic, _data) {
switch (topic) {
case "nsPref:changed":
case "intl:app-locales-changed": {
this.#resetPreferredLanguages();
break;
}
default:
throw new Error("Unknown observer event", topic);
}
}
/**
* Provide a way for tests to override the system locales.
* @type {null | string[]}
*/
mockedSystemLocales = null;
/**
* An ordered list of preferred languages based on:
*
* 1. App languages
* 2. Web requested languages
* 3. OS language
*
* @returns {string[]}
*/
static getPreferredLanguages() {
if (TranslationsParent.#preferredLanguages) {
return TranslationsParent.#preferredLanguages;
}
if (!TranslationsParent.#observingLanguages) {
Services.obs.addObserver(
TranslationsParent.#resetPreferredLanguages,
"intl:app-locales-changed"
);
Services.prefs.addObserver(
"intl.accept_languages",
TranslationsParent.#resetPreferredLanguages
);
TranslationsParent.#observingLanguages = true;
}
// The "Accept-Language" values that the localizer or user has indicated for
// the preferences for the web. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
// Note that this preference often falls back ultimately to English, even if the
// user doesn't actually speak English, or to other languages they do not speak.
// However, this preference will be used as an indication that a user may prefer
// this language.
const webLanguages = Services.prefs
.getComplexValue("intl.accept_languages", Ci.nsIPrefLocalizedString)
.data.split(/\s*,\s*/g);
// The system language could also be a good option for a language to offer the user.
const osPrefs = Cc["@mozilla.org/intl/ospreferences;1"].getService(
Ci.mozIOSPreferences
);
const systemLocales = this.mockedSystemLocales ?? osPrefs.systemLocales;
// Combine the locales together.
const preferredLocales = new Set([
...Services.locale.appLocalesAsBCP47,
...webLanguages,
...systemLocales,
]);
// Attempt to convert the locales to lang tags. Do not completely trust the
// values coming from preferences and the OS to have been validated as correct
// BCP 47 locale identifiers.
const langTags = new Set();
for (const locale of preferredLocales) {
try {
langTags.add(new Intl.Locale(locale).language);
} catch (_) {
// The locale was invalid, discard it.
}
}
// Convert the Set to an array to indicate that it is an ordered listing of languages.
TranslationsParent.#preferredLanguages = [...langTags];
return TranslationsParent.#preferredLanguages;
}
async receiveMessage({ name, data }) {
switch (name) {
case "Translations:GetTranslationsEnginePayload": {
const { fromLanguage, toLanguage } = data;
const bergamotWasmArrayBuffer = this.#getBergamotWasmArrayBuffer();
let files = await this.getLanguageTranslationModelFiles(
fromLanguage,
toLanguage
);
let languageModelFiles;
if (files) {
languageModelFiles = [files];
} else {
// No matching model was found, try to pivot between English.
const [files1, files2] = await Promise.all([
this.getLanguageTranslationModelFiles(fromLanguage, PIVOT_LANGUAGE),
this.getLanguageTranslationModelFiles(PIVOT_LANGUAGE, toLanguage),
]);
if (!files1 || !files2) {
throw new Error(
`No language models were found for ${fromLanguage} to ${toLanguage}`
);
}
languageModelFiles = [files1, files2];
}
return {
bergamotWasmArrayBuffer: await bergamotWasmArrayBuffer,
languageModelFiles,
isMocked: TranslationsParent.#isTranslationsEngineMocked,
};
}
case "Translations:GetLanguageIdEnginePayload": {
const [modelBuffer, wasmBuffer] = await Promise.all([
this.#getLanguageIdModelArrayBuffer(),
this.#getLanguageIdWasmArrayBuffer(),
]);
return {
modelBuffer,
wasmBuffer,
mockedConfidence: TranslationsParent.#mockedLanguageIdConfidence,
mockedLangTag: TranslationsParent.#mockedLangTag,
};
}
case "Translations:GetIsTranslationsEngineMocked": {
return TranslationsParent.#isTranslationsEngineMocked;
}
case "Translations:GetIsTranslationsEngineSupported": {
return TranslationsParent.getIsTranslationsEngineSupported();
}
case "Translations:FullPageTranslationFailed": {
this.languageState.error = data.reason;
break;
}
case "Translations:GetSupportedLanguages": {
return this.getSupportedLanguages();
}
case "Translations:HasAllFilesForLanguage": {
return this.hasAllFilesForLanguage(data.language);
}
case "Translations:DownloadLanguageFiles": {
return this.downloadLanguageFiles(data.language);
}
case "Translations:DownloadAllFiles": {
return this.downloadAllFiles();
}
case "Translations:DeleteAllLanguageFiles": {
return this.deleteAllLanguageFiles();
}
case "Translations:DeleteLanguageFiles": {
return this.deleteLanguageFiles(data.language);
}
case "Translations:GetLanguagePairs": {
return this.getLanguagePairs();
}
case "Translations:GetPreferredLanguages": {
return TranslationsParent.getPreferredLanguages();
}
case "Translations:EngineIsReady": {
this.isEngineReady = true;
this.languageState.isEngineReady = true;
break;
}
case "Translations:GetTranslationConditions": {
const maybeAutoTranslate = TranslationsParent.#maybeAutoTranslate(
data.docLangTag
);
const maybeNeverTranslate =
TranslationsParent.shouldNeverTranslateLanguage(data.docLangTag) ||
(await this.shouldNeverTranslateSite());
if (maybeAutoTranslate && !maybeNeverTranslate) {
this.languageState.requestedTranslationPair = {
fromLanguage: data.docLangTag,
toLanguage: data.userLangTag,
};
}
return { maybeAutoTranslate, maybeNeverTranslate };
}
case "Translations:ReportDetectedLangTags": {
this.languageState.detectedLanguages = data.langTags;
return undefined;
}
}
return undefined;
}
/**
* Returns true if translations should auto-translate from the given
* language, otherwise returns false.
*
* @param {string} langTag - A BCP-47 language tag
* @returns {boolean}
*/
static #maybeAutoTranslate(langTag) {
if (
// The user has not marked this language as always translate.
!TranslationsParent.shouldAlwaysTranslateLanguage(langTag) &&
// The pref to always auto-translate is off.
!lazy.autoTranslatePagePref
) {
return false;
}
if (TranslationsParent.#isPageRestoredForAutoTranslate) {
// The user clicked the restore button. Respect it for one page load.
TranslationsParent.#isPageRestoredForAutoTranslate = false;
// Skip this auto-translation.
return false;
}
// The page can be auto-translated
return true;
}
/**
* Retrieves the language-identification model binary from remote settings.
*
* @returns {Promise<ArrayBuffer>}
*/
async #getLanguageIdModelArrayBuffer() {
lazy.console.log("Getting language-identification model array buffer.");
const now = Date.now();
const client = this.#getLanguageIdModelRemoteClient();
/** @type {LanguageIdModelRecord[]} */
let modelRecords = await TranslationsParent.getMaxVersionRecords(client);
if (modelRecords.length === 0) {
throw new Error(
"Unable to get language-identification model record from remote settings"
);
}
if (modelRecords.length > 1) {
TranslationsParent.reportError(
new Error(
"Expected the language-identification model collection to have only 1 record."
),
modelRecords
);
}
const [modelRecord] = modelRecords;
await chaosMode(1 / 3);
/** @type {{buffer: ArrayBuffer}} */
const { buffer } = await client.attachments.download(modelRecord);
const duration = (Date.now() - now) / 1000;
lazy.console.log(
`Remote language-identification model loaded in ${duration} seconds.`
);
return buffer;
}
/**
* Initializes the RemoteSettingsClient for the language-identification model binary.
*
* @returns {RemoteSettingsClient}
*/
#getLanguageIdModelRemoteClient() {
if (TranslationsParent.#languageIdModelsRemoteClient) {
return TranslationsParent.#languageIdModelsRemoteClient;
}
/** @type {RemoteSettingsClient} */
const client = lazy.RemoteSettings("translations-identification-models");
TranslationsParent.#languageIdModelsRemoteClient = client;
return client;
}
/**
* Retrieves the language-identification wasm binary from remote settings.
*
* @returns {Promise<ArrayBuffer>}
*/
async #getLanguageIdWasmArrayBuffer() {
const start = Date.now();
const client = this.#getTranslationsWasmRemoteClient();
// Load the wasm binary from remote settings, if it hasn't been already.
lazy.console.log(`Getting remote language-identification wasm binary.`);
/** @type {WasmRecord[]} */
let wasmRecords = await TranslationsParent.getMaxVersionRecords(client, {
filters: { name: "fasttext-wasm" },
});
if (wasmRecords.length === 0) {
// The remote settings client provides an empty list of records when there is
// an error.
throw new Error(
'Unable to get "fasttext-wasm" language-identification wasm binary from Remote Settings.'
);
}
if (wasmRecords.length > 1) {
TranslationsParent.reportError(
new Error(
'Expected the "fasttext-wasm" language-identification wasm collection to only have 1 record.'
),
wasmRecords
);
}
// Unlike the models, greedily download the wasm. It will pull it from a locale
// cache on disk if it's already been downloaded. Do not retain a copy, as
// this will be running in the parent process. It's not worth holding onto
// this much memory, so reload it every time it is needed.
await chaosMode(1 / 3);
/** @type {{buffer: ArrayBuffer}} */
const { buffer } = await client.attachments.download(wasmRecords[0]);
const duration = (Date.now() - start) / 1000;
lazy.console.log(
`Remote language-identification wasm binary loaded in ${duration} seconds.`
);
return buffer;
}
/**
* Creates a lookup key that is unique to each fromLanguage-toLanguage pair.
*
* @param {string} fromLanguage
* @param {string} toLanguage
* @returns {string}
*/
static languagePairKey(fromLanguage, toLanguage) {
return `${fromLanguage},${toLanguage}`;
}
/**
* Get the list of translation pairs supported by the translations engine.
*
* @returns {Promise<Array<LanguagePair>>}
*/
async getLanguagePairs() {
const records = await this.#getTranslationModelRecords();
const languagePairMap = new Map();
for (const { fromLang, toLang, version } of records.values()) {
const isBeta = Services.vc.compare(version, "1.0") < 0;
const key = TranslationsParent.languagePairKey(fromLang, toLang);
if (!languagePairMap.has(key)) {
languagePairMap.set(key, { fromLang, toLang, isBeta });
}
}
return Array.from(languagePairMap.values());
}
/**
* Returns all of the information needed to render dropdowns for translation
* language selection.
*
* @returns {Promise<SupportedLanguages>}
*/
async getSupportedLanguages() {
const languagePairs = await this.getLanguagePairs();
/** @type {Map<string, boolean>} */
const fromLanguages = new Map();
/** @type {Map<string, boolean>} */
const toLanguages = new Map();
for (const { fromLang, toLang, isBeta } of languagePairs) {
// [BetaLanguage, BetaLanguage] => isBeta == true,
// [BetaLanguage, NonBetaLanguage] => isBeta == true,
// [NonBetaLanguage, BetaLanguage] => isBeta == true,
// [NonBetaLanguage, NonBetaLanguage] => isBeta == false,
if (isBeta) {
// If these languages are part of a beta languagePair, at least one of them is a beta language
// but the other may not be, so only tentatively mark them as beta if there is no entry.
if (!fromLanguages.has(fromLang)) {
fromLanguages.set(fromLang, isBeta);
}
if (!toLanguages.has(toLang)) {
toLanguages.set(toLang, isBeta);
}
} else {
// If these languages are part of a non-beta languagePair, then they are both
// guaranteed to be non-beta languages. Idempotently overwrite any previous entry.
fromLanguages.set(fromLang, isBeta);
toLanguages.set(toLang, isBeta);
}
}
// Build a map of the langTag to the display name.
/** @type {Map<string, string>} */
const displayNames = new Map();
{
const dn = new Services.intl.DisplayNames(undefined, {
type: "language",
});
for (const langTagSet of [fromLanguages, toLanguages]) {
for (const langTag of langTagSet.keys()) {
if (displayNames.has(langTag)) {
continue;
}
displayNames.set(langTag, dn.of(langTag));
}
}
}
const addDisplayName = ([langTag, isBeta]) => ({
langTag,
isBeta,
displayName: displayNames.get(langTag),
});
const sort = (a, b) => a.displayName.localeCompare(b.displayName);
return {
languagePairs,
fromLanguages: Array.from(fromLanguages.entries())
.map(addDisplayName)
.sort(sort),
toLanguages: Array.from(toLanguages.entries())
.map(addDisplayName)
.sort(sort),
};
}
/**
* Lazily initializes the RemoteSettingsClient for the language models.
*
* @returns {RemoteSettingsClient}
*/
#getTranslationModelsRemoteClient() {
if (TranslationsParent.#translationModelsRemoteClient) {
return TranslationsParent.#translationModelsRemoteClient;
}
/** @type {RemoteSettingsClient} */
const client = lazy.RemoteSettings("translations-models");
TranslationsParent.#translationModelsRemoteClient = client;
client.on("sync", async ({ data: { created, updated, deleted } }) => {
// Language model attachments will only be downloaded when they are used.
lazy.console.log(
`Remote Settings "sync" event for remote language models `,
{
created,
updated,
deleted,
}
);
// Remove all the deleted records.
for (const record of deleted) {
await client.attachments.deleteDownloaded(record);
this.#translationModelRecords.delete(record.id);
}
// Pre-emptively remove the old downloads, and set the new updated record.
for (const { old: oldRecord, new: newRecord } of updated) {
await client.attachments.deleteDownloaded(oldRecord);
// The language pairs should be the same on the update, but use the old
// record just in case.
this.#translationModelRecords.delete(oldRecord.id);
this.#translationModelRecords.set(newRecord.id, newRecord);
}
// Add the new records, but don't download any attachments.
for (const record of created) {
this.#translationModelRecords.set(record.id, record);
}
});
return client;
}
/**
* Retrieves the maximum version of each record in the RemoteSettingsClient.
*
* If the client contains two different-version copies of the same record (e.g. 1.0 and 1.1)
* then only the 1.1-version record will be returned in the resulting collection.
*
* @param {RemoteSettingsClient} remoteSettingsClient
* @param {Object} [options]
* @param {Object} [options.filters={}]
* The filters to apply when retrieving the records from RemoteSettings.
* Filters should correspond to properties on the RemoteSettings records themselves.
* For example, A filter to retrieve only records with a `fromLang` value of "en" and a `toLang` value of "es":
* { filters: { fromLang: "en", toLang: "es" } }
* @param {Function} [options.lookupKey=(record => record.name)]
* The function to use to extract a lookup key from each record.
* This function should take a record as input and return a string that represents the lookup key for the record.
* For most record types, the name (default) is sufficient, however if a collection contains records with
* non-unique name values, it may be necessary to provide an alternative function here.
* @returns {Array<TranslationModelRecord | LanguageIdModelRecord | WasmRecord>}
*/
static async getMaxVersionRecords(
remoteSettingsClient,
{ filters = {}, lookupKey = record => record.name } = {}
) {
try {
await chaosMode(1 / 4);
} catch (_error) {
// Simulate an error by providing empty records.
return [];
}
const retrievedRecords = await remoteSettingsClient.get({
// Pull the records from the network.
syncIfEmpty: true,
// Don't verify the signature if the client is mocked.
verifySignature: VERIFY_SIGNATURES_FROM_FS,
// Apply any filters for retrieving the records.
filters,
});
// Create a mapping to only the max version of each record discriminated by
// the result of the lookupKey() function.
const maxVersionRecordMap = retrievedRecords.reduce((records, record) => {
const key = lookupKey(record);
const existing = records.get(key);
if (
!existing ||
// existing version less than record version
Services.vc.compare(existing.version, record.version) < 0
) {
records.set(key, record);
}
return records;
}, new Map());
return Array.from(maxVersionRecordMap.values());
}
/**
* Lazily initializes the model records, and returns the cached ones if they
* were already retrieved. The key of the returned `Map` is the record id.
*
* @returns {Promise<Map<string, TranslationModelRecord>>}
*/
async #getTranslationModelRecords() {
if (this.#translationModelRecords.size > 0) {
return this.#translationModelRecords;
}
const now = Date.now();
const client = this.#getTranslationModelsRemoteClient();
// Load the models. If no data is present, then there will be an initial sync.
// Rely on Remote Settings for the syncing strategy for receiving updates.
lazy.console.log(`Getting remote language models.`);
/** @type {TranslationModelRecord[]} */
const translationModelRecords =
await TranslationsParent.getMaxVersionRecords(client, {
// Names in this collection are not unique, so we are appending the languagePairKey
// to guarantee uniqueness.
lookupKey: record =>
`${record.name}${TranslationsParent.languagePairKey(
record.fromLang,
record.toLang
)}`,
});
if (translationModelRecords.length === 0) {
throw new Error("Unable to retrieve the translation models.");
}
for (const record of TranslationsParent.ensureLanguagePairsHavePivots(
translationModelRecords
)) {
this.#translationModelRecords.set(record.id, record);
}
const duration = (Date.now() - now) / 1000;
lazy.console.log(
`Remote language models loaded in ${duration} seconds.`,
this.#translationModelRecords
);
return this.#translationModelRecords;
}
/**
* This implementation assumes that every language pair has access to the
* pivot language. If any languages are added without a pivot language, or the
* pivot language is changed, then this implementation will need a more complicated
* language solver. This means that any UI pickers would need to be updated, and
* the pivot language selection would need a solver.
*
* @param {TranslationModelRecord[] | LanguagePair[]} records
*/
static ensureLanguagePairsHavePivots(records) {
// lang -> pivot
const hasToPivot = new Set();
// pivot -> en
const hasFromPivot = new Set();
const fromLangs = new Set();
const toLangs = new Set();
for (const { fromLang, toLang } of records) {
fromLangs.add(fromLang);
toLangs.add(toLang);
if (toLang === PIVOT_LANGUAGE) {
// lang -> pivot
hasToPivot.add(fromLang);
}
if (fromLang === PIVOT_LANGUAGE) {
// pivot -> en
hasFromPivot.add(toLang);
}
}
const fromLangsToRemove = new Set();
const toLangsToRemove = new Set();
for (const lang of fromLangs) {
if (lang === PIVOT_LANGUAGE) {
continue;
}
// Check for "lang -> pivot"
if (!hasToPivot.has(lang)) {
TranslationsParent.reportError(
new Error(
`The "from" language model "${lang}" is being discarded as it doesn't have a pivot language.`
)
);
fromLangsToRemove.add(lang);
}
}
for (const lang of toLangs) {
if (lang === PIVOT_LANGUAGE) {
continue;
}
// Check for "pivot -> lang"
if (!hasFromPivot.has(lang)) {
TranslationsParent.reportError(
new Error(
`The "to" language model "${lang}" is being discarded as it doesn't have a pivot language.`
)
);
toLangsToRemove.add(lang);
}
}
const after = records.filter(record => {
if (fromLangsToRemove.has(record.fromLang)) {
return false;
}
if (toLangsToRemove.has(record.toLang)) {
return false;
}
return true;
});
return after;
}
/**
* Lazily initializes the RemoteSettingsClient for the downloaded wasm binary data.
*
* @returns {RemoteSettingsClient}
*/
#getTranslationsWasmRemoteClient() {
if (TranslationsParent.#translationsWasmRemoteClient) {
return TranslationsParent.#translationsWasmRemoteClient;
}
/** @type {RemoteSettingsClient} */
const client = lazy.RemoteSettings("translations-wasm");
TranslationsParent.#translationsWasmRemoteClient = client;
client.on("sync", async ({ data: { created, updated, deleted } }) => {
lazy.console.log(`"sync" event for remote bergamot wasm `, {
created,
updated,
deleted,
});
// Remove all the deleted records.
for (const record of deleted) {
await client.attachments.deleteDownloaded(record);
}
// Remove any updated records, and download the new ones.
for (const { old: oldRecord } of updated) {
await client.attachments.deleteDownloaded(oldRecord);
}
// Do nothing for the created records.
});
return client;
}
/**
* Bergamot is the translation engine that has been compiled to wasm. It is shipped
* to the user via Remote Settings.
*
* https://github.com/mozilla/bergamot-translator/
*/
/**
* @returns {Promise<ArrayBuffer>}
*/
async #getBergamotWasmArrayBuffer() {
const start = Date.now();
const client = this.#getTranslationsWasmRemoteClient();
// Load the wasm binary from remote settings, if it hasn't been already.
lazy.console.log(`Getting remote bergamot-translator wasm records.`);
/** @type {WasmRecord[]} */
const wasmRecords = await TranslationsParent.getMaxVersionRecords(client, {
filters: { name: "bergamot-translator" },
});
if (wasmRecords.length === 0) {
// The remote settings client provides an empty list of records when there is
// an error.
throw new Error(
"Unable to get the bergamot translator from Remote Settings."
);
}
if (wasmRecords.length > 1) {
TranslationsParent.reportError(
new Error("Expected the bergamot-translator to only have 1 record."),
wasmRecords
);
}
// Unlike the models, greedily download the wasm. It will pull it from a locale
// cache on disk if it's already been downloaded. Do not retain a copy, as
// this will be running in the parent process. It's not worth holding onto
// this much memory, so reload it every time it is needed.
await chaosModeError(1 / 3);
/** @type {{buffer: ArrayBuffer}} */
const { buffer } = await client.attachments.download(wasmRecords[0]);
const duration = Date.now() - start;
lazy.console.log(
`"bergamot-translator" wasm binary loaded in ${duration / 1000} seconds`
);
return buffer;
}
/**
* Deletes language files that match a language.
*
* @param {string} requestedLanguage The BCP 47 language tag.
*/
async deleteLanguageFiles(language) {
const client = this.#getTranslationModelsRemoteClient();
const isForDeletion = true;
return Promise.all(
Array.from(
await this.getRecordsForTranslatingToAndFromAppLanguage(
language,
isForDeletion
)
).map(record => {
lazy.console.log("Deleting record", record);
return client.attachments.deleteDownloaded(record);
})
);
}
/**
* Download language files that match a language.
*
* @param {string} requestedLanguage The BCP 47 language tag.
*/
async downloadLanguageFiles(language) {
const client = this.#getTranslationModelsRemoteClient();
const queue = [];
for (const record of await this.getRecordsForTranslatingToAndFromAppLanguage(
language
)) {
const download = () => {
lazy.console.log("Downloading record", record.name, record.id);
return client.attachments.download(record);
};
queue.push({ download });
}
return downloadManager(queue);
}
/**
* Download all files used for translations.
*/
async downloadAllFiles() {
const client = this.#getTranslationModelsRemoteClient();
const queue = [];
for (const [recordId, record] of await this.#getTranslationModelRecords()) {
queue.push({
onSuccess: () => {
this.sendQuery("Translations:DownloadedLanguageFile", { recordId });
},
// The download may be attempted multiple times.
onFailure: () => {
this.sendQuery("Translations:DownloadLanguageFileError", {
recordId,
});
},
download: () => client.attachments.download(record),
});
}
queue.push({ download: () => this.#getBergamotWasmArrayBuffer() });
queue.push({ download: () => this.#getLanguageIdModelArrayBuffer() });
queue.push({ download: () => this.#getLanguageIdWasmArrayBuffer() });
return downloadManager(queue);
}
/**
* Delete all language model files.
* @returns {Promise<string[]>} A list of record IDs.
*/
async deleteAllLanguageFiles() {
const client = this.#getTranslationModelsRemoteClient();
await chaosMode();
await client.attachments.deleteAll();
return [...(await this.#getTranslationModelRecords()).keys()];
}
/**
* Only returns true if all language files are present for a requested language.
* It's possible only half the files exist for a pivot translation into another
* language, or there was a download error, and we're still missing some files.
*
* @param {string} requestedLanguage The BCP 47 language tag.
*/
async hasAllFilesForLanguage(requestedLanguage) {
const client = this.#getTranslationModelsRemoteClient();
for (const record of await this.getRecordsForTranslatingToAndFromAppLanguage(
requestedLanguage,
true
)) {
if (!(await client.attachments.isDownloaded(record))) {
return false;
}
}
return true;
}
/**
* Get the necessary files for translating to and from the app language and a
* requested language. This may require the files for a pivot language translation
* if there is no language model for a direct translation.
*
* @param {string} requestedLanguage The BCP 47 language tag.
* @param {boolean} isForDeletion - Return a more restrictive set of languages, as
* these files are marked for deletion. We don't want to remove
* files that are needed for some other language's pivot translation.
* @returns {Set<TranslationModelRecord>}
*/
async getRecordsForTranslatingToAndFromAppLanguage(
requestedLanguage,
isForDeletion = false
) {
const records = await this.#getTranslationModelRecords();
const appLanguage = new Intl.Locale(Services.locale.appLocaleAsBCP47)
.language;
let matchedRecords = new Set();
if (requestedLanguage === appLanguage) {
// There are no records if the requested language and app language are the same.
return matchedRecords;
}
const addLanguagePair = (fromLang, toLang) => {
let matchFound = false;
for (const record of records.values()) {
if (record.fromLang === fromLang && record.toLang === toLang) {
matchedRecords.add(record);
matchFound = true;
}
}
return matchFound;
};
if (
// Is there a direct translation?
!addLanguagePair(requestedLanguage, appLanguage)
) {
// This is no direct translation, get the pivot files.
addLanguagePair(requestedLanguage, PIVOT_LANGUAGE);
// These files may be required for other pivot translations, so don't remove
// them if we are deleting records.
if (!isForDeletion) {
addLanguagePair(PIVOT_LANGUAGE, appLanguage);
}
}
if (
// Is there a direct translation?
!addLanguagePair(appLanguage, requestedLanguage)
) {
// This is no direct translation, get the pivot files.
addLanguagePair(PIVOT_LANGUAGE, requestedLanguage);
// These files may be required for other pivot translations, so don't remove
// them if we are deleting records.
if (!isForDeletion) {
addLanguagePair(appLanguage, PIVOT_LANGUAGE);
}
}
return matchedRecords;
}
/**
* Gets the language model files in an array buffer by downloading attachments from
* Remote Settings, or retrieving them from the local cache. Each translation
* requires multiple files.
*
* Results are only returned if the model is found.
*
* @param {string} fromLanguage
* @param {string} toLanguage
* @param {boolean} withQualityEstimation
* @returns {null | LanguageTranslationModelFiles}
*/
async getLanguageTranslationModelFiles(
fromLanguage,
toLanguage,
withQualityEstimation = false
) {
const client = this.#getTranslationModelsRemoteClient();
lazy.console.log(
`Beginning model downloads: "${fromLanguage}" to "${toLanguage}"`
);
const records = [...(await this.#getTranslationModelRecords()).values()];
/** @type {LanguageTranslationModelFiles} */
let results;
// Use Promise.all to download (or retrieve from cache) the model files in parallel.
await Promise.all(
records.map(async record => {
if (record.fileType === "qualityModel" && !withQualityEstimation) {
// Do not include the quality models if they aren't needed.
return;
}
if (record.fromLang !== fromLanguage || record.toLang !== toLanguage) {
// Only use models that match.
return;
}
if (!results) {
results = {};
}
const start = Date.now();
// Download or retrieve from the local cache:
await chaosMode(1 / 3);
/** @type {{buffer: ArrayBuffer }} */
const { buffer } = await client.attachments.download(record);
results[record.fileType] = {
buffer,
record,
};
const duration = Date.now() - start;
lazy.console.log(
`Translation model fetched in ${duration / 1000} seconds:`,
record.fromLang,
record.toLang,
record.fileType
);
})
);
if (!results) {
// No model files were found, pivoting will be required.
return null;
}
// Validate that all of the files we expected were actually available and
// downloaded.
if (!results.model) {
throw new Error(
`No model file was found for "${fromLanguage}" to "${toLanguage}."`
);
}
if (!results.lex) {
throw new Error(
`No lex file was found for "${fromLanguage}" to "${toLanguage}."`
);
}
if (withQualityEstimation && !results.qualityModel) {
throw new Error(
`No quality file was found for "${fromLanguage}" to "${toLanguage}."`
);
}
if (results.vocab) {
if (results.srcvocab) {
throw new Error(
`A srcvocab and vocab file were both included for "${fromLanguage}" to "${toLanguage}." Only one is needed.`
);
}
if (results.trgvocab) {
throw new Error(
`A trgvocab and vocab file were both included for "${fromLanguage}" to "${toLanguage}." Only one is needed.`
);
}
} else if (!results.srcvocab || !results.srcvocab) {
throw new Error(
`No vocab files were provided for "${fromLanguage}" to "${toLanguage}."`
);
}
return results;
}
/**
* For testing purposes, allow the Translations Engine to be mocked. If called
* with `null` the mock is removed.
*
* @param {null | RemoteSettingsClient} [translationModelsRemoteClient]
* @param {null | RemoteSettingsClient} [translationsWasmRemoteClient]
*/
static mockTranslationsEngine(
translationModelsRemoteClient,
translationsWasmRemoteClient
) {
lazy.console.log("Mocking RemoteSettings for the translations engine.");
TranslationsParent.#translationModelsRemoteClient =
translationModelsRemoteClient;
TranslationsParent.#translationsWasmRemoteClient =
translationsWasmRemoteClient;
TranslationsParent.#isTranslationsEngineMocked = true;
}
/**
* Remove the mocks.
*/
static unmockTranslationsEngine() {
lazy.console.log(
"Removing RemoteSettings mock for the translations engine."
);
TranslationsParent.#translationModelsRemoteClient = null;
TranslationsParent.#translationsWasmRemoteClient = null;
TranslationsParent.#isTranslationsEngineMocked = false;
}
/**
* For testing purposes, allow the LanguageIdEngine to be mocked. If called
* with `null` in each argument, the mock is removed.
*
* @param {string} langTag - The BCP 47 language tag.
* @param {number} confidence - The confidence score of the detected language.
* @param {RemoteSettingsClient} client
*/
static mockLanguageIdentification(langTag, confidence, client) {
lazy.console.log("Mocking language identification.", {
langTag,
confidence,
});
TranslationsParent.#mockedLangTag = langTag;
TranslationsParent.#mockedLanguageIdConfidence = confidence;
TranslationsParent.#languageIdModelsRemoteClient = client;
}
/**
* Remove the mocks
*/
static unmockLanguageIdentification() {
lazy.console.log("Removing language identification mock.");
TranslationsParent.#mockedLangTag = null;
TranslationsParent.#mockedLanguageIdConfidence = null;
TranslationsParent.#languageIdModelsRemoteClient = null;
}
/**
* Report an error. Having this as a method allows tests to check that an error
* was properly reported.
* @param {Error} error - Providing an Error object makes sure the stack is properly
* reported.
* @param {any[]} args - Any args to pass on to console.error.
*/
static reportError(error, ...args) {
lazy.console.log(error, ...args);
}
/**
* @param {string} fromLanguage
* @param {string} toLanguage
*/
translate(fromLanguage, toLanguage) {
if (this.languageState.requestedTranslationPair) {
// This page has already been translated, restore it and translate it
// again once the actor has been recreated.
TranslationsParent.#translateOnPageReload = { fromLanguage, toLanguage };
this.restorePage(fromLanguage);
} else {
this.languageState.requestedTranslationPair = {
fromLanguage,
toLanguage,
};
this.sendAsyncMessage("Translations:TranslatePage", {
fromLanguage,
toLanguage,
});
}
}
/**
* Restore the page to the original language by doing a hard reload.
*
* @param {string} fromLanguage A BCP-47 language tag
*/
restorePage(fromLanguage) {
if (
lazy.autoTranslatePagePref ||
TranslationsParent.shouldAlwaysTranslateLanguage(fromLanguage)
) {
// Skip auto-translate for one page load.
TranslationsParent.#isPageRestoredForAutoTranslate = true;
}
this.languageState.requestedTranslationPair = null;
const browser = this.browsingContext.embedderElement;
browser.reload();
}
/**
* Keep track of when the location changes.
*/
static #locationChangeId = 0;
static onLocationChange(browser) {
if (!lazy.translationsEnabledPref) {
// The pref isn't enabled, so don't attempt to get the actor.
return;
}
let windowGlobal = browser.browsingContext.currentWindowGlobal;
let actor = windowGlobal.getActor("Translations");
TranslationsParent.#locationChangeId++;
actor.languageState.locationChangeId = TranslationsParent.#locationChangeId;
}
/**
* Is this actor active for the current location change?
*
* @param {number} locationChangeId - The id sent by the "TranslationsParent:LanguageState" event.
* @returns {boolean}
*/
static isActiveLocation(locationChangeId) {
return locationChangeId === TranslationsParent.#locationChangeId;
}
/**
* Returns the lang tags that should be offered for translation.
*
* @returns {Promise<LangTags>}
*/
getLangTagsForTranslation() {
return this.sendQuery("Translations:GetLangTagsForTranslation");
}
/**
* Returns the principal from the content window's origin.
* @returns {nsIPrincipal}
*/
getContentWindowPrincipal() {
return this.sendQuery("Translations:GetContentWindowPrincipal");
}
/**
* Returns true if the given language tag is present in the always-translate
* languages preference, otherwise false.
*
* @param {string} langTag - A BCP-47 language tag
* @returns {boolean}
*/
static shouldAlwaysTranslateLanguage(langTag) {
return lazy.alwaysTranslateLangTags.includes(langTag);
}
/**
* Returns true if the given language tag is present in the never-translate
* languages preference, otherwise false.
*
* @param {string} langTag - A BCP-47 language tag
* @returns {boolean}
*/
static shouldNeverTranslateLanguage(langTag) {
return lazy.neverTranslateLangTags.includes(langTag);
}
/**
* Returns true if the current site is denied permissions to translate,
* otherwise returns false.
*
* @returns {Promise<boolean>}
*/
async shouldNeverTranslateSite() {
let principal;
try {
principal = await this.getContentWindowPrincipal();
} catch {
// Unable to get content window principal.
return false;
}
const perms = Services.perms;
const permission = perms.getPermissionObject(
principal,
TRANSLATIONS_PERMISSION,
/* exactHost */ false
);
return permission?.capability === perms.DENY_ACTION;
}
/**
* Removes the given language tag from the given preference.
*
* @param {string} langTag - A BCP-47 language tag
* @param {string} prefName - The pref name
*/
static #removeLangTagFromPref(langTag, prefName) {
const langTags =
prefName === ALWAYS_TRANSLATE_LANGS_PREF
? lazy.alwaysTranslateLangTags
: lazy.neverTranslateLangTags;
const newLangTags = langTags.filter(tag => tag !== langTag);
Services.prefs.setCharPref(prefName, newLangTags.join(","));
}
/**
* Adds the given language tag to the given preference.
*
* @param {string} langTag - A BCP-47 language tag
* @param {string} prefName - The pref name
*/
static #addLangTagToPref(langTag, prefName) {
const langTags =
prefName === ALWAYS_TRANSLATE_LANGS_PREF
? lazy.alwaysTranslateLangTags
: lazy.neverTranslateLangTags;
if (!langTags.includes(langTag)) {
langTags.push(langTag);
}
Services.prefs.setCharPref(prefName, langTags.join(","));
}
/**
* Toggles the always-translate language preference by adding the language
* to the pref list if it is not present, or removing it if it is present.
*
* @param {string} langTag - A BCP-47 language tag
*/
static toggleAlwaysTranslateLanguagePref(langTag) {
if (TranslationsParent.shouldAlwaysTranslateLanguage(langTag)) {
// The pref was toggled off for this langTag
this.#removeLangTagFromPref(langTag, ALWAYS_TRANSLATE_LANGS_PREF);
return;
}
// The pref was toggled on for this langTag
this.#addLangTagToPref(langTag, ALWAYS_TRANSLATE_LANGS_PREF);
this.#removeLangTagFromPref(langTag, NEVER_TRANSLATE_LANGS_PREF);
}
/**
* Toggles the never-translate language preference by adding the language
* to the pref list if it is not present, or removing it if it is present.
*
* @param {string} langTag - A BCP-47 language tag
*/
static toggleNeverTranslateLanguagePref(langTag) {
if (TranslationsParent.shouldNeverTranslateLanguage(langTag)) {
// The pref was toggled off for this langTag
this.#removeLangTagFromPref(langTag, NEVER_TRANSLATE_LANGS_PREF);
return;
}
// The pref was toggled on for this langTag
this.#addLangTagToPref(langTag, NEVER_TRANSLATE_LANGS_PREF);
this.#removeLangTagFromPref(langTag, ALWAYS_TRANSLATE_LANGS_PREF);
}
/**
* Toggles the never-translate site permissions by adding DENY_ACTION to
* the site principal if it is not present, or removing it if it is present.
*/
async toggleNeverTranslateSitePermissions() {
const perms = Services.perms;
const principal = await this.getContentWindowPrincipal();
const shouldNeverTranslateSite = await this.shouldNeverTranslateSite();
if (shouldNeverTranslateSite) {
perms.removeFromPrincipal(principal, TRANSLATIONS_PERMISSION);
} else {
perms.addFromPrincipal(
principal,
TRANSLATIONS_PERMISSION,
perms.DENY_ACTION
);
}
}
}
/**
* WebAssembly modules must be instantiated from a Worker, since it's considered
* unsafe eval.
*/
function detectSimdSupport() {
return new Promise(resolve => {
lazy.console.log("Loading wasm simd detector worker.");
const worker = new Worker(
"chrome://global/content/translations/simd-detect-worker.js"
);
// This should pretty much immediately resolve, so it does not need Firefox shutdown
// detection.
worker.addEventListener("message", ({ data }) => {
resolve(data.isSimdSupported);
worker.terminate();
});
});
}
/**
* State that affects the UI. Any of the state that gets set triggers a dispatch to update
* the UI.
*/
class TranslationsLanguageState {
/**
* @param {TranslationsParent} actor
*/
constructor(actor) {
this.#actor = actor;
this.dispatch();
}
/**
* The data members for TranslationsLanguageState, see the getters for their
* documentation.
*/
/** @type {TranslationsParent} */
#actor;
/** @type {TranslationPair | null} */
#requestedTranslationPair = null;
/** @type {LangTags | null} */
#detectedLanguages = null;
/** @type {number} */
#locationChangeId = -1;
/** @type {null | TranslationErrors} */
#error = null;
#isEngineReady = false;
/**
* Dispatch anytime the language details change, so that any UI can react to it.
*/
dispatch() {
if (!TranslationsParent.isActiveLocation(this.#locationChangeId)) {
// Do not dispatch as this location is not active.
return;
}
const browser = this.#actor.browsingContext.top.embedderElement;
if (!browser) {
return;
}
const { CustomEvent } = browser.ownerGlobal;
browser.dispatchEvent(
new CustomEvent("TranslationsParent:LanguageState", {
bubbles: true,
detail: {
detectedLanguages: this.#detectedLanguages,
requestedTranslationPair: this.#requestedTranslationPair,
error: this.#error,
isEngineReady: this.#isEngineReady,
},
})
);
}
/**
* When a translation is requested, this contains the translation pair. This means
* that the TranslationsChild should be creating a TranslationsDocument and keep
* the page updated with the target language.
*
* @returns {TranslationPair | null}
*/
get requestedTranslationPair() {
return this.#requestedTranslationPair;
}
set requestedTranslationPair(requestedTranslationPair) {
this.#error = null;
this.#isEngineReady = false;
this.#requestedTranslationPair = requestedTranslationPair;
this.dispatch();
}
/**
* The TranslationsChild will detect languages and offer them up for translation.
* The results are stored here.
*
* @returns {LangTags | null}
*/
get detectedLanguages() {
return this.#detectedLanguages;
}
set detectedLanguages(detectedLanguages) {
this.#detectedLanguages = detectedLanguages;
this.dispatch();
}
/**
* This id represents the last location change that happened for this actor. This
* allows the UI to disambiguate when there are races and out of order events that
* are dispatched. Only the most up to date `locationChangeId` is used.
*
* @returns {number}
*/
get locationChangeId() {
return this.#locationChangeId;
}
set locationChangeId(locationChangeId) {
this.#locationChangeId = locationChangeId;
// When the location changes remove the previous error.
this.#error = null;
this.dispatch();
}
/**
* The last error that occured during translation.
*/
get error() {
return this.#error;
}
set error(error) {
this.#error = error;
// Setting an error invalidates the requested translation pair.
this.#requestedTranslationPair = null;
this.#isEngineReady = false;
this.dispatch();
}
/**
* Stores when the translations engine is ready. The wasm and language files must
* be downloaded, which can take some time.
*/
get isEngineReady() {
return this.#isEngineReady;
}
set isEngineReady(isEngineReady) {
this.#isEngineReady = isEngineReady;
this.dispatch();
}
}
/**
* @typedef {Object} QueueItem
* @prop {Function} download
* @prop {Function} [onSuccess]
* @prop {Function} [onFailure]
* @prop {number} [retriesLeft]
*/
/**
* Manage the download of the files by providing a maximum number of concurrent files
* and the ability to retry a file download in case of an error.
*
* @param {QueueItem[]} queue
*/
async function downloadManager(queue) {
const NOOP = () => {};
const pendingDownloadAttempts = new Set();
let failCount = 0;
let index = 0;
const start = Date.now();
const originalQueueLength = queue.length;
while (index < queue.length || pendingDownloadAttempts.size > 0) {
// Start new downloads up to the maximum limit
while (
index < queue.length &&
pendingDownloadAttempts.size < TranslationsParent.MAX_CONCURRENT_DOWNLOADS
) {
lazy.console.log(`Starting download ${index + 1} of ${queue.length}`);
const {
download,
onSuccess = NOOP,
onFailure = NOOP,
retriesLeft = TranslationsParent.MAX_DOWNLOAD_RETRIES,
} = queue[index];
const handleFailedDownload = error => {
// The download failed. Either retry it, or report the failure.
TranslationsParent.reportError(
new Error("Failed to download file."),
error
);
const newRetriesLeft = retriesLeft - 1;
if (retriesLeft > 0) {
lazy.console.log(
`Queueing another attempt. ${newRetriesLeft} attempts left.`
);
queue.push({
download,
retriesLeft: newRetriesLeft,
onSuccess,
onFailure,
});
} else {
// Give up on this download.
failCount++;
onFailure();
}
};
const afterDownloadAttempt = () => {
pendingDownloadAttempts.delete(downloadAttempt);
};
// Kick off the download. If it fails, retry it a certain number of attempts.
// This is done asynchronously from the rest of the for loop.
const downloadAttempt = download()
.then(onSuccess, handleFailedDownload)
.then(afterDownloadAttempt);
pendingDownloadAttempts.add(downloadAttempt);
index++;
}
// Wait for any active downloads to complete.
await Promise.race(pendingDownloadAttempts);
}
const duration = ((Date.now() - start) / 1000).toFixed(3);
if (failCount > 0) {
const message = `Finished downloads in ${duration} seconds, but ${failCount} download(s) failed.`;
lazy.console.log(
`Finished downloads in ${duration} seconds, but ${failCount} download(s) failed.`
);
throw new Error(message);
}
lazy.console.log(
`Finished ${originalQueueLength} downloads in ${duration} seconds.`
);
}
/**
* The translations code has lots of async code and fallible network requests. To test
* this manually while using the feature, enable chaos mode by setting "errors" to true
* and "timeoutMS" to a positive number of milliseconds.
* prefs to true:
*
* - browser.translations.chaos.timeoutMS
* - browser.translations.chaos.errors
*/
async function chaosMode(probability = 0.5) {
await chaosModeTimer();
await chaosModeError(probability);
}
/**
* The translations code has lots of async code that relies on the network. To test
* this manually while using the feature, enable chaos mode by setting the following pref
* to a positive number of milliseconds.
*
* - browser.translations.chaos.timeoutMS
*/
async function chaosModeTimer() {
if (lazy.chaosTimeoutMSPref) {
const timeout = Math.random() * lazy.chaosTimeoutMSPref;
lazy.console.log(
`Chaos mode timer started for ${(timeout / 1000).toFixed(1)} seconds.`
);
await new Promise(resolve => lazy.setTimeout(resolve, timeout));
}
}
/**
* The translations code has lots of async code that is fallible. To test this manually
* while using the feature, enable chaos mode by setting the following pref to true.
*
* - browser.translations.chaos.errors
*/
async function chaosModeError(probability = 0.5) {
if (lazy.chaosErrorsPref && Math.random() < probability) {
lazy.console.trace(`Chaos mode error generated.`);
throw new Error(
`Chaos Mode error from the pref "browser.translations.chaos.errors".`
);
}
}
|