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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/
*/
const { ClientID } = ChromeUtils.import("resource://gre/modules/ClientID.jsm");
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
ChromeUtils.import("resource://gre/modules/TelemetryController.jsm", this);
ChromeUtils.import("resource://gre/modules/TelemetryStorage.jsm", this);
ChromeUtils.import("resource://gre/modules/TelemetrySend.jsm", this);
ChromeUtils.import("resource://gre/modules/TelemetryUtils.jsm", this);
const { Preferences } = ChromeUtils.import(
"resource://gre/modules/Preferences.jsm"
);
const PING_FORMAT_VERSION = 4;
const DELETION_REQUEST_PING_TYPE = "deletion-request";
const TEST_PING_TYPE = "test-ping-type";
function sendPing(addEnvironment = false) {
let options = {
addClientId: true,
addEnvironment,
};
return TelemetryController.submitExternalPing(TEST_PING_TYPE, {}, options);
}
add_task(async function test_setup() {
// Addon manager needs a profile directory
do_get_profile();
// Make sure we don't generate unexpected pings due to pref changes.
await setEmptyPrefWatchlist();
Services.prefs.setBoolPref(TelemetryUtils.Preferences.FhrUploadEnabled, true);
await new Promise(resolve =>
Telemetry.asyncFetchTelemetryData(wrapWithExceptionHandler(resolve))
);
PingServer.start();
Preferences.set(
TelemetryUtils.Preferences.Server,
"http://localhost:" + PingServer.port
);
await TelemetryController.testSetup();
});
/**
* Testing the following scenario:
*
* 1. Telemetry upload gets disabled
* 2. Canary client ID is set
* 3. Instance is shut down
* 4. Telemetry upload flag is toggled
* 5. Instance is started again
* 6. Detect that upload is enabled and reset client ID
*
* This scenario e.g. happens when switching between channels
* with and without the deletion-request ping reset included.
*/
add_task(async function test_clientid_reset_after_reenabling() {
await sendPing();
let ping = await PingServer.promiseNextPing();
Assert.equal(ping.type, TEST_PING_TYPE, "The ping must be a test ping");
Assert.ok("clientId" in ping);
let firstClientId = ping.clientId;
Assert.notEqual(
TelemetryUtils.knownClientID,
firstClientId,
"Client ID should be valid and random"
);
// Disable FHR upload: this should trigger a deletion-request ping.
Preferences.set(TelemetryUtils.Preferences.FhrUploadEnabled, false);
ping = await PingServer.promiseNextPing();
Assert.equal(
ping.type,
DELETION_REQUEST_PING_TYPE,
"The ping must be a deletion-request ping"
);
Assert.equal(ping.clientId, firstClientId);
let clientId = await ClientID.getClientID();
Assert.equal(TelemetryUtils.knownClientID, clientId);
// Now shutdown the instance
await TelemetryController.testShutdown();
await TelemetryStorage.testClearPendingPings();
// Flip the pref again
Preferences.set(TelemetryUtils.Preferences.FhrUploadEnabled, true);
// Start the instance
await TelemetryController.testReset();
let newClientId = await ClientID.getClientID();
Assert.notEqual(
TelemetryUtils.knownClientID,
newClientId,
"Client ID should be valid and random"
);
Assert.notEqual(
firstClientId,
newClientId,
"Client ID should be newly generated"
);
});
/**
* Testing the following scenario:
* (Reverse of the first test)
*
* 1. Telemetry upload gets disabled, canary client ID is set
* 2. Telemetry upload is enabled
* 3. New client ID is generated.
* 3. Instance is shut down
* 4. Telemetry upload flag is toggled
* 5. Instance is started again
* 6. Detect that upload is disabled and sets canary client ID
*
* This scenario e.g. happens when switching between channels
* with and without the deletion-request ping reset included.
*/
add_task(async function test_clientid_canary_after_disabling() {
await sendPing();
let ping = await PingServer.promiseNextPing();
Assert.equal(ping.type, TEST_PING_TYPE, "The ping must be a test ping");
Assert.ok("clientId" in ping);
let firstClientId = ping.clientId;
Assert.notEqual(
TelemetryUtils.knownClientID,
firstClientId,
"Client ID should be valid and random"
);
// Disable FHR upload: this should trigger a deletion-request ping.
Preferences.set(TelemetryUtils.Preferences.FhrUploadEnabled, false);
ping = await PingServer.promiseNextPing();
Assert.equal(
ping.type,
DELETION_REQUEST_PING_TYPE,
"The ping must be a deletion-request ping"
);
Assert.equal(ping.clientId, firstClientId);
let clientId = await ClientID.getClientID();
Assert.equal(TelemetryUtils.knownClientID, clientId);
Preferences.set(TelemetryUtils.Preferences.FhrUploadEnabled, true);
await sendPing();
ping = await PingServer.promiseNextPing();
Assert.equal(ping.type, TEST_PING_TYPE, "The ping must be a test ping");
Assert.notEqual(
firstClientId,
ping.clientId,
"Client ID should be newly generated"
);
// Now shutdown the instance
await TelemetryController.testShutdown();
await TelemetryStorage.testClearPendingPings();
// Flip the pref again
Preferences.set(TelemetryUtils.Preferences.FhrUploadEnabled, false);
// Start the instance
await TelemetryController.testReset();
let newClientId = await ClientID.getClientID();
Assert.equal(
TelemetryUtils.knownClientID,
newClientId,
"Client ID should be a canary when upload disabled"
);
});
add_task(async function stopServer() {
await PingServer.stop();
});
|
