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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
/* import-globals-from ../../unit/head.js */
ChromeUtils.defineESModuleGetters(this, {
QuickSuggest: "resource:///modules/QuickSuggest.sys.mjs",
QuickSuggestRemoteSettings:
"resource:///modules/urlbar/private/QuickSuggestRemoteSettings.sys.mjs",
TelemetryTestUtils: "resource://testing-common/TelemetryTestUtils.sys.mjs",
UrlbarProviderAutofill: "resource:///modules/UrlbarProviderAutofill.sys.mjs",
UrlbarProviderQuickSuggest:
"resource:///modules/UrlbarProviderQuickSuggest.sys.mjs",
});
add_setup(async function setUpQuickSuggestXpcshellTest() {
// Initializing TelemetryEnvironment in an xpcshell environment requires
// jumping through a bunch of hoops. Suggest's use of TelemetryEnvironment is
// tested in browser tests, and there's no other necessary reason to wait for
// TelemetryEnvironment initialization in xpcshell tests, so just skip it.
UrlbarPrefs._testSkipTelemetryEnvironmentInit = true;
});
/**
* Tests quick suggest prefs migrations.
*
* @param {object} options
* The options object.
* @param {object} options.testOverrides
* An object that modifies how migration is performed. It has the following
* properties, and all are optional:
*
* {number} migrationVersion
* Migration will stop at this version, so for example you can test
* migration only up to version 1 even when the current actual version is
* larger than 1.
* {object} defaultPrefs
* An object that maps pref names (relative to `browser.urlbar`) to
* default-branch values. These should be the default prefs for the given
* `migrationVersion` and will be set as defaults before migration occurs.
*
* @param {string} options.scenario
* The scenario to set at the time migration occurs.
* @param {object} options.expectedPrefs
* The expected prefs after migration: `{ defaultBranch, userBranch }`
* Pref names should be relative to `browser.urlbar`.
* @param {object} [options.initialUserBranch]
* Prefs to set on the user branch before migration ocurs. Use these to
* simulate user actions like disabling prefs or opting in or out of the
* online modal. Pref names should be relative to `browser.urlbar`.
*/
async function doMigrateTest({
testOverrides,
scenario,
expectedPrefs,
initialUserBranch = {},
}) {
info(
"Testing migration: " +
JSON.stringify({
testOverrides,
initialUserBranch,
scenario,
expectedPrefs,
})
);
function setPref(branch, name, value) {
switch (typeof value) {
case "boolean":
branch.setBoolPref(name, value);
break;
case "number":
branch.setIntPref(name, value);
break;
case "string":
branch.setCharPref(name, value);
break;
default:
Assert.ok(
false,
`Pref type not handled for setPref: ${name} = ${value}`
);
break;
}
}
function getPref(branch, name) {
let type = typeof UrlbarPrefs.get(name);
switch (type) {
case "boolean":
return branch.getBoolPref(name);
case "number":
return branch.getIntPref(name);
case "string":
return branch.getCharPref(name);
default:
Assert.ok(false, `Pref type not handled for getPref: ${name} ${type}`);
break;
}
return null;
}
let defaultBranch = Services.prefs.getDefaultBranch("browser.urlbar.");
let userBranch = Services.prefs.getBranch("browser.urlbar.");
// Set initial prefs. `initialDefaultBranch` are firefox.js values, i.e.,
// defaults immediately after startup and before any scenario update and
// migration happens.
UrlbarPrefs._updatingFirefoxSuggestScenario = true;
UrlbarPrefs.clear("quicksuggest.migrationVersion");
let initialDefaultBranch = {
"suggest.quicksuggest.nonsponsored": false,
"suggest.quicksuggest.sponsored": false,
"quicksuggest.dataCollection.enabled": false,
};
for (let name of Object.keys(initialDefaultBranch)) {
userBranch.clearUserPref(name);
}
for (let [branch, prefs] of [
[defaultBranch, initialDefaultBranch],
[userBranch, initialUserBranch],
]) {
for (let [name, value] of Object.entries(prefs)) {
if (value !== undefined) {
setPref(branch, name, value);
}
}
}
UrlbarPrefs._updatingFirefoxSuggestScenario = false;
// Update the scenario and check prefs twice. The first time the migration
// should happen, and the second time the migration should not happen and
// all the prefs should stay the same.
for (let i = 0; i < 2; i++) {
info(`Calling updateFirefoxSuggestScenario, i=${i}`);
// Do the scenario update and set `isStartup` to simulate startup.
await UrlbarPrefs.updateFirefoxSuggestScenario({
...testOverrides,
scenario,
isStartup: true,
});
// Check expected pref values. Store expected effective values as we go so
// we can check them afterward. For a given pref, the expected effective
// value is the user value, or if there's not a user value, the default
// value.
let expectedEffectivePrefs = {};
let {
defaultBranch: expectedDefaultBranch,
userBranch: expectedUserBranch,
} = expectedPrefs;
expectedDefaultBranch = expectedDefaultBranch || {};
expectedUserBranch = expectedUserBranch || {};
for (let [branch, prefs, branchType] of [
[defaultBranch, expectedDefaultBranch, "default"],
[userBranch, expectedUserBranch, "user"],
]) {
let entries = Object.entries(prefs);
if (!entries.length) {
continue;
}
info(
`Checking expected prefs on ${branchType} branch after updating scenario`
);
for (let [name, value] of entries) {
expectedEffectivePrefs[name] = value;
if (branch == userBranch) {
Assert.ok(
userBranch.prefHasUserValue(name),
`Pref ${name} is on user branch`
);
}
Assert.equal(
getPref(branch, name),
value,
`Pref ${name} value on ${branchType} branch`
);
}
}
info(
`Making sure prefs on the default branch without expected user-branch values are not on the user branch`
);
for (let name of Object.keys(initialDefaultBranch)) {
if (!expectedUserBranch.hasOwnProperty(name)) {
Assert.ok(
!userBranch.prefHasUserValue(name),
`Pref ${name} is not on user branch`
);
}
}
info(`Checking expected effective prefs`);
for (let [name, value] of Object.entries(expectedEffectivePrefs)) {
Assert.equal(
UrlbarPrefs.get(name),
value,
`Pref ${name} effective value`
);
}
let currentVersion =
testOverrides?.migrationVersion === undefined
? UrlbarPrefs.FIREFOX_SUGGEST_MIGRATION_VERSION
: testOverrides.migrationVersion;
Assert.equal(
UrlbarPrefs.get("quicksuggest.migrationVersion"),
currentVersion,
"quicksuggest.migrationVersion is correct after migration"
);
}
// Clean up.
UrlbarPrefs._updatingFirefoxSuggestScenario = true;
UrlbarPrefs.clear("quicksuggest.migrationVersion");
let userBranchNames = [
...Object.keys(initialUserBranch),
...Object.keys(expectedPrefs.userBranch || {}),
];
for (let name of userBranchNames) {
userBranch.clearUserPref(name);
}
UrlbarPrefs._updatingFirefoxSuggestScenario = false;
}
|
