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
|
/* -*- js-indent-level: 2; indent-tabs-mode: nil -*- */
/* 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/. */
import { Log } from "resource://gre/modules/Log.sys.mjs";
import { TelemetryUtils } from "resource://gre/modules/TelemetryUtils.sys.mjs";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
TelemetryController: "resource://gre/modules/TelemetryController.sys.mjs",
});
const LOGGER_NAME = "Toolkit.Telemetry";
const PING_TYPE = "update";
const UPDATE_DOWNLOADED_TOPIC = "update-downloaded";
const UPDATE_STAGED_TOPIC = "update-staged";
/**
* This module is responsible for listening to all the relevant update
* signals, gathering the needed information and assembling the "update"
* ping.
*/
export var UpdatePing = {
_enabled: false,
earlyInit() {
this._log = Log.repository.getLoggerWithMessagePrefix(
LOGGER_NAME,
"UpdatePing::"
);
this._enabled = Services.prefs.getBoolPref(
TelemetryUtils.Preferences.UpdatePing,
false
);
this._log.trace("init - enabled: " + this._enabled);
if (!this._enabled) {
return;
}
Services.obs.addObserver(this, UPDATE_DOWNLOADED_TOPIC);
Services.obs.addObserver(this, UPDATE_STAGED_TOPIC);
},
/**
* Get the information about the update we're going to apply/was just applied
* from the update manager.
*
* @return {nsIUpdate} The information about the update, if available, or null.
*/
_getActiveUpdate() {
let updateManager = Cc["@mozilla.org/updates/update-manager;1"].getService(
Ci.nsIUpdateManager
);
if (!updateManager || !updateManager.readyUpdate) {
return null;
}
return updateManager.readyUpdate;
},
/**
* Generate an "update" ping with reason "success" and dispatch it
* to the Telemetry system.
*
* @param {String} aPreviousVersion The browser version we updated from.
* @param {String} aPreviousBuildId The browser build id we updated from.
*/
handleUpdateSuccess(aPreviousVersion, aPreviousBuildId) {
if (!this._enabled) {
return;
}
this._log.trace("handleUpdateSuccess");
// An update could potentially change the update channel. Moreover,
// updates can only be applied if the update's channel matches with the build channel.
// There's no way to pass this information from the caller nor the environment as,
// in that case, the environment would report the "new" channel. However, the
// update manager should still have information about the active update: given the
// previous assumptions, we can simply get the channel from the update and assume
// it matches with the state previous to the update.
let update = this._getActiveUpdate();
const payload = {
reason: "success",
previousChannel: update ? update.channel : null,
previousVersion: aPreviousVersion,
previousBuildId: aPreviousBuildId,
};
const options = {
addClientId: true,
addEnvironment: true,
usePingSender: false,
};
lazy.TelemetryController.submitExternalPing(
PING_TYPE,
payload,
options
).catch(e =>
this._log.error("handleUpdateSuccess - failed to submit update ping", e)
);
},
/**
* Generate an "update" ping with reason "ready" and dispatch it
* to the Telemetry system.
*
* @param {String} aUpdateState The state of the downloaded patch. See
* nsIUpdateService.idl for a list of possible values.
*/
_handleUpdateReady(aUpdateState) {
const ALLOWED_STATES = [
"applied",
"applied-service",
"pending",
"pending-service",
"pending-elevate",
];
if (!ALLOWED_STATES.includes(aUpdateState)) {
this._log.trace("Unexpected update state: " + aUpdateState);
return;
}
// Get the information about the update we're going to apply from the
// update manager.
let update = this._getActiveUpdate();
if (!update) {
this._log.trace(
"Cannot get the update manager or no update is currently active."
);
return;
}
const payload = {
reason: "ready",
targetChannel: update.channel,
targetVersion: update.appVersion,
targetBuildId: update.buildID,
targetDisplayVersion: update.displayVersion,
};
const options = {
addClientId: true,
addEnvironment: true,
usePingSender: true,
};
lazy.TelemetryController.submitExternalPing(
PING_TYPE,
payload,
options
).catch(e =>
this._log.error("_handleUpdateReady - failed to submit update ping", e)
);
},
/**
* The notifications handler.
*/
observe(aSubject, aTopic, aData) {
this._log.trace("observe - aTopic: " + aTopic);
if (aTopic == UPDATE_DOWNLOADED_TOPIC || aTopic == UPDATE_STAGED_TOPIC) {
this._handleUpdateReady(aData);
}
},
shutdown() {
if (!this._enabled) {
return;
}
Services.obs.removeObserver(this, UPDATE_DOWNLOADED_TOPIC);
Services.obs.removeObserver(this, UPDATE_STAGED_TOPIC);
},
};
|
