Bug 1968126 — Remove pktTelemetry.sys.js and metrics r=fchasen,rking

Differential Revision: https://phabricator.services.mozilla.com/D252418
This commit is contained in:
kpatenio 2025-06-09 18:28:36 +00:00 committed by rking@mozilla.com
parent e34c3413de
commit 97bdaced27
4 changed files with 0 additions and 220 deletions

View file

@ -1,74 +0,0 @@
/* 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/. */
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
TelemetryEnvironment: "resource://gre/modules/TelemetryEnvironment.sys.mjs",
pktApi: "chrome://pocket/content/pktApi.sys.mjs",
});
const PREF_IMPRESSION_ID = "browser.newtabpage.activity-stream.impressionId";
export var pktTelemetry = {
get impressionId() {
if (!this._impressionId) {
this._impressionId = this.getOrCreateImpressionId();
}
return this._impressionId;
},
// Sets or gets the impression id that's use for Pocket impressions.
// The impression id cannot be tied to a client id.
// This is the same impression id used in newtab pocket impressions.
getOrCreateImpressionId() {
let impressionId = Services.prefs.getStringPref(PREF_IMPRESSION_ID, "");
if (!impressionId) {
impressionId = String(Services.uuid.generateUUID());
Services.prefs.setStringPref(PREF_IMPRESSION_ID, impressionId);
}
return impressionId;
},
_profileCreationDate() {
return (
lazy.TelemetryEnvironment.currentEnvironment.profile.resetDate ||
lazy.TelemetryEnvironment.currentEnvironment.profile.creationDate
);
},
/**
* Records the provided data and common pocket-button data to Glean,
* then submits it all in a pocket-button ping.
*
* @param eventAction - A string like "click"
* @param eventSource - A string like "save_button"
* @param eventPosition - (optional) A 0-based index.
* If falsey and not 0, is coalesced to undefined.
* @param model - (optional) An identifier for the machine learning model
* used to generate the recommendations like "vec-bestarticle"
*/
submitPocketButtonPing(
eventAction,
eventSource,
eventPosition = undefined,
model = undefined
) {
eventPosition = eventPosition || eventPosition === 0 ? 0 : undefined;
Glean.pocketButton.impressionId.set(this.impressionId);
Glean.pocketButton.pocketLoggedInStatus.set(lazy.pktApi.isUserLoggedIn());
Glean.pocketButton.profileCreationDate.set(this._profileCreationDate());
Glean.pocketButton.eventAction.set(eventAction);
Glean.pocketButton.eventSource.set(eventSource);
if (eventPosition !== undefined) {
Glean.pocketButton.eventPosition.set(eventPosition);
}
if (model !== undefined) {
Glean.pocketButton.model.set(model);
}
GleanPings.pocketButton.submit();
},
};

View file

@ -5,4 +5,3 @@
browser.jar:
% content pocket %content/pocket/ contentaccessible=yes
content/pocket/pktApi.sys.mjs (content/pktApi.sys.mjs)
content/pocket/pktTelemetry.sys.mjs (content/pktTelemetry.sys.mjs)

View file

@ -1,144 +0,0 @@
# 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/.
# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
- 'Firefox :: Pocket'
pocket.button:
impression_id:
type: uuid
description: >
A UUID representing this profile.
This isn't client_id, nor can it be used to link to a client_id.
This also means it should never be sent in a ping with a client_id.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_sensitivity:
- technical
notification_emails:
- chutten@mozilla.com
- kdemtchouk@mozilla.com
- sdowne@mozilla.com
expires: never
send_in_pings: [ pocket-button ]
pocket_logged_in_status:
type: boolean
description: >
Whether there was a logged-in Pocket account in the Pocket-Firefox
integration at the point in time this action occurred.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_sensitivity:
- technical
notification_emails:
- chutten@mozilla.com
- kdemtchouk@mozilla.com
- sdowne@mozilla.com
expires: never
send_in_pings: [ pocket-button ]
profile_creation_date:
type: quantity
unit: days_since_jan_1_1970
description: >
The days since Jan 1, 1970 that the oldest file in the profile dir was
modified. Or created. Or just the day and time of the first thing to ask
for the profile age called in. Or something earlier or later than that.
You may not want to use this.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_sensitivity:
- technical
notification_emails:
- chutten@mozilla.com
- kdemtchouk@mozilla.com
- sdowne@mozilla.com
expires: never
send_in_pings: [ pocket-button ]
event_action:
type: string
description: >
The action that was taken, like "click" or... actually, it might only
ever be "click".
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_sensitivity:
- interaction
notification_emails:
- chutten@mozilla.com
- kdemtchouk@mozilla.com
- sdowne@mozilla.com
expires: never
send_in_pings: [ pocket-button ]
event_source:
type: string
description: >
The source of the taken action, like "save_button", "home_button",
"on_save_recs", or the like.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_sensitivity:
- interaction
notification_emails:
- chutten@mozilla.com
- kdemtchouk@mozilla.com
- sdowne@mozilla.com
expires: never
send_in_pings: [ pocket-button ]
event_position:
type: quantity
unit: index
description: >
0-based index of the item on which the action was performed.
Not always provided.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_sensitivity:
- interaction
notification_emails:
- chutten@mozilla.com
- kdemtchouk@mozilla.com
- sdowne@mozilla.com
expires: never
send_in_pings: [ pocket-button ]
model:
type: string
description: >
A string that identifies the ML model (if any) used to generate on-save
recommendations. Like "doc2vec-incremental-best-article-pubspread".
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
data_sensitivity:
- interaction
notification_emails:
- chutten@mozilla.com
- kdemtchouk@mozilla.com
- sdowne@mozilla.com
expires: never
send_in_pings: [ pocket-button ]

View file

@ -124,7 +124,6 @@ firefox_desktop_metrics = [
"browser/components/migration/metrics.yaml",
"browser/components/newtab/metrics.yaml",
"browser/components/places/metrics.yaml",
"browser/components/pocket/metrics.yaml",
"browser/components/preferences/metrics.yaml",
"browser/components/privatebrowsing/metrics.yaml",
"browser/components/profiles/metrics.yaml",