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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
/*
* This test ensures we are correctly extracting domains from a SERP.
*/
ChromeUtils.defineESModuleGetters(this, {
SearchUtils: "resource://gre/modules/SearchUtils.sys.mjs",
});
const TESTS = [
{
title: "Extract domain from href (absolute URL) - one link.",
extractorInfos: [
{
selectors:
'#test1 [data-layout="organic"] a[data-testid="result-title-a"]',
method: "href",
},
],
expectedDomains: ["foobar.com"],
},
{
title: "Extract domain from href (absolute URL) - multiple links.",
extractorInfos: [
{
selectors:
'#test2 [data-layout="organic"] a[data-testid="result-title-a"]',
method: "href",
},
],
expectedDomains: ["foo.com", "bar.com", "baz.com", "qux.com"],
},
{
title: "Extract domain from href (relative URL).",
extractorInfos: [
{
selectors:
'#test3 [data-layout="organic"] a[data-testid="result-title-a"]',
method: "href",
},
],
expectedDomains: ["example.org"],
},
{
title: "Extract domain from data attribute - one link.",
extractorInfos: [
{
selectors: "#test4 [data-dtld]",
method: "data-attribute",
options: {
dataAttributeKey: "dtld",
},
},
],
expectedDomains: ["www.abc.com"],
},
{
title: "Extract domain from data attribute - multiple links.",
extractorInfos: [
{
selectors: "#test5 [data-dtld]",
method: "data-attribute",
options: {
dataAttributeKey: "dtld",
},
},
],
expectedDomains: [
"www.foo.com",
"www.bar.com",
"www.baz.com",
"www.qux.com",
],
},
{
title: "Extract domain from an href's query param value.",
extractorInfos: [
{
selectors:
'#test6 .js-carousel-item-title, #test6 [data-layout="ad"] [data-testid="result-title-a"]',
method: "href",
options: {
queryParamKey: "ad_domain",
},
},
],
expectedDomains: ["def.com"],
},
{
title:
"Extract domain from an href's query param value containing an href.",
extractorInfos: [
{
selectors: "#test7 a",
method: "href",
options: {
queryParamKey: "ad_domain",
queryParamValueIsHref: true,
},
},
],
expectedDomains: ["def.com"],
},
{
title:
"The param value contains an invalid href while queryParamValueIsHref enabled.",
extractorInfos: [
{
selectors: "#test8 a",
method: "href",
options: {
queryParamKey: "ad_domain",
queryParamValueIsHref: true,
},
},
],
expectedDomains: [],
},
{
title: "Param value is missing from the href.",
extractorInfos: [
{
selectors: "#test9 a",
method: "href",
options: {
queryParamKey: "ad_domain",
queryParamValueIsHref: true,
},
},
],
expectedDomains: [],
},
{
title: "Extraction preserves order of domains within the page.",
extractorInfos: [
{
selectors:
'#test10 [data-layout="organic"] a[data-testid="result-title-a"]',
method: "href",
},
{
selectors: "#test10 [data-dtld]",
method: "data-attribute",
options: {
dataAttributeKey: "dtld",
},
},
{
selectors:
'#test10 .js-carousel-item-title, #test7 [data-layout="ad"] [data-testid="result-title-a"]',
method: "href",
options: {
queryParamKey: "ad_domain",
},
},
],
expectedDomains: ["foobar.com", "www.abc.com", "def.com"],
},
{
title: "No elements match the selectors.",
extractorInfos: [
{
selectors:
'#test11 [data-layout="organic"] a[data-testid="result-title-a"]',
method: "href",
},
],
expectedDomains: [],
},
{
title: "Data attribute is present, but value is missing.",
extractorInfos: [
{
selectors: "#test12 [data-dtld]",
method: "data-attribute",
options: {
dataAttributeKey: "dtld",
},
},
],
expectedDomains: [],
},
{
title: "Query param is present, but value is missing.",
extractorInfos: [
{
selectors: '#test13 [data-layout="ad"] [data-testid="result-title-a"]',
method: "href",
options: {
queryParamKey: "ad_domain",
},
},
],
expectedDomains: [],
},
{
title: "Non-standard URL scheme.",
extractorInfos: [
{
selectors:
'#test14 [data-layout="organic"] a[data-testid="result-title-a"]',
method: "href",
},
],
expectedDomains: [],
},
];
add_setup(async function () {
await SpecialPowers.pushPrefEnv({
set: [
["browser.search.serpEventTelemetry.enabled", true],
["browser.search.serpEventTelemetryCategorization.enabled", true],
],
});
await SearchSERPTelemetry.init();
registerCleanupFunction(async () => {
resetTelemetry();
});
});
add_task(async function test_domain_extraction_heuristics() {
resetTelemetry();
let url = getSERPUrl("searchTelemetryDomainExtraction.html");
info(
"Load a sample SERP where domains need to be extracted in different ways."
);
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, url);
for (let currentTest of TESTS) {
if (currentTest.title) {
info(currentTest.title);
}
let expectedDomains = new Set(currentTest.expectedDomains);
let actualDomains = await SpecialPowers.spawn(
gBrowser.selectedBrowser,
[currentTest.extractorInfos],
extractorInfos => {
const { domainExtractor } = ChromeUtils.importESModule(
"resource:///actors/SearchSERPTelemetryChild.sys.mjs"
);
return domainExtractor.extractDomainsFromDocument(
content.document,
extractorInfos
);
}
);
Assert.deepEqual(
Array.from(actualDomains),
Array.from(expectedDomains),
"Domains should have been extracted correctly."
);
}
BrowserTestUtils.removeTab(tab);
});
|
