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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
/* import-globals-from ../../../../../browser/base/content/test/webextensions/head.js */
loadTestSubscript(
"../../../../../browser/base/content/test/webextensions/head.js"
);
const { BuiltInThemes } = ChromeUtils.importESModule(
"resource:///modules/BuiltInThemes.sys.mjs"
);
AddonTestUtils.initMochitest(this);
const server = AddonTestUtils.createHttpServer();
const SERVER_BASE_URL = `http://localhost:${server.identity.primaryPort}`;
const EXPIRED_COLORWAY_THEME_ID1 = "2022red-colorway@mozilla.org";
const EXPIRED_COLORWAY_THEME_ID2 = "2022orange-colorway@mozilla.org";
const ICON_SVG = `
<svg width="63" height="62" viewBox="0 0 63 62" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="31.5" cy="31" r="31" fill="url(#paint0_linear)"/>
<defs>
<linearGradient id="paint0_linear" x1="44.4829" y1="19" x2="10.4829" y2="53" gradientUnits="userSpaceOnUse">
<stop stop-color="hsl(147, 94%, 25%)"/>
<stop offset="1" stop-color="hsl(146, 38%, 49%)"/>
</linearGradient>
</defs>
</svg>
`;
AddonTestUtils.registerJSON(server, "/updates.json", {
addons: {
[EXPIRED_COLORWAY_THEME_ID1]: {
updates: [
{
version: "2.0.0",
update_link: `${SERVER_BASE_URL}/${EXPIRED_COLORWAY_THEME_ID1}.xpi`,
},
],
},
[EXPIRED_COLORWAY_THEME_ID2]: {
updates: [
{
version: "3.0.0",
update_link: `${SERVER_BASE_URL}/${EXPIRED_COLORWAY_THEME_ID2}.xpi`,
},
],
},
},
});
const createMockThemeManifest = (id, version) => ({
name: `Mock theme ${id} ${version}`,
author: "Mozilla",
version,
icons: { 32: "icon.svg" },
theme: {
colors: {
toolbar: "red",
},
},
browser_specific_settings: {
gecko: { id },
},
});
function createWebExtensionFile(id, version) {
return AddonTestUtils.createTempWebExtensionFile({
files: { "icon.svg": ICON_SVG },
manifest: createMockThemeManifest(id, version),
});
}
let expiredThemeUpdate1 = createWebExtensionFile(
EXPIRED_COLORWAY_THEME_ID1,
"2.0.0"
);
let expiredThemeUpdate2 = createWebExtensionFile(
EXPIRED_COLORWAY_THEME_ID2,
"3.0.0"
);
server.registerFile(`/${EXPIRED_COLORWAY_THEME_ID1}.xpi`, expiredThemeUpdate1);
server.registerFile(`/${EXPIRED_COLORWAY_THEME_ID2}.xpi`, expiredThemeUpdate2);
const goBack = async win => {
let loaded = waitForViewLoad(win);
let backButton = win.document.querySelector(".back-button");
ok(!backButton.disabled, "back button is enabled");
backButton.click();
await loaded;
};
const assertAddonCardFound = (win, { addonId, expectColorwayBuiltIn }) => {
const msg = expectColorwayBuiltIn
? `Found addon card for colorway builtin ${addonId}`
: `Found addon card for migrated colorway ${addonId}`;
Assert.equal(
getAddonCard(win, addonId)?.addon.isBuiltinColorwayTheme,
expectColorwayBuiltIn,
msg
);
};
const assertDetailView = async (win, { addonId, expectThemeName }) => {
let loadedDetailView = waitForViewLoad(win);
await gBrowser.ownerGlobal.promiseDocumentFlushed(() => {});
const themeCard = getAddonCard(win, addonId);
themeCard.click();
await loadedDetailView;
Assert.equal(
themeCard.querySelector(".addon-name")?.textContent,
expectThemeName,
`Got the expected addon name in the addon details for ${addonId}`
);
};
async function test_update_expired_colorways_builtins() {
// Set expired theme as a retained colorway theme
const retainedThemePrefName = "browser.theme.retainedExpiredThemes";
await SpecialPowers.pushPrefEnv({
set: [
[PREF_UPDATEURL, `${SERVER_BASE_URL}/updates.json`],
["extensions.checkUpdateSecurity", false],
["browser.theme.colorway-migration", true],
[
retainedThemePrefName,
JSON.stringify([
EXPIRED_COLORWAY_THEME_ID1,
EXPIRED_COLORWAY_THEME_ID2,
]),
],
],
});
await BuiltInThemes.ensureBuiltInThemes();
async function uninstallTestAddons() {
for (const addonId of [
EXPIRED_COLORWAY_THEME_ID1,
EXPIRED_COLORWAY_THEME_ID2,
]) {
info(`Uninstalling test theme ${addonId}`);
let addon = await AddonManager.getAddonByID(addonId);
await addon?.uninstall();
}
}
registerCleanupFunction(uninstallTestAddons);
const expiredAddon1 = await AddonManager.getAddonByID(
EXPIRED_COLORWAY_THEME_ID1
);
const expiredAddon2 = await AddonManager.getAddonByID(
EXPIRED_COLORWAY_THEME_ID2
);
await expiredAddon2.disable();
await expiredAddon1.enable();
info("Open about:addons theme list view");
let win = await loadInitialView("theme");
assertAddonCardFound(win, {
addonId: EXPIRED_COLORWAY_THEME_ID1,
expectColorwayBuiltIn: true,
});
assertAddonCardFound(win, {
addonId: EXPIRED_COLORWAY_THEME_ID2,
expectColorwayBuiltIn: true,
});
info("Trigger addon update check");
const promiseInstallsEnded = Promise.all([
AddonTestUtils.promiseInstallEvent(
"onInstallEnded",
addon => addon.id === EXPIRED_COLORWAY_THEME_ID1
),
AddonTestUtils.promiseInstallEvent(
"onInstallEnded",
addon => addon.id === EXPIRED_COLORWAY_THEME_ID1
),
]);
// Wait for active theme to also execute the update bootstrap method.
let promiseUpdatedAddon1 = waitForUpdate(expiredAddon1);
triggerPageOptionsAction(win, "check-for-updates");
info("Wait for addon update to be completed");
await Promise.all([promiseUpdatedAddon1, promiseInstallsEnded]);
info("Verify theme list view addon cards");
assertAddonCardFound(win, {
addonId: EXPIRED_COLORWAY_THEME_ID1,
expectColorwayBuiltIn: false,
});
assertAddonCardFound(win, {
addonId: EXPIRED_COLORWAY_THEME_ID2,
expectColorwayBuiltIn: false,
});
info(`Switch to detail view for theme ${EXPIRED_COLORWAY_THEME_ID1}`);
await assertDetailView(win, {
addonId: EXPIRED_COLORWAY_THEME_ID1,
expectThemeName: `Mock theme ${EXPIRED_COLORWAY_THEME_ID1} 2.0.0`,
});
info("Switch back to list view");
await goBack(win);
assertAddonCardFound(win, {
addonId: EXPIRED_COLORWAY_THEME_ID1,
expectColorwayBuiltIn: false,
});
assertAddonCardFound(win, {
addonId: EXPIRED_COLORWAY_THEME_ID2,
expectColorwayBuiltIn: false,
});
info(`Switch to detail view for theme ${EXPIRED_COLORWAY_THEME_ID2}`);
await assertDetailView(win, {
addonId: EXPIRED_COLORWAY_THEME_ID2,
expectThemeName: `Mock theme ${EXPIRED_COLORWAY_THEME_ID2} 3.0.0`,
});
info("Switch back to list view");
await goBack(win);
assertAddonCardFound(win, {
addonId: EXPIRED_COLORWAY_THEME_ID1,
expectColorwayBuiltIn: false,
});
assertAddonCardFound(win, {
addonId: EXPIRED_COLORWAY_THEME_ID2,
expectColorwayBuiltIn: false,
});
Assert.deepEqual(
JSON.parse(
Services.prefs.getStringPref("browser.theme.retainedExpiredThemes")
),
[],
"Migrated colorways theme have been removed from the retainedExpiredThemes pref"
);
await closeView(win);
await uninstallTestAddons();
await SpecialPowers.popPrefEnv();
}
add_task(async function test_colorways_builtin_theme_migration() {
await test_update_expired_colorways_builtins();
});
add_task(
async function test_colorways_builtin_theme_migration_on_disabledAutoUpdates() {
await SpecialPowers.pushPrefEnv({
set: [["extensions.update.autoUpdateDefault", false]],
});
await test_update_expired_colorways_builtins();
await SpecialPowers.popPrefEnv();
}
);
|
