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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const CONFIG = [
{
// Just a basic engine that won't be changed.
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}",
},
appliesTo: [
{
included: { everywhere: true },
default: "yes",
},
],
},
{
// This engine will have the locale swapped when the experiment is set.
webExtension: {
id: "engine-same-name@search.mozilla.org",
default_locale: "en",
searchProvider: {
en: {
name: "engine-same-name",
search_url: "https://www.google.com/search?q={searchTerms}",
},
gd: {
name: "engine-same-name",
search_url: "https://www.example.com/search?q={searchTerms}",
},
},
},
appliesTo: [
{
included: { everywhere: true },
webExtension: {
locales: ["en"],
},
},
{
included: { everywhere: true },
webExtension: {
locales: ["gd"],
},
experiment: "xpcshell",
},
],
},
];
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",
},
},
},
variants: [
{
environment: { allRegionsAndLocales: true },
},
],
},
{
recordType: "engine",
identifier: "engine-same-name-en",
base: {
name: "engine-same-name",
urls: {
search: {
base: "https://www.google.com/search",
searchTermParamName: "q",
},
},
},
variants: [
{
environment: { allRegionsAndLocales: true },
},
],
},
{
recordType: "engine",
identifier: "engine-same-name-gd",
base: {
name: "engine-same-name",
urls: {
search: {
base: "https://www.example.com/search",
searchTermParamName: "q",
},
},
},
variants: [
{
environment: { allRegionsAndLocales: true, experiment: "xpcshell" },
},
],
},
{
recordType: "defaultEngines",
globalDefault: "engine",
specificDefaults: [],
},
{
recordType: "engineOrders",
orders: [],
},
];
add_setup(async function () {
await SearchTestUtils.useTestEngines(
"data",
null,
SearchUtils.newSearchConfigEnabled ? CONFIG_V2 : CONFIG
);
await AddonTestUtils.promiseStartupManager();
});
// This is to verify that the loaded configuration matches what we expect for
// the test.
add_task(async function test_initial_config_correct() {
await Services.search.init();
const installedEngines = await Services.search.getAppProvidedEngines();
Assert.deepEqual(
installedEngines.map(e => e.identifier),
["engine", "engine-same-name-en"],
"Should have the correct list of engines installed."
);
Assert.equal(
(await Services.search.getDefault()).identifier,
"engine",
"Should have loaded the expected default engine"
);
});
add_task(async function test_config_updated_engine_changes() {
// Update the config.
const reloadObserved =
SearchTestUtils.promiseSearchNotification("engines-reloaded");
const enginesAdded = [];
const enginesModified = [];
const enginesRemoved = [];
function enginesObs(subject, topic, data) {
if (data == SearchUtils.MODIFIED_TYPE.ADDED) {
enginesAdded.push(subject.QueryInterface(Ci.nsISearchEngine).identifier);
} else if (data == SearchUtils.MODIFIED_TYPE.CHANGED) {
enginesModified.push(
subject.QueryInterface(Ci.nsISearchEngine).identifier
);
} else if (data == SearchUtils.MODIFIED_TYPE.REMOVED) {
enginesRemoved.push(subject.QueryInterface(Ci.nsISearchEngine).name);
}
}
Services.obs.addObserver(enginesObs, SearchUtils.TOPIC_ENGINE_MODIFIED);
Services.prefs.setCharPref(
SearchUtils.BROWSER_SEARCH_PREF + "experiment",
"xpcshell"
);
await reloadObserved;
Services.obs.removeObserver(enginesObs, SearchUtils.TOPIC_ENGINE_MODIFIED);
if (SearchUtils.newSearchConfigEnabled) {
// In the new config, engine-same-name-en and engine-same-name-gd are two
// different engine configs and they will be treated as different engines
// and not the same. That's the reason why the assertions are different below.
Assert.deepEqual(
enginesAdded,
["engine-same-name-gd"],
"Should have added the correct engines"
);
Assert.deepEqual(
enginesModified.sort(),
["engine", "engine-same-name-en"],
"Should have modified the expected engines"
);
Assert.deepEqual(
enginesRemoved,
["engine-same-name"],
"Should have removed the expected engine"
);
} else {
Assert.deepEqual(enginesAdded, [], "Should have added the correct engines");
Assert.deepEqual(
enginesModified.sort(),
["engine", "engine-same-name-gd"],
"Should have modified the expected engines"
);
Assert.deepEqual(
enginesRemoved,
[],
"Should have removed the expected engine"
);
}
const installedEngines = await Services.search.getAppProvidedEngines();
Assert.deepEqual(
installedEngines.map(e => e.identifier),
["engine", "engine-same-name-gd"],
"Should have the correct list of engines installed in the expected order."
);
const engineWithSameName = await Services.search.getEngineByName(
"engine-same-name"
);
Assert.equal(
engineWithSameName.getSubmission("test").uri.spec,
"https://www.example.com/search?q=test",
"Should have correctly switched to the engine of the same name"
);
Assert.equal(
Services.search.wrappedJSObject._settings.getMetaDataAttribute(
"useSavedOrder"
),
false,
"Should not have set the useSavedOrder preference"
);
});
|
