Log metrics for the Location Settings Dialog prompt for geolocation.

chrome/browser/geolocation/geolocation_permission_context_android.cc

 // Copyright 2012 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.
 
 #include "chrome/browser/geolocation/geolocation_permission_context_android.h"
 
 #include <utility>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/feature_list.h"
+#include "base/metrics/histogram_functions.h"
 #include "chrome/browser/android/location_settings.h"
 #include "chrome/browser/android/location_settings_impl.h"
 #include "chrome/browser/android/search_geolocation/search_geolocation_disclosure_tab_helper.h"
 #include "chrome/browser/android/search_geolocation/search_geolocation_service.h"
 #include "chrome/browser/permissions/permission_request_id.h"
 #include "chrome/browser/permissions/permission_update_infobar_delegate_android.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
 #include "chrome/common/chrome_features.h"
 #include "chrome/common/pref_names.h"
 #include "components/infobars/core/infobar.h"
 #include "components/prefs/pref_registry_simple.h"
 #include "components/prefs/pref_service.h"
 #include "components/search_engines/template_url.h"
 #include "components/search_engines/template_url_service.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/web_contents.h"
 #include "url/gurl.h"
 
 namespace {
 
 int g_day_offset_for_testing = 0;
+const char* g_dse_origin_for_testing = nullptr;
 
-const char* g_dse_origin_for_testing = nullptr;
+const char kLocationSettingsShowMetricBase[] =
+    "Geolocation.SettingsDialog.ShowEvent.";
+const char kLocationSettingsSuppressMetricBase[] =
+    "Geolocation.SettingsDialog.SuppressEvent.";
+const char kLocationSettingsAcceptMetricBase[] =
+    "Geolocation.SettingsDialog.AcceptEvent.";
+const char kLocationSettingsDenyMetricBase[] =
+    "Geolocation.SettingsDialog.DenyEvent.";
+
+const char kLocationSettingsMetricDSESuffix[] = "DSE";
+const char kLocationSettingsMetricNonDSESuffix[] = "NonDSE";
 
 base::Time GetTimeNow() {
   return base::Time::Now() +
          base::TimeDelta::FromDays(g_day_offset_for_testing);
 }
 
+void LogLocationSettingsMetric(
+    const std::string& metric_base,
+    bool is_default_search,
+    GeolocationPermissionContextAndroid::LocationSettingsDialogBackOff
+        backoff) {
+  std::string metric_name = metric_base;
+  if (is_default_search)
+    metric_name.append(kLocationSettingsMetricDSESuffix);
+  else
+    metric_name.append(kLocationSettingsMetricNonDSESuffix);
+
+  base::UmaHistogramEnumeration(metric_name, backoff,
+                                GeolocationPermissionContextAndroid::
+                                    LocationSettingsDialogBackOff::kCount);
+}
+
 }  // namespace
 
 // static
 void GeolocationPermissionContextAndroid::RegisterProfilePrefs(
     PrefRegistrySimple* registry) {
   registry->RegisterIntegerPref(prefs::kLocationSettingsBackoffLevelDSE, 0);
   registry->RegisterIntegerPref(prefs::kLocationSettingsBackoffLevelDefault, 0);
   registry->RegisterInt64Pref(prefs::kLocationSettingsNextShowDSE, 0);
   registry->RegisterInt64Pref(prefs::kLocationSettingsNextShowDefault, 0);
 }
@@ skipping 113 matching lines @@
 }
 
 void GeolocationPermissionContextAndroid::UserMadePermissionDecision(
     const PermissionRequestID& id,
     const GURL& requesting_origin,
     const GURL& embedding_origin,
     ContentSetting content_setting) {
   // If the user has accepted geolocation, reset the location settings dialog
   // backoff.
   if (content_setting == CONTENT_SETTING_ALLOW)
-    ResetLocationSettingsBackOff(requesting_origin);
+    ResetLocationSettingsBackOff(IsRequestingOriginDSE(requesting_origin));
 }
 
 void GeolocationPermissionContextAndroid::NotifyPermissionSet(
     const PermissionRequestID& id,
     const GURL& requesting_origin,
     const GURL& embedding_origin,
     const BrowserPermissionCallback& callback,
     bool persist,
     ContentSetting content_setting) {
+  bool is_default_search = IsRequestingOriginDSE(requesting_origin);
   if (content_setting == CONTENT_SETTING_ALLOW &&
       !location_settings_->IsSystemLocationSettingEnabled()) {
     // There is no need to check CanShowLocationSettingsDialog here again, as it
     // must have been checked to get this far. But, the backoff will not have
     // been checked, so check that. Backoff isn't checked earlier because if the
     // content setting is ASK the backoff should be ignored. However if we get
     // here and the content setting was ASK, the user must have accepted which
     // would reset the backoff.
-    if (IsInLocationSettingsBackOff(requesting_origin)) {
+    if (IsInLocationSettingsBackOff(is_default_search)) {
       FinishNotifyPermissionSet(id, requesting_origin, embedding_origin,
                                 callback, false /* persist */,
                                 CONTENT_SETTING_BLOCK);
+      LogLocationSettingsMetric(
+          kLocationSettingsSuppressMetricBase, is_default_search,
+          LocationSettingsBackOffLevel(is_default_search));
       return;
     }
 
+    LogLocationSettingsMetric(kLocationSettingsShowMetricBase,
+                              is_default_search,
+                              LocationSettingsBackOffLevel(is_default_search));
     content::WebContents* web_contents =
         content::WebContents::FromRenderFrameHost(
             content::RenderFrameHost::FromID(id.render_process_id(),
                                              id.render_frame_id()));
     location_settings_->PromptToEnableSystemLocationSetting(
-        IsRequestingOriginDSE(requesting_origin) ? SEARCH : DEFAULT,
-        web_contents,
+        is_default_search ? SEARCH : DEFAULT, web_contents,
         base::BindOnce(
             &GeolocationPermissionContextAndroid::OnLocationSettingsDialogShown,
             weak_factory_.GetWeakPtr(), id, requesting_origin, embedding_origin,
             callback, persist, content_setting));
     return;
   }
 
   FinishNotifyPermissionSet(id, requesting_origin, embedding_origin, callback,
                             persist, content_setting);
 }
@@ skipping 34 matching lines @@
       result.content_setting = CONTENT_SETTING_ASK;
       result.source = PermissionStatusSource::UNSPECIFIED;
     }
   }
 
   return result;
 }
 
 std::string
 GeolocationPermissionContextAndroid::GetLocationSettingsBackOffLevelPref(
-    const GURL& requesting_origin) const {
-  if (IsRequestingOriginDSE(requesting_origin))
-    return prefs::kLocationSettingsBackoffLevelDSE;
-
-  return prefs::kLocationSettingsBackoffLevelDefault;
+    bool is_default_search) const {
+  return is_default_search ? prefs::kLocationSettingsBackoffLevelDSE
+                           : prefs::kLocationSettingsBackoffLevelDefault;
 }
 
 std::string
 GeolocationPermissionContextAndroid::GetLocationSettingsNextShowPref(
-    const GURL& requesting_origin) const {
-  if (IsRequestingOriginDSE(requesting_origin))
-    return prefs::kLocationSettingsNextShowDSE;
-
-  return prefs::kLocationSettingsNextShowDefault;
+    bool is_default_search) const {
+  return is_default_search ? prefs::kLocationSettingsNextShowDSE
+                           : prefs::kLocationSettingsNextShowDefault;
 }
 
 bool GeolocationPermissionContextAndroid::IsInLocationSettingsBackOff(
-    const GURL& requesting_origin) const {
+    bool is_default_search) const {
   base::Time next_show =
       base::Time::FromInternalValue(profile()->GetPrefs()->GetInt64(
-          GetLocationSettingsNextShowPref(requesting_origin)));
+          GetLocationSettingsNextShowPref(is_default_search)));
 
   return GetTimeNow() < next_show;
 }
 
 void GeolocationPermissionContextAndroid::ResetLocationSettingsBackOff(
-    const GURL& requesting_origin) {
+    bool is_default_search) {
   PrefService* prefs = profile()->GetPrefs();
-  prefs->ClearPref(GetLocationSettingsNextShowPref(requesting_origin));
-  prefs->ClearPref(GetLocationSettingsBackOffLevelPref(requesting_origin));
+  prefs->ClearPref(GetLocationSettingsNextShowPref(is_default_search));
+  prefs->ClearPref(GetLocationSettingsBackOffLevelPref(is_default_search));
 }
 
 void GeolocationPermissionContextAndroid::UpdateLocationSettingsBackOff(
-    const GURL& requesting_origin) {
-  // Backoff levels:
-  // 0: 1 week
-  // 1: 1 month
-  // 2: 3 months
-  PrefService* prefs = profile()->GetPrefs();
-  int backoff_level =
-      prefs->GetInteger(GetLocationSettingsBackOffLevelPref(requesting_origin));
+    bool is_default_search) {
+  LocationSettingsDialogBackOff backoff_level =
+      LocationSettingsBackOffLevel(is_default_search);
 
   base::Time next_show = GetTimeNow();
   switch (backoff_level) {
-    case 0:
+    case LocationSettingsDialogBackOff::kNoBackOff:
+      backoff_level = LocationSettingsDialogBackOff::kOneWeek;
       next_show += base::TimeDelta::FromDays(7);
       break;
-    case 1:
+    case LocationSettingsDialogBackOff::kOneWeek:
+      backoff_level = LocationSettingsDialogBackOff::kOneMonth;
       next_show += base::TimeDelta::FromDays(30);
       break;
+    case LocationSettingsDialogBackOff::kOneMonth:
+      backoff_level = LocationSettingsDialogBackOff::kThreeMonths;
+    // fall through

[raymes, 2017/04/04 22:35:36]

nit: // Fall through.
I'd tend to write the longhand here with repetition but I'll leave it up to you
:)

+    case LocationSettingsDialogBackOff::kThreeMonths:
+      next_show += base::TimeDelta::FromDays(90);
+      break;
     default:
-      next_show += base::TimeDelta::FromDays(90);
+      NOTREACHED();
   }
 
-  if (backoff_level < 2)
-    backoff_level++;
+  PrefService* prefs = profile()->GetPrefs();
+  prefs->SetInteger(GetLocationSettingsBackOffLevelPref(is_default_search),
+                    static_cast<int>(backoff_level));
+  prefs->SetInt64(GetLocationSettingsNextShowPref(is_default_search),
+                  next_show.ToInternalValue());
+}
 
-  prefs->SetInteger(GetLocationSettingsBackOffLevelPref(requesting_origin),
-                    backoff_level);
-  prefs->SetInt64(GetLocationSettingsNextShowPref(requesting_origin),
-                  next_show.ToInternalValue());
+GeolocationPermissionContextAndroid::LocationSettingsDialogBackOff
+GeolocationPermissionContextAndroid::LocationSettingsBackOffLevel(
+    bool is_default_search) const {
+  PrefService* prefs = profile()->GetPrefs();
+  int int_backoff =
+      prefs->GetInteger(GetLocationSettingsBackOffLevelPref(is_default_search));
+  return static_cast<LocationSettingsDialogBackOff>(int_backoff);
 }
 
 bool GeolocationPermissionContextAndroid::IsLocationAccessPossible(
     content::WebContents* web_contents,
     const GURL& requesting_origin,
     bool user_gesture) {
   return (location_settings_->HasAndroidLocationPermission() ||
           location_settings_->CanPromptForAndroidLocationPermission(
               web_contents)) &&
          (location_settings_->IsSystemLocationSettingEnabled() ||
@@ skipping 39 matching lines @@
                       false /* persist */, new_setting);
 }
 
 bool GeolocationPermissionContextAndroid::CanShowLocationSettingsDialog(
     const GURL& requesting_origin,
     bool user_gesture,
     bool ignore_backoff) const {
   if (!base::FeatureList::IsEnabled(features::kLsdPermissionPrompt))
     return false;
 
+  bool is_default_search = IsRequestingOriginDSE(requesting_origin);
   // If this isn't the default search engine, a gesture is needed.
-  if (!IsRequestingOriginDSE(requesting_origin) && !user_gesture) {
+  if (!is_default_search && !user_gesture) {
     return false;
   }
 
-  if (!ignore_backoff && IsInLocationSettingsBackOff(requesting_origin))
+  if (!ignore_backoff && IsInLocationSettingsBackOff(is_default_search))
     return false;
 
   return location_settings_->CanPromptToEnableSystemLocationSetting();
 }
 
 void GeolocationPermissionContextAndroid::OnLocationSettingsDialogShown(
     const PermissionRequestID& id,
     const GURL& requesting_origin,
     const GURL& embedding_origin,
     const BrowserPermissionCallback& callback,
     bool persist,
     ContentSetting content_setting,
     LocationSettingsDialogOutcome prompt_outcome) {
+  bool is_default_search = IsRequestingOriginDSE(requesting_origin);
   if (prompt_outcome == GRANTED) {
-    ResetLocationSettingsBackOff(requesting_origin);
+    LogLocationSettingsMetric(kLocationSettingsAcceptMetricBase,
+                              is_default_search,
+                              LocationSettingsBackOffLevel(is_default_search));
+    ResetLocationSettingsBackOff(is_default_search);
   } else {
-    UpdateLocationSettingsBackOff(requesting_origin);
+    LogLocationSettingsMetric(kLocationSettingsDenyMetricBase,
+                              is_default_search,
+                              LocationSettingsBackOffLevel(is_default_search));
+    UpdateLocationSettingsBackOff(is_default_search);
     content_setting = CONTENT_SETTING_BLOCK;
     persist = false;
   }
 
   FinishNotifyPermissionSet(id, requesting_origin, embedding_origin, callback,
                             persist, content_setting);
 }
 
 void GeolocationPermissionContextAndroid::FinishNotifyPermissionSet(
     const PermissionRequestID& id,
@@ skipping 22 matching lines @@
     // The tab helper can be null in tests.
     if (disclosure_helper)
       disclosure_helper->MaybeShowDisclosure(requesting_origin);
   }
 }
 
 void GeolocationPermissionContextAndroid::SetLocationSettingsForTesting(
     std::unique_ptr<LocationSettings> settings) {
   location_settings_ = std::move(settings);
 }