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
|
/* 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/. */
"use strict";
const { AboutProtectionsParent } = ChromeUtils.importESModule(
"resource:///actors/AboutProtectionsParent.sys.mjs"
);
let { Region } = ChromeUtils.importESModule(
"resource://gre/modules/Region.sys.mjs"
);
const initialHomeRegion = Region._home;
const initialCurrentRegion = Region._current;
async function checkVPNCardVisibility(tab, shouldBeHidden, subscribed = false) {
await SpecialPowers.spawn(
tab.linkedBrowser,
[{ _shouldBeHidden: shouldBeHidden, _subscribed: subscribed }],
async function ({ _shouldBeHidden, _subscribed }) {
await ContentTaskUtils.waitForCondition(() => {
const vpnCard = content.document.querySelector(".vpn-card");
const subscribedStateCorrect =
vpnCard.classList.contains("subscribed") == _subscribed;
return (
ContentTaskUtils.is_hidden(vpnCard) === _shouldBeHidden &&
subscribedStateCorrect
);
});
const visibilityState = _shouldBeHidden ? "hidden" : "shown";
ok(true, `VPN card is ${visibilityState}.`);
}
);
}
async function checkVPNPromoBannerVisibility(tab, shouldBeHidden) {
await SpecialPowers.spawn(
tab.linkedBrowser,
[{ _shouldBeHidden: shouldBeHidden }],
async function ({ _shouldBeHidden }) {
await ContentTaskUtils.waitForCondition(() => {
const vpnBanner = content.document.querySelector(".vpn-banner");
return ContentTaskUtils.is_hidden(vpnBanner) === _shouldBeHidden;
});
const visibilityState = _shouldBeHidden ? "hidden" : "shown";
ok(true, `VPN banner is ${visibilityState}.`);
}
);
}
async function setCurrentRegion(region) {
Region._setCurrentRegion(region);
}
async function setHomeRegion(region) {
// _setHomeRegion sets a char pref to the value of region. A non-string value will result in an error, so default to an empty string when region is falsey.
Region._setHomeRegion(region || "");
}
async function revertRegions() {
setCurrentRegion(initialCurrentRegion);
setHomeRegion(initialHomeRegion);
}
add_setup(async function () {
await SpecialPowers.pushPrefEnv({
set: [
["browser.contentblocking.report.monitor.enabled", false],
["browser.contentblocking.report.lockwise.enabled", false],
["browser.vpn_promo.enabled", true],
],
});
AboutProtectionsParent.setTestOverride(getVPNOverrides(false));
setCurrentRegion("us");
const avLocales = Services.locale.availableLocales;
registerCleanupFunction(() => {
Services.locale.availableLocales = avLocales;
});
});
add_task(async function testVPNCardVisibility() {
AboutProtectionsParent.setTestOverride(getVPNOverrides(false));
await promiseSetHomeRegion("us");
setCurrentRegion("us");
let tab = await BrowserTestUtils.openNewForegroundTab({
url: "about:protections",
gBrowser,
});
info("Enable showing the VPN card");
await SpecialPowers.pushPrefEnv({
set: [
["browser.vpn_promo.enabled", true],
["browser.contentblocking.report.vpn_regions", "us,ca,nz,sg,my,gb"],
[
"browser.vpn_promo.disallowed_regions",
"ae,by,cn,cu,iq,ir,kp,om,ru,sd,sy,tm,tr,ua",
],
],
});
info(
"Check that vpn card is hidden if neither the user's home nor current location is on the regions list."
);
AboutProtectionsParent.setTestOverride(getVPNOverrides(false));
setCurrentRegion("ls");
await promiseSetHomeRegion("ls");
await BrowserTestUtils.reloadTab(tab);
await checkVPNCardVisibility(tab, true);
info(
"Check that vpn card is hidden if user's location is in the list of disallowed regions."
);
AboutProtectionsParent.setTestOverride(getVPNOverrides(false));
setCurrentRegion("sy");
await BrowserTestUtils.reloadTab(tab);
await checkVPNCardVisibility(tab, true);
info(
"Check that vpn card shows a different version if user has subscribed to Mozilla vpn."
);
AboutProtectionsParent.setTestOverride(getVPNOverrides(true));
setCurrentRegion("us");
await BrowserTestUtils.reloadTab(tab);
await checkVPNCardVisibility(tab, false, true);
info(
"VPN card should be hidden when vpn not enabled, though all other conditions are true"
);
await SpecialPowers.pushPrefEnv({
set: [["browser.vpn_promo.enabled", false]],
});
await BrowserTestUtils.reloadTab(tab);
await checkVPNCardVisibility(tab, true);
await BrowserTestUtils.removeTab(tab);
revertRegions();
});
add_task(async function testVPNPromoBanner() {
AboutProtectionsParent.setTestOverride(getVPNOverrides(false));
let tab = await BrowserTestUtils.openNewForegroundTab({
url: "about:protections",
gBrowser,
});
info("Enable showing the VPN card and banner");
await SpecialPowers.pushPrefEnv({
set: [
["browser.vpn_promo.enabled", true],
["browser.contentblocking.report.vpn_regions", "us,ca,nz,sg,my,gb"],
[
"browser.vpn_promo.disallowed_regions",
"ae,by,cn,cu,iq,ir,kp,om,ru,sd,sy,tm,tr,ua",
],
["browser.contentblocking.report.hide_vpn_banner", false],
],
});
info("Check that vpn banner is shown if user's region is supported");
setCurrentRegion("us");
await BrowserTestUtils.reloadTab(tab);
await checkVPNPromoBannerVisibility(tab, false);
is(
Services.prefs.getBoolPref(
"browser.contentblocking.report.hide_vpn_banner",
false
),
true,
"After showing the banner once, the pref to hide the VPN banner is flipped"
);
info("The banner does not show when the pref to hide it is flipped");
await BrowserTestUtils.reloadTab(tab);
await checkVPNPromoBannerVisibility(tab, true);
// VPN Banner flips this pref each time it shows, flip back between each instruction.
await SpecialPowers.pushPrefEnv({
set: [["browser.contentblocking.report.hide_vpn_banner", false]],
});
info(
"Check that VPN banner is hidden if user's location is not on the regions list."
);
AboutProtectionsParent.setTestOverride(getVPNOverrides(false));
setCurrentRegion("ls");
await setHomeRegion("ls'");
await BrowserTestUtils.reloadTab(tab);
await checkVPNPromoBannerVisibility(tab, true);
info(
"Check that VPN banner is hidden if user's location is in the disallowed regions list."
);
AboutProtectionsParent.setTestOverride(getVPNOverrides(false));
setCurrentRegion("sy");
await BrowserTestUtils.reloadTab(tab);
await checkVPNPromoBannerVisibility(tab, true);
info(
"VPN banner should be hidden when vpn not enabled, though all other conditions are true"
);
await SpecialPowers.pushPrefEnv({
set: [
["browser.vpn_promo.enabled", false],
["browser.contentblocking.report.hide_vpn_banner", false],
],
});
await BrowserTestUtils.reloadTab(tab);
await checkVPNPromoBannerVisibility(tab, true);
await SpecialPowers.pushPrefEnv({
set: [
["browser.vpn_promo.enabled", true],
["browser.contentblocking.report.hide_vpn_banner", false],
],
});
info("If user is subscribed to VPN already the promo banner should not show");
AboutProtectionsParent.setTestOverride(getVPNOverrides(true));
setCurrentRegion("us");
await BrowserTestUtils.reloadTab(tab);
await checkVPNPromoBannerVisibility(tab, true);
await BrowserTestUtils.removeTab(tab);
revertRegions();
});
// Expect the vpn card and banner to not show as we are expressly excluding China. Even when cn is in the supported region pref.
add_task(async function testVPNDoesNotShowChina() {
AboutProtectionsParent.setTestOverride(getVPNOverrides(false));
setCurrentRegion("us");
let tab = await BrowserTestUtils.openNewForegroundTab({
url: "about:protections",
gBrowser,
});
info("Enable showing the VPN card and banners");
await SpecialPowers.pushPrefEnv({
set: [
["browser.vpn_promo.enabled", true],
["browser.contentblocking.report.vpn_regions", "us,ca,nz,sg,my,gb,cn"],
[
"browser.vpn_promo.disallowed_regions",
"ae,by,cn,cu,iq,ir,kp,om,ru,sd,sy,tm,tr,ua",
],
["browser.contentblocking.report.hide_vpn_banner", false],
],
});
info(
"set home location to China, even though user is currently in the US, expect vpn card to be hidden"
);
await promiseSetHomeRegion("CN");
await BrowserTestUtils.reloadTab(tab);
await checkVPNPromoBannerVisibility(tab, true);
await BrowserTestUtils.reloadTab(tab);
await checkVPNCardVisibility(tab, true);
// VPN Banner flips this pref each time it shows, flip back between each instruction.
await SpecialPowers.pushPrefEnv({
set: [["browser.contentblocking.report.hide_vpn_banner", false]],
});
info("home region is US, but current location is China");
AboutProtectionsParent.setTestOverride(getVPNOverrides(false));
await promiseSetHomeRegion("US");
setCurrentRegion("CN");
await BrowserTestUtils.reloadTab(tab);
await checkVPNPromoBannerVisibility(tab, true);
await BrowserTestUtils.reloadTab(tab);
await checkVPNCardVisibility(tab, true);
await BrowserTestUtils.removeTab(tab);
revertRegions();
});
|
