chrome/browser/resources/settings/metrics_browser_proxy.js

// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

/** @fileoverview Handles metrics for the settings pages. */

// clang-format off
import {addSingletonGetter} from 'chrome://resources/js/cr.m.js';
// clang-format on

  /**
   * Contains all possible recorded interactions across privacy settings pages.
   *
   * These values are persisted to logs. Entries should not be renumbered and
   * numeric values should never be reused.
   *
   * Must be kept in sync with the SettingsPrivacyElementInteractions enum in
   * histograms/enums.xml
   * @enum {number}
   */
  export const PrivacyElementInteractions = {
    SYNC_AND_GOOGLE_SERVICES: 0,
    CHROME_SIGN_IN: 1,
    DO_NOT_TRACK: 2,
    PAYMENT_METHOD: 3,
    NETWORK_PREDICTION: 4,
    MANAGE_CERTIFICATES: 5,
    SAFE_BROWSING: 6,
    PASSWORD_CHECK: 7,
    IMPROVE_SECURITY: 8,
    COOKIES_ALL: 9,
    COOKIES_INCOGNITO: 10,
    COOKIES_THIRD: 11,
    COOKIES_BLOCK: 12,
    COOKIES_SESSION: 13,
    // Leave this at the end.
    COUNT: 14,
  };

  /**
   * Contains all safety check interactions.
   *
   * These values are persisted to logs. Entries should not be renumbered and
   * numeric values should never be reused.
   *
   * Must be kept in sync with the SafetyCheckInteractions enum in
   * histograms/enums.xml
   * @enum {number}
   */
  export const SafetyCheckInteractions = {
    SAFETY_CHECK_START: 0,
    SAFETY_CHECK_UPDATES_RELAUNCH: 1,
    SAFETY_CHECK_PASSWORDS_MANAGE: 2,
    SAFETY_CHECK_SAFE_BROWSING_MANAGE: 3,
    SAFETY_CHECK_EXTENSIONS_REVIEW: 4,
    // Leave this at the end.
    COUNT: 5,
  };

  /** @interface */
  export class MetricsBrowserProxy {
    /**
     * Helper function that calls recordAction with one action from
     * tools/metrics/actions/actions.xml.
     * @param {!string} action One action to be recorded.
     */
    recordAction(action) {}

    /**
     * Helper function that calls recordHistogram for the
     * Settings.SafetyCheck.Interactions histogram
     * @param {!SafetyCheckInteractions} interaction
     */
    recordSafetyCheckInteractionHistogram(interaction) {}

    /**
     * Helper function that calls recordHistogram for the
     * SettingsPage.PrivacyElementInteractions histogram
     * @param {!PrivacyElementInteractions} interaction
     */
    recordSettingsPageHistogram(interaction) {}
  }

  /**
   * @implements {MetricsBrowserProxy}
   */
  export class MetricsBrowserProxyImpl {
    /** @override */
    recordAction(action) {
      chrome.send('metricsHandler:recordAction', [action]);
    }

    /** @override*/
    recordSafetyCheckInteractionHistogram(interaction) {
      chrome.send('metricsHandler:recordInHistogram', [
        'Settings.SafetyCheck.Interactions', interaction,
        SafetyCheckInteractions.COUNT
      ]);
    }

    /** @override*/
    recordSettingsPageHistogram(interaction) {
      chrome.send('metricsHandler:recordInHistogram', [
        'Settings.PrivacyElementInteractions', interaction,
        PrivacyElementInteractions.COUNT
      ]);
    }
  }

  addSingletonGetter(MetricsBrowserProxyImpl);