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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const { ClientID } = ChromeUtils.importESModule(
"resource://gre/modules/ClientID.sys.mjs"
);
const PREF_CACHED_CLIENTID = "toolkit.telemetry.cachedClientID";
var drsPath;
const uuidRegex =
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
function run_test() {
do_get_profile();
drsPath = PathUtils.join(PathUtils.profileDir, "datareporting", "state.json");
Services.prefs.setBoolPref(
"toolkit.telemetry.testing.overrideProductsCheck",
true
);
run_next_test();
}
add_task(function test_setup() {
// FOG needs a profile and to be init.
do_get_profile();
Services.fog.initializeFOG();
});
add_task(async function test_client_id() {
const invalidIDs = [
[-1, "setIntPref"],
[0.5, "setIntPref"],
["INVALID-UUID", "setStringPref"],
[true, "setBoolPref"],
["", "setStringPref"],
["3d1e1560-682a-4043-8cf2-aaaaaaaaaaaZ", "setStringPref"],
];
// If there is no DRS file, and no cached id, we should get a new client ID.
await ClientID._reset();
Services.prefs.clearUserPref(PREF_CACHED_CLIENTID);
await IOUtils.remove(drsPath, { ignoreAbsent: true });
let clientID = await ClientID.getClientID();
Assert.equal(typeof clientID, "string");
Assert.ok(uuidRegex.test(clientID));
if (AppConstants.platform != "android") {
Assert.equal(clientID, Glean.legacyTelemetry.clientId.testGetValue());
}
// We should be guarded against invalid DRS json.
await ClientID._reset();
Services.prefs.clearUserPref(PREF_CACHED_CLIENTID);
await IOUtils.writeUTF8(drsPath, "abcd", {
tmpPath: drsPath + ".tmp",
});
clientID = await ClientID.getClientID();
Assert.equal(typeof clientID, "string");
Assert.ok(uuidRegex.test(clientID));
if (AppConstants.platform != "android") {
Assert.equal(clientID, Glean.legacyTelemetry.clientId.testGetValue());
}
// If the DRS data is broken, we should end up with the cached ID.
let oldClientID = clientID;
for (let [invalidID] of invalidIDs) {
await ClientID._reset();
await IOUtils.writeJSON(drsPath, { clientID: invalidID });
clientID = await ClientID.getClientID();
Assert.equal(clientID, oldClientID);
if (AppConstants.platform != "android") {
Assert.equal(clientID, Glean.legacyTelemetry.clientId.testGetValue());
}
}
// Test that valid DRS actually works.
const validClientID = "5afebd62-a33c-416c-b519-5c60fb988e8e";
await ClientID._reset();
await IOUtils.writeJSON(drsPath, { clientID: validClientID });
clientID = await ClientID.getClientID();
Assert.equal(clientID, validClientID);
if (AppConstants.platform != "android") {
Assert.equal(clientID, Glean.legacyTelemetry.clientId.testGetValue());
}
// Test that reloading a valid DRS works.
await ClientID._reset();
Services.prefs.clearUserPref(PREF_CACHED_CLIENTID);
clientID = await ClientID.getClientID();
Assert.equal(clientID, validClientID);
if (AppConstants.platform != "android") {
Assert.equal(clientID, Glean.legacyTelemetry.clientId.testGetValue());
}
// Assure that cached IDs are being checked for validity.
for (let [invalidID, prefFunc] of invalidIDs) {
await ClientID._reset();
Services.prefs[prefFunc](PREF_CACHED_CLIENTID, invalidID);
let cachedID = ClientID.getCachedClientID();
Assert.strictEqual(
cachedID,
null,
"ClientID should ignore invalid cached IDs"
);
Assert.ok(
!Services.prefs.prefHasUserValue(PREF_CACHED_CLIENTID),
"ClientID should reset invalid cached IDs"
);
Assert.ok(
Services.prefs.getPrefType(PREF_CACHED_CLIENTID) ==
Ci.nsIPrefBranch.PREF_INVALID,
"ClientID should reset invalid cached IDs"
);
}
});
add_task(async function test_setCanaryClientID() {
const KNOWN_UUID = "c0ffeec0-ffee-c0ff-eec0-ffeec0ffeec0";
await ClientID._reset();
// We should be able to set a valid UUID
await ClientID.setCanaryClientID();
let clientID = await ClientID.getClientID();
Assert.equal(KNOWN_UUID, clientID);
if (AppConstants.platform != "android") {
Assert.equal(clientID, Glean.legacyTelemetry.clientId.testGetValue());
}
});
add_task(async function test_removeParallelGet() {
// We should get a valid UUID after reset
await ClientID.removeClientID();
let firstClientID = await ClientID.getClientID();
if (AppConstants.platform != "android") {
Assert.equal(firstClientID, Glean.legacyTelemetry.clientId.testGetValue());
}
// We should get the same ID twice when requesting it in parallel to a reset.
let promiseRemoveClientID = ClientID.removeClientID();
let p = ClientID.getClientID();
let newClientID = await ClientID.getClientID();
await promiseRemoveClientID;
let otherClientID = await p;
Assert.notEqual(
firstClientID,
newClientID,
"After reset client ID should be different."
);
Assert.equal(
newClientID,
otherClientID,
"Getting the client ID in parallel to a reset should give the same id."
);
if (AppConstants.platform != "android") {
Assert.equal(newClientID, Glean.legacyTelemetry.clientId.testGetValue());
}
});
|
