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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const SEARCH_SERVICE_TOPIC = "browser-search-service";
const SEARCH_ENGINE_TOPIC = "browser-search-engine-modified";
const CONFIG = [
{
webExtension: {
id: "engine@search.mozilla.org",
name: "Test search engine",
search_url: "https://www.google.com/search",
params: [
{
name: "q",
value: "{searchTerms}",
},
{
name: "channel",
condition: "purpose",
purpose: "contextmenu",
value: "rcs",
},
{
name: "channel",
condition: "purpose",
purpose: "keyword",
value: "fflb",
},
],
suggest_url:
"https://suggestqueries.google.com/complete/search?output=firefox&client=firefox&hl={moz:locale}&q={searchTerms}",
},
orderHint: 30,
appliesTo: [
{
included: { everywhere: true },
excluded: { regions: ["FR"] },
default: "yes",
defaultPrivate: "yes",
},
],
},
{
webExtension: {
id: "engine-pref@search.mozilla.org",
name: "engine-pref",
search_url: "https://www.google.com/search",
params: [
{
name: "q",
value: "{searchTerms}",
},
{
name: "code",
condition: "pref",
pref: "code",
},
{
name: "test",
condition: "pref",
pref: "test",
},
],
},
orderHint: 20,
appliesTo: [
{
included: { regions: ["FR"] },
default: "yes",
defaultPrivate: "yes",
},
],
},
];
const CONFIG_V2 = [
{
recordType: "engine",
identifier: "engine",
base: {
name: "Test search engine",
urls: {
search: {
base: "https://www.google.com/search",
params: [
{
name: "channel",
searchAccessPoint: {
addressbar: "fflb",
contextmenu: "rcs",
},
},
],
searchTermParamName: "q",
},
suggestions: {
base: "https://suggestqueries.google.com/complete/search?output=firefox&client=firefox&hl={moz:locale}",
searchTermParamName: "q",
},
},
},
variants: [
{
environment: { excludedRegions: ["FR"] },
},
],
},
{
recordType: "engine",
identifier: "engine-pref",
base: {
name: "engine-pref",
urls: {
search: {
base: "https://www.google.com/search",
params: [
{
name: "code",
experimentConfig: "code",
},
{
name: "test",
experimentConfig: "test",
},
],
searchTermParamName: "q",
},
},
},
variants: [
{
environment: { allRegionsAndLocales: true },
},
],
},
{
recordType: "defaultEngines",
specificDefaults: [
{
default: "engine",
defaultPrivate: "engine",
environment: { excludedRegions: ["FR"] },
},
{
default: "engine-pref",
defaultPrivate: "engine-pref",
environment: { regions: ["FR"] },
},
],
},
{
recordType: "engineOrders",
orders: [],
},
];
// Default engine with no region defined.
const DEFAULT = "Test search engine";
// Default engine with region set to FR.
const FR_DEFAULT = "engine-pref";
function listenFor(name, key) {
let notifyObserved = false;
let obs = (subject, topic, data) => {
if (data == key) {
notifyObserved = true;
}
};
Services.obs.addObserver(obs, name);
return () => {
Services.obs.removeObserver(obs, name);
return notifyObserved;
};
}
add_setup(async function () {
Services.prefs.setBoolPref("browser.search.separatePrivateDefault", true);
Services.prefs.setBoolPref(
SearchUtils.BROWSER_SEARCH_PREF + "separatePrivateDefault.ui.enabled",
true
);
SearchTestUtils.useMockIdleService();
await SearchTestUtils.useTestEngines(
"data",
null,
SearchUtils.newSearchConfigEnabled ? CONFIG_V2 : CONFIG
);
await AddonTestUtils.promiseStartupManager();
});
// This tests what we expect is the normal startup route for a fresh profile -
// the search service initializes with no region details, then gets a region
// notified part way through / afterwards.
add_task(async function test_initialization_with_region() {
let reloadObserved = listenFor(SEARCH_SERVICE_TOPIC, "engines-reloaded");
let initPromise;
// Ensure the region lookup completes after init so the
// engines are reloaded
let srv = useHttpServer();
srv.registerPathHandler("/fetch_region", async (req, res) => {
res.processAsync();
await initPromise;
res.setStatusLine("1.1", 200, "OK");
res.write(JSON.stringify({ country_code: "FR" }));
res.finish();
});
Services.prefs.setCharPref(
"browser.region.network.url",
`http://localhost:${srv.identity.primaryPort}/fetch_region`
);
Region._setHomeRegion("", false);
Region.init();
initPromise = Services.search.init();
await initPromise;
let otherPromises = [
// This test expects settings to be saved twice.
promiseAfterSettings().then(promiseAfterSettings),
SearchTestUtils.promiseSearchNotification(
"engine-default",
SEARCH_ENGINE_TOPIC
),
];
Assert.equal(
Services.search.defaultEngine.name,
DEFAULT,
"Test engine shouldn't be the default anymore"
);
await Promise.all(otherPromises);
// Ensure that correct engine is being reported as the default.
Assert.equal(
Services.search.defaultEngine.name,
FR_DEFAULT,
"engine-pref should be the default in FR"
);
Assert.equal(
(await Services.search.getDefaultPrivate()).name,
FR_DEFAULT,
"engine-pref should be the private default in FR"
);
Assert.ok(reloadObserved(), "Engines do reload with delayed region fetch");
});
|
