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
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
/**
* Tests that we apply dark theme variants to PBM windows where applicable.
*/
const { BuiltInThemes } = ChromeUtils.importESModule(
"resource:///modules/BuiltInThemes.sys.mjs"
);
const { PromptTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/PromptTestUtils.sys.mjs"
);
const IS_LINUX = AppConstants.platform == "linux";
const LIGHT_THEME_ID = "firefox-compact-light@mozilla.org";
const DARK_THEME_ID = "firefox-compact-dark@mozilla.org";
// This tests opens many chrome windows which is slow on debug builds.
requestLongerTimeout(2);
/**
* Test a window's theme color scheme.
*
* @param {*} options - Test options.
* @param {Window} options.win - Window object to test.
* @param {boolean} options.colorScheme - Whether expected chrome color scheme
* is dark (true) or light (false).
* @param {boolean} options.expectLWTAttributes - Whether the window should
* have the LWT attributes set matching the color scheme.
* @param {boolean} options.expectDefaultDarkAttribute - Whether the window
* should have the "lwt-default-theme-in-dark-mode" attribute.
*/
async function testWindowColorScheme({
win,
expectDark,
expectLWTAttributes,
expectDefaultDarkAttribute,
}) {
let docEl = win.document.documentElement;
is(
docEl.hasAttribute("lwt-default-theme-in-dark-mode"),
expectDefaultDarkAttribute,
`Window should${
expectDefaultDarkAttribute ? "" : " not"
} have lwt-default-theme-in-dark-mode attribute.`
);
if (expectLWTAttributes) {
ok(docEl.hasAttribute("lwtheme"), "Window should have LWT attribute.");
is(
docEl.getAttribute("lwtheme-brighttext"),
expectDark ? "true" : null,
"LWT text color attribute should be set."
);
} else {
ok(!docEl.hasAttribute("lwtheme"), "Window should not have LWT attribute.");
ok(
!docEl.hasAttribute("lwtheme-brighttext"),
"LWT text color attribute should not be set."
);
}
}
/**
* Match the prefers-color-scheme media query and return the results.
*
* @param {object} options
* @param {Window} options.win - If chrome=true, window to test, otherwise
* parent window of the content window to test.
* @param {boolean} options.chrome - If true the media queries will be matched
* against the supplied chrome window. Otherwise they will be matched against
* the content window.
* @returns {Promise<{light: boolean, dark: boolean}>} - Resolves with an
* object of the media query results.
*/
function getPrefersColorSchemeInfo({ win, chrome = false }) {
let fn = async windowObj => {
// If called in the parent, we use the supplied win object. Otherwise use
// the content window global.
let win = windowObj || content;
// LookAndFeel updates are async.
await new Promise(resolve => {
win.requestAnimationFrame(() => win.requestAnimationFrame(resolve));
});
return {
light: win.matchMedia("(prefers-color-scheme: light)").matches,
dark: win.matchMedia("(prefers-color-scheme: dark)").matches,
};
};
if (chrome) {
return fn(win);
}
return SpecialPowers.spawn(win.gBrowser.selectedBrowser, [], fn);
}
add_setup(async function () {
// Set system theme to light to ensure consistency across test machines.
await SpecialPowers.pushPrefEnv({
set: [
["browser.theme.dark-private-windows", true],
["ui.systemUsesDarkTheme", 0],
],
});
// Ensure the built-in themes are initialized.
await BuiltInThemes.ensureBuiltInThemes();
// The previous test, browser_ext_themes_ntp_colors.js has side effects.
// Switch to a theme, then switch back to the default theme to reach a
// consistent themeData state. Without this, themeData in
// LightWeightConsumer#_update does not contain darkTheme data and PBM windows
// don't get themed correctly.
let lightTheme = await AddonManager.getAddonByID(LIGHT_THEME_ID);
await lightTheme.enable();
await lightTheme.disable();
});
// For the default theme with light color scheme, private browsing windows
// should be themed dark.
// The PBM window's content should not be themed dark.
add_task(async function test_default_theme_light() {
info("Normal browsing window should not be in dark mode.");
await testWindowColorScheme({
win: window,
expectDark: false,
expectLWTAttributes: false,
expectDefaultDarkAttribute: false,
});
let windowB = await BrowserTestUtils.openNewBrowserWindow();
info("Additional normal browsing window should not be in dark mode.");
await testWindowColorScheme({
win: windowB,
expectDark: false,
expectLWTAttributes: false,
expectDefaultDarkAttribute: false,
});
let pbmWindowA = await BrowserTestUtils.openNewBrowserWindow({
private: true,
});
info("Private browsing window should be in dark mode.");
await testWindowColorScheme({
win: pbmWindowA,
expectDark: true,
expectLWTAttributes: true,
expectDefaultDarkAttribute: true,
});
let prefersColorScheme = await getPrefersColorSchemeInfo({ win: pbmWindowA });
ok(
prefersColorScheme.light && !prefersColorScheme.dark,
"Content of dark themed PBM window should still be themed light"
);
let pbmWindowB = await BrowserTestUtils.openNewBrowserWindow({
private: true,
});
info("Additional private browsing window should be in dark mode.");
await testWindowColorScheme({
win: pbmWindowB,
expectDark: true,
expectLWTAttributes: true,
expectDefaultDarkAttribute: true,
});
await BrowserTestUtils.closeWindow(windowB);
await BrowserTestUtils.closeWindow(pbmWindowA);
await BrowserTestUtils.closeWindow(pbmWindowB);
});
// For the default theme with dark color scheme, normal and private browsing
// windows should be themed dark.
add_task(async function test_default_theme_dark() {
// Set the system theme to dark. The default theme will follow this color
// scheme.
await SpecialPowers.pushPrefEnv({ set: [["ui.systemUsesDarkTheme", 1]] });
info("Normal browsing window should be in dark mode.");
await testWindowColorScheme({
win: window,
expectDark: true,
expectLWTAttributes: !IS_LINUX,
expectDefaultDarkAttribute: !IS_LINUX,
});
let pbmWindow = await BrowserTestUtils.openNewBrowserWindow({
private: true,
});
info("Private browsing window should be in dark mode.");
await testWindowColorScheme({
win: pbmWindow,
expectDark: true,
expectLWTAttributes: !IS_LINUX,
expectDefaultDarkAttribute: !IS_LINUX,
});
await BrowserTestUtils.closeWindow(pbmWindow);
await SpecialPowers.popPrefEnv();
});
// For the light theme both normal and private browsing windows should have a
// bright color scheme applied.
add_task(async function test_light_theme_builtin() {
let lightTheme = await AddonManager.getAddonByID(LIGHT_THEME_ID);
await lightTheme.enable();
info("Normal browsing window should not be in dark mode.");
await testWindowColorScheme({
win: window,
expectDark: false,
expectLWTAttributes: true,
expectDefaultDarkAttribute: false,
});
let pbmWindow = await BrowserTestUtils.openNewBrowserWindow({
private: true,
});
info("Private browsing window should not be in dark mode.");
await testWindowColorScheme({
win: pbmWindow,
expectDark: false,
expectLWTAttributes: true,
expectDefaultDarkAttribute: false,
});
await BrowserTestUtils.closeWindow(pbmWindow);
await lightTheme.disable();
});
// For the dark theme both normal and private browsing should have a dark color
// scheme applied.
add_task(async function test_dark_theme_builtin() {
let darkTheme = await AddonManager.getAddonByID(DARK_THEME_ID);
await darkTheme.enable();
info("Normal browsing window should be in dark mode.");
await testWindowColorScheme({
win: window,
expectDark: true,
expectLWTAttributes: true,
expectDefaultDarkAttribute: false,
});
let pbmWindow = await BrowserTestUtils.openNewBrowserWindow({
private: true,
});
info("Private browsing window should be in dark mode.");
await testWindowColorScheme({
win: pbmWindow,
expectDark: true,
expectLWTAttributes: true,
expectDefaultDarkAttribute: false,
});
await BrowserTestUtils.closeWindow(pbmWindow);
await darkTheme.disable();
});
// When switching between default, light and dark theme the private browsing
// window color scheme should update accordingly.
add_task(async function test_theme_switch_updates_existing_pbm_win() {
let windowB = await BrowserTestUtils.openNewBrowserWindow();
let pbmWindow = await BrowserTestUtils.openNewBrowserWindow({
private: true,
});
info("Normal browsing window should not be in dark mode.");
await testWindowColorScheme({
win: window,
expectDark: false,
expectLWTAttributes: false,
expectDefaultDarkAttribute: false,
});
info("Private browsing window should be in dark mode.");
await testWindowColorScheme({
win: pbmWindow,
expectDark: true,
expectLWTAttributes: true,
expectDefaultDarkAttribute: true,
});
info("Enabling light theme.");
let lightTheme = await AddonManager.getAddonByID(LIGHT_THEME_ID);
await lightTheme.enable();
info("Normal browsing window should not be in dark mode.");
await testWindowColorScheme({
win: window,
expectDark: false,
expectLWTAttributes: true,
expectDefaultDarkAttribute: false,
});
info("Private browsing window should not be in dark mode.");
await testWindowColorScheme({
win: pbmWindow,
expectDark: false,
expectLWTAttributes: true,
expectDefaultDarkAttribute: false,
});
await lightTheme.disable();
info("Enabling dark theme.");
let darkTheme = await AddonManager.getAddonByID(DARK_THEME_ID);
await darkTheme.enable();
info("Normal browsing window should be in dark mode.");
await testWindowColorScheme({
win: window,
expectDark: true,
expectLWTAttributes: true,
expectDefaultDarkAttribute: false,
});
info("Private browsing window should be in dark mode.");
await testWindowColorScheme({
win: pbmWindow,
expectDark: true,
expectLWTAttributes: true,
expectDefaultDarkAttribute: false,
});
await darkTheme.disable();
await BrowserTestUtils.closeWindow(windowB);
await BrowserTestUtils.closeWindow(pbmWindow);
});
// pageInfo windows should inherit the PBM window dark theme.
add_task(async function test_pbm_dark_page_info() {
for (let isPBM of [false, true]) {
let win = await BrowserTestUtils.openNewBrowserWindow({
private: isPBM,
});
let windowTypeStr = isPBM ? "private" : "normal";
info(`Opening pageInfo from ${windowTypeStr} browsing.`);
await BrowserTestUtils.withNewTab(
{ gBrowser: win.gBrowser, url: "https://example.com" },
async () => {
let pageInfo = win.BrowserPageInfo(null, "securityTab");
await BrowserTestUtils.waitForEvent(pageInfo, "page-info-init");
let prefersColorScheme = await getPrefersColorSchemeInfo({
win: pageInfo,
chrome: true,
});
if (isPBM) {
ok(
!prefersColorScheme.light && prefersColorScheme.dark,
"pageInfo from private window should be themed dark."
);
} else {
ok(
prefersColorScheme.light && !prefersColorScheme.dark,
"pageInfo from normal window should be themed light."
);
}
pageInfo.close();
}
);
await BrowserTestUtils.closeWindow(win);
}
});
// Prompts should inherit the PBM window dark theme.
add_task(async function test_pbm_dark_prompts() {
const { MODAL_TYPE_TAB, MODAL_TYPE_CONTENT } = Services.prompt;
for (let isPBM of [false, true]) {
let win = await BrowserTestUtils.openNewBrowserWindow({
private: isPBM,
});
// TODO: Once Bug 1751953 has been fixed, we can also test MODAL_TYPE_WINDOW
// here.
for (let modalType of [MODAL_TYPE_TAB, MODAL_TYPE_CONTENT]) {
let windowTypeStr = isPBM ? "private" : "normal";
let modalTypeStr = modalType == MODAL_TYPE_TAB ? "tab" : "content";
info(`Opening ${modalTypeStr} prompt from ${windowTypeStr} browsing.`);
let openPromise = PromptTestUtils.waitForPrompt(
win.gBrowser.selectedBrowser,
{
modalType,
promptType: "alert",
}
);
let promptPromise = Services.prompt.asyncAlert(
win.gBrowser.selectedBrowser.browsingContext,
modalType,
"Hello",
"Hello, world!"
);
let dialog = await openPromise;
let prefersColorScheme = await getPrefersColorSchemeInfo({
win: dialog.ui.prompt,
chrome: true,
});
if (isPBM) {
ok(
!prefersColorScheme.light && prefersColorScheme.dark,
"Prompt from private window should be themed dark."
);
} else {
ok(
prefersColorScheme.light && !prefersColorScheme.dark,
"Prompt from normal window should be themed light."
);
}
await PromptTestUtils.handlePrompt(dialog);
await promptPromise;
}
await BrowserTestUtils.closeWindow(win);
}
});
|