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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
/**
* Manually destroy the engine while a page is in the background, and test that the page
* is still translated after switching back to it.
*/
add_task(async function test_translations_panel_fuzzing() {
const {
cleanup,
runInPage: runInSpanishPage,
tab: spanishTab,
} = await loadTestPage({
page: SPANISH_PAGE_URL,
languagePairs: LANGUAGE_PAIRS,
autoDownloadFromRemoteSettings: true,
});
/**
* @typedef {object} Tab
*/
/** @type {Tab?} */
let englishTab;
/** @type {Function?} */
let removeEnglishTab;
/** @type {boolean} */
let isSpanishPageTranslated = false;
/** @type {"spanish" | "english"} */
let activeTab = "spanish";
/** @type {boolean} */
let isEngineMaybeDestroyed = true;
/** @type {boolean} */
let isTitleMutated = false;
/** @type {boolean} */
let hasVerifiedMutation = true;
function reportOperation(name) {
info(
`\n\nOperation: ${name} ` +
JSON.stringify({
activeTab,
englishTab: !!englishTab,
isSpanishPageTranslated,
isEngineMaybeDestroyed,
isTitleMutated,
})
);
}
/**
* A list of fuzzing operations. They return false when they are a noop given the
* conditions.
*
* @type {object} - Record<string, () => Promise<boolean>>
*/
const operations = {
async addEnglishTab() {
if (!englishTab) {
reportOperation("addEnglishTab");
const { removeTab, tab } = await addTab(
ENGLISH_PAGE_URL,
"Creating a new tab for a page in English."
);
englishTab = tab;
removeEnglishTab = removeTab;
activeTab = "english";
return true;
}
return false;
},
async removeEnglishTab() {
if (removeEnglishTab) {
reportOperation("removeEnglishTab");
await removeEnglishTab();
englishTab = null;
removeEnglishTab = null;
activeTab = "spanish";
return true;
}
return false;
},
async translateSpanishPage() {
if (!isSpanishPageTranslated) {
reportOperation("translateSpanishPage");
if (activeTab === "english") {
await switchTab(spanishTab, "spanish tab");
}
await FullPageTranslationsTestUtils.assertTranslationsButton(
{ button: true },
"The button is available."
);
await FullPageTranslationsTestUtils.openPanel({
onOpenPanel: FullPageTranslationsTestUtils.assertPanelViewDefault,
});
await FullPageTranslationsTestUtils.clickTranslateButton();
await FullPageTranslationsTestUtils.assertTranslationsButton(
{ button: true, circleArrows: false, locale: true, icon: true },
"Translations button is fully loaded."
);
await FullPageTranslationsTestUtils.assertPageIsTranslated(
"es",
"en",
runInSpanishPage
);
isSpanishPageTranslated = true;
isEngineMaybeDestroyed = false;
activeTab = "spanish";
return true;
}
return false;
},
async destroyEngineProcess() {
if (
!isEngineMaybeDestroyed &&
// Don't destroy the engine process until the mutation has been verified.
// There is an artifical race (e.g. only in tests) that happens from a new
// engine being requested, and forcefully destroyed before the it can be
// initialized.
hasVerifiedMutation
) {
reportOperation("destroyEngineProcess");
await EngineProcess.destroyTranslationsEngine();
isEngineMaybeDestroyed = true;
}
return true;
},
async mutateSpanishPage() {
if (isSpanishPageTranslated && !isTitleMutated) {
reportOperation("mutateSpanishPage");
info("Mutate the page's content to re-trigger a translation.");
await runInSpanishPage(async TranslationsTest => {
const { getH1 } = TranslationsTest.getSelectors();
getH1().innerText = "New text for the H1";
});
if (isEngineMaybeDestroyed) {
info("The engine may be recreated now.");
}
isEngineMaybeDestroyed = false;
isTitleMutated = true;
hasVerifiedMutation = false;
return true;
}
return false;
},
async switchToSpanishTab() {
if (activeTab !== "spanish") {
reportOperation("switchToSpanishTab");
await switchTab(spanishTab, "spanish tab");
activeTab = "spanish";
if (isTitleMutated) {
await runInSpanishPage(async TranslationsTest => {
const { getH1 } = TranslationsTest.getSelectors();
await TranslationsTest.assertTranslationResult(
"The mutated content should be translated.",
getH1,
"NEW TEXT FOR THE H1 [es to en]"
);
});
hasVerifiedMutation = true;
}
return true;
}
return false;
},
async switchToEnglishTab() {
if (activeTab !== "english" && englishTab) {
reportOperation("switchToEnglishTab");
await switchTab(englishTab, "english tab");
activeTab = "english";
return true;
}
return false;
},
async restoreSpanishPage() {
if (activeTab === "spanish" && isSpanishPageTranslated) {
reportOperation("restoreSpanishPage");
await FullPageTranslationsTestUtils.openPanel({
onOpenPanel: FullPageTranslationsTestUtils.assertPanelViewRevisit,
});
await FullPageTranslationsTestUtils.clickRestoreButton();
await FullPageTranslationsTestUtils.assertPageIsUntranslated(
runInSpanishPage
);
await FullPageTranslationsTestUtils.assertTranslationsButton(
{ button: true, circleArrows: false, locale: false, icon: true },
"The button is reverted to have an icon."
);
isSpanishPageTranslated = false;
isTitleMutated = false;
return true;
}
return false;
},
};
const fuzzSteps = 100;
info(`Starting the fuzzing with ${fuzzSteps} operations.`);
const opsArray = Object.values(operations);
for (let i = 0; i < fuzzSteps; i++) {
// Pick a random operation and check if that it was not a noop, otherwise continue
// trying to find a valid operation.
while (true) {
const operation = opsArray[Math.floor(Math.random() * opsArray.length)];
if (await operation()) {
break;
}
}
}
if (removeEnglishTab) {
await removeEnglishTab();
}
await cleanup();
});
|
