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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
// We're in an xpcshell test but have an eslint browser test env applied;
// We definitely do need to manually import CustomizableUI.
// eslint-disable-next-line mozilla/no-redeclare-with-import-autofix
const { CustomizableUI } = ChromeUtils.importESModule(
"resource:///modules/CustomizableUI.sys.mjs"
);
do_get_profile();
// Make Cu.isInAutomation true. This is necessary so that we can use
// CustomizableUIInternal.
Services.prefs.setBoolPref(
"security.turn_off_all_security_so_that_viruses_can_take_over_this_computer",
true
);
const CustomizableUIInternal = CustomizableUI.getTestOnlyInternalProp(
"CustomizableUIInternal"
);
// Migration 19 was the Unified Extensions migration version introduced
// in 109, so we'll run tests by artificially setting the migration version
// to one value earlier.
const PRIOR_MIGRATION_VERSION = 18;
/**
* Writes customization state into CustomizableUI and then performs the forward migration
* for Unified Extensions.
*
* @param {object|null} stateObj An object that will be structure-cloned and
* written into CustomizableUI's internal `gSavedState` state variable. Should
* not include the currentVersion property, as this will be set automatically by
* function if stateObj is not null.
* @returns {object}
* the saved state object (minus the currentVersion property).
*/
function migrateForward(stateObj) {
// We make sure to use structuredClone here so that we don't end up comparing
// SAVED_STATE against itself.
let stateToSave = structuredClone(stateObj);
if (stateToSave) {
stateToSave.currentVersion = PRIOR_MIGRATION_VERSION;
}
CustomizableUI.setTestOnlyInternalProp("gSavedState", stateToSave);
CustomizableUIInternal._updateForNewVersion();
let migratedState = CustomizableUI.getTestOnlyInternalProp("gSavedState");
if (migratedState) {
delete migratedState.currentVersion;
}
return migratedState;
}
/**
* Test that attempting a migration on a new profile with no saved
* state exits safely.
*/
add_task(async function test_no_saved_state() {
let migratedState = migrateForward(null);
Assert.deepEqual(
migratedState,
null,
"gSavedState should not have been modified"
);
});
/**
* Test that attempting a migration on a new profile with no saved
* state exits safely.
*/
add_task(async function test_no_saved_placements() {
let migratedState = migrateForward({});
Assert.deepEqual(
migratedState,
{},
"gSavedState should not have been modified"
);
});
/**
* Test that placements that don't involve any extension buttons are
* not changed during the migration.
*/
add_task(async function test_no_extensions() {
const SAVED_STATE = {
placements: {
"nav-bar": [
"back-button",
"forward-button",
"spring",
"urlbar-container",
"save-to-pocket-button",
],
"toolbar-menubar": [
"home-button",
"menubar-items",
"spring",
"downloads-button",
],
TabsToolbar: [
"firefox-view-button",
"tabbrowser-tabs",
"new-tab-button",
"alltabs-button",
"developer-button",
],
PersonalToolbar: ["personal-bookmarks", "fxa-toolbar-menu-button"],
"widget-overflow-fixed-list": ["privatebrowsing-button", "panic-button"],
},
};
// ADDONS_AREA should end up with an empty array as its set of placements.
const EXPECTED_STATE = structuredClone(SAVED_STATE);
EXPECTED_STATE.placements[CustomizableUI.AREA_ADDONS] = [];
let migratedState = migrateForward(SAVED_STATE);
Assert.deepEqual(
migratedState,
EXPECTED_STATE,
"Got the expected state after the migration."
);
});
/**
* Test that if there's an existing set of items in CustomizableUI.AREA_ADDONS,
* and no extension buttons to migrate from the overflow menu, then we don't
* change the state at all.
*/
add_task(async function test_existing_browser_actions_no_movement() {
const SAVED_STATE = {
placements: {
"nav-bar": [
"back-button",
"forward-button",
"spring",
"urlbar-container",
"save-to-pocket-button",
],
"toolbar-menubar": [
"home-button",
"menubar-items",
"spring",
"downloads-button",
],
TabsToolbar: [
"firefox-view-button",
"tabbrowser-tabs",
"new-tab-button",
"alltabs-button",
"developer-button",
],
PersonalToolbar: ["personal-bookmarks", "fxa-toolbar-menu-button"],
"widget-overflow-fixed-list": ["privatebrowsing-button", "panic-button"],
"unified-extensions-area": ["ext0-browser-action", "ext1-browser-action"],
},
};
let migratedState = migrateForward(SAVED_STATE);
Assert.deepEqual(
migratedState,
SAVED_STATE,
"The saved state should not have changed after migration."
);
});
/**
* Test that we can migrate extension buttons out from the overflow panel
* into the addons panel.
*/
add_task(async function test_migrate_extension_buttons() {
const SAVED_STATE = {
placements: {
"nav-bar": [
"back-button",
"forward-button",
"spring",
"urlbar-container",
"save-to-pocket-button",
],
"toolbar-menubar": [
"home-button",
"menubar-items",
"spring",
"downloads-button",
],
TabsToolbar: [
"firefox-view-button",
"tabbrowser-tabs",
"new-tab-button",
"alltabs-button",
"developer-button",
],
PersonalToolbar: ["personal-bookmarks", "fxa-toolbar-menu-button"],
"widget-overflow-fixed-list": [
"ext0-browser-action",
"privatebrowsing-button",
"ext1-browser-action",
"panic-button",
"ext2-browser-action",
],
},
};
const EXPECTED_STATE = structuredClone(SAVED_STATE);
EXPECTED_STATE.placements[CustomizableUI.AREA_FIXED_OVERFLOW_PANEL] = [
"privatebrowsing-button",
"panic-button",
];
EXPECTED_STATE.placements[CustomizableUI.AREA_ADDONS] = [
"ext0-browser-action",
"ext1-browser-action",
"ext2-browser-action",
];
let migratedState = migrateForward(SAVED_STATE);
Assert.deepEqual(
migratedState,
EXPECTED_STATE,
"The saved state should not have changed after migration."
);
});
/**
* Test that we won't overwrite existing placements within the addons panel
* if we migrate things over from the overflow panel. We'll prepend the
* migrated items to the addons panel instead.
*/
add_task(async function test_migrate_extension_buttons_no_overwrite() {
const SAVED_STATE = {
placements: {
"nav-bar": [
"back-button",
"forward-button",
"spring",
"urlbar-container",
"save-to-pocket-button",
],
"toolbar-menubar": [
"home-button",
"menubar-items",
"spring",
"downloads-button",
],
TabsToolbar: [
"firefox-view-button",
"tabbrowser-tabs",
"new-tab-button",
"alltabs-button",
"developer-button",
],
PersonalToolbar: ["personal-bookmarks", "fxa-toolbar-menu-button"],
"widget-overflow-fixed-list": [
"ext0-browser-action",
"privatebrowsing-button",
"ext1-browser-action",
"panic-button",
"ext2-browser-action",
],
"unified-extensions-area": ["ext3-browser-action", "ext4-browser-action"],
},
};
const EXPECTED_STATE = structuredClone(SAVED_STATE);
EXPECTED_STATE.placements[CustomizableUI.AREA_FIXED_OVERFLOW_PANEL] = [
"privatebrowsing-button",
"panic-button",
];
EXPECTED_STATE.placements[CustomizableUI.AREA_ADDONS] = [
"ext0-browser-action",
"ext1-browser-action",
"ext2-browser-action",
"ext3-browser-action",
"ext4-browser-action",
];
let migratedState = migrateForward(SAVED_STATE);
Assert.deepEqual(
migratedState,
EXPECTED_STATE,
"The saved state should not have changed after migration."
);
});
/**
* Test that extension buttons from areas other than the overflow panel
* won't be moved.
*/
add_task(async function test_migrate_extension_buttons_elsewhere() {
const SAVED_STATE = {
placements: {
"nav-bar": [
"back-button",
"ext0-browser-action",
"forward-button",
"ext1-browser-action",
"spring",
"ext2-browser-action",
"urlbar-container",
"ext3-browser-action",
"save-to-pocket-button",
"ext4-browser-action",
],
"toolbar-menubar": [
"home-button",
"ext5-browser-action",
"menubar-items",
"ext6-browser-action",
"spring",
"ext7-browser-action",
"downloads-button",
"ext8-browser-action",
],
TabsToolbar: [
"firefox-view-button",
"ext9-browser-action",
"tabbrowser-tabs",
"ext10-browser-action",
"new-tab-button",
"ext11-browser-action",
"alltabs-button",
"ext12-browser-action",
"developer-button",
"ext13-browser-action",
],
PersonalToolbar: [
"personal-bookmarks",
"ext14-browser-action",
"fxa-toolbar-menu-button",
"ext15-browser-action",
],
"widget-overflow-fixed-list": [
"ext16-browser-action",
"privatebrowsing-button",
"ext17-browser-action",
"panic-button",
"ext18-browser-action",
],
},
};
const EXPECTED_STATE = structuredClone(SAVED_STATE);
EXPECTED_STATE.placements[CustomizableUI.AREA_FIXED_OVERFLOW_PANEL] = [
"privatebrowsing-button",
"panic-button",
];
EXPECTED_STATE.placements[CustomizableUI.AREA_ADDONS] = [
"ext16-browser-action",
"ext17-browser-action",
"ext18-browser-action",
];
let migratedState = migrateForward(SAVED_STATE);
Assert.deepEqual(
migratedState,
EXPECTED_STATE,
"The saved state should not have changed after migration."
);
});
|
