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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/
*/
"use strict";
ChromeUtils.defineESModuleGetters(this, {
TelemetryPrioPing: "resource://gre/modules/PrioPing.sys.mjs",
});
function checkPingStructure(type, payload, options) {
Assert.equal(
type,
TelemetryPrioPing.PRIO_PING_TYPE,
"Should be a prio ping."
);
// Check the payload for required fields.
Assert.ok("version" in payload, "Payload must have version.");
Assert.ok("reason" in payload, "Payload must have reason.");
Assert.ok(
Object.values(TelemetryPrioPing.Reason).some(
reason => payload.reason === reason
),
"Should be a known reason."
);
Assert.ok(
Array.isArray(payload.prioData),
"Payload prioData must be present and an array."
);
payload.prioData.forEach(prioData => {
Assert.ok("encoding" in prioData, "All prioData must have encodings.");
Assert.ok("prio" in prioData, "All prioData must have prio blocks.");
});
// Ensure we forbid client id and environment
Assert.equal(options.addClientId, false, "Must forbid client Id.");
Assert.equal(options.addEnvironment, false, "Must forbid Environment.");
}
function fakePolicy(set, clear, send, snapshot) {
let { Policy } = ChromeUtils.importESModule(
"resource://gre/modules/PrioPing.sys.mjs"
);
Policy.setTimeout = set;
Policy.clearTimeout = clear;
Policy.sendPing = send;
Policy.getEncodedOriginSnapshot = snapshot;
}
function pass() {
/* intentionally empty */
}
function fail() {
Assert.ok(false, "Not allowed");
}
function fakeSnapshot() {
return [
{
encoding: "telemetry.test-1-1",
prio: {},
},
{
encoding: "telemetry.test-1-1",
prio: {},
},
];
}
add_task(async function setup() {
// Trigger a proper telemetry init.
do_get_profile(true);
// Make sure we don't generate unexpected pings due to pref changes.
await setEmptyPrefWatchlist();
await TelemetryController.testSetup();
TelemetryPrioPing.testReset();
});
// Similarly to test_EventPing tests in this file often follow the form:
// 1: Fake out timeout, ping submission, and snapshotting
// 2: Trigger a "prio" ping to happen
// 3: Inside the fake ping submission, ensure the ping is correctly formed.
// In sinon this would be replaced with spies and .wasCalledWith().
add_task(async function test_limit_reached() {
// Ensure that on being notified of the limit we immediately trigger a ping
// with reason "max"
fakePolicy(
pass,
pass,
(type, payload, options) => {
checkPingStructure(type, payload, options);
Assert.equal(
payload.reason,
TelemetryPrioPing.Reason.MAX,
"Sent using max reason."
);
},
fakeSnapshot
);
Services.obs.notifyObservers(null, "origin-telemetry-storage-limit-reached");
});
add_task(async function test_periodic() {
fakePolicy(
pass,
pass,
(type, payload, options) => {
checkPingStructure(type, payload, options);
Assert.equal(
payload.reason,
TelemetryPrioPing.Reason.PERIODIC,
"Sent with periodic reason."
);
},
fakeSnapshot
);
// This is normally triggered by the scheduler once a day
TelemetryPrioPing.periodicPing();
});
add_task(async function test_shutdown() {
fakePolicy(
fail,
pass,
(type, payload, options) => {
checkPingStructure(type, payload, options);
Assert.equal(
payload.reason,
TelemetryPrioPing.Reason.SHUTDOWN,
"Sent with shutdown reason."
);
},
fakeSnapshot
);
await TelemetryPrioPing.shutdown();
});
|
