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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
// Tests that the console records the reverse search telemetry event with expected data
// on open, navigate forward, navigate back and evaluate expression.
"use strict";
const { TelemetryTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/TelemetryTestUtils.sys.mjs"
);
const TEST_URI = `data:text/html,<!DOCTYPE html><meta charset=utf8>Test reverse_search telemetry event`;
const ALL_CHANNELS = Ci.nsITelemetry.DATASET_ALL_CHANNELS;
const isMacOS = AppConstants.platform === "macosx";
add_task(async function () {
// Let's reset the counts.
Services.telemetry.clearEvents();
// Ensure no events have been logged
TelemetryTestUtils.assertNumberOfEvents(0);
const hud = await openNewTabAndConsole(TEST_URI);
info("Evaluate single line expressions");
await keyboardExecuteAndWaitForResultMessage(hud, `"single line 1"`, "");
await keyboardExecuteAndWaitForResultMessage(hud, `"single line 2"`, "");
await keyboardExecuteAndWaitForResultMessage(hud, `"single line 3"`, "");
info("Open editor mode");
await toggleLayout(hud);
info("Open reverse search from editor mode");
hud.ui.outputNode
.querySelector(".webconsole-editor-toolbar-reverseSearchButton")
.click();
info("Close reverse search");
EventUtils.synthesizeKey("KEY_Escape");
info("Open reverse search using keyboard shortcut");
await openReverseSearch(hud);
info("Send keys to reverse search");
EventUtils.sendString("sin");
info("Reverse search navigate next - keyboard");
navigateReverseSearch("keyboard", "next", hud);
info("Reverse search navigate previous - keyboard");
navigateReverseSearch("keyboard", "previous", hud);
info("Reverse search navigate next - mouse");
navigateReverseSearch("mouse", "next", hud);
info("Reverse search navigate previous - mouse");
navigateReverseSearch("mouse", "previous", hud);
info("Reverse search evaluate expression");
const onMessage = waitForMessageByType(hud, "single line 3", ".result");
EventUtils.synthesizeKey("KEY_Enter");
await onMessage;
info("Check reverse search telemetry");
checkEventTelemetry([
getTelemetryEventData("editor-toolbar-icon", { functionality: "open" }),
getTelemetryEventData("keyboard", { functionality: "open" }),
getTelemetryEventData("keyboard", { functionality: "navigate next" }),
getTelemetryEventData("keyboard", { functionality: "navigate previous" }),
getTelemetryEventData("click", { functionality: "navigate next" }),
getTelemetryEventData("click", { functionality: "navigate previous" }),
getTelemetryEventData(null, { functionality: "evaluate expression" }),
]);
info("Revert to inline layout");
await toggleLayout(hud);
});
function triggerPreviousResultShortcut() {
if (isMacOS) {
EventUtils.synthesizeKey("r", { ctrlKey: true });
} else {
EventUtils.synthesizeKey("VK_F9");
}
}
function triggerNextResultShortcut() {
if (isMacOS) {
EventUtils.synthesizeKey("s", { ctrlKey: true });
} else {
EventUtils.synthesizeKey("VK_F9", { shiftKey: true });
}
}
function clickPreviousButton(hud) {
const reverseSearchElement = getReverseSearchElement(hud);
if (!reverseSearchElement) {
return;
}
const button = reverseSearchElement.querySelector(
".search-result-button-prev"
);
if (!button) {
return;
}
button.click();
}
function clickNextButton(hud) {
const reverseSearchElement = getReverseSearchElement(hud);
if (!reverseSearchElement) {
return;
}
const button = reverseSearchElement.querySelector(
".search-result-button-next"
);
if (!button) {
return;
}
button.click();
}
function navigateReverseSearch(access, direction, hud) {
if (access == "keyboard") {
if (direction === "previous") {
triggerPreviousResultShortcut();
} else {
triggerNextResultShortcut();
}
} else if (access === "mouse") {
if (direction === "previous") {
clickPreviousButton(hud);
} else {
clickNextButton(hud);
}
}
}
function getTelemetryEventData(value, extra) {
return {
timestamp: null,
category: "devtools.main",
method: "reverse_search",
object: "webconsole",
value,
extra,
};
}
function checkEventTelemetry(expectedData) {
const snapshot = Services.telemetry.snapshotEvents(ALL_CHANNELS, true);
const events = snapshot.parent.filter(event => event[2] === "reverse_search");
for (const [i, expected] of expectedData.entries()) {
const [timestamp, category, method, object, value, extra] = events[i];
Assert.greater(timestamp, 0, "timestamp is greater than 0");
is(category, expected.category, "'category' is correct");
is(method, expected.method, "'method' is correct");
is(object, expected.object, "'object' is correct");
is(value, expected.value, "'value' is correct");
is(
extra.functionality,
expected.extra.functionality,
"'functionality' is correct"
);
Assert.greater(Number(extra.session_id), 0, "'session_id' is correct");
}
}
|
