Limit the amount the Location Settings Dialog will be shown to users.

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>
@@ skipping 162 matching lines @@
   void AddNewTab(const GURL& url);
   void CheckTabContentsState(const GURL& requesting_frame,
                              ContentSetting expected_content_setting);
 #if !defined(OS_ANDROID)
   void SetupRequestManager(content::WebContents* web_contents);
   size_t GetBubblesQueueSize(PermissionRequestManager* manager);
   void AcceptBubble(PermissionRequestManager* manager);
   void DenyBubble(PermissionRequestManager* manager);
   void CloseBubble(PermissionRequestManager* manager);
 #endif
+#if defined(OS_ANDROID)
+  void CheckThatLSDIsShown(const GURL& origin, bool expected_shown);
+  void CheckThatLSDIsShownWithPermissionPrompt(const GURL& origin,
+                                               bool expected_shown);
+  void AddDayOffsetForTesting(int days);
+  void SetDSEOriginForTesting(const GURL& dse_origin);
+#endif
   void RequestManagerDocumentLoadCompleted();
   void RequestManagerDocumentLoadCompleted(content::WebContents* web_contents);
   ContentSetting GetGeolocationContentSetting(GURL frame_0, GURL frame_1);
   void SetGeolocationContentSetting(GURL frame_0,
                                     GURL frame_1,
                                     ContentSetting content_setting);
   size_t GetNumberOfPrompts();
   void AcceptPrompt();
   base::string16 GetPromptText();
 
@@ skipping 173 matching lines @@
     PermissionRequestManager* manager) {
   manager->Deny();
 }
 
 void GeolocationPermissionContextTests::CloseBubble(
     PermissionRequestManager* manager) {
   manager->Closing();
 }
 #endif
 
+#if defined(OS_ANDROID)
+void GeolocationPermissionContextTests::CheckThatLSDIsShown(
+    const GURL& origin,
+    bool expected_shown) {
+  NavigateAndCommit(origin);
+  MockLocationSettings::ClearHasShownLocationSettingsDialog();
+  RequestGeolocationPermission(web_contents(), RequestID(0), origin, true);
+
+  EXPECT_EQ(MockLocationSettings::HasShownLocationSettingsDialog(),
+            expected_shown);

[raymes, 2017/03/15 04:28:25]

optional: alternatively you can return HasShownLocationSettingsDialog() here and
call EXPECT_TRUE/FALSE at the callsite. It avoids having to document the bools
that get passed in.

[benwells, 2017/03/15 23:10:49]

Yeah that's much nicer, done.

+}
+
+void GeolocationPermissionContextTests::CheckThatLSDIsShownWithPermissionPrompt(
+    const GURL& origin,
+    bool expected_shown) {
+  NavigateAndCommit(origin);
+  MockLocationSettings::ClearHasShownLocationSettingsDialog();
+  RequestGeolocationPermission(web_contents(), RequestID(0), origin, 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();
+
+  EXPECT_EQ(MockLocationSettings::HasShownLocationSettingsDialog(),
+            expected_shown);
+}
+
+void GeolocationPermissionContextTests::AddDayOffsetForTesting(int days) {
+  GeolocationPermissionContextAndroid::AddDayOffsetForTesting(days);
+}
+
+void GeolocationPermissionContextTests::SetDSEOriginForTesting(
+    const GURL& dse_origin) {
+  GeolocationPermissionContextAndroid::SetDSEOriginForTesting(dse_origin);
+}
+#endif
+
 void GeolocationPermissionContextTests::RequestManagerDocumentLoadCompleted() {
   GeolocationPermissionContextTests::RequestManagerDocumentLoadCompleted(
       web_contents());
 }
 
 void GeolocationPermissionContextTests::RequestManagerDocumentLoadCompleted(
     content::WebContents* web_contents) {
 #if !defined(OS_ANDROID)
   PermissionRequestManager::FromWebContents(web_contents)->
       DocumentOnLoadCompletedInMainFrame();
@@ skipping 225 matching lines @@
                                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());
 }
+
+TEST_F(GeolocationPermissionContextTests, LSDBackOffDifferentSites) {
+  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");
+  GURL requesting_frame_dse("https://www.dse.com/geolocation");
+
+  SetDSEOriginForTesting(requesting_frame_dse);
+
+  // Set all origin geolocation permissions to ALLOW.
+  SetGeolocationContentSetting(requesting_frame_1, requesting_frame_1,
+                               CONTENT_SETTING_ALLOW);
+  SetGeolocationContentSetting(requesting_frame_2, requesting_frame_2,
+                               CONTENT_SETTING_ALLOW);
+  SetGeolocationContentSetting(requesting_frame_dse, requesting_frame_dse,
+                               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, DENIED);

[raymes, 2017/03/15 04:28:25]

nit: here and elsewhere, please document the boolean for this function

[benwells, 2017/03/15 23:10:49]

Done.

+
+  // Now permission requests should trigger the LSD, but the LSD will be denied,
+  // putting the requesting origins into backoff. Check that the two non-DSE
+  // origins share the same backoff, which is distinct to the DSE origin.
+  // First, cancel a LSE prompt on the first non-DSE origin to go into backoff.
+  CheckThatLSDIsShown(requesting_frame_1, true /* expected_shown */);
+
+  // Now check that the LSD is prevented on this origin.
+  CheckThatLSDIsShown(requesting_frame_1, false /* expected_shown */);
+
+  // Now ask on the other non-DSE origin and check backoff prevented the prompt.
+  CheckThatLSDIsShown(requesting_frame_2, false /* expected_shown */);
+
+  // Now request on the DSE and check that the LSD is shown, as the non-DSE
+  // backoff should not apply.
+  CheckThatLSDIsShown(requesting_frame_dse, true /* expected_shown */);
+
+  // Now check that the DSE is in backoff.
+  CheckThatLSDIsShown(requesting_frame_dse, false /* expected_shown */);
+}
+
+TEST_F(GeolocationPermissionContextTests, LSDBackOffTiming) {
+  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, DENIED);
+
+  // First, cancel a LSE prompt on the first non-DSE origin to go into backoff.

[raymes, 2017/03/15 04:28:25]

nit: LSD

[benwells, 2017/03/15 23:10:49]

Done.

+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+
+  // Check the LSD is prevented in 6 days time.
+  AddDayOffsetForTesting(6);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+
+  // Check it is shown in one more days time, but then not straight after..
+  AddDayOffsetForTesting(1);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+
+  // Check that it isn't shown 29 days after that.
+  AddDayOffsetForTesting(29);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+
+  // Check it is shown in one more days time, but then not straight after..
+  AddDayOffsetForTesting(1);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+
+  // Check that it isn't shown 89 days after that.
+  AddDayOffsetForTesting(89);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+
+  // Check it is shown in one more days time, but then not straight after..
+  AddDayOffsetForTesting(1);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+
+  // Check that it isn't shown 89 days after that.
+  AddDayOffsetForTesting(89);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+
+  // Check it is shown in one more days time, but then not straight after..
+  AddDayOffsetForTesting(1);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+}
+
+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);
+
+  // Turn off system location but allow the LSD to be shown, and denied.
+  MockLocationSettings::SetLocationStatus(true /* android */,
+                                          false /* system */);
+  MockLocationSettings::SetLocationSettingsDialogStatus(true, DENIED);
+
+  // The permission status should reflect that the LSD will be shown.
+  ASSERT_EQ(blink::mojom::PermissionStatus::ASK,
+            PermissionManager::Get(profile())->GetPermissionStatus(
+                content::PermissionType::GEOLOCATION, requesting_frame,
+                requesting_frame));
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+
+  // Now that the LSD is in backoff, the permission status should reflect it.
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+  ASSERT_EQ(blink::mojom::PermissionStatus::DENIED,
+            PermissionManager::Get(profile())->GetPermissionStatus(
+                content::PermissionType::GEOLOCATION, requesting_frame,
+                requesting_frame));
+}
+
+TEST_F(GeolocationPermissionContextTests, LSDBackOffAskPromptsDespiteBackOff) {
+  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, DENIED);
+
+  // First, cancel a LSE prompt on the first non-DSE origin to go into backoff.

[raymes, 2017/03/15 04:28:25]

nit: LSD

[benwells, 2017/03/15 23:10:49]

Done.

+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  CheckThatLSDIsShown(requesting_frame, false) /* expected_shown */;
+
+  // Set the content setting back to ASK. The permission status should be
+  // prompt, and the LSD prompt should now be shown.
+  SetGeolocationContentSetting(requesting_frame, requesting_frame,
+                               CONTENT_SETTING_ASK);
+  ASSERT_EQ(blink::mojom::PermissionStatus::ASK,
+            PermissionManager::Get(profile())->GetPermissionStatus(
+                content::PermissionType::GEOLOCATION, requesting_frame,
+                requesting_frame));
+  CheckThatLSDIsShownWithPermissionPrompt(requesting_frame,
+                                          true /* expected_shown */);
+}
+
+TEST_F(GeolocationPermissionContextTests,
+       LSDBackOffAcceptPermissionResetsBackOff) {
+  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, DENIED);
+
+  // First, get into the highest backoff state.
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  AddDayOffsetForTesting(7);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  AddDayOffsetForTesting(30);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  AddDayOffsetForTesting(90);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+
+  // Now accept a permissions prompt.
+  SetGeolocationContentSetting(requesting_frame, requesting_frame,
+                               CONTENT_SETTING_ASK);
+  CheckThatLSDIsShownWithPermissionPrompt(requesting_frame,
+                                          true /* expected_shown */);
+
+  // And check that back in the lowest backoff state.
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+  AddDayOffsetForTesting(7);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+}
+
+TEST_F(GeolocationPermissionContextTests, LSDBackOffAcceptLSDResetsBackOff) {
+  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, DENIED);
+
+  // First, get into the highest backoff state.
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  AddDayOffsetForTesting(7);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  AddDayOffsetForTesting(30);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+
+  // Now accept the LSD.
+  AddDayOffsetForTesting(90);
+  MockLocationSettings::SetLocationSettingsDialogStatus(true, GRANTED);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+
+  // Check that not in backoff, and that at the lowest backoff state.
+  MockLocationSettings::SetLocationSettingsDialogStatus(true, DENIED);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+  CheckThatLSDIsShown(requesting_frame, false /* expected_shown */);
+  AddDayOffsetForTesting(7);
+  CheckThatLSDIsShown(requesting_frame, true /* expected_shown */);
+}
 #endif
 
 TEST_F(GeolocationPermissionContextTests, QueuedPermission) {
   GURL requesting_frame_0("https://www.example.com/geolocation");
   GURL requesting_frame_1("https://www.example-2.com/geolocation");
   EXPECT_EQ(
       CONTENT_SETTING_ASK,
       GetGeolocationContentSetting(requesting_frame_0, requesting_frame_1));
   EXPECT_EQ(
       CONTENT_SETTING_ASK,
@@ skipping 533 matching lines @@
   // permission status should still be BLOCK.
   SetGeolocationContentSetting(requesting_frame, requesting_frame,
                                CONTENT_SETTING_BLOCK);
   MockLocationSettings::SetLocationSettingsDialogStatus(true, GRANTED);
   ASSERT_EQ(blink::mojom::PermissionStatus::DENIED,
             PermissionManager::Get(profile())->GetPermissionStatus(
                 content::PermissionType::GEOLOCATION, requesting_frame,
                 requesting_frame));
 }
 #endif  // defined(OS_ANDROID)