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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
/**
* Tests that ensure application provided engines have all base fields set up
* correctly from the search configuration.
*/
"use strict";
let CONFIG = [
{
identifier: "testEngine",
recordType: "engine",
base: {
aliases: ["testEngine1", "testEngine2"],
charset: "EUC-JP",
classification: "general",
name: "testEngine name",
partnerCode: "pc",
urls: {
search: {
base: "https://example.com/1",
// Method defaults to GET
params: [
{ name: "partnerCode", value: "{partnerCode}" },
{ name: "starbase", value: "Regula I" },
{ name: "experiment", value: "Genesis" },
{
name: "accessPoint",
searchAccessPoint: {
addressbar: "addressbar",
contextmenu: "contextmenu",
homepage: "homepage",
newtab: "newtab",
searchbar: "searchbar",
},
},
],
searchTermParamName: "search",
},
suggestions: {
base: "https://example.com/2",
method: "POST",
searchTermParamName: "suggestions",
},
trending: {
base: "https://example.com/3",
searchTermParamName: "trending",
},
},
},
variants: [{ environment: { allRegionsAndLocales: true } }],
},
{
identifier: "testOtherValuesEngine",
recordType: "engine",
base: {
classification: "unknown",
name: "testOtherValuesEngine name",
urls: {
search: {
base: "https://example.com/1",
searchTermParamName: "search",
},
},
},
variants: [{ environment: { allRegionsAndLocales: true } }],
},
{
identifier: "override",
recordType: "engine",
base: {
classification: "unknown",
name: "override name",
urls: {
search: {
base: "https://www.example.com/search",
params: [
{
name: "old_param",
value: "old_value",
},
],
searchTermParamName: "q",
},
},
},
variants: [
{
environment: {
locales: ["en-US"],
},
},
],
},
{
recordType: "defaultEngines",
globalDefault: "engine_no_initial_icon",
specificDefaults: [],
},
{
recordType: "engineOrders",
orders: [],
},
];
const TEST_CONFIG_OVERRIDE = [
{
identifier: "override",
urls: {
search: {
params: [{ name: "new_param", value: "new_value" }],
},
},
telemetrySuffix: "tsfx",
clickUrl: "https://example.org/somewhere",
},
];
add_setup(async function () {
await SearchTestUtils.useTestEngines("simple-engines", null, CONFIG);
await Services.search.init();
});
add_task(async function test_engine_with_all_params_set() {
let engine = Services.search.getEngineById(
"testEngine@search.mozilla.orgdefault"
);
Assert.ok(engine, "Should have found the engine");
Assert.equal(
engine.name,
"testEngine name",
"Should have the correct engine name"
);
Assert.deepEqual(
engine.aliases,
["@testEngine1", "@testEngine2"],
"Should have the correct aliases"
);
Assert.ok(
engine.isGeneralPurposeEngine,
"Should be a general purpose engine"
);
Assert.equal(
engine.wrappedJSObject.queryCharset,
"EUC-JP",
"Should have the correct encoding"
);
let submission = engine.getSubmission("test");
Assert.equal(
submission.uri.spec,
"https://example.com/1?partnerCode=pc&starbase=Regula%20I&experiment=Genesis&accessPoint=searchbar&search=test",
"Should have the correct search URL"
);
Assert.ok(!submission.postData, "Should not have postData for a GET url");
let suggestSubmission = engine.getSubmission(
"test",
SearchUtils.URL_TYPE.SUGGEST_JSON
);
Assert.equal(
suggestSubmission.uri.spec,
"https://example.com/2",
"Should have the correct suggestion URL"
);
Assert.equal(
suggestSubmission.postData.data.data,
"suggestions=test",
"Should have the correct postData for a POST URL"
);
let trendingSubmission = engine.getSubmission(
"test",
SearchUtils.URL_TYPE.TRENDING_JSON
);
Assert.equal(
trendingSubmission.uri.spec,
"https://example.com/3?trending=test"
);
Assert.ok(!submission.postData, "Should not have postData for a GET url");
});
add_task(async function test_engine_with_some_params_set() {
let engine = Services.search.getEngineById(
"testOtherValuesEngine@search.mozilla.orgdefault"
);
Assert.ok(engine, "Should have found the engine");
Assert.equal(
engine.name,
"testOtherValuesEngine name",
"Should have the correct engine name"
);
Assert.deepEqual(engine.aliases, [], "Should have no aliases");
Assert.ok(
!engine.isGeneralPurposeEngine,
"Should not be a general purpose engine"
);
Assert.equal(
engine.wrappedJSObject.queryCharset,
"UTF-8",
"Should default to UTF-8 charset"
);
Assert.equal(
engine.getSubmission("test").uri.spec,
"https://example.com/1?search=test",
"Should have the correct search URL"
);
Assert.equal(
engine.getSubmission("test", SearchUtils.URL_TYPE.SUGGEST_JSON),
null,
"Should not have a suggestions URL"
);
Assert.equal(
engine.getSubmission("test", SearchUtils.URL_TYPE.TRENDING_JSON),
null,
"Should not have a trending URL"
);
});
add_task(async function test_engine_remote_override() {
// First check the existing engine doesn't have the overrides.
let engine = Services.search.getEngineById(
"override@search.mozilla.orgdefault"
);
Assert.ok(engine, "Should have found the override engine");
Assert.equal(engine.name, "override name", "Should have the expected name");
Assert.equal(
engine.telemetryId,
"override",
"Should have the overridden telemetry suffix"
);
Assert.equal(
engine.getSubmission("test").uri.spec,
"https://www.example.com/search?old_param=old_value&q=test",
"Should have the overridden URL"
);
Assert.equal(engine.clickUrl, null, "Should not have a click URL");
// Now apply and test the overrides.
const overrides = await RemoteSettings(
SearchUtils.NEW_SETTINGS_OVERRIDES_KEY
);
sinon.stub(overrides, "get").returns(TEST_CONFIG_OVERRIDE);
await Services.search.wrappedJSObject.reset();
await Services.search.init();
engine = Services.search.getEngineById("override@search.mozilla.orgdefault");
Assert.ok(engine, "Should have found the override engine");
Assert.equal(engine.name, "override name", "Should have the expected name");
Assert.equal(
engine.telemetryId,
"override-tsfx",
"Should have the overridden telemetry suffix"
);
Assert.equal(
engine.getSubmission("test").uri.spec,
"https://www.example.com/search?new_param=new_value&q=test",
"Should have the overridden URL"
);
Assert.equal(
engine.clickUrl,
"https://example.org/somewhere",
"Should have the click URL specified by the override"
);
});
|
