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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
let engine;
let originalDefaultEngine;
SearchTestUtils.initXPCShellAddonManager(this);
/**
* A simple observer to ensure we get only the expected notifications.
*/
class SearchObserver {
constructor(expectedNotifications, returnAddedEngine = false) {
this.observer = this.observer.bind(this);
this.deferred = PromiseUtils.defer();
this.expectedNotifications = expectedNotifications;
this.returnAddedEngine = returnAddedEngine;
Services.obs.addObserver(this.observer, SearchUtils.TOPIC_ENGINE_MODIFIED);
}
get promise() {
return this.deferred.promise;
}
observer(subject, topic, data) {
Assert.greater(
this.expectedNotifications.length,
0,
"Should be expecting a notification"
);
Assert.equal(
data,
this.expectedNotifications[0],
"Should have received the next expected notification"
);
if (this.returnAddedEngine && data == SearchUtils.MODIFIED_TYPE.ADDED) {
this.addedEngine = subject.QueryInterface(Ci.nsISearchEngine);
}
this.expectedNotifications.shift();
if (!this.expectedNotifications.length) {
this.deferred.resolve(this.addedEngine);
Services.obs.removeObserver(
this.observer,
SearchUtils.TOPIC_ENGINE_MODIFIED
);
}
}
}
add_task(async function setup() {
await AddonTestUtils.promiseStartupManager();
useHttpServer();
Services.prefs.setBoolPref(
SearchUtils.BROWSER_SEARCH_PREF + "separatePrivateDefault.ui.enabled",
true
);
Services.prefs.setBoolPref(
SearchUtils.BROWSER_SEARCH_PREF + "separatePrivateDefault",
true
);
originalDefaultEngine = await Services.search.getDefault();
});
add_task(async function test_addingEngine_opensearch() {
const addEngineObserver = new SearchObserver(
[
// engine-loaded
// Engine was loaded.
SearchUtils.MODIFIED_TYPE.LOADED,
// engine-added
// Engine was added to the store by the search service.
SearchUtils.MODIFIED_TYPE.ADDED,
],
true
);
await Services.search.addOpenSearchEngine(gDataUrl + "engine.xml", null);
engine = await addEngineObserver.promise;
let retrievedEngine = Services.search.getEngineByName("Test search engine");
Assert.equal(engine, retrievedEngine);
});
add_task(async function test_addingEngine_webExtension() {
const addEngineObserver = new SearchObserver(
[
// engine-added
// Engine was added to the store by the search service.
SearchUtils.MODIFIED_TYPE.ADDED,
],
true
);
let extension = await SearchTestUtils.installSearchExtension({
name: "Example Engine",
});
await extension.awaitStartup();
let webExtensionEngine = await addEngineObserver.promise;
let retrievedEngine = Services.search.getEngineByName("Example Engine");
Assert.equal(webExtensionEngine, retrievedEngine);
await extension.unload();
});
async function defaultNotificationTest(
setPrivateDefault,
expectNotificationForPrivate
) {
const defaultObserver = new SearchObserver([
expectNotificationForPrivate
? SearchUtils.MODIFIED_TYPE.DEFAULT_PRIVATE
: SearchUtils.MODIFIED_TYPE.DEFAULT,
]);
Services.search[
setPrivateDefault ? "defaultPrivateEngine" : "defaultEngine"
] = engine;
await defaultObserver.promise;
}
add_task(async function test_defaultEngine_notifications() {
await defaultNotificationTest(false, false);
});
add_task(async function test_defaultPrivateEngine_notifications() {
await defaultNotificationTest(true, true);
});
add_task(
async function test_defaultPrivateEngine_notifications_when_not_enabled() {
await Services.search.setDefault(originalDefaultEngine);
Services.prefs.setBoolPref(
SearchUtils.BROWSER_SEARCH_PREF + "separatePrivateDefault",
false
);
await defaultNotificationTest(true, true);
}
);
add_task(async function test_removeEngine() {
const removedObserver = new SearchObserver([
SearchUtils.MODIFIED_TYPE.REMOVED,
]);
await Services.search.removeEngine(engine);
await removedObserver;
});
|
