Log metrics for the Location Settings Dialog prompt for geolocation.

chrome/browser/geolocation/geolocation_permission_context_unittest.cc

 // Copyright (c) 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.h"
 
 #include <stddef.h>
 
 #include <set>
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/containers/hash_tables.h"
 #include "base/gtest_prod_util.h"
 #include "base/id_map.h"
 #include "base/memory/ptr_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/synchronization/waitable_event.h"
+#include "base/test/histogram_tester.h"
 #include "base/test/scoped_feature_list.h"
 #include "base/test/simple_test_clock.h"
 #include "base/time/clock.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/content_settings/host_content_settings_map_factory.h"
 #include "chrome/browser/content_settings/tab_specific_content_settings.h"
 #include "chrome/browser/infobars/infobar_service.h"
 #include "chrome/browser/permissions/permission_context_base.h"
 #include "chrome/browser/permissions/permission_manager.h"
 #include "chrome/browser/permissions/permission_request.h"
@@ skipping 581 matching lines @@
   ConfirmInfoBarDelegate* infobar_delegate =
       infobar_service()->infobar_at(0)->delegate()->AsConfirmInfoBarDelegate();
   ASSERT_TRUE(infobar_delegate);
   infobar_delegate->Accept();
   CheckTabContentsState(requesting_frame, CONTENT_SETTING_ALLOW);
   CheckPermissionMessageSent(0, true);
   EXPECT_FALSE(MockLocationSettings::HasShownLocationSettingsDialog());
 }
 
 TEST_F(GeolocationPermissionContextTests, SystemLocationOffLSDAccept) {
+  base::HistogramTester tester;
   base::test::ScopedFeatureList scoped_feature_list;
   scoped_feature_list.InitAndEnableFeature(features::kLsdPermissionPrompt);
 
   GURL requesting_frame("https://www.example.com/geolocation");
   NavigateAndCommit(requesting_frame);
   MockLocationSettings::SetLocationStatus(true /* android */,
                                           false /* system */);
   MockLocationSettings::SetLocationSettingsDialogStatus(true /* enabled */,
                                                         GRANTED);
   EXPECT_EQ(0U, infobar_service()->infobar_count());
   RequestGeolocationPermission(web_contents(), RequestID(0), requesting_frame,
                                true);
   EXPECT_EQ(1U, infobar_service()->infobar_count());
   ConfirmInfoBarDelegate* infobar_delegate =
       infobar_service()->infobar_at(0)->delegate()->AsConfirmInfoBarDelegate();
   ASSERT_TRUE(infobar_delegate);
   infobar_delegate->Accept();
   CheckTabContentsState(requesting_frame, CONTENT_SETTING_ALLOW);
   CheckPermissionMessageSent(0, true);
   EXPECT_TRUE(MockLocationSettings::HasShownLocationSettingsDialog());
+
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.NonDSE", 1);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.AcceptEvent.NonDSE", 1);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.DenyEvent.NonDSE", 0);
 }
 
 TEST_F(GeolocationPermissionContextTests, SystemLocationOffLSDReject) {
+  base::HistogramTester tester;
   base::test::ScopedFeatureList scoped_feature_list;
   scoped_feature_list.InitAndEnableFeature(features::kLsdPermissionPrompt);
 
   GURL requesting_frame("https://www.example.com/geolocation");
   NavigateAndCommit(requesting_frame);
   MockLocationSettings::SetLocationStatus(true /* android */,
                                           false /* system */);
   MockLocationSettings::SetLocationSettingsDialogStatus(true /* enabled */,
                                                         DENIED);
   EXPECT_EQ(0U, infobar_service()->infobar_count());
   RequestGeolocationPermission(web_contents(), RequestID(0), requesting_frame,
                                true);
   EXPECT_EQ(1U, infobar_service()->infobar_count());
   ConfirmInfoBarDelegate* infobar_delegate =
       infobar_service()->infobar_at(0)->delegate()->AsConfirmInfoBarDelegate();
   ASSERT_TRUE(infobar_delegate);
   infobar_delegate->Accept();
   CheckTabContentsState(requesting_frame, CONTENT_SETTING_BLOCK);
   CheckPermissionMessageSent(0, false);
   EXPECT_TRUE(MockLocationSettings::HasShownLocationSettingsDialog());
+
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.NonDSE", 1);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.AcceptEvent.NonDSE", 0);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.DenyEvent.NonDSE", 1);
 }
 
 TEST_F(GeolocationPermissionContextTests, LSDBackOffDifferentSites) {
+  base::HistogramTester tester;
   base::test::ScopedFeatureList scoped_feature_list;
   scoped_feature_list.InitAndEnableFeature(features::kLsdPermissionPrompt);
 
   GURL requesting_frame_1("https://www.example.com/geolocation");
   GURL requesting_frame_2("https://www.example-2.com/geolocation");
   const char* requesting_frame_dse_ptr = "https://www.dse.com/geolocation";
   GURL requesting_frame_dse(requesting_frame_dse_ptr);
 
   SetDSEOriginForTesting(requesting_frame_dse_ptr);
 
@@ skipping 16 matching lines @@
   // origins share the same backoff, which is distinct to the DSE origin.
   // First, cancel a LSD prompt on the first non-DSE origin to go into backoff.
   EXPECT_TRUE(RequestPermissionIsLSDShown(requesting_frame_1));
 
   // Now check that the LSD is prevented on this origin.
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame_1));
 
   // Now ask on the other non-DSE origin and check backoff prevented the prompt.
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame_2));
 
+  // Test that the right histograms are updated.
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.NonDSE", 1);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.DSE", 0);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.SuppressEvent.NonDSE", 2);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.SuppressEvent.DSE", 0);
+
   // Now request on the DSE and check that the LSD is shown, as the non-DSE
   // backoff should not apply.
   EXPECT_TRUE(RequestPermissionIsLSDShown(requesting_frame_dse));
 
   // Now check that the DSE is in backoff.
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame_dse));
+
+  // Test that the right histograms are updated.
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.NonDSE", 1);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.DSE", 1);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.SuppressEvent.NonDSE", 2);
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.SuppressEvent.DSE", 1);
 }
 
 TEST_F(GeolocationPermissionContextTests, LSDBackOffTiming) {
+  base::HistogramTester tester;
   base::test::ScopedFeatureList scoped_feature_list;
   scoped_feature_list.InitAndEnableFeature(features::kLsdPermissionPrompt);
 
   GURL requesting_frame("https://www.example.com/geolocation");
   SetGeolocationContentSetting(requesting_frame, requesting_frame,
                                CONTENT_SETTING_ALLOW);
 
   // Turn off system location but allow the LSD to be shown, and denied.
   MockLocationSettings::SetLocationStatus(true /* android */,
                                           false /* system */);
   MockLocationSettings::SetLocationSettingsDialogStatus(true /* enabled */,
                                                         DENIED);
 
   // First, cancel a LSD prompt on the first non-DSE origin to go into backoff.
   EXPECT_TRUE(RequestPermissionIsLSDShown(requesting_frame));
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame));
 
   // Check the LSD is prevented in 6 days time.
   AddDayOffsetForTesting(6);
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame));
 
+  // Check histograms so far.
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.NonDSE", 1);
+  tester.ExpectBucketCount("Geolocation.SettingsDialog.ShowEvent.NonDSE",
+                           static_cast<base::HistogramBase::Sample>(
+                               GeolocationPermissionContextAndroid::
+                                   LocationSettingsDialogBackOff::kNoBackOff),
+                           1);
+
   // Check it is shown in one more days time, but then not straight after..
   AddDayOffsetForTesting(1);
   EXPECT_TRUE(RequestPermissionIsLSDShown(requesting_frame));
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame));
 
   // Check that it isn't shown 29 days after that.
   AddDayOffsetForTesting(29);
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame));
 
+  // Check histograms so far.
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.NonDSE", 2);
+  tester.ExpectBucketCount("Geolocation.SettingsDialog.ShowEvent.NonDSE",
+                           static_cast<base::HistogramBase::Sample>(
+                               GeolocationPermissionContextAndroid::
+                                   LocationSettingsDialogBackOff::kOneWeek),
+                           1);
+
   // Check it is shown in one more days time, but then not straight after..
   AddDayOffsetForTesting(1);
   EXPECT_TRUE(RequestPermissionIsLSDShown(requesting_frame));
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame));
 
   // Check that it isn't shown 89 days after that.
   AddDayOffsetForTesting(89);
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame));
 
+  // Check histograms so far.
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.NonDSE", 3);
+  tester.ExpectBucketCount("Geolocation.SettingsDialog.ShowEvent.NonDSE",
+                           static_cast<base::HistogramBase::Sample>(
+                               GeolocationPermissionContextAndroid::
+                                   LocationSettingsDialogBackOff::kOneMonth),
+                           1);
+
   // Check it is shown in one more days time, but then not straight after..
   AddDayOffsetForTesting(1);
   EXPECT_TRUE(RequestPermissionIsLSDShown(requesting_frame));
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame));
 
   // Check that it isn't shown 89 days after that.
   AddDayOffsetForTesting(89);
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame));
 
   // Check it is shown in one more days time, but then not straight after..
   AddDayOffsetForTesting(1);
   EXPECT_TRUE(RequestPermissionIsLSDShown(requesting_frame));
   EXPECT_FALSE(RequestPermissionIsLSDShown(requesting_frame));
+
+  // Check histograms so far.
+  tester.ExpectTotalCount("Geolocation.SettingsDialog.ShowEvent.NonDSE", 5);
+  tester.ExpectBucketCount("Geolocation.SettingsDialog.ShowEvent.NonDSE",
+                           static_cast<base::HistogramBase::Sample>(
+                               GeolocationPermissionContextAndroid::
+                                   LocationSettingsDialogBackOff::kThreeMonths),
+                           2);
 }
 
 TEST_F(GeolocationPermissionContextTests, LSDBackOffPermissionStatus) {
   base::test::ScopedFeatureList scoped_feature_list;
   scoped_feature_list.InitAndEnableFeature(features::kLsdPermissionPrompt);
 
   GURL requesting_frame("https://www.example.com/geolocation");
   SetGeolocationContentSetting(requesting_frame, requesting_frame,
                                CONTENT_SETTING_ALLOW);
 
@@ skipping 671 matching lines @@
   SetGeolocationContentSetting(requesting_frame, requesting_frame,
                                CONTENT_SETTING_BLOCK);
   MockLocationSettings::SetLocationSettingsDialogStatus(true /* enabled */,
                                                         GRANTED);
   ASSERT_EQ(blink::mojom::PermissionStatus::DENIED,
             PermissionManager::Get(profile())->GetPermissionStatus(
                 content::PermissionType::GEOLOCATION, requesting_frame,
                 requesting_frame));
 }
 #endif  // defined(OS_ANDROID)