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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
// This tests the Privacy pane's Firefox Suggest UI.
"use strict";
ChromeUtils.defineESModuleGetters(this, {
QuickSuggest: "resource:///modules/QuickSuggest.sys.mjs",
});
const CONTAINER_ID = "dataCollectionGroup";
const DATA_COLLECTION_TOGGLE_ID = "firefoxSuggestDataCollectionPrivacyToggle";
const LEARN_MORE_CLASS = "firefoxSuggestLearnMore";
// This test can take a while due to the many permutations some of these tasks
// run through, so request a longer timeout.
requestLongerTimeout(10);
// Clicks each of the checkboxes and toggles and makes sure the prefs and info box are updated.
add_task(async function clickCheckboxesOrToggle() {
await openPreferencesViaOpenPreferencesAPI("privacy", { leaveOpen: true });
let doc = gBrowser.selectedBrowser.contentDocument;
let dataCollectionSection = doc.getElementById(CONTAINER_ID);
dataCollectionSection.scrollIntoView();
async function clickElement(id, eventName) {
let element = doc.getElementById(id);
let changed = BrowserTestUtils.waitForEvent(element, eventName);
if (eventName == "toggle") {
element = element.buttonEl;
}
EventUtils.synthesizeMouseAtCenter(
element,
{},
gBrowser.selectedBrowser.contentWindow
);
await changed;
}
// Set initial state.
await SpecialPowers.pushPrefEnv({
set: [["browser.urlbar.quicksuggest.dataCollection.enabled", true]],
});
assertPrefUIState({
[DATA_COLLECTION_TOGGLE_ID]: true,
});
// data collection toggle
await clickElement(DATA_COLLECTION_TOGGLE_ID, "toggle");
Assert.ok(
!Services.prefs.getBoolPref(
"browser.urlbar.quicksuggest.dataCollection.enabled"
),
"quicksuggest.dataCollection.enabled is false after clicking data collection toggle"
);
assertPrefUIState({
[DATA_COLLECTION_TOGGLE_ID]: false,
});
gBrowser.removeCurrentTab();
await SpecialPowers.popPrefEnv();
});
// Clicks the learn-more links and checks the help page is opened in a new tab.
add_task(async function clickLearnMore() {
await openPreferencesViaOpenPreferencesAPI("privacy", { leaveOpen: true });
let doc = gBrowser.selectedBrowser.contentDocument;
let dataCollectionSection = doc.getElementById(CONTAINER_ID);
dataCollectionSection.scrollIntoView();
// Set initial state so that the info box and learn more link are shown.
await SpecialPowers.pushPrefEnv({
set: [["browser.urlbar.quicksuggest.dataCollection.enabled", true]],
});
let learnMoreLinks = doc.querySelectorAll(
`#${CONTAINER_ID} .` + LEARN_MORE_CLASS
);
Assert.equal(
learnMoreLinks.length,
1,
"Expected number of learn-more links are present"
);
for (let link of learnMoreLinks) {
Assert.ok(
BrowserTestUtils.isVisible(link),
"Learn-more link is visible: " + link.id
);
}
let prefsTab = gBrowser.selectedTab;
for (let link of learnMoreLinks) {
let tabPromise = BrowserTestUtils.waitForNewTab(
gBrowser,
QuickSuggest.HELP_URL
);
info("Clicking learn-more link: " + link.id);
Assert.ok(link.id, "Sanity check: Learn-more link has an ID");
await BrowserTestUtils.synthesizeMouseAtCenter(
"#" + link.id,
{},
gBrowser.selectedBrowser
);
info("Waiting for help page to load in a new tab");
await tabPromise;
gBrowser.removeCurrentTab();
gBrowser.selectedTab = prefsTab;
}
gBrowser.removeCurrentTab();
await SpecialPowers.popPrefEnv();
});
/**
* Verifies the state of pref related to checkboxes or toggles.
*
* @param {object} stateByElementID
* Maps checkbox or toggle element IDs to booleans. Each boolean
* is the expected state of the corresponding ID.
*/
function assertPrefUIState(stateByElementID) {
let doc = gBrowser.selectedBrowser.contentDocument;
let container = doc.getElementById(CONTAINER_ID);
let attr;
Assert.ok(BrowserTestUtils.isVisible(container), "The container is visible");
for (let [id, state] of Object.entries(stateByElementID)) {
let element = doc.getElementById(id);
if (element.tagName === "checkbox") {
attr = "checked";
} else if (element.tagName === "html:moz-toggle") {
attr = "pressed";
}
Assert.equal(element[attr], state, "Expected state for ID: " + id);
}
}
|
