components/permissions/permission_uma_util.h - chromium/src - Git at Google

 // Copyright 2014 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.

 #ifndef COMPONENTS_PERMISSIONS_PERMISSION_UMA_UTIL_H_
 #define COMPONENTS_PERMISSIONS_PERMISSION_UMA_UTIL_H_

 #include <vector>

 #include "base/memory/raw_ptr.h"
 #include "base/time/time.h"
 #include "base/version.h"
 #include "components/content_settings/core/common/content_settings_types.h"
 #include "components/permissions/permission_request.h"
 #include "components/permissions/permission_result.h"
 #include "components/permissions/permission_util.h"
 #include "components/permissions/prediction_service/prediction_service_messages.pb.h"
 #include "third_party/abseil-cpp/absl/types/optional.h"

 namespace content {
 class BrowserContext;
 class WebContents;
 }  // namespace content

 class GURL;

 namespace permissions {
 enum class PermissionRequestGestureType;
 class PermissionRequest;

 // Used for UMA to record the types of permission prompts shown.
 // When updating, you also need to update:
 //   1) The PermissionRequestType enum in tools/metrics/histograms/enums.xml.
 //   2) The PermissionRequestTypes suffix list in
 //      tools/metrics/histograms/histograms.xml.
 //   3) GetPermissionRequestString below.
 //
 // The usual rules of updating UMA values applies to this enum:
 // - don't remove values
 // - only ever add values at the end
 enum class RequestTypeForUma {
   UNKNOWN = 0,
   MULTIPLE = 1,
   // UNUSED_PERMISSION = 2,
   QUOTA = 3,
   DOWNLOAD = 4,
   // MEDIA_STREAM = 5,
   REGISTER_PROTOCOL_HANDLER = 6,
   PERMISSION_GEOLOCATION = 7,
   PERMISSION_MIDI_SYSEX = 8,
   PERMISSION_NOTIFICATIONS = 9,
   PERMISSION_PROTECTED_MEDIA_IDENTIFIER = 10,
   // PERMISSION_PUSH_MESSAGING = 11,
   PERMISSION_FLASH = 12,
   PERMISSION_MEDIASTREAM_MIC = 13,
   PERMISSION_MEDIASTREAM_CAMERA = 14,
   PERMISSION_ACCESSIBILITY_EVENTS = 15,
   // PERMISSION_CLIPBOARD_READ = 16, // Replaced by
   // PERMISSION_CLIPBOARD_READ_WRITE in M81.
   PERMISSION_SECURITY_KEY_ATTESTATION = 17,
   PERMISSION_PAYMENT_HANDLER = 18,
   PERMISSION_NFC = 19,
   PERMISSION_CLIPBOARD_READ_WRITE = 20,
   PERMISSION_VR = 21,
   PERMISSION_AR = 22,
   PERMISSION_STORAGE_ACCESS = 23,
   PERMISSION_CAMERA_PAN_TILT_ZOOM = 24,
   PERMISSION_WINDOW_PLACEMENT = 25,
   PERMISSION_LOCAL_FONTS = 26,
   PERMISSION_IDLE_DETECTION = 27,
   PERMISSION_FILE_HANDLING = 28,
   PERMISSION_U2F_API_REQUEST = 29,
   // NUM must be the last value in the enum.
   NUM
 };

 // Any new values should be inserted immediately prior to NUM.
 enum class PermissionSourceUI {
   // Permission prompt.
   PROMPT = 0,

   // Origin info bubble.
   // https://www.chromium.org/Home/chromium-security/enamel/goals-for-the-origin-info-bubble
   OIB = 1,

   // chrome://settings/content/siteDetails?site=[SITE]
   // chrome://settings/content/[PERMISSION TYPE]
   SITE_SETTINGS = 2,

   // Page action bubble.
   PAGE_ACTION = 3,

   // Permission settings from Android.
   // Currently this value is only used when revoking notification permission in
   // Android O+ system channel settings.
   ANDROID_SETTINGS = 4,

   // Permission settings as part of the event's UI.
   // Currently this value is only used when revoking notification permission
   // through the notification UI.
   INLINE_SETTINGS = 5,

   // Permission settings changes as part of the abusive origins revocation.
   AUTO_REVOCATION = 6,

   // Always keep this at the end.
   NUM,
 };

 // Any new values should be inserted immediately prior to NUM.
 enum class PermissionEmbargoStatus {
   NOT_EMBARGOED = 0,
   // Removed: PERMISSIONS_BLACKLISTING = 1,
   REPEATED_DISMISSALS = 2,
   REPEATED_IGNORES = 3,

   // Keep this at the end.
   NUM,
 };

 // The kind of permission prompt UX used to surface a permission request.
 // Enum used in UKMs and UMAs, do not re-order or change values. Deprecated
 // items should only be commented out. New items should be added at the end,
 // and the "PermissionPromptDisposition" histogram suffix needs to be updated to
 // match (tools/metrics/histograms/metadata/histogram_suffixes_list.xml).
 enum class PermissionPromptDisposition {
   // Not all permission actions will have an associated permission prompt (e.g.
   // changing permission via the settings page).
   NOT_APPLICABLE = 0,

   // Only used on desktop, a bubble under the site settings padlock.
   ANCHORED_BUBBLE = 1,

   // Only used on desktop, a static indicator on the right-hand side of the
   // location bar.
   LOCATION_BAR_RIGHT_STATIC_ICON = 2,

   // Only used on desktop, an animated indicator on the right-hand side of the
   // location bar.
   LOCATION_BAR_RIGHT_ANIMATED_ICON = 3,

   // Only used on Android, a modal dialog.
   MODAL_DIALOG = 4,

   // Only used on Android, an initially-collapsed infobar at the bottom of the
   // page.
   MINI_INFOBAR = 5,

   // Only used on desktop, a chip on the left-hand side of the location bar that
   // shows a bubble when clicked.
   LOCATION_BAR_LEFT_CHIP = 6,

   // There was no UI being shown. This is usually because the user closed an
   // inactive tab that had a pending permission request.
   NONE_VISIBLE = 7,

   // Other custom modal dialogs.
   CUSTOM_MODAL_DIALOG = 8,

   // Only used on desktop, a less prominent version of chip on the left-hand
   // side of the location bar that shows a bubble when clicked.
   LOCATION_BAR_LEFT_QUIET_CHIP = 9,

   // Only used on Android, a message bubble near top of the screen and below the
   // location bar. Message UI is an alternative UI to infobar UI.
   MESSAGE_UI = 10,

   // Only used on desktop, a chip on the left-hand side of the location bar that
   // automatically shows a bubble.
   LOCATION_BAR_LEFT_QUIET_ABUSIVE_CHIP = 11,

   // Only used on desktop, a chip on the left-hand side of the location bar that
   // automatically shows a bubble.
   LOCATION_BAR_LEFT_CHIP_AUTO_BUBBLE = 12,
 };

 // The reason why the permission prompt disposition was used. Enum used in UKMs,
 // do not re-order or change values. Deprecated items should only be commented
 // out.
 enum class PermissionPromptDispositionReason {
   // Disposition was selected in prefs.
   USER_PREFERENCE_IN_SETTINGS = 0,

   // Disposition was chosen because Safe Browsing classifies the origin
   // as being spammy or abusive with permission requests.
   SAFE_BROWSING_VERDICT = 1,

   // Disposition was chosen based on grant likelihood predicted by the
   // Web Permission Prediction Service.
   PREDICTION_SERVICE = 2,

   // Disposition was used as a fallback, if no selector made a decision.
   DEFAULT_FALLBACK = 3,

   // Disposition was chosen based on grant likelihood predicted by the On-Device
   // Permission Prediction Model.
   ON_DEVICE_PREDICTION_MODEL = 4,
 };

 enum class AdaptiveTriggers {
   // None of the adaptive triggers were met. Currently this means two or less
   // consecutive denies in a row.
   NONE = 0,

   // User denied permission prompt 3 or more times.
   THREE_CONSECUTIVE_DENIES = 0x01,
 };

 enum class PermissionAutoRevocationHistory {
   // Permission has not been automatically revoked.
   NONE = 0,

   // Permission has been automatically revoked.
   PREVIOUSLY_AUTO_REVOKED = 0x01,
 };

 // This enum backs up the `AutoDSEPermissionRevertTransition` histogram enum.
 // Never reuse values and mirror any updates to it.
 // Describes the transition that has occured for the setting of a DSE origin
 // when DSE autogrant becomes disabled.
 enum class AutoDSEPermissionRevertTransition {
   // The user has not previously made any decision so it results in an `ASK` end
   // state.
   NO_DECISION_ASK = 0,
   // The user has decided to `ALLOW` the origin before it was the DSE origin and
   // has not reverted this decision.
   PRESERVE_ALLOW = 1,
   // The user has previously `BLOCKED` the origin but has allowed it after it
   // became the DSE origin. Resolve the conflict by setting it to `ASK` so the
   // user will make a decision again.
   CONFLICT_ASK = 2,
   // The user has blocked the DSE origin and has not made a previous decision
   // before the origin became the DSE origin.
   PRESERVE_BLOCK_ASK = 3,
   // The user has blocked the DSE origin and has `ALLOWED` it before it became
   // the DSE origin, preserve the latest decision.
   PRESERVE_BLOCK_ALLOW = 4,
   // The user has blocked the DSE origin and has `BLOCKED` it before it became
   // the DSE origin as well.
   PRESERVE_BLOCK_BLOCK = 5,
   // There has been an invalid transition.
   INVALID_END_STATE = 6,

   // Always keep at the end.
   kMaxValue = INVALID_END_STATE,
 };

 // This enum backs up the 'PermissionPredictionSource` histogram enum. It
 // indicates whether the permission prediction was done by the local on device
 // model or by the server side model.
 enum class PermissionPredictionSource {
   ON_DEVICE = 0,
   SERVER_SIDE = 1,

   // Always keep at the end.
   kMaxValue = SERVER_SIDE,
 };

 // Provides a convenient way of logging UMA for permission related operations.
 class PermissionUmaUtil {
  public:
   using PredictionGrantLikelihood =
       PermissionPrediction_Likelihood_DiscretizedLikelihood;

   static const char kPermissionsPromptShown[];
   static const char kPermissionsPromptShownGesture[];
   static const char kPermissionsPromptShownNoGesture[];
   static const char kPermissionsPromptAccepted[];
   static const char kPermissionsPromptAcceptedGesture[];
   static const char kPermissionsPromptAcceptedNoGesture[];
   static const char kPermissionsPromptAcceptedOnce[];
   static const char kPermissionsPromptAcceptedOnceGesture[];
   static const char kPermissionsPromptAcceptedOnceNoGesture[];
   static const char kPermissionsPromptDenied[];
   static const char kPermissionsPromptDeniedGesture[];
   static const char kPermissionsPromptDeniedNoGesture[];

   PermissionUmaUtil() = delete;
   PermissionUmaUtil(const PermissionUmaUtil&) = delete;
   PermissionUmaUtil& operator=(const PermissionUmaUtil&) = delete;

   static void PermissionRequested(ContentSettingsType permission,
                                   const GURL& requesting_origin);

   // Records the revocation UMA and UKM metrics for ContentSettingsTypes that
   // have user facing permission prompts. The passed in `permission` must be
   // such that PermissionUtil::IsPermission(permission) returns true.
   static void PermissionRevoked(ContentSettingsType permission,
                                 PermissionSourceUI source_ui,
                                 const GURL& revoked_origin,
                                 content::BrowserContext* browser_context);

   static void RecordEmbargoPromptSuppression(
       PermissionEmbargoStatus embargo_status);

   static void RecordEmbargoPromptSuppressionFromSource(
       PermissionStatusSource source);

   static void RecordEmbargoStatus(PermissionEmbargoStatus embargo_status);

   // UMA specifically for when permission prompts are shown. This should be
   // roughly equivalent to the metrics above, however it is
   // useful to have separate UMA to a few reasons:
   // - to account for, and get data on coalesced permission bubbles
   // - there are other types of permissions prompts (e.g. download limiting)
   //   which don't go through PermissionContext
   // - the above metrics don't always add up (e.g. sum of
   //   granted+denied+dismissed+ignored is not equal to requested), so it is
   //   unclear from those metrics alone how many prompts are seen by users.
   static void PermissionPromptShown(
       const std::vector<PermissionRequest*>& requests);

   static void PermissionPromptResolved(
       const std::vector<PermissionRequest*>& requests,
       content::WebContents* web_contents,
       PermissionAction permission_action,
       base::TimeDelta time_to_decision,
       PermissionPromptDisposition ui_disposition,
       absl::optional<PermissionPromptDispositionReason> ui_reason,
       absl::optional<PredictionGrantLikelihood> predicted_grant_likelihood,
       absl::optional<bool> prediction_decision_held_back,
       bool did_show_prompt,
       bool did_click_manage,
       bool did_click_learn_more);

   static void RecordWithBatteryBucket(const std::string& histogram);

   static void RecordInfobarDetailsExpanded(bool expanded);

   static void RecordCrowdDenyDelayedPushNotification(base::TimeDelta delay);

   static void RecordCrowdDenyVersionAtAbuseCheckTime(
       const absl::optional<base::Version>& version);

   // Record UMAs related to the Android "Missing permissions" infobar.
   static void RecordMissingPermissionInfobarShouldShow(
       bool should_show,
       const std::vector<ContentSettingsType>& content_settings_types);
   static void RecordMissingPermissionInfobarAction(
       PermissionAction action,
       const std::vector<ContentSettingsType>& content_settings_types);

   static void RecordPermissionUsage(ContentSettingsType permission_type,
                                     content::BrowserContext* browser_context,
                                     content::WebContents* web_contents,
                                     const GURL& requesting_origin);

   static void RecordTimeElapsedBetweenGrantAndUse(ContentSettingsType type,
                                                   base::TimeDelta delta);

   static void RecordTimeElapsedBetweenGrantAndRevoke(ContentSettingsType type,
                                                      base::TimeDelta delta);

   static void RecordAutoDSEPermissionReverted(
       ContentSettingsType permission_type,
       ContentSetting backed_up_setting,
       ContentSetting effective_setting,
       ContentSetting end_state_setting);

   static void RecordDSEEffectiveSetting(ContentSettingsType permission_type,
                                         ContentSetting setting);

   static void RecordPermissionPredictionSource(
       PermissionPredictionSource prediction_type);

   static void RecordPermissionPredictionServiceHoldback(
       RequestType request_type,
       bool is_on_device,
       bool is_heldback);

   static std::string GetPermissionActionString(
       PermissionAction permission_action);

   static std::string GetPromptDispositionString(
       PermissionPromptDisposition ui_disposition);

   static std::string GetPromptDispositionReasonString(
       PermissionPromptDispositionReason ui_disposition_reason);

   static std::string GetRequestTypeString(RequestType request_type);

   static bool IsPromptDispositionQuiet(
       PermissionPromptDisposition prompt_disposition);

   static bool IsPromptDispositionLoud(
       PermissionPromptDisposition prompt_disposition);

   // A scoped class that will check the current resolved content setting on
   // construction and report a revocation metric accordingly if the revocation
   // condition is met (from ALLOW to something else).
   class ScopedRevocationReporter {
    public:
     ScopedRevocationReporter(content::BrowserContext* browser_context,
                              const GURL& primary_url,
                              const GURL& secondary_url,
                              ContentSettingsType content_type,
                              PermissionSourceUI source_ui);

     ScopedRevocationReporter(content::BrowserContext* browser_context,
                              const ContentSettingsPattern& primary_pattern,
                              const ContentSettingsPattern& secondary_pattern,
                              ContentSettingsType content_type,
                              PermissionSourceUI source_ui);

     ~ScopedRevocationReporter();

    private:
     raw_ptr<content::BrowserContext> browser_context_;
     const GURL primary_url_;
     const GURL secondary_url_;
     ContentSettingsType content_type_;
     PermissionSourceUI source_ui_;
     bool is_initially_allowed_;
     base::Time last_modified_date_;
   };

  private:
   friend class PermissionUmaUtilTest;

   // Records UMA and UKM metrics for ContentSettingsTypes that have user facing
   // permission prompts. The passed in `permission` must be such that
   // PermissionUtil::IsPermission(permission) returns true.
   // web_contents may be null when for recording non-prompt actions.
   static void RecordPermissionAction(
       ContentSettingsType permission,
       PermissionAction action,
       PermissionSourceUI source_ui,
       PermissionRequestGestureType gesture_type,
       base::TimeDelta time_to_decision,
       PermissionPromptDisposition ui_disposition,
       absl::optional<PermissionPromptDispositionReason> ui_reason,
       const GURL& requesting_origin,
       content::WebContents* web_contents,
       content::BrowserContext* browser_context,
       absl::optional<PredictionGrantLikelihood> predicted_grant_likelihood,
       absl::optional<bool> prediction_decision_held_back);

   // Records |count| total prior actions for a prompt of type |permission|
   // for a single origin using |prefix| for the metric.
   static void RecordPermissionPromptPriorCount(ContentSettingsType permission,
                                                const std::string& prefix,
                                                int count);

   static void RecordPromptDecided(
       const std::vector<PermissionRequest*>& requests,
       bool accepted,
       bool is_one_time);
 };

 }  // namespace permissions

 #endif  // COMPONENTS_PERMISSIONS_PERMISSION_UMA_UTIL_H_
	// Copyright 2014 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.

	#ifndef COMPONENTS_PERMISSIONS_PERMISSION_UMA_UTIL_H_
	#define COMPONENTS_PERMISSIONS_PERMISSION_UMA_UTIL_H_

	#include <vector>

	#include "base/memory/raw_ptr.h"
	#include "base/time/time.h"
	#include "base/version.h"
	#include "components/content_settings/core/common/content_settings_types.h"
	#include "components/permissions/permission_request.h"
	#include "components/permissions/permission_result.h"
	#include "components/permissions/permission_util.h"
	#include "components/permissions/prediction_service/prediction_service_messages.pb.h"
	#include "third_party/abseil-cpp/absl/types/optional.h"

	namespace content {
	class BrowserContext;
	class WebContents;
	} // namespace content

	class GURL;

	namespace permissions {
	enum class PermissionRequestGestureType;
	class PermissionRequest;

	// Used for UMA to record the types of permission prompts shown.
	// When updating, you also need to update:
	// 1) The PermissionRequestType enum in tools/metrics/histograms/enums.xml.
	// 2) The PermissionRequestTypes suffix list in
	// tools/metrics/histograms/histograms.xml.
	// 3) GetPermissionRequestString below.
	//
	// The usual rules of updating UMA values applies to this enum:
	// - don't remove values
	// - only ever add values at the end
	enum class RequestTypeForUma {
	UNKNOWN = 0,
	MULTIPLE = 1,
	// UNUSED_PERMISSION = 2,
	QUOTA = 3,
	DOWNLOAD = 4,
	// MEDIA_STREAM = 5,
	REGISTER_PROTOCOL_HANDLER = 6,
	PERMISSION_GEOLOCATION = 7,
	PERMISSION_MIDI_SYSEX = 8,
	PERMISSION_NOTIFICATIONS = 9,
	PERMISSION_PROTECTED_MEDIA_IDENTIFIER = 10,
	// PERMISSION_PUSH_MESSAGING = 11,
	PERMISSION_FLASH = 12,
	PERMISSION_MEDIASTREAM_MIC = 13,
	PERMISSION_MEDIASTREAM_CAMERA = 14,
	PERMISSION_ACCESSIBILITY_EVENTS = 15,
	// PERMISSION_CLIPBOARD_READ = 16, // Replaced by
	// PERMISSION_CLIPBOARD_READ_WRITE in M81.
	PERMISSION_SECURITY_KEY_ATTESTATION = 17,
	PERMISSION_PAYMENT_HANDLER = 18,
	PERMISSION_NFC = 19,
	PERMISSION_CLIPBOARD_READ_WRITE = 20,
	PERMISSION_VR = 21,
	PERMISSION_AR = 22,
	PERMISSION_STORAGE_ACCESS = 23,
	PERMISSION_CAMERA_PAN_TILT_ZOOM = 24,
	PERMISSION_WINDOW_PLACEMENT = 25,
	PERMISSION_LOCAL_FONTS = 26,
	PERMISSION_IDLE_DETECTION = 27,
	PERMISSION_FILE_HANDLING = 28,
	PERMISSION_U2F_API_REQUEST = 29,
	// NUM must be the last value in the enum.
	NUM
	};

	// Any new values should be inserted immediately prior to NUM.
	enum class PermissionSourceUI {
	// Permission prompt.
	PROMPT = 0,

	// Origin info bubble.
	// https://www.chromium.org/Home/chromium-security/enamel/goals-for-the-origin-info-bubble
	OIB = 1,

	// chrome://settings/content/siteDetails?site=[SITE]
	// chrome://settings/content/[PERMISSION TYPE]
	SITE_SETTINGS = 2,

	// Page action bubble.
	PAGE_ACTION = 3,

	// Permission settings from Android.
	// Currently this value is only used when revoking notification permission in
	// Android O+ system channel settings.
	ANDROID_SETTINGS = 4,

	// Permission settings as part of the event's UI.
	// Currently this value is only used when revoking notification permission
	// through the notification UI.
	INLINE_SETTINGS = 5,

	// Permission settings changes as part of the abusive origins revocation.
	AUTO_REVOCATION = 6,

	// Always keep this at the end.
	NUM,
	};

	// Any new values should be inserted immediately prior to NUM.
	enum class PermissionEmbargoStatus {
	NOT_EMBARGOED = 0,
	// Removed: PERMISSIONS_BLACKLISTING = 1,
	REPEATED_DISMISSALS = 2,
	REPEATED_IGNORES = 3,

	// Keep this at the end.
	NUM,
	};

	// The kind of permission prompt UX used to surface a permission request.
	// Enum used in UKMs and UMAs, do not re-order or change values. Deprecated
	// items should only be commented out. New items should be added at the end,
	// and the "PermissionPromptDisposition" histogram suffix needs to be updated to
	// match (tools/metrics/histograms/metadata/histogram_suffixes_list.xml).
	enum class PermissionPromptDisposition {
	// Not all permission actions will have an associated permission prompt (e.g.
	// changing permission via the settings page).
	NOT_APPLICABLE = 0,

	// Only used on desktop, a bubble under the site settings padlock.
	ANCHORED_BUBBLE = 1,

	// Only used on desktop, a static indicator on the right-hand side of the
	// location bar.
	LOCATION_BAR_RIGHT_STATIC_ICON = 2,

	// Only used on desktop, an animated indicator on the right-hand side of the
	// location bar.
	LOCATION_BAR_RIGHT_ANIMATED_ICON = 3,

	// Only used on Android, a modal dialog.
	MODAL_DIALOG = 4,

	// Only used on Android, an initially-collapsed infobar at the bottom of the
	// page.
	MINI_INFOBAR = 5,

	// Only used on desktop, a chip on the left-hand side of the location bar that
	// shows a bubble when clicked.
	LOCATION_BAR_LEFT_CHIP = 6,

	// There was no UI being shown. This is usually because the user closed an
	// inactive tab that had a pending permission request.
	NONE_VISIBLE = 7,

	// Other custom modal dialogs.
	CUSTOM_MODAL_DIALOG = 8,

	// Only used on desktop, a less prominent version of chip on the left-hand
	// side of the location bar that shows a bubble when clicked.
	LOCATION_BAR_LEFT_QUIET_CHIP = 9,

	// Only used on Android, a message bubble near top of the screen and below the
	// location bar. Message UI is an alternative UI to infobar UI.
	MESSAGE_UI = 10,

	// Only used on desktop, a chip on the left-hand side of the location bar that
	// automatically shows a bubble.
	LOCATION_BAR_LEFT_QUIET_ABUSIVE_CHIP = 11,

	// Only used on desktop, a chip on the left-hand side of the location bar that
	// automatically shows a bubble.
	LOCATION_BAR_LEFT_CHIP_AUTO_BUBBLE = 12,
	};

	// The reason why the permission prompt disposition was used. Enum used in UKMs,
	// do not re-order or change values. Deprecated items should only be commented
	// out.
	enum class PermissionPromptDispositionReason {
	// Disposition was selected in prefs.
	USER_PREFERENCE_IN_SETTINGS = 0,

	// Disposition was chosen because Safe Browsing classifies the origin
	// as being spammy or abusive with permission requests.
	SAFE_BROWSING_VERDICT = 1,

	// Disposition was chosen based on grant likelihood predicted by the
	// Web Permission Prediction Service.
	PREDICTION_SERVICE = 2,

	// Disposition was used as a fallback, if no selector made a decision.
	DEFAULT_FALLBACK = 3,

	// Disposition was chosen based on grant likelihood predicted by the On-Device
	// Permission Prediction Model.
	ON_DEVICE_PREDICTION_MODEL = 4,
	};

	enum class AdaptiveTriggers {
	// None of the adaptive triggers were met. Currently this means two or less
	// consecutive denies in a row.
	NONE = 0,

	// User denied permission prompt 3 or more times.
	THREE_CONSECUTIVE_DENIES = 0x01,
	};

	enum class PermissionAutoRevocationHistory {
	// Permission has not been automatically revoked.
	NONE = 0,

	// Permission has been automatically revoked.
	PREVIOUSLY_AUTO_REVOKED = 0x01,
	};

	// This enum backs up the `AutoDSEPermissionRevertTransition` histogram enum.
	// Never reuse values and mirror any updates to it.
	// Describes the transition that has occured for the setting of a DSE origin
	// when DSE autogrant becomes disabled.
	enum class AutoDSEPermissionRevertTransition {
	// The user has not previously made any decision so it results in an `ASK` end
	// state.
	NO_DECISION_ASK = 0,
	// The user has decided to `ALLOW` the origin before it was the DSE origin and
	// has not reverted this decision.
	PRESERVE_ALLOW = 1,
	// The user has previously `BLOCKED` the origin but has allowed it after it
	// became the DSE origin. Resolve the conflict by setting it to `ASK` so the
	// user will make a decision again.
	CONFLICT_ASK = 2,
	// The user has blocked the DSE origin and has not made a previous decision
	// before the origin became the DSE origin.
	PRESERVE_BLOCK_ASK = 3,
	// The user has blocked the DSE origin and has `ALLOWED` it before it became
	// the DSE origin, preserve the latest decision.
	PRESERVE_BLOCK_ALLOW = 4,
	// The user has blocked the DSE origin and has `BLOCKED` it before it became
	// the DSE origin as well.
	PRESERVE_BLOCK_BLOCK = 5,
	// There has been an invalid transition.
	INVALID_END_STATE = 6,

	// Always keep at the end.
	kMaxValue = INVALID_END_STATE,
	};

	// This enum backs up the 'PermissionPredictionSource` histogram enum. It
	// indicates whether the permission prediction was done by the local on device
	// model or by the server side model.
	enum class PermissionPredictionSource {
	ON_DEVICE = 0,
	SERVER_SIDE = 1,

	// Always keep at the end.
	kMaxValue = SERVER_SIDE,
	};

	// Provides a convenient way of logging UMA for permission related operations.
	class PermissionUmaUtil {
	public:
	using PredictionGrantLikelihood =
	PermissionPrediction_Likelihood_DiscretizedLikelihood;

	static const char kPermissionsPromptShown[];
	static const char kPermissionsPromptShownGesture[];
	static const char kPermissionsPromptShownNoGesture[];
	static const char kPermissionsPromptAccepted[];
	static const char kPermissionsPromptAcceptedGesture[];
	static const char kPermissionsPromptAcceptedNoGesture[];
	static const char kPermissionsPromptAcceptedOnce[];
	static const char kPermissionsPromptAcceptedOnceGesture[];
	static const char kPermissionsPromptAcceptedOnceNoGesture[];
	static const char kPermissionsPromptDenied[];
	static const char kPermissionsPromptDeniedGesture[];
	static const char kPermissionsPromptDeniedNoGesture[];

	PermissionUmaUtil() = delete;
	PermissionUmaUtil(const PermissionUmaUtil&) = delete;
	PermissionUmaUtil& operator=(const PermissionUmaUtil&) = delete;

	static void PermissionRequested(ContentSettingsType permission,
	const GURL& requesting_origin);

	// Records the revocation UMA and UKM metrics for ContentSettingsTypes that
	// have user facing permission prompts. The passed in `permission` must be
	// such that PermissionUtil::IsPermission(permission) returns true.
	static void PermissionRevoked(ContentSettingsType permission,
	PermissionSourceUI source_ui,
	const GURL& revoked_origin,
	content::BrowserContext* browser_context);

	static void RecordEmbargoPromptSuppression(
	PermissionEmbargoStatus embargo_status);

	static void RecordEmbargoPromptSuppressionFromSource(
	PermissionStatusSource source);

	static void RecordEmbargoStatus(PermissionEmbargoStatus embargo_status);

	// UMA specifically for when permission prompts are shown. This should be
	// roughly equivalent to the metrics above, however it is
	// useful to have separate UMA to a few reasons:
	// - to account for, and get data on coalesced permission bubbles
	// - there are other types of permissions prompts (e.g. download limiting)
	// which don't go through PermissionContext
	// - the above metrics don't always add up (e.g. sum of
	// granted+denied+dismissed+ignored is not equal to requested), so it is
	// unclear from those metrics alone how many prompts are seen by users.
	static void PermissionPromptShown(
	const std::vector<PermissionRequest*>& requests);

	static void PermissionPromptResolved(
	const std::vector<PermissionRequest*>& requests,
	content::WebContents* web_contents,
	PermissionAction permission_action,
	base::TimeDelta time_to_decision,
	PermissionPromptDisposition ui_disposition,
	absl::optional<PermissionPromptDispositionReason> ui_reason,
	absl::optional<PredictionGrantLikelihood> predicted_grant_likelihood,
	absl::optional<bool> prediction_decision_held_back,
	bool did_show_prompt,
	bool did_click_manage,
	bool did_click_learn_more);

	static void RecordWithBatteryBucket(const std::string& histogram);

	static void RecordInfobarDetailsExpanded(bool expanded);

	static void RecordCrowdDenyDelayedPushNotification(base::TimeDelta delay);

	static void RecordCrowdDenyVersionAtAbuseCheckTime(
	const absl::optional<base::Version>& version);

	// Record UMAs related to the Android "Missing permissions" infobar.
	static void RecordMissingPermissionInfobarShouldShow(
	bool should_show,
	const std::vector<ContentSettingsType>& content_settings_types);
	static void RecordMissingPermissionInfobarAction(
	PermissionAction action,
	const std::vector<ContentSettingsType>& content_settings_types);

	static void RecordPermissionUsage(ContentSettingsType permission_type,
	content::BrowserContext* browser_context,
	content::WebContents* web_contents,
	const GURL& requesting_origin);

	static void RecordTimeElapsedBetweenGrantAndUse(ContentSettingsType type,
	base::TimeDelta delta);

	static void RecordTimeElapsedBetweenGrantAndRevoke(ContentSettingsType type,
	base::TimeDelta delta);

	static void RecordAutoDSEPermissionReverted(
	ContentSettingsType permission_type,
	ContentSetting backed_up_setting,
	ContentSetting effective_setting,
	ContentSetting end_state_setting);

	static void RecordDSEEffectiveSetting(ContentSettingsType permission_type,
	ContentSetting setting);

	static void RecordPermissionPredictionSource(
	PermissionPredictionSource prediction_type);

	static void RecordPermissionPredictionServiceHoldback(
	RequestType request_type,
	bool is_on_device,
	bool is_heldback);

	static std::string GetPermissionActionString(
	PermissionAction permission_action);

	static std::string GetPromptDispositionString(
	PermissionPromptDisposition ui_disposition);

	static std::string GetPromptDispositionReasonString(
	PermissionPromptDispositionReason ui_disposition_reason);

	static std::string GetRequestTypeString(RequestType request_type);

	static bool IsPromptDispositionQuiet(
	PermissionPromptDisposition prompt_disposition);

	static bool IsPromptDispositionLoud(
	PermissionPromptDisposition prompt_disposition);

	// A scoped class that will check the current resolved content setting on
	// construction and report a revocation metric accordingly if the revocation
	// condition is met (from ALLOW to something else).
	class ScopedRevocationReporter {
	public:
	ScopedRevocationReporter(content::BrowserContext* browser_context,
	const GURL& primary_url,
	const GURL& secondary_url,
	ContentSettingsType content_type,
	PermissionSourceUI source_ui);

	ScopedRevocationReporter(content::BrowserContext* browser_context,
	const ContentSettingsPattern& primary_pattern,
	const ContentSettingsPattern& secondary_pattern,
	ContentSettingsType content_type,
	PermissionSourceUI source_ui);

	~ScopedRevocationReporter();

	private:
	raw_ptr<content::BrowserContext> browser_context_;
	const GURL primary_url_;
	const GURL secondary_url_;
	ContentSettingsType content_type_;
	PermissionSourceUI source_ui_;
	bool is_initially_allowed_;
	base::Time last_modified_date_;
	};

	private:
	friend class PermissionUmaUtilTest;

	// Records UMA and UKM metrics for ContentSettingsTypes that have user facing
	// permission prompts. The passed in `permission` must be such that
	// PermissionUtil::IsPermission(permission) returns true.
	// web_contents may be null when for recording non-prompt actions.
	static void RecordPermissionAction(
	ContentSettingsType permission,
	PermissionAction action,
	PermissionSourceUI source_ui,
	PermissionRequestGestureType gesture_type,
	base::TimeDelta time_to_decision,
	PermissionPromptDisposition ui_disposition,
	absl::optional<PermissionPromptDispositionReason> ui_reason,
	const GURL& requesting_origin,
	content::WebContents* web_contents,
	content::BrowserContext* browser_context,
	absl::optional<PredictionGrantLikelihood> predicted_grant_likelihood,
	absl::optional<bool> prediction_decision_held_back);

	// Records \|count\| total prior actions for a prompt of type \|permission\|
	// for a single origin using \|prefix\| for the metric.
	static void RecordPermissionPromptPriorCount(ContentSettingsType permission,
	const std::string& prefix,
	int count);

	static void RecordPromptDecided(
	const std::vector<PermissionRequest*>& requests,
	bool accepted,
	bool is_one_time);
	};

	} // namespace permissions

	#endif // COMPONENTS_PERMISSIONS_PERMISSION_UMA_UTIL_H_