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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/
*/
"use strict";
const { PingCentre, PingCentreConstants } = ChromeUtils.import(
"resource:///modules/PingCentre.jsm"
);
const { TelemetryEnvironment } = ChromeUtils.importESModule(
"resource://gre/modules/TelemetryEnvironment.sys.mjs"
);
const { AppConstants } = ChromeUtils.importESModule(
"resource://gre/modules/AppConstants.sys.mjs"
);
const { UpdateUtils } = ChromeUtils.importESModule(
"resource://gre/modules/UpdateUtils.sys.mjs"
);
const { sinon } = ChromeUtils.importESModule(
"resource://testing-common/Sinon.sys.mjs"
);
const FAKE_PING = { event: "fake_event", value: "fake_value", locale: "en-US" };
const FAKE_ENDPOINT = "https://www.test.com";
let pingCentre;
let sandbox;
let fogInitd = false;
function _setUp() {
Services.prefs.setBoolPref(PingCentreConstants.TELEMETRY_PREF, true);
Services.prefs.setBoolPref(PingCentreConstants.FHR_UPLOAD_ENABLED_PREF, true);
Services.prefs.setBoolPref(PingCentreConstants.LOGGING_PREF, true);
sandbox.restore();
if (fogInitd) {
Services.fog.testResetFOG();
}
}
add_setup(function setup() {
sandbox = sinon.createSandbox();
_setUp();
pingCentre = new PingCentre({ topic: "test_topic" });
registerCleanupFunction(() => {
sandbox.restore();
Services.prefs.clearUserPref(PingCentreConstants.TELEMETRY_PREF);
Services.prefs.clearUserPref(PingCentreConstants.FHR_UPLOAD_ENABLED_PREF);
Services.prefs.clearUserPref(PingCentreConstants.LOGGING_PREF);
});
// On Android, FOG is set up through head.js
if (AppConstants.platform != "android") {
do_get_profile();
Services.fog.initializeFOG();
fogInitd = true;
}
});
add_task(function test_enabled() {
_setUp();
Assert.ok(pingCentre.enabled, "Telemetry should be on");
});
add_task(function test_disabled_by_pingCentre() {
_setUp();
Services.prefs.setBoolPref(PingCentreConstants.TELEMETRY_PREF, false);
Assert.ok(!pingCentre.enabled, "Telemetry should be off");
});
add_task(function test_disabled_by_FirefoxHealthReport() {
_setUp();
Services.prefs.setBoolPref(
PingCentreConstants.FHR_UPLOAD_ENABLED_PREF,
false
);
Assert.ok(!pingCentre.enabled, "Telemetry should be off");
});
add_task(function test_logging() {
_setUp();
Assert.ok(pingCentre.logging, "Logging should be on");
Services.prefs.setBoolPref(PingCentreConstants.LOGGING_PREF, false);
Assert.ok(!pingCentre.logging, "Logging should be off");
});
add_task(function test_createExperimentsPayload() {
_setUp();
const activeExperiments = {
exp1: { branch: "foo", enrollmentID: "SOME_RANDON_ID" },
exp2: { branch: "bar", type: "PrefStudy" },
exp3: {},
};
sandbox
.stub(TelemetryEnvironment, "getActiveExperiments")
.returns(activeExperiments);
const expected = {
exp1: { branch: "foo" },
exp2: { branch: "bar" },
};
const experiments = pingCentre._createExperimentsPayload();
Assert.deepEqual(
experiments,
expected,
"Should create experiments with all the required context"
);
});
add_task(function test_createExperimentsPayload_without_active_experiments() {
_setUp();
sandbox.stub(TelemetryEnvironment, "getActiveExperiments").returns({});
const experiments = pingCentre._createExperimentsPayload({});
Assert.deepEqual(experiments, {}, "Should send an empty object");
});
add_task(function test_createStructuredIngestionPing() {
_setUp();
sandbox
.stub(TelemetryEnvironment, "getActiveExperiments")
.returns({ exp1: { branch: "foo" } });
const ping = pingCentre._createStructuredIngestionPing(FAKE_PING);
const expected = {
experiments: { exp1: { branch: "foo" } },
locale: "en-US",
version: AppConstants.MOZ_APP_VERSION,
release_channel: UpdateUtils.getUpdateChannel(false),
...FAKE_PING,
};
Assert.deepEqual(ping, expected, "Should create a valid ping");
});
add_task(function test_sendStructuredIngestionPing_disabled() {
_setUp();
sandbox.stub(PingCentre, "_sendStandalonePing").resolves();
Services.prefs.setBoolPref(PingCentreConstants.TELEMETRY_PREF, false);
pingCentre.sendStructuredIngestionPing(FAKE_PING, FAKE_ENDPOINT);
Assert.ok(PingCentre._sendStandalonePing.notCalled, "Should not be sent");
});
add_task(async function test_sendStructuredIngestionPing_success() {
_setUp();
sandbox.stub(PingCentre, "_sendStandalonePing").resolves();
await pingCentre.sendStructuredIngestionPing(
FAKE_PING,
FAKE_ENDPOINT,
"messaging-system"
);
Assert.equal(PingCentre._sendStandalonePing.callCount, 1, "Should be sent");
Assert.equal(
1,
Glean.pingCentre.sendSuccessesByNamespace.messaging_system.testGetValue()
);
// Test an unknown namespace
await pingCentre.sendStructuredIngestionPing(
FAKE_PING,
FAKE_ENDPOINT,
"different-system"
);
Assert.equal(PingCentre._sendStandalonePing.callCount, 2, "Should be sent");
Assert.equal(
1,
Glean.pingCentre.sendSuccessesByNamespace.__other__.testGetValue()
);
});
add_task(async function test_sendStructuredIngestionPing_failure() {
_setUp();
sandbox.stub(PingCentre, "_sendStandalonePing").rejects();
Assert.equal(undefined, Glean.pingCentre.sendFailures.testGetValue());
await pingCentre.sendStructuredIngestionPing(
FAKE_PING,
FAKE_ENDPOINT,
"activity-stream"
);
Assert.equal(1, Glean.pingCentre.sendFailures.testGetValue());
Assert.equal(
1,
Glean.pingCentre.sendFailuresByNamespace.activity_stream.testGetValue()
);
});
|
