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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const { promiseShutdownManager, promiseStartupManager } = AddonTestUtils;
add_task(async function setup() {
await SearchTestUtils.useTestEngines("data1");
await promiseStartupManager();
await Services.search.init();
await promiseAfterSettings();
registerCleanupFunction(promiseShutdownManager);
});
add_task(async function test_basic_upgrade() {
let extension = await SearchTestUtils.installSearchExtension(
{
version: "1.0",
search_url_get_params: `q={searchTerms}&version=1.0`,
keyword: "foo",
},
{ skipUnload: true }
);
let engine = await Services.search.getEngineByAlias("foo");
Assert.ok(engine, "Can fetch engine with alias");
engine.alias = "testing";
engine = await Services.search.getEngineByAlias("testing");
Assert.ok(engine, "Can fetch engine by alias");
let params = engine.getSubmission("test").uri.query.split("&");
Assert.ok(params.includes("version=1.0"), "Correct version installed");
await Services.search.setDefault(
engine,
Ci.nsISearchService.CHANGE_REASON_UNKNOWN
);
let promiseChanged = TestUtils.topicObserved(
"browser-search-engine-modified",
(eng, verb) => verb == "engine-changed"
);
let manifest = SearchTestUtils.createEngineManifest({
version: "2.0",
search_url_get_params: `q={searchTerms}&version=2.0`,
keyword: "bar",
});
await extension.upgrade({
useAddonManager: "permanent",
manifest,
});
await AddonTestUtils.waitForSearchProviderStartup(extension);
await promiseChanged;
engine = await Services.search.getEngineByAlias("testing");
Assert.ok(engine, "Engine still has alias set");
params = engine.getSubmission("test").uri.query.split("&");
Assert.ok(params.includes("version=2.0"), "Correct version installed");
Assert.equal(
Services.search.defaultEngine.name,
"Example",
"Should have retained the same default engine"
);
await extension.unload();
await promiseAfterSettings();
});
add_task(async function test_upgrade_changes_name() {
let extension = await SearchTestUtils.installSearchExtension(
{
name: "engine",
id: "engine@tests.mozilla.org",
search_url_get_params: `q={searchTerms}&version=1.0`,
version: "1.0",
},
{ skipUnload: true }
);
let engine = Services.search.getEngineByName("engine");
Assert.ok(!!engine, "Should have loaded the engine");
await Services.search.setDefault(
engine,
Ci.nsISearchService.CHANGE_REASON_UNKNOWN
);
// When we add engines currently, we normally force using the saved order.
// Reset that here, so we can check the order is reset in the case this
// is a application provided engine change.
Services.search.wrappedJSObject._settings.setMetaDataAttribute(
"useSavedOrder",
false
);
Services.search.getEngineByName("engine1").wrappedJSObject._orderHint = null;
Services.search.getEngineByName("engine2").wrappedJSObject._orderHint = null;
Assert.deepEqual(
(await Services.search.getVisibleEngines()).map(e => e.name),
["engine1", "engine2", "engine"],
"Should have the expected order initially"
);
let promiseChanged = TestUtils.topicObserved(
"browser-search-engine-modified",
(eng, verb) => verb == "engine-changed"
);
let manifest = SearchTestUtils.createEngineManifest({
name: "Bar",
id: "engine@tests.mozilla.org",
search_url_get_params: `q={searchTerms}&version=2.0`,
version: "2.0",
});
await extension.upgrade({
useAddonManager: "permanent",
manifest,
});
await AddonTestUtils.waitForSearchProviderStartup(extension);
await promiseChanged;
engine = Services.search.getEngineByName("Bar");
Assert.ok(!!engine, "Should be able to get the new engine");
Assert.equal(
(await Services.search.getDefault()).name,
"Bar",
"Should have kept the default engine the same"
);
Assert.deepEqual(
(await Services.search.getVisibleEngines()).map(e => e.name),
// Expected order: Default, then others in alphabetical.
["engine1", "Bar", "engine2"],
"Should have updated the engine order"
);
await extension.unload();
await promiseAfterSettings();
});
add_task(async function test_upgrade_to_existing_name_not_allowed() {
let extension = await SearchTestUtils.installSearchExtension(
{
name: "engine",
search_url_get_params: `q={searchTerms}&version=1.0`,
version: "1.0",
},
{ skipUnload: true }
);
let engine = Services.search.getEngineByName("engine");
Assert.ok(!!engine, "Should have loaded the engine");
let promise = AddonTestUtils.waitForSearchProviderStartup(extension);
let name = "engine1";
consoleAllowList.push(`An engine called ${name} already exists`);
let manifest = SearchTestUtils.createEngineManifest({
name,
search_url_get_params: `q={searchTerms}&version=2.0`,
version: "2.0",
});
await extension.upgrade({
useAddonManager: "permanent",
manifest,
});
await promise;
Assert.equal(
Services.search.getEngineByName("engine1").getSubmission("").uri.spec,
"https://1.example.com/",
"Should have not changed the original engine"
);
console.log((await Services.search.getEngines()).map(e => e.name));
engine = Services.search.getEngineByName("engine");
Assert.ok(!!engine, "Should still be able to get the engine by the old name");
await extension.unload();
await promiseAfterSettings();
});
|
