Source code
Revision control
Copy as Markdown
Other Tools
/* 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 { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
const lazy = {};
XPCOMUtils.defineLazyServiceGetter(
lazy,
"TrackingDBService",
"@mozilla.org/tracking-db-service;1",
Ci.nsITrackingDBService
);
/**
* @typedef {object} PrivacyMetricsStats
* @property {number} total - Total blocks this week
* @property {number} trackers - Tracker count
* @property {number} cookies - Tracking cookie count
* @property {number} fingerprinters - Fingerprinter count
* @property {number} cryptominers - Cryptominer count
* @property {number} socialTrackers - Social tracker count
* @property {number} lastUpdated - Timestamp in milliseconds
*/
/**
* Service for collecting privacy metrics from TrackingDBService.
* Provides weekly tracking protection statistics.
*/
export const PrivacyMetricsService = {
/**
* Get weekly tracking protection statistics.
*
* @returns {Promise<PrivacyMetricsStats>}
*/
async getWeeklyStats() {
/** @type {number} */
const todayInMs = Date.now();
/** @type {number} */
const weekAgoInMs = todayInMs - 7 * 24 * 60 * 60 * 1000;
const eventRows = await lazy.TrackingDBService.getEventsByDateRange(
weekAgoInMs,
todayInMs
);
return this._aggregateStats(eventRows);
},
/**
* Aggregate TrackingDBService data by category.
*
* @param {Array} eventRows - Array of database rows from TrackingDBService
* @returns {PrivacyMetricsStats}
*/
_aggregateStats(eventRows) {
let trackers = 0;
let cookies = 0;
let fingerprinters = 0;
let cryptominers = 0;
let socialTrackers = 0;
for (let row of eventRows) {
const count = row.getResultByName("count");
const type = row.getResultByName("type");
switch (type) {
case Ci.nsITrackingDBService.TRACKERS_ID:
trackers += count;
break;
case Ci.nsITrackingDBService.TRACKING_COOKIES_ID:
cookies += count;
break;
case Ci.nsITrackingDBService.FINGERPRINTERS_ID:
case Ci.nsITrackingDBService.SUSPICIOUS_FINGERPRINTERS_ID:
fingerprinters += count;
break;
case Ci.nsITrackingDBService.CRYPTOMINERS_ID:
cryptominers += count;
break;
case Ci.nsITrackingDBService.SOCIAL_ID:
socialTrackers += count;
break;
}
}
const total =
trackers + cookies + cryptominers + fingerprinters + socialTrackers;
return {
total,
trackers,
cookies,
fingerprinters,
cryptominers,
socialTrackers,
lastUpdated: Date.now(),
};
},
};