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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
/**
* Check the existence of a shopping tab and navigation to a shopping page.
* Most existing tests don't include shopping tabs, so this explicitly loads a
* page with a shopping tab and clicks on it.
*/
"use strict";
const { SearchSERPTelemetry, SearchSERPTelemetryUtils } =
ChromeUtils.importESModule("resource:///modules/SearchSERPTelemetry.sys.mjs");
// The setup for each test is the same, the only differences are the various
// permutations of the search tests.
const BASE_TEST_PROVIDER = {
telemetryId: "example",
searchPageRegexp:
/^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/searchTelemetryAd/,
queryParamName: "s",
codeParamName: "abc",
taggedCodes: ["ff"],
extraAdServersRegexps: [/^https:\/\/example\.org\/ad/],
components: [
{
type: SearchSERPTelemetryUtils.COMPONENTS.AD_LINK,
default: true,
},
],
};
const TEST_PROVIDER_INFO_1 = [
{
...BASE_TEST_PROVIDER,
shoppingTab: {
selector: "nav a",
regexp: "&page=shopping&",
inspectRegexpInSERP: true,
},
},
];
const TEST_PROVIDER_INFO_2 = [
{
...BASE_TEST_PROVIDER,
shoppingTab: {
selector: "nav a#shopping",
regexp: "&page=shopping&",
inspectRegexpInSERP: false,
},
},
];
function getSERPUrl(page) {
let url =
getRootDirectory(gTestPath).replace(
"chrome://mochitests/content",
"https://example.org"
) + page;
return `${url}?s=test&abc=ff`;
}
// sharedData messages are only passed to the child on idle. Therefore
// we wait for a few idles to try and ensure the messages have been able
// to be passed across and handled.
async function waitForIdle() {
for (let i = 0; i < 10; i++) {
await new Promise(resolve => Services.tm.idleDispatchToMainThread(resolve));
}
}
add_setup(async function () {
SearchSERPTelemetry.overrideSearchTelemetryForTests(TEST_PROVIDER_INFO_1);
await waitForIdle();
// Enable local telemetry recording for the duration of the tests.
let oldCanRecord = Services.telemetry.canRecordExtended;
Services.telemetry.canRecordExtended = true;
await SpecialPowers.pushPrefEnv({
set: [
["browser.search.log", true],
["browser.search.serpEventTelemetry.enabled", true],
],
});
registerCleanupFunction(async () => {
SearchSERPTelemetry.overrideSearchTelemetryForTests();
Services.telemetry.canRecordExtended = oldCanRecord;
resetTelemetry();
});
});
async function loadSerpAndClickShoppingTab(page) {
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
getSERPUrl(page)
);
assertImpressionEvents([
{
impression: {
provider: "example",
tagged: "true",
partner_code: "ff",
source: "unknown",
is_shopping_page: "false",
shopping_tab_displayed: "true",
},
},
]);
await waitForPageWithAdImpressions();
let pageLoadPromise = BrowserTestUtils.waitForLocationChange(gBrowser);
BrowserTestUtils.synthesizeMouseAtCenter("#shopping", {}, tab.linkedBrowser);
await pageLoadPromise;
assertImpressionEvents([
{
impression: {
provider: "example",
tagged: "true",
partner_code: "ff",
source: "unknown",
is_shopping_page: "false",
shopping_tab_displayed: "true",
},
engagements: [
{
action: SearchSERPTelemetryUtils.ACTIONS.CLICKED,
target: SearchSERPTelemetryUtils.COMPONENTS.SHOPPING_TAB,
},
],
},
]);
BrowserTestUtils.removeTab(tab);
}
add_task(async function test_inspect_shopping_tab_regexp_on_serp() {
resetTelemetry();
await loadSerpAndClickShoppingTab("searchTelemetryAd_shopping.html");
});
add_task(async function test_no_inspect_shopping_tab_regexp_on_serp() {
resetTelemetry();
SearchSERPTelemetry.overrideSearchTelemetryForTests(TEST_PROVIDER_INFO_2);
await waitForIdle();
await loadSerpAndClickShoppingTab("searchTelemetryAd_shopping.html");
});
|
