f2e07044ae
When using the tab context menu or drag-dropping tabs to put them into a group, record a metric for the number of tabs added to the group. Data Science asked us to launch with this metric disabled so that they could control it using server knobs. They expect a high volume of events, so they expect to only enable this metric for some proportion of users. I converted the existing `TabMove` event derived from `UIEvent` being fired when tabs change their tab index in the tab strip. `UIEvent` doesn't allow for attaching additional context/detail to the event. `TabMove` is now a `CustomEvent` that provides more context about the moved tab and it fires in more cases -- it's possible for the tab index not to change despite the tab having "moved" into/out of a tab group. This approach would not capture tab movements that occur across multiple frames/event loop iterations. Differential Revision: https://phabricator.services.mozilla.com/D244616
63 lines
1.8 KiB
JavaScript
63 lines
1.8 KiB
JavaScript
/* 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/. */
|
|
|
|
/**
|
|
* A common list of systems, surfaces, controls, etc. from which user
|
|
* interactions with tabs could originate. These "source" values
|
|
* should be sent as extra data with tab-related metrics events.
|
|
*/
|
|
const METRIC_SOURCE = Object.freeze({
|
|
TAB_OVERFLOW_MENU: "tab_overflow",
|
|
TAB_GROUP_MENU: "tab_group",
|
|
TAB_MENU: "tab_menu",
|
|
DRAG_AND_DROP: "drag",
|
|
SUGGEST: "suggest",
|
|
RECENT_TABS: "recent",
|
|
UNKNOWN: "unknown",
|
|
});
|
|
|
|
const METRIC_TABS_LAYOUT = Object.freeze({
|
|
HORIZONTAL: "horizontal",
|
|
VERTICAL: "vertical",
|
|
});
|
|
|
|
const METRIC_REOPEN_TYPE = Object.freeze({
|
|
SAVED: "saved",
|
|
DELETED: "deleted",
|
|
});
|
|
|
|
/**
|
|
* @typedef {object} TabMetricsContext
|
|
* @property {boolean} [isUserTriggered=false]
|
|
* Should be true if there was an explicit action/request from the user
|
|
* (as opposed to some action being taken internally or for technical
|
|
* bookkeeping reasons alone). This causes telemetry events to fire.
|
|
* @property {string} [telemetrySource="unknown"]
|
|
* The system, surface, or control the user used to take this action.
|
|
* @see TabMetrics.METRIC_SOURCE for possible values.
|
|
* Defaults to "unknown".
|
|
*/
|
|
|
|
/**
|
|
* Creates a `TabMetricsContext` object for a user event originating from
|
|
* the specified source.
|
|
*
|
|
* @param {string} telemetrySource
|
|
* @see TabMetrics.METRIC_SOURCE
|
|
* @returns {TabMetricsContext}
|
|
*/
|
|
function userTriggeredContext(telemetrySource) {
|
|
return {
|
|
isUserTriggered: true,
|
|
telemetrySource,
|
|
};
|
|
}
|
|
|
|
export const TabMetrics = {
|
|
METRIC_SOURCE,
|
|
METRIC_TABS_LAYOUT,
|
|
METRIC_REOPEN_TYPE,
|
|
userTriggeredContext,
|
|
};
|