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
264
265
266
267
268
269
270
271
272
273
274
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
/* import-globals-from helper-telemetry.js */
Services.scriptloader.loadSubScript(
CHROME_URL_ROOT + "helper-telemetry.js",
this
);
const USB_RUNTIME = {
id: "runtime-id-1",
deviceName: "Device A",
name: "Runtime 1",
shortName: "R1",
};
/**
* Check that telemetry events for connection attempts are correctly recorded in various
* scenarios:
* - successful connection
* - successful connection after showing the timeout warning
* - failed connection
* - connection timeout
*/
add_task(async function testSuccessfulConnectionAttempt() {
const { doc, mocks, runtimeId, sessionId, tab } =
await setupConnectionAttemptTest();
await connectToRuntime(USB_RUNTIME.deviceName, doc);
const connectionEvents = checkTelemetryEvents(
[
{ method: "runtime_connected", extras: { runtime_id: runtimeId } },
{
method: "connection_attempt",
extras: getEventExtras("start", runtimeId),
},
{
method: "connection_attempt",
extras: getEventExtras("success", runtimeId),
},
],
sessionId
).filter(({ method }) => method === "connection_attempt");
checkConnectionId(connectionEvents);
await removeUsbRuntime(USB_RUNTIME, mocks, doc);
await removeTab(tab);
});
add_task(async function testFailedConnectionAttempt() {
const { doc, mocks, runtimeId, sessionId, tab } =
await setupConnectionAttemptTest();
mocks.runtimeClientFactoryMock.createClientForRuntime = async runtime => {
throw new Error("failed");
};
info(
"Try to connect to the runtime and wait for the connection error message"
);
const usbRuntimeSidebarItem = findSidebarItemByText(
USB_RUNTIME.deviceName,
doc
);
const connectButton =
usbRuntimeSidebarItem.querySelector(".qa-connect-button");
connectButton.click();
await waitUntil(() =>
usbRuntimeSidebarItem.querySelector(".qa-connection-error")
);
const connectionEvents = checkTelemetryEvents(
[
{
method: "connection_attempt",
extras: getEventExtras("start", runtimeId),
},
{
method: "connection_attempt",
extras: getEventExtras("failed", runtimeId),
},
],
sessionId
).filter(({ method }) => method === "connection_attempt");
checkConnectionId(connectionEvents);
await removeUsbRuntime(USB_RUNTIME, mocks, doc);
await removeTab(tab);
});
add_task(async function testPendingConnectionAttempt() {
info("Set timeout preferences to avoid cancelling the connection");
await pushPref(
"devtools.aboutdebugging.test-connection-timing-out-delay",
100
);
await pushPref(
"devtools.aboutdebugging.test-connection-cancel-delay",
100000
);
const { doc, mocks, runtimeId, sessionId, tab } =
await setupConnectionAttemptTest();
info("Simulate a pending connection");
let resumeConnection;
const resumeConnectionPromise = new Promise(r => {
resumeConnection = r;
});
mocks.runtimeClientFactoryMock.createClientForRuntime = async runtime => {
await resumeConnectionPromise;
return mocks._clients[runtime.type][runtime.id];
};
info("Click on the connect button and wait for the warning message");
const usbRuntimeSidebarItem = findSidebarItemByText(
USB_RUNTIME.deviceName,
doc
);
const connectButton =
usbRuntimeSidebarItem.querySelector(".qa-connect-button");
connectButton.click();
await waitUntil(() => doc.querySelector(".qa-connection-not-responding"));
info("Resume the connection and wait for the connection to succeed");
resumeConnection();
await waitUntil(
() => !usbRuntimeSidebarItem.querySelector(".qa-connect-button")
);
const connectionEvents = checkTelemetryEvents(
[
{ method: "runtime_connected", extras: { runtime_id: runtimeId } },
{
method: "connection_attempt",
extras: getEventExtras("start", runtimeId),
},
{
method: "connection_attempt",
extras: getEventExtras("not responding", runtimeId),
},
{
method: "connection_attempt",
extras: getEventExtras("success", runtimeId),
},
],
sessionId
).filter(({ method }) => method === "connection_attempt");
checkConnectionId(connectionEvents);
await removeUsbRuntime(USB_RUNTIME, mocks, doc);
await removeTab(tab);
});
add_task(async function testCancelledConnectionAttempt() {
info("Set timeout preferences to quickly cancel the connection");
await pushPref(
"devtools.aboutdebugging.test-connection-timing-out-delay",
100
);
await pushPref("devtools.aboutdebugging.test-connection-cancel-delay", 1000);
const { doc, mocks, runtimeId, sessionId, tab } =
await setupConnectionAttemptTest();
info("Simulate a connection timeout");
mocks.runtimeClientFactoryMock.createClientForRuntime = async runtime => {
await new Promise(r => {});
};
info("Click on the connect button and wait for the error message");
const usbRuntimeSidebarItem = findSidebarItemByText(
USB_RUNTIME.deviceName,
doc
);
const connectButton =
usbRuntimeSidebarItem.querySelector(".qa-connect-button");
connectButton.click();
await waitUntil(() =>
usbRuntimeSidebarItem.querySelector(".qa-connection-timeout")
);
const connectionEvents = checkTelemetryEvents(
[
{
method: "connection_attempt",
extras: getEventExtras("start", runtimeId),
},
{
method: "connection_attempt",
extras: getEventExtras("not responding", runtimeId),
},
{
method: "connection_attempt",
extras: getEventExtras("cancelled", runtimeId),
},
],
sessionId
).filter(({ method }) => method === "connection_attempt");
checkConnectionId(connectionEvents);
await removeUsbRuntime(USB_RUNTIME, mocks, doc);
await removeTab(tab);
});
function checkConnectionId(connectionEvents) {
const connectionId = connectionEvents[0].extras.connection_id;
ok(
!!connectionId,
"Found a valid connection id in the first connection_attempt event"
);
for (const evt of connectionEvents) {
is(
evt.extras.connection_id,
connectionId,
"All connection_attempt events share the same connection id"
);
}
}
// Small helper to create the expected event extras object for connection_attempt events
function getEventExtras(status, runtimeId) {
return {
connection_type: "usb",
runtime_id: runtimeId,
status,
};
}
// Open about:debugging, setup telemetry, mocks and create a mocked USB runtime.
async function setupConnectionAttemptTest() {
const mocks = new Mocks();
setupTelemetryTest();
const { tab, document } = await openAboutDebugging();
const sessionId = getOpenEventSessionId();
ok(!isNaN(sessionId), "Open event has a valid session id");
mocks.createUSBRuntime(USB_RUNTIME.id, {
deviceName: USB_RUNTIME.deviceName,
name: USB_RUNTIME.name,
shortName: USB_RUNTIME.shortName,
});
mocks.emitUSBUpdate();
info("Wait for the runtime to appear in the sidebar");
await waitUntil(() => findSidebarItemByText(USB_RUNTIME.shortName, document));
const evts = checkTelemetryEvents(
[
{ method: "device_added", extras: {} },
{ method: "runtime_added", extras: {} },
],
sessionId
);
const runtimeId = evts.filter(e => e.method === "runtime_added")[0].extras
.runtime_id;
return { doc: document, mocks, runtimeId, sessionId, tab };
}
async function removeUsbRuntime(runtime, mocks, doc) {
mocks.removeRuntime(runtime.id);
mocks.emitUSBUpdate();
await waitUntil(
() =>
!findSidebarItemByText(runtime.name, doc) &&
!findSidebarItemByText(runtime.shortName, doc)
);
}
|
