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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/*
* This module sends Origin Telemetry periodically:
* https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/prio-ping.html
*/
"use strict";
var EXPORTED_SYMBOLS = ["TelemetryPrioPing"];
ChromeUtils.import("resource://gre/modules/XPCOMUtils.jsm", this);
XPCOMUtils.defineLazyModuleGetters(this, {
TelemetryController: "resource://gre/modules/TelemetryController.jsm",
Log: "resource://gre/modules/Log.jsm",
});
XPCOMUtils.defineLazyServiceGetters(this, {
Telemetry: ["@mozilla.org/base/telemetry;1", "nsITelemetry"],
});
const { TelemetryUtils } = ChromeUtils.import(
"resource://gre/modules/TelemetryUtils.jsm"
);
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
const Utils = TelemetryUtils;
const LOGGER_NAME = "Toolkit.Telemetry";
const LOGGER_PREFIX = "TelemetryPrioPing";
// Triggered from native Origin Telemetry storage.
const PRIO_LIMIT_REACHED_TOPIC = "origin-telemetry-storage-limit-reached";
const PRIO_PING_VERSION = "1";
var Policy = {
sendPing: (type, payload, options) =>
TelemetryController.submitExternalPing(type, payload, options),
getEncodedOriginSnapshot: async aClear =>
Telemetry.getEncodedOriginSnapshot(aClear),
};
var TelemetryPrioPing = {
Reason: Object.freeze({
PERIODIC: "periodic", // Sent the ping containing Origin Telemetry from the past periodic interval (default 24h).
MAX: "max", // Sent the ping containing at least the maximum number (default 10) of prioData elements, earlier than the periodic interval.
SHUTDOWN: "shutdown", // Recorded data was sent on shutdown.
}),
PRIO_PING_TYPE: "prio",
_logger: null,
_testing: false,
_timeoutId: null,
startup() {
if (!this._testing && !Telemetry.canRecordPrereleaseData) {
this._log.trace("Extended collection disabled. Prio ping disabled.");
return;
}
if (
!this._testing &&
!Services.prefs.getBoolPref(Utils.Preferences.PrioPingEnabled, true)
) {
this._log.trace("Prio ping disabled by pref.");
return;
}
this._log.trace("Starting up.");
Services.obs.addObserver(this, PRIO_LIMIT_REACHED_TOPIC);
},
async shutdown() {
this._log.trace("Shutting down.");
// removeObserver may throw, which could interrupt shutdown.
try {
Services.obs.removeObserver(this, PRIO_LIMIT_REACHED_TOPIC);
} catch (ex) {}
await this._submitPing(this.Reason.SHUTDOWN);
},
observe(aSubject, aTopic, aData) {
switch (aTopic) {
case PRIO_LIMIT_REACHED_TOPIC:
this._log.trace("prio limit reached");
this._submitPing(this.Reason.MAX);
break;
}
},
periodicPing() {
this._log.trace("periodic ping triggered");
this._submitPing(this.Reason.PERIODIC);
},
/**
* Submits an "prio" ping and restarts the timer for the next interval.
*
* @param {String} reason The reason we're sending the ping. One of TelemetryPrioPing.Reason.
*/
async _submitPing(reason) {
this._log.trace("_submitPing");
let snapshot = await Policy.getEncodedOriginSnapshot(true /* clear */);
if (!this._testing) {
snapshot = snapshot.filter(
({ encoding }) => !encoding.startsWith("telemetry.test")
);
}
if (snapshot.length === 0) {
// Don't send a ping if we haven't anything to send
this._log.trace("nothing to send");
return;
}
let payload = {
version: PRIO_PING_VERSION,
reason,
prioData: snapshot,
};
const options = {
addClientId: false,
addEnvironment: false,
usePingSender: reason === this.Reason.SHUTDOWN,
};
Policy.sendPing(this.PRIO_PING_TYPE, payload, options);
},
/**
* Test-only, restore to initial state.
*/
testReset() {
this._testing = true;
},
get _log() {
if (!this._logger) {
this._logger = Log.repository.getLoggerWithMessagePrefix(
LOGGER_NAME,
LOGGER_PREFIX + "::"
);
}
return this._logger;
},
};
|
