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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
// Tests best match rows in the view. See also:
//
// browser_quicksuggest_bestMatch.js
// UI test for quick suggest best matches specifically
// test_quicksuggest_bestMatch.js
// Tests triggering quick suggest best matches and things that don't depend on
// the view
"use strict";
// Tests a non-sponsored best match row.
add_task(async function nonsponsored() {
let result = makeBestMatchResult();
await withProvider(result, async () => {
await UrlbarTestUtils.promiseAutocompleteResultPopup({
window,
value: "test",
});
await checkBestMatchRow({ result });
await UrlbarTestUtils.promisePopupClose(window);
});
});
// Tests a non-sponsored best match row with a help button.
add_task(async function nonsponsoredHelpButton() {
let result = makeBestMatchResult({ helpUrl: "https://example.com/help" });
await withProvider(result, async () => {
await UrlbarTestUtils.promiseAutocompleteResultPopup({
window,
value: "test",
});
await checkBestMatchRow({ result, hasHelpUrl: true });
await UrlbarTestUtils.promisePopupClose(window);
});
});
// Tests a sponsored best match row.
add_task(async function sponsored() {
let result = makeBestMatchResult({ isSponsored: true });
await withProvider(result, async () => {
await UrlbarTestUtils.promiseAutocompleteResultPopup({
window,
value: "test",
});
await checkBestMatchRow({ result, isSponsored: true });
await UrlbarTestUtils.promisePopupClose(window);
});
});
// Tests a sponsored best match row with a help button.
add_task(async function sponsoredHelpButton() {
let result = makeBestMatchResult({
isSponsored: true,
helpUrl: "https://example.com/help",
});
await withProvider(result, async () => {
await UrlbarTestUtils.promiseAutocompleteResultPopup({
window,
value: "test",
});
await checkBestMatchRow({ result, isSponsored: true, hasHelpUrl: true });
await UrlbarTestUtils.promisePopupClose(window);
});
});
// Tests keyboard selection.
add_task(async function keySelection() {
let result = makeBestMatchResult({
isSponsored: true,
helpUrl: "https://example.com/help",
});
await withProvider(result, async () => {
// Ordered list of class names of the elements that should be selected.
let expectedClassNames = [
"urlbarView-row-inner",
UrlbarPrefs.get("resultMenu")
? "urlbarView-button-menu"
: "urlbarView-button-help",
];
await UrlbarTestUtils.promiseAutocompleteResultPopup({
window,
value: "test",
});
await checkBestMatchRow({
result,
isSponsored: true,
hasHelpUrl: true,
});
// Test with the tab key in order vs. reverse order.
for (let reverse of [false, true]) {
info("Doing TAB key selection: " + JSON.stringify({ reverse }));
let classNames = [...expectedClassNames];
if (reverse) {
classNames.reverse();
}
let sendKey = () => {
EventUtils.synthesizeKey("KEY_Tab", { shiftKey: reverse });
};
// Move selection through each expected element.
for (let className of classNames) {
info("Expecting selection: " + className);
sendKey();
Assert.ok(gURLBar.view.isOpen, "View remains open");
let { selectedElement } = gURLBar.view;
Assert.ok(selectedElement, "Selected element exists");
Assert.ok(
selectedElement.classList.contains(className),
"Expected element is selected"
);
}
sendKey();
Assert.ok(
gURLBar.view.isOpen,
"View remains open after keying through best match row"
);
}
await UrlbarTestUtils.promisePopupClose(window);
});
});
async function checkBestMatchRow({
result,
isSponsored = false,
hasHelpUrl = false,
}) {
Assert.equal(
UrlbarTestUtils.getResultCount(window),
1,
"One result is present"
);
let details = await UrlbarTestUtils.getDetailsOfResultAt(window, 0);
let { row } = details.element;
Assert.equal(row.getAttribute("type"), "bestmatch", "row[type] is bestmatch");
let favicon = row._elements.get("favicon");
Assert.ok(favicon, "Row has a favicon");
let title = row._elements.get("title");
Assert.ok(title, "Row has a title");
Assert.ok(title.textContent, "Row title has non-empty textContext");
Assert.equal(title.textContent, result.payload.title, "Row title is correct");
let url = row._elements.get("url");
Assert.ok(url, "Row has a URL");
Assert.ok(url.textContent, "Row URL has non-empty textContext");
Assert.equal(
url.textContent,
result.payload.displayUrl,
"Row URL is correct"
);
let bottom = row._elements.get("bottom");
Assert.ok(bottom, "Row has a bottom");
Assert.equal(
!!result.payload.isSponsored,
isSponsored,
"Sanity check: Row's expected isSponsored matches result's"
);
if (isSponsored) {
Assert.equal(
bottom.textContent,
"Sponsored",
"Sponsored row bottom has Sponsored textContext"
);
} else {
Assert.equal(
bottom.textContent,
"",
"Non-sponsored row bottom has empty textContext"
);
}
let button = row._buttons.get(
UrlbarPrefs.get("resultMenu") ? "menu" : "help"
);
Assert.equal(
!!result.payload.helpUrl,
hasHelpUrl,
"Sanity check: Row's expected hasHelpUrl matches result"
);
if (hasHelpUrl) {
Assert.ok(button, "Row with helpUrl has a help or menu button");
} else {
Assert.ok(
!button,
"Row without helpUrl does not have a help or menu button"
);
}
}
async function withProvider(result, callback) {
let provider = new UrlbarTestUtils.TestProvider({
results: [result],
priority: Infinity,
});
UrlbarProvidersManager.registerProvider(provider);
try {
await callback();
} finally {
UrlbarProvidersManager.unregisterProvider(provider);
}
}
function makeBestMatchResult(payloadExtra = {}) {
return Object.assign(
new UrlbarResult(
UrlbarUtils.RESULT_TYPE.URL,
UrlbarUtils.RESULT_SOURCE.SEARCH,
...UrlbarResult.payloadAndSimpleHighlights([], {
title: "Test best match",
url: "https://example.com/best-match",
...payloadExtra,
})
),
{ isBestMatch: true }
);
}
|
