Add UMA for recording embargo reasons and autoblocker interactions.

chrome/browser/permissions/permission_context_base_unittest.cc

 // 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.
 
 #include "chrome/browser/permissions/permission_context_base.h"
 
 #include <map>
 #include <set>
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/feature_list.h"
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/metrics/field_trial.h"
 #include "base/run_loop.h"
 #include "base/test/histogram_tester.h"
 #include "base/test/mock_entropy_provider.h"
 #include "base/test/scoped_feature_list.h"
 #include "build/build_config.h"
 #include "chrome/browser/content_settings/host_content_settings_map_factory.h"
 #include "chrome/browser/infobars/infobar_service.h"
 #include "chrome/browser/permissions/permission_decision_auto_blocker.h"
 #include "chrome/browser/permissions/permission_queue_controller.h"
 #include "chrome/browser/permissions/permission_request_id.h"
+#include "chrome/browser/permissions/permission_uma_util.h"
 #include "chrome/browser/permissions/permission_util.h"
 #include "chrome/common/chrome_features.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/test/base/chrome_render_view_host_test_harness.h"
 #include "chrome/test/base/testing_profile.h"
 #include "components/content_settings/core/browser/host_content_settings_map.h"
 #include "components/content_settings/core/common/content_settings.h"
 #include "components/content_settings/core/common/content_settings_types.h"
 #include "components/safe_browsing_db/database_manager.h"
 #include "components/safe_browsing_db/test_database_manager.h"
@@ skipping 311 matching lines @@
           base::Bind(&TestPermissionContext::TrackPermissionDecision,
                     base::Unretained(&permission_context)));
       histograms.ExpectTotalCount(
           "Permissions.Prompt.Dismissed.PriorDismissCount." +
               PermissionUtil::GetPermissionString(permission_type),
           i + 1);
       histograms.ExpectBucketCount(
           "Permissions.Prompt.Dismissed.PriorDismissCount." +
               PermissionUtil::GetPermissionString(permission_type),
           i, 1);
+      histograms.ExpectTotalCount("Permissions.AutoBlocker.EmbargoReason",
+                                  i + 1);
+      if (i < 2) {
+        histograms.ExpectUniqueSample("Permissions.AutoBlocker.EmbargoReason",
+                                      PermissionEmbargoReason::NOT_EMBARGOED,
+                                      i + 1);
+      } else {
+        histograms.ExpectBucketCount(
+            "Permissions.AutoBlocker.EmbargoReason",
+            PermissionEmbargoReason::REPEATED_DISMISSALS, 1);
+      }
+
       ASSERT_EQ(1u, permission_context.decisions().size());
       EXPECT_EQ(expected, permission_context.decisions()[0]);
       EXPECT_TRUE(permission_context.tab_context_updated());
       EXPECT_EQ(expected, permission_context.GetPermissionStatus(url, url));
     }
 
     TestPermissionContext permission_context(profile(), permission_type,
                                              content_settings_type);
     const PermissionRequestID id(
         web_contents()->GetRenderProcessHost()->GetID(),
@@ skipping 34 matching lines @@
                      false, CONTENT_SETTING_ASK));
       permission_context.RequestPermission(
           web_contents(), id, url, true /* user_gesture */,
           base::Bind(&TestPermissionContext::TrackPermissionDecision,
                     base::Unretained(&permission_context)));
       histograms.ExpectTotalCount(
           "Permissions.Prompt.Dismissed.PriorDismissCount.Geolocation",
           i + 1);
       histograms.ExpectBucketCount(
           "Permissions.Prompt.Dismissed.PriorDismissCount.Geolocation", i, 1);
+      histograms.ExpectUniqueSample("Permissions.AutoBlocker.EmbargoReason",
+                                    PermissionEmbargoReason::NOT_EMBARGOED,
+                                    i + 1);
+
       ASSERT_EQ(1u, permission_context.decisions().size());
       EXPECT_EQ(CONTENT_SETTING_ASK, permission_context.decisions()[0]);
       EXPECT_TRUE(permission_context.tab_context_updated());
       EXPECT_EQ(CONTENT_SETTING_ASK,
                 permission_context.GetContentSettingFromMap(url, url));
     }
 
     // Flush the dismissal counts. Enable the block on too many dismissals
     // feature, which is disabled by default.
     auto* map = HostContentSettingsMapFactory::GetForProfile(profile());
@@ skipping 70 matching lines @@
 
       EXPECT_EQ(1u, permission_context.decisions().size());
       ASSERT_EQ(expected, permission_context.decisions()[0]);
       EXPECT_TRUE(permission_context.tab_context_updated());
       EXPECT_EQ(expected, permission_context.GetPermissionStatus(url, url));
 
       histograms.ExpectTotalCount(
           "Permissions.Prompt.Dismissed.PriorDismissCount.MidiSysEx", i + 1);
       histograms.ExpectBucketCount(
           "Permissions.Prompt.Dismissed.PriorDismissCount.MidiSysEx", i, 1);
+
+      histograms.ExpectTotalCount("Permissions.AutoBlocker.EmbargoReason",
+                                  i + 1);
+      if (i < 4) {
+        histograms.ExpectUniqueSample("Permissions.AutoBlocker.EmbargoReason",
+                                      PermissionEmbargoReason::NOT_EMBARGOED,
+                                      i + 1);
+      } else {
+        histograms.ExpectBucketCount(
+            "Permissions.AutoBlocker.EmbargoReason",
+            PermissionEmbargoReason::REPEATED_DISMISSALS, 1);
+      }
     }
 
     // Ensure that we finish in the block state.
     TestPermissionContext permission_context(
         profile(), content::PermissionType::MIDI_SYSEX,
         CONTENT_SETTINGS_TYPE_MIDI_SYSEX);
     EXPECT_EQ(CONTENT_SETTING_BLOCK,
               permission_context.GetPermissionStatus(url, url));
     variations::testing::ClearAllVariationParams();
   }
@@ skipping 126 matching lines @@
 
     EXPECT_EQ(response, permission_context.GetContentSettingFromMap(url, url));
   }
 
   void TestPermissionsBlacklisting(
       content::PermissionType permission_type,
       ContentSettingsType content_settings_type,
       scoped_refptr<safe_browsing::SafeBrowsingDatabaseManager> db_manager,
       const GURL& url,
       int timeout,
-      ContentSetting expected_permission_status) {
+      ContentSetting expected_permission_status,
+      PermissionEmbargoReason expected_embargo_reason) {
     NavigateAndCommit(url);
+    base::HistogramTester histograms;
     base::test::ScopedFeatureList scoped_feature_list;
     scoped_feature_list.InitAndEnableFeature(features::kPermissionsBlacklist);
     TestPermissionContext permission_context(profile(), permission_type,
                                              content_settings_type);
     PermissionDecisionAutoBlocker::GetForProfile(profile())
         ->SetSafeBrowsingDatabaseManagerAndTimeoutForTesting(db_manager,
                                                              timeout);
     const PermissionRequestID id(
         web_contents()->GetRenderProcessHost()->GetID(),
         web_contents()->GetMainFrame()->GetRoutingID(), -1);
@@ skipping 12 matching lines @@
         web_contents(), id, url, true /* user_gesture */,
         base::Bind(&TestPermissionContext::TrackPermissionDecision,
                    base::Unretained(&permission_context)));
     EXPECT_EQ(expected_permission_status,
               permission_context.GetPermissionStatus(url, url));
 
     if (expected_permission_status == CONTENT_SETTING_ALLOW) {
       ASSERT_EQ(1u, permission_context.decisions().size());
       EXPECT_EQ(expected_permission_status, permission_context.decisions()[0]);
     }
+    histograms.ExpectUniqueSample("Permissions.AutoBlocker.EmbargoReason",
+                                  expected_embargo_reason, 1);
   }
 
  private:
   // ChromeRenderViewHostTestHarness:
   void SetUp() override {
     ChromeRenderViewHostTestHarness::SetUp();
 #if defined(OS_ANDROID)
     InfoBarService::CreateForWebContents(web_contents());
 #else
     PermissionRequestManager::CreateForWebContents(web_contents());
@@ skipping 147 matching lines @@
 // Tests a blacklisted (URL, permission) pair has had its permission request
 // blocked.
 TEST_F(PermissionContextBaseTests, TestPermissionsBlacklistingBlocked) {
   scoped_refptr<MockSafeBrowsingDatabaseManager> db_manager =
       new MockSafeBrowsingDatabaseManager(true /* perform_callback */);
   const GURL url("https://www.example.com");
   std::set<std::string> blacklisted_permissions{"GEOLOCATION"};
   db_manager->BlacklistUrlPermissions(url, blacklisted_permissions);
   TestPermissionsBlacklisting(content::PermissionType::GEOLOCATION,
                               CONTENT_SETTINGS_TYPE_GEOLOCATION, db_manager,
-                              url, 2000 /* timeout */, CONTENT_SETTING_BLOCK);
+                              url, 2000 /* timeout */, CONTENT_SETTING_BLOCK,
+                              PermissionEmbargoReason::BLACKLISTED);
 }
 
 // Tests that a URL that is blacklisted for one permission can still request
 // another and grant another.
 TEST_F(PermissionContextBaseTests, TestPermissionsBlacklistingAllowed) {
   scoped_refptr<MockSafeBrowsingDatabaseManager> db_manager =
       new MockSafeBrowsingDatabaseManager(true /* perform_callback */);
   const GURL url("https://www.example.com");
   std::set<std::string> blacklisted_permissions{"GEOLOCATION"};
   db_manager->BlacklistUrlPermissions(url, blacklisted_permissions);
   TestPermissionsBlacklisting(content::PermissionType::NOTIFICATIONS,
                               CONTENT_SETTINGS_TYPE_NOTIFICATIONS, db_manager,
-                              url, 2000 /* timeout */, CONTENT_SETTING_ALLOW);
+                              url, 2000 /* timeout */, CONTENT_SETTING_ALLOW,
+                              PermissionEmbargoReason::NOT_EMBARGOED);
 }

[raymes, 2017/02/08 23:20:09]

Are we testing that NOT_EMBARGOED will be recorded when the prompt is
allowed/blocked/ignored? Is that hard to test?

[meredithl, 2017/02/09 00:15:37]

Not at all. I've added a histogram check into TestAskAndDecide to check that
only NOT_EMBARGOED is recorded, and that test is only called for the
allow/block/ignore content settings.