Add a feature which, when enabled, blocks permissions after X prompt dismissals.

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 <vector>
 
 #include "base/bind.h"
 #include "base/command_line.h"
+#include "base/feature_list.h"
 #include "base/macros.h"
 #include "base/metrics/field_trial.h"
+#include "base/test/histogram_tester.h"
 #include "base/test/mock_entropy_provider.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_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/variations/variations_associated_data.h"
 #include "content/public/browser/permission_type.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/test/mock_render_process_host.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 #if defined(OS_ANDROID)
 #include "chrome/browser/permissions/permission_queue_controller.h"
 #else
 #include "chrome/browser/permissions/permission_request_manager.h"
 #endif
 
 const char* kPermissionsKillSwitchFieldStudy =
     PermissionContextBase::kPermissionsKillSwitchFieldStudy;
 const char* kPermissionsKillSwitchBlockedValue =
     PermissionContextBase::kPermissionsKillSwitchBlockedValue;
 const char kPermissionsKillSwitchTestGroup[] = "TestGroup";
+const char* kPromptGroupName = kPermissionsKillSwitchTestGroup;
+const char kPromptTrialName[] = "PermissionPromptsUX";
 
 class TestPermissionContext : public PermissionContextBase {
  public:
   TestPermissionContext(Profile* profile,
                         const content::PermissionType permission_type,
                         const ContentSettingsType content_settings_type)
       : PermissionContextBase(profile, permission_type, content_settings_type),
-        tab_context_updated_(false),
-        field_trial_list_(
-            new base::FieldTrialList(new base::MockEntropyProvider)) {}
+        tab_context_updated_(false) {}
 
   ~TestPermissionContext() override {}
 
 #if defined(OS_ANDROID)
   PermissionQueueController* GetInfoBarController() {
     return GetQueueController();
   }
 #endif
 
   const std::vector<ContentSetting>& decisions() { return decisions_; }
 
   bool tab_context_updated() {
     return tab_context_updated_;
   }
 
   void TrackPermissionDecision(ContentSetting content_setting) {
     decisions_.push_back(content_setting);
   }
 
-  void ResetFieldTrialList() {
-    // Destroy the existing FieldTrialList before creating a new one to avoid
-    // a DCHECK.
-    field_trial_list_.reset();
-    field_trial_list_.reset(new base::FieldTrialList(
-        new base::MockEntropyProvider));
-    variations::testing::ClearAllVariationParams();
-  }
-
   ContentSetting GetContentSettingFromMap(const GURL& url_a,
                                           const GURL& url_b) {
     return HostContentSettingsMapFactory::GetForProfile(profile())
         ->GetContentSetting(url_a.GetOrigin(), url_b.GetOrigin(),
                             content_settings_type(), std::string());
   }
 
  protected:
   void UpdateTabContext(const PermissionRequestID& id,
                         const GURL& requesting_origin,
                         bool allowed) override {
     tab_context_updated_ = true;
   }
 
   bool IsRestrictedToSecureOrigins() const override {
     return false;
   }
 
  private:
   std::vector<ContentSetting> decisions_;
   bool tab_context_updated_;
+};
+
+class TestKillSwitchPermissionContext : public TestPermissionContext {
+ public:
+  TestKillSwitchPermissionContext(
+      Profile* profile,
+      const content::PermissionType permission_type,
+      const ContentSettingsType content_settings_type)
+      : TestPermissionContext(profile, permission_type, content_settings_type),
+        field_trial_list_(
+            new base::FieldTrialList(new base::MockEntropyProvider)) {}
+
+  void ResetFieldTrialList() {
+    // Destroy the existing FieldTrialList before creating a new one to avoid
+    // a DCHECK.
+    field_trial_list_.reset();
+    field_trial_list_.reset(new base::FieldTrialList(
+        new base::MockEntropyProvider));
+    variations::testing::ClearAllVariationParams();
+  }
+
+ private:
   std::unique_ptr<base::FieldTrialList> field_trial_list_;
 };
 
 class PermissionContextBaseTests : public ChromeRenderViewHostTestHarness {
  protected:
   PermissionContextBaseTests() {}
 
   // Accept or dismiss the permission bubble or infobar.
   void RespondToPermission(TestPermissionContext* context,
                            const PermissionRequestID& id,
@@ skipping 70 matching lines @@
                    base::Unretained(&permission_context)));
 
     RespondToPermission(&permission_context, id, url, CONTENT_SETTING_ASK);
     EXPECT_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));
   }
 
+  void DismissMultipleTimesAndExpectBlock(
+      const GURL& url,
+      content::PermissionType permission_type,
+      ContentSettingsType content_settings_type,
+      uint32_t iterations) {
+    base::HistogramTester histograms;
+
+    // Dismiss |iterations| times. The final dismiss should change the decision
+    // from dismiss to block, and hence change the persisted content setting.
+    for (uint32_t i = 0; i < iterations; ++i) {
+      TestPermissionContext permission_context(
+          profile(), permission_type, content_settings_type);
+      ContentSetting expected =
+          (i < (iterations - 1)) ? CONTENT_SETTING_ASK : CONTENT_SETTING_BLOCK;
+
+      const PermissionRequestID id(
+          web_contents()->GetRenderProcessHost()->GetID(),
+          web_contents()->GetMainFrame()->GetRoutingID(), i);
+      permission_context.RequestPermission(
+          web_contents(), id, url, true /* user_gesture */,
+          base::Bind(&TestPermissionContext::TrackPermissionDecision,
+                    base::Unretained(&permission_context)));
+
+      RespondToPermission(&permission_context, id, url, CONTENT_SETTING_ASK);
+      histograms.ExpectTotalCount(
+          "Permissions.Prompt.DismissCount." +
+              PermissionUtil::GetPermissionString(permission_type),
+          i + 1);
+
+      EXPECT_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.GetContentSettingFromMap(url, url));
+    }
+
+    // Ensure that we finish in the block state.
+    TestPermissionContext permission_context(
+        profile(), permission_type, content_settings_type);
+    EXPECT_EQ(CONTENT_SETTING_BLOCK,
+              permission_context.GetContentSettingFromMap(url, url));
+  }
+
+  void TestBlockOnSeveralDismissals_TestContent() {
+    GURL url("https://www.google.com");
+    NavigateAndCommit(url);
+    base::HistogramTester histograms;
+
+    // First, ensure that > 3 dismissals behaves correctly.
+    for (uint32_t i = 0; i < 4; ++i) {
+      TestPermissionContext permission_context(
+          profile(), content::PermissionType::GEOLOCATION,
+          CONTENT_SETTINGS_TYPE_GEOLOCATION);
+
+      const PermissionRequestID id(
+          web_contents()->GetRenderProcessHost()->GetID(),
+          web_contents()->GetMainFrame()->GetRoutingID(), i);
+      permission_context.RequestPermission(
+          web_contents(), id, url, true /* user_gesture */,
+          base::Bind(&TestPermissionContext::TrackPermissionDecision,
+                    base::Unretained(&permission_context)));
+
+      RespondToPermission(&permission_context, id, url, CONTENT_SETTING_ASK);
+      histograms.ExpectTotalCount("Permissions.Prompt.DismissCount.Geolocation",
+                                  i + 1);
+      EXPECT_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.
+    HostContentSettingsMapFactory::GetForProfile(profile())
+        ->ClearSettingsForOneType(
+            CONTENT_SETTINGS_TYPE_PROMPT_NO_DECISION_COUNT);
+
+    // Set up the custom parameter.
+    base::FieldTrialList field_trials_(nullptr);
+    base::FieldTrial* trial = base::FieldTrialList::CreateFieldTrial(
+        kPromptTrialName, kPromptGroupName);
+    base::FeatureList::ClearInstanceForTesting();

[Lei Zhang, 2016/09/27 21:57:51]

If you read the comments for ClearInstanceForTesting(), you should know not to
use it, because you leave the base::FeatureList global instance as a nullptr at
the end.

https://codereview.chromium.org/2373883002 changes this test to use a
base::test::ScopedFeatureList.

+    std::unique_ptr<base::FeatureList> feature_list(new base::FeatureList);
+    feature_list->RegisterFieldTrialOverride(
+        features::kBlockPromptsIfDismissedOften.name,
+        base::FeatureList::OVERRIDE_ENABLE_FEATURE, trial);
+    base::FeatureList::SetInstance(std::move(feature_list));
+    EXPECT_EQ(base::FeatureList::GetFieldTrial(
+                  features::kBlockPromptsIfDismissedOften),
+              trial);
+
+    EXPECT_TRUE(
+        base::FeatureList::IsEnabled(features::kBlockPromptsIfDismissedOften));
+
+    // Sanity check independence per permission type by checking two of them.
+    DismissMultipleTimesAndExpectBlock(url,
+                                       content::PermissionType::GEOLOCATION,
+                                       CONTENT_SETTINGS_TYPE_GEOLOCATION, 3);
+    DismissMultipleTimesAndExpectBlock(url,
+                                       content::PermissionType::NOTIFICATIONS,
+                                       CONTENT_SETTINGS_TYPE_NOTIFICATIONS, 3);
+    base::FeatureList::ClearInstanceForTesting();
+  }
+
+  void TestVariationBlockOnSeveralDismissals_TestContent() {
+    GURL url("https://www.google.com");
+    NavigateAndCommit(url);
+
+    // Set up the custom parameter and custom value.
+    base::FieldTrialList field_trials_(nullptr);
+    base::FieldTrial* trial = base::FieldTrialList::CreateFieldTrial(
+        kPromptTrialName, kPromptGroupName);
+    std::map<std::string, std::string> params;
+    params[PermissionDecisionAutoBlocker::kPromptDismissCountKey] = "5";
+    ASSERT_TRUE(variations::AssociateVariationParams(
+        kPromptTrialName, kPromptGroupName, params));
+
+    base::FeatureList::ClearInstanceForTesting();
+    std::unique_ptr<base::FeatureList> feature_list(new base::FeatureList);
+    feature_list->RegisterFieldTrialOverride(
+        features::kBlockPromptsIfDismissedOften.name,
+        base::FeatureList::OVERRIDE_ENABLE_FEATURE, trial);
+    base::FeatureList::SetInstance(std::move(feature_list));
+    EXPECT_EQ(base::FeatureList::GetFieldTrial(
+                  features::kBlockPromptsIfDismissedOften),
+              trial);
+
+    std::map<std::string, std::string> actualParams;
+    EXPECT_TRUE(variations::GetVariationParamsByFeature(
+        features::kBlockPromptsIfDismissedOften, &actualParams));
+    EXPECT_EQ(params, actualParams);
+
+    for (uint32_t i = 0; i < 5; ++i) {
+      TestPermissionContext permission_context(
+          profile(), content::PermissionType::MIDI_SYSEX,
+          CONTENT_SETTINGS_TYPE_MIDI_SYSEX);
+
+      ContentSetting expected =
+          (i < 4) ? CONTENT_SETTING_ASK : CONTENT_SETTING_BLOCK;
+      const PermissionRequestID id(
+          web_contents()->GetRenderProcessHost()->GetID(),
+          web_contents()->GetMainFrame()->GetRoutingID(), i);
+      permission_context.RequestPermission(
+          web_contents(), id, url, true /* user_gesture */,
+          base::Bind(&TestPermissionContext::TrackPermissionDecision,
+                    base::Unretained(&permission_context)));
+
+      RespondToPermission(&permission_context, id, url, CONTENT_SETTING_ASK);
+      EXPECT_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.GetContentSettingFromMap(url, url));
+    }
+
+    // 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.GetContentSettingFromMap(url, url));
+    base::FeatureList::ClearInstanceForTesting();
+    variations::testing::ClearAllVariationParams();
+  }
+
   void TestRequestPermissionInvalidUrl(
       content::PermissionType permission_type,
       ContentSettingsType content_settings_type) {
     TestPermissionContext permission_context(profile(), permission_type,
                                              content_settings_type);
     GURL url;
     ASSERT_FALSE(url.is_valid());
     NavigateAndCommit(url);
 
     const PermissionRequestID id(
@@ skipping 44 matching lines @@
         permission_context.GetContentSettingFromMap(url, url);
     ContentSetting default_setting =
         HostContentSettingsMapFactory::GetForProfile(profile())
             ->GetDefaultContentSetting(content_settings_type, nullptr);
     EXPECT_EQ(default_setting, setting_after_reset);
   }
 
   void TestGlobalPermissionsKillSwitch(
       content::PermissionType permission_type,
       ContentSettingsType content_settings_type) {
-    TestPermissionContext permission_context(profile(), permission_type,
-                                             content_settings_type);
+    TestKillSwitchPermissionContext permission_context(
+        profile(), permission_type, content_settings_type);
     permission_context.ResetFieldTrialList();
 
     EXPECT_FALSE(permission_context.IsPermissionKillSwitchOn());
     std::map<std::string, std::string> params;
     params[PermissionUtil::GetPermissionString(permission_type)] =
         kPermissionsKillSwitchBlockedValue;
     variations::AssociateVariationParams(
         kPermissionsKillSwitchFieldStudy, kPermissionsKillSwitchTestGroup,
         params);
     base::FieldTrialList::CreateFieldTrial(kPermissionsKillSwitchFieldStudy,
@@ skipping 57 matching lines @@
 TEST_F(PermissionContextBaseTests, TestAskAndGrant) {
   TestAskAndGrant_TestContent();
 }
 
 // Simulates clicking Dismiss (X) in the infobar/bubble.
 // The permission should be denied but not saved for future use.
 TEST_F(PermissionContextBaseTests, TestAskAndDismiss) {
   TestAskAndDismiss_TestContent();
 }
 
+// Simulates clicking Dismiss (X) in the infobar/bubble with the block on too
+// many dismissals feature active. The permission should be blocked after
+// several dismissals.
+TEST_F(PermissionContextBaseTests, TestDismissUntilBlocked) {
+  TestBlockOnSeveralDismissals_TestContent();
+}
+
+// Test setting a custom number of dismissals before block via variations.
+TEST_F(PermissionContextBaseTests, TestDismissVariations) {
+  TestVariationBlockOnSeveralDismissals_TestContent();
+}
+
 // Simulates non-valid requesting URL.
 // The permission should be denied but not saved for future use.
 TEST_F(PermissionContextBaseTests, TestNonValidRequestingUrl) {
   TestRequestPermissionInvalidUrl(content::PermissionType::GEOLOCATION,
                                   CONTENT_SETTINGS_TYPE_GEOLOCATION);
   TestRequestPermissionInvalidUrl(content::PermissionType::NOTIFICATIONS,
                                   CONTENT_SETTINGS_TYPE_NOTIFICATIONS);
   TestRequestPermissionInvalidUrl(content::PermissionType::MIDI_SYSEX,
                                   CONTENT_SETTINGS_TYPE_MIDI_SYSEX);
   TestRequestPermissionInvalidUrl(content::PermissionType::PUSH_MESSAGING,
@@ skipping 71 matching lines @@
   TestParallelRequests(CONTENT_SETTING_ALLOW);
 }
 
 TEST_F(PermissionContextBaseTests, TestParallelRequestsBlocked) {
   TestParallelRequests(CONTENT_SETTING_BLOCK);
 }
 
 TEST_F(PermissionContextBaseTests, TestParallelRequestsDismissed) {
   TestParallelRequests(CONTENT_SETTING_ASK);
 }