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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
// Test edge cases for engagement.
Services.scriptloader.loadSubScript(
"chrome://mochitests/content/browser/browser/components/urlbar/tests/ext/browser/head.js",
this
);
add_setup(async function () {
await setup();
});
/**
* UrlbarProvider that does not add any result.
*/
class NoResponseTestProvider extends UrlbarTestUtils.TestProvider {
constructor() {
super({ name: "TestProviderNoResponse ", results: [] });
this.#deferred = PromiseUtils.defer();
}
get type() {
return UrlbarUtils.PROVIDER_TYPE.HEURISTIC;
}
async startQuery(context, addCallback) {
await this.#deferred.promise;
}
done() {
this.#deferred.resolve();
}
#deferred = null;
}
const noResponseProvider = new NoResponseTestProvider();
/**
* UrlbarProvider that adds a heuristic result immediately as usual.
*/
class AnotherHeuristicProvider extends UrlbarTestUtils.TestProvider {
constructor({ results }) {
super({ name: "TestProviderAnotherHeuristic ", results });
this.#deferred = PromiseUtils.defer();
}
get type() {
return UrlbarUtils.PROVIDER_TYPE.HEURISTIC;
}
async startQuery(context, addCallback) {
for (const result of this._results) {
addCallback(this, result);
}
this.#deferred.resolve(context);
}
onQueryStarted() {
return this.#deferred.promise;
}
#deferred = null;
}
const anotherHeuristicProvider = new AnotherHeuristicProvider({
results: [
Object.assign(
new UrlbarResult(
UrlbarUtils.RESULT_TYPE.URL,
UrlbarUtils.RESULT_SOURCE.OTHER_LOCAL,
{ url: "https://example.com/immediate" }
),
{ heuristic: true }
),
],
});
add_task(async function engagement_before_showing_results() {
await SpecialPowers.pushPrefEnv({
// Avoid showing search tip.
set: [["browser.urlbar.tipShownCount.searchTip_onboard", 999]],
});
// Update chunkResultsDelayMs to delay the call to notifyResults.
const originalChuldResultDelayMs =
UrlbarProvidersManager._chunkResultsDelayMs;
UrlbarProvidersManager._chunkResultsDelayMs = 1000000;
// Add a provider that waits forever in startQuery() to avoid fireing
// heuristicProviderTimer.
UrlbarProvidersManager.registerProvider(noResponseProvider);
// Add a provider that add a result immediately as usual.
UrlbarProvidersManager.registerProvider(anotherHeuristicProvider);
const cleanup = () => {
UrlbarProvidersManager.unregisterProvider(noResponseProvider);
UrlbarProvidersManager.unregisterProvider(anotherHeuristicProvider);
UrlbarProvidersManager._chunkResultsDelayMs = originalChuldResultDelayMs;
};
registerCleanupFunction(cleanup);
await doTest(async browser => {
// Try to show the results.
await UrlbarTestUtils.inputIntoURLBar(window, "exam");
// Wait until starting the query and filling expected results.
const context = await anotherHeuristicProvider.onQueryStarted();
const query = UrlbarProvidersManager.queries.get(context);
await BrowserTestUtils.waitForCondition(
() =>
query.unsortedResults.some(
r => r.providerName === "HeuristicFallback"
) &&
query.unsortedResults.some(
r => r.providerName === anotherHeuristicProvider.name
)
);
// Type Enter key before showing any results.
await doEnter();
assertEngagementTelemetry([
{
selected_result: "input_field",
selected_result_subtype: "",
provider: undefined,
results: "",
groups: "",
},
]);
// Clear the pending query.
noResponseProvider.done();
});
cleanup();
await SpecialPowers.popPrefEnv();
});
add_task(async function engagement_after_closing_results() {
const TRIGGERS = [
() => EventUtils.synthesizeKey("KEY_Escape"),
() =>
EventUtils.synthesizeMouseAtCenter(
document.getElementById("customizableui-special-spring2"),
{}
),
];
for (const trigger of TRIGGERS) {
await doTest(async browser => {
await openPopup("test");
await UrlbarTestUtils.promisePopupClose(window, () => {
trigger();
});
Assert.equal(
gURLBar.value,
"test",
"The inputted text remains even if closing the results"
);
// The tested trigger should not record abandonment event.
assertAbandonmentTelemetry([]);
// Endgagement.
await doEnter();
assertEngagementTelemetry([
{
selected_result: "input_field",
selected_result_subtype: "",
provider: undefined,
results: "",
groups: "",
},
]);
});
}
});
add_task(async function enter_to_reload_current_url() {
await doTest(async browser => {
// Open a URL once.
await openPopup("https://example.com");
await doEnter();
// Focus the urlbar.
EventUtils.synthesizeMouseAtCenter(gURLBar.inputField, {});
await BrowserTestUtils.waitForCondition(
() => window.document.activeElement === gURLBar.inputField
);
await UrlbarTestUtils.promiseSearchComplete(window);
// Press Enter key to reload the page without selecting any suggestions.
await doEnter();
assertEngagementTelemetry([
{
selected_result: "url",
selected_result_subtype: "",
provider: "HeuristicFallback",
results: "url",
groups: "heuristic",
},
{
selected_result: "input_field",
selected_result_subtype: "",
provider: undefined,
results: "action",
groups: "suggested_index",
},
]);
});
});
|
