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
283
284
285
286
287
288
289
290
291
292
|
/* 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/. */
const { UrlbarSearchUtils } = ChromeUtils.import(
"resource:///modules/UrlbarSearchUtils.jsm"
);
add_task(async function() {
await UrlbarSearchUtils.init();
// Tell the search service we are running in the US. This also has the
// desired side-effect of preventing our geoip lookup.
Services.prefs.setCharPref("browser.search.region", "US");
Services.search.restoreDefaultEngines();
Services.search.resetToOriginalDefaultEngine();
});
add_task(async function search_engine_match() {
let engine = await Services.search.getDefault();
let domain = engine.getResultDomain();
let token = domain.substr(0, 1);
let matchedEngine = (
await UrlbarSearchUtils.enginesForDomainPrefix(token)
)[0];
Assert.equal(matchedEngine, engine);
});
add_task(async function no_match() {
Assert.equal(
0,
(await UrlbarSearchUtils.enginesForDomainPrefix("test")).length
);
});
add_task(async function hide_search_engine_nomatch() {
let engine = await Services.search.getDefault();
let domain = engine.getResultDomain();
let token = domain.substr(0, 1);
let promiseTopic = promiseSearchTopic("engine-changed");
await Promise.all([Services.search.removeEngine(engine), promiseTopic]);
Assert.ok(engine.hidden);
let matchedEngines = await UrlbarSearchUtils.enginesForDomainPrefix(token);
Assert.ok(
!matchedEngines.length || matchedEngines[0].getResultDomain() != domain
);
engine.hidden = false;
await TestUtils.waitForCondition(
async () => (await UrlbarSearchUtils.enginesForDomainPrefix(token)).length
);
let matchedEngine2 = (
await UrlbarSearchUtils.enginesForDomainPrefix(token)
)[0];
Assert.ok(matchedEngine2);
});
add_task(async function onlyEnabled_option_nomatch() {
let engine = await Services.search.getDefault();
let domain = engine.getResultDomain();
let token = domain.substr(0, 1);
Services.prefs.setCharPref("browser.search.hiddenOneOffs", engine.name);
let matchedEngines = await UrlbarSearchUtils.enginesForDomainPrefix(token, {
onlyEnabled: true,
});
Assert.ok(
!matchedEngines.length || matchedEngines[0].getResultDomain() != domain
);
Services.prefs.clearUserPref("browser.search.hiddenOneOffs");
matchedEngines = await UrlbarSearchUtils.enginesForDomainPrefix(token, {
onlyEnabled: true,
});
Assert.ok(
matchedEngines.length && matchedEngines[0].getResultDomain() == domain
);
});
add_task(async function add_search_engine_match() {
let promiseTopic = promiseSearchTopic("engine-added");
Assert.equal(
0,
(await UrlbarSearchUtils.enginesForDomainPrefix("bacon")).length
);
await Promise.all([
Services.search.addEngineWithDetails("bacon", {
alias: "pork",
description: "Search Bacon",
method: "GET",
template: "http://www.bacon.moz/?search={searchTerms}",
}),
promiseTopic,
]);
await promiseTopic;
let matchedEngine = (
await UrlbarSearchUtils.enginesForDomainPrefix("bacon")
)[0];
Assert.ok(matchedEngine);
Assert.equal(matchedEngine.searchForm, "http://www.bacon.moz");
Assert.equal(matchedEngine.name, "bacon");
Assert.equal(matchedEngine.iconURI, null);
info("also type part of the public suffix");
matchedEngine = (
await UrlbarSearchUtils.enginesForDomainPrefix("bacon.m")
)[0];
Assert.ok(matchedEngine);
Assert.equal(matchedEngine.searchForm, "http://www.bacon.moz");
Assert.equal(matchedEngine.name, "bacon");
Assert.equal(matchedEngine.iconURI, null);
});
add_task(async function match_multiple_search_engines() {
let promiseTopic = promiseSearchTopic("engine-added");
Assert.equal(
0,
(await UrlbarSearchUtils.enginesForDomainPrefix("baseball")).length
);
await Promise.all([
Services.search.addEngineWithDetails("baseball", {
description: "Search Baseball",
method: "GET",
template: "http://www.baseball.moz/?search={searchTerms}",
}),
promiseTopic,
]);
await promiseTopic;
let matchedEngines = await UrlbarSearchUtils.enginesForDomainPrefix("ba");
Assert.equal(
matchedEngines.length,
2,
"enginesForDomainPrefix returned two engines."
);
Assert.equal(matchedEngines[0].searchForm, "http://www.bacon.moz");
Assert.equal(matchedEngines[0].name, "bacon");
Assert.equal(matchedEngines[1].searchForm, "http://www.baseball.moz");
Assert.equal(matchedEngines[1].name, "baseball");
});
add_task(async function test_aliased_search_engine_match() {
Assert.equal(null, await UrlbarSearchUtils.engineForAlias("sober"));
// Lower case
let matchedEngine = await UrlbarSearchUtils.engineForAlias("pork");
Assert.ok(matchedEngine);
Assert.equal(matchedEngine.name, "bacon");
Assert.ok(matchedEngine.aliases.includes("pork"));
Assert.equal(matchedEngine.iconURI, null);
// Upper case
matchedEngine = await UrlbarSearchUtils.engineForAlias("PORK");
Assert.ok(matchedEngine);
Assert.equal(matchedEngine.name, "bacon");
Assert.ok(matchedEngine.aliases.includes("pork"));
Assert.equal(matchedEngine.iconURI, null);
// Cap case
matchedEngine = await UrlbarSearchUtils.engineForAlias("Pork");
Assert.ok(matchedEngine);
Assert.equal(matchedEngine.name, "bacon");
Assert.ok(matchedEngine.aliases.includes("pork"));
Assert.equal(matchedEngine.iconURI, null);
});
add_task(async function test_aliased_search_engine_match_upper_case_alias() {
let promiseTopic = promiseSearchTopic("engine-added");
Assert.equal(
0,
(await UrlbarSearchUtils.enginesForDomainPrefix("patch")).length
);
await Promise.all([
Services.search.addEngineWithDetails("patch", {
alias: "PR",
description: "Search Patch",
method: "GET",
template: "http://www.patch.moz/?search={searchTerms}",
}),
promiseTopic,
]);
// lower case
let matchedEngine = await UrlbarSearchUtils.engineForAlias("pr");
Assert.ok(matchedEngine);
Assert.equal(matchedEngine.name, "patch");
Assert.ok(matchedEngine.aliases.includes("PR"));
Assert.equal(matchedEngine.iconURI, null);
// Upper case
matchedEngine = await UrlbarSearchUtils.engineForAlias("PR");
Assert.ok(matchedEngine);
Assert.equal(matchedEngine.name, "patch");
Assert.ok(matchedEngine.aliases.includes("PR"));
Assert.equal(matchedEngine.iconURI, null);
// Cap case
matchedEngine = await UrlbarSearchUtils.engineForAlias("Pr");
Assert.ok(matchedEngine);
Assert.equal(matchedEngine.name, "patch");
Assert.ok(matchedEngine.aliases.includes("PR"));
Assert.equal(matchedEngine.iconURI, null);
});
add_task(async function remove_search_engine_nomatch() {
let engine = Services.search.getEngineByName("bacon");
let promiseTopic = promiseSearchTopic("engine-removed");
await Promise.all([Services.search.removeEngine(engine), promiseTopic]);
Assert.equal(
0,
(await UrlbarSearchUtils.enginesForDomainPrefix("bacon")).length
);
});
add_task(async function test_builtin_aliased_search_engine_match() {
let engine = await UrlbarSearchUtils.engineForAlias("@google");
Assert.ok(engine);
Assert.equal(engine.name, "Google");
let promiseTopic = promiseSearchTopic("engine-changed");
await Promise.all([Services.search.removeEngine(engine), promiseTopic]);
let matchedEngine = await UrlbarSearchUtils.engineForAlias("@google");
Assert.ok(!matchedEngine);
engine.hidden = false;
await TestUtils.waitForCondition(() =>
UrlbarSearchUtils.engineForAlias("@google")
);
engine = await UrlbarSearchUtils.engineForAlias("@google");
Assert.ok(engine);
});
add_task(async function test_serps_are_equivalent() {
info("Subset URL has extraneous parameters.");
let url1 = "https://example.com/search?q=test&type=images";
let url2 = "https://example.com/search?q=test";
Assert.ok(!UrlbarSearchUtils.serpsAreEquivalent(url1, url2));
info("Superset URL has extraneous parameters.");
Assert.ok(UrlbarSearchUtils.serpsAreEquivalent(url2, url1));
info("Same keys, different values.");
url1 = "https://example.com/search?q=test&type=images";
url2 = "https://example.com/search?q=test123&type=maps";
Assert.ok(!UrlbarSearchUtils.serpsAreEquivalent(url1, url2));
Assert.ok(!UrlbarSearchUtils.serpsAreEquivalent(url2, url1));
info("Subset matching isn't strict (URL is subset of itself).");
Assert.ok(UrlbarSearchUtils.serpsAreEquivalent(url1, url1));
info("Origin and pathname are ignored.");
url1 = "https://example.com/search?q=test";
url2 = "https://example-1.com/maps?q=test";
Assert.ok(UrlbarSearchUtils.serpsAreEquivalent(url1, url2));
Assert.ok(UrlbarSearchUtils.serpsAreEquivalent(url2, url1));
info("Params can be optionally ignored");
url1 = "https://example.com/search?q=test&abc=123&foo=bar";
url2 = "https://example.com/search?q=test";
Assert.ok(!UrlbarSearchUtils.serpsAreEquivalent(url1, url2));
Assert.ok(UrlbarSearchUtils.serpsAreEquivalent(url1, url2, ["abc", "foo"]));
});
add_task(async function test_get_root_domain_from_engine() {
let engine = await Services.search.addEngineWithDetails("TestEngine2", {
template: "http://example.com",
});
Assert.equal(UrlbarSearchUtils.getRootDomainFromEngine(engine), "example");
await Services.search.removeEngine(engine);
engine = await Services.search.addEngineWithDetails("TestEngine", {
template: "http://www.subdomain.othersubdomain.example.com",
});
Assert.equal(UrlbarSearchUtils.getRootDomainFromEngine(engine), "example");
await Services.search.removeEngine(engine);
// We let engines with URL ending in .test through even though its not a valid
// TLD.
engine = await Services.search.addEngineWithDetails("TestMalformed", {
template: `http://mochi.test/?search={searchTerms}`,
});
Assert.equal(UrlbarSearchUtils.getRootDomainFromEngine(engine), "mochi");
await Services.search.removeEngine(engine);
// We return the domain for engines with a malformed URL.
engine = await Services.search.addEngineWithDetails("TestMalformed", {
template: `http://subdomain.foobar/?search={searchTerms}`,
});
Assert.equal(
UrlbarSearchUtils.getRootDomainFromEngine(engine),
"subdomain.foobar"
);
await Services.search.removeEngine(engine);
});
function promiseSearchTopic(expectedVerb) {
return new Promise(resolve => {
Services.obs.addObserver(function observe(subject, topic, verb) {
info("browser-search-engine-modified: " + verb);
if (verb == expectedVerb) {
Services.obs.removeObserver(observe, "browser-search-engine-modified");
resolve();
}
}, "browser-search-engine-modified");
});
}
|
