Add page info permissions observer for callbacks and metrics

Add an observer for SingleWebsiteSettings. Implement the callbacks to
record metrics and tell the PageInfoController to update permissions.

Bug: 1077766
Change-Id: I2d4f9d234b66a312372cf68e5d9f9a2cd49af798
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2431665Reviewed-by: Balazs Engedy <engedy@chromium.org>
Reviewed-by: Christian Dullweber <dullweber@chromium.org>
Commit-Queue: Ehimare Okoyomon <eokoyomon@chromium.org>
Cr-Commit-Position: refs/heads/master@{#812197}

chrome/android/javatests/src/org/chromium/chrome/browser/page_info/PageInfoViewTest.java

@@ -15,6 +15,8 @@ import static androidx.test.espresso.matcher.ViewMatchers.withText;
 
 import static org.hamcrest.CoreMatchers.allOf;
 import static org.hamcrest.CoreMatchers.containsString;
+import static org.hamcrest.Matchers.instanceOf;
+import static org.hamcrest.Matchers.is;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 
@@ -23,6 +25,7 @@ import static org.chromium.components.content_settings.PrefNames.COOKIE_CONTROLS
 
 import android.os.Build;
 import android.view.View;
+import android.widget.Button;
 
 import androidx.test.filters.MediumTest;
 
@@ -43,6 +46,7 @@ import org.chromium.chrome.test.ChromeJUnit4ClassRunner;
 import org.chromium.chrome.test.ChromeTabbedActivityTestRule;
 import org.chromium.chrome.test.util.browser.Features;
 import org.chromium.components.browser_ui.site_settings.WebsitePreferenceBridge;
+import org.chromium.components.browser_ui.site_settings.WebsitePreferenceBridgeJni;
 import org.chromium.components.content_settings.ContentSettingValues;
 import org.chromium.components.content_settings.ContentSettingsType;
 import org.chromium.components.content_settings.CookieControlsMode;
@@ -143,6 +147,20 @@ public class PageInfoViewTest {
         });
     }
 
+    private void expectHasPermissions(String url, boolean hasPermissions) {
+        // The default value for these types is ask.
+        @ContentSettingValues
+        int expected = hasPermissions ? ContentSettingValues.ALLOW : ContentSettingValues.ASK;
+        TestThreadUtils.runOnUiThreadBlocking(() -> {
+            assertEquals(expected,
+                    WebsitePreferenceBridgeJni.get().getNotificationSettingForOrigin(
+                            Profile.getLastUsedRegularProfile(), url));
+            assertEquals(expected,
+                    WebsitePreferenceBridgeJni.get().getGeolocationSettingForOrigin(
+                            Profile.getLastUsedRegularProfile(), url, "*"));
+        });
+    }
+
     private void addDefaultSettingPermissions(String url) {
         TestThreadUtils.runOnUiThreadBlocking(() -> {
             WebsitePreferenceBridge.setContentSettingForPattern(Profile.getLastUsedRegularProfile(),
@@ -299,20 +317,6 @@ public class PageInfoViewTest {
         mRenderTestRule.render(getPageInfoView(), "PageInfo_ConnectionInfoSubpage");
     }
 
-    /**
-     * Tests that the permissions page of the new PageInfo UI is gone when there are no permissions
-     * set.
-     */
-    @Test
-    @MediumTest
-    @Features.EnableFeatures(PageInfoFeatureList.PAGE_INFO_V2)
-    public void testNoPermissionsSubpage() throws IOException {
-        loadUrlAndOpenPageInfo(mTestServerRule.getServer().getURL(sSimpleHtml));
-        View dialog = (View) getPageInfoView().getParent();
-        onView(withId(R.id.page_info_permissions_row))
-                .check(matches(withEffectiveVisibility(GONE)));
-    }
-
     /**
      * Tests the permissions page of the new PageInfo UI with permissions.
      */
@@ -341,6 +345,20 @@ public class PageInfoViewTest {
         mRenderTestRule.render(getPageInfoView(), "PageInfo_CookiesSubpage");
     }
 
+    /**
+     * Tests that the permissions page of the new PageInfo UI is gone when there are no permissions
+     * set.
+     */
+    @Test
+    @MediumTest
+    @Features.EnableFeatures(PageInfoFeatureList.PAGE_INFO_V2)
+    public void testNoPermissionsSubpage() throws IOException {
+        loadUrlAndOpenPageInfo(mTestServerRule.getServer().getURL(sSimpleHtml));
+        View dialog = (View) getPageInfoView().getParent();
+        onView(withId(R.id.page_info_permissions_row))
+                .check(matches(withEffectiveVisibility(GONE)));
+    }
+
     /**
      * Tests clearing cookies on the cookies page of the new PageInfo UI.
      */
@@ -366,5 +384,32 @@ public class PageInfoViewTest {
         expectHasCookies(false);
     }
 
+    /**
+     * Tests resetting permissions on the permissions page of the new PageInfo UI.
+     */
+    @Test
+    @MediumTest
+    @Features.EnableFeatures(PageInfoFeatureList.PAGE_INFO_V2)
+    public void testResetPermissionsOnSubpage() throws Exception {
+        mActivityTestRule.loadUrl(mTestServerRule.getServer().getURL(sSiteDataHtml));
+        String url = mTestServerRule.getServer().getURL("/");
+        // Create permissions.
+        expectHasPermissions(url, false);
+        addSomePermissions(url);
+        expectHasPermissions(url, true);
+        // Go to permissions subpage.
+        onView(withId(R.id.location_bar_status_icon)).perform(click());
+        onView(withId(R.id.page_info_permissions_row)).perform(click());
+        // Clear permissions in page info.
+        onView(withText("Reset permissions")).perform(click());
+        onView(allOf(is(instanceOf(Button.class)), withText("Reset permissions"))).perform(click());
+        // Wait until the UI navigates back and check permissions are reset.
+        onViewWaiting(allOf(withId(R.id.page_info_row_wrapper), isDisplayed()));
+        // Make sure that the permission section is gone because there are no longer exceptions.
+        onView(withId(R.id.page_info_permissions_row))
+                .check(matches(withEffectiveVisibility(GONE)));
+        expectHasPermissions(url, false);
+    }
+
     // TODO(1071762): Add tests for preview pages, offline pages, offline state and other states.
 }

components/browser_ui/site_settings/android/java/src/org/chromium/components/browser_ui/site_settings/SingleWebsiteSettings.java

@@ -43,6 +43,21 @@ import java.util.Map;
  */
 public class SingleWebsiteSettings extends SiteSettingsPreferenceFragment
         implements Preference.OnPreferenceChangeListener, Preference.OnPreferenceClickListener {
+    /**
+     * Interface for a class that wants to receive updates from SingleWebsiteSettings.
+     */
+    public interface Observer {
+        /**
+         * Notifies the observer that the website was reset.
+         */
+        void onPermissionsReset();
+
+        /**
+         * Notifies the observer that a permission was changed.
+         */
+        void onPermissionChanged();
+    }
+
     // SingleWebsiteSettings expects either EXTRA_SITE (a Website) or
     // EXTRA_SITE_ADDRESS (a WebsiteAddress) to be present (but not both). If
     // EXTRA_SITE is present, the fragment will display the permissions in that
@@ -131,7 +146,7 @@ public class SingleWebsiteSettings extends SiteSettingsPreferenceFragment
     };
 
     // The callback to be run after this site is reset.
-    private Runnable mWebsiteResetCallback;
+    private Observer mWebsiteSettingsObserver;
 
     private static final int REQUEST_CODE_NOTIFICATION_CHANNEL_SETTINGS = 1;
 
@@ -260,8 +275,8 @@ public class SingleWebsiteSettings extends SiteSettingsPreferenceFragment
         mHideNonPermissionPreferences = hide;
     }
 
-    public void setWebsiteResetCallback(Runnable callback) {
-        mWebsiteResetCallback = callback;
+    public void setWebsiteSettingsObserver(Observer observer) {
+        mWebsiteSettingsObserver = observer;
     }
 
     /**
@@ -1010,6 +1025,9 @@ public class SingleWebsiteSettings extends SiteSettingsPreferenceFragment
             } else {
                 mSite.setPermission(browserContextHandle, type, permission);
             }
+            if (mWebsiteSettingsObserver != null) {
+                mWebsiteSettingsObserver.onPermissionChanged();
+            }
         }
 
         return true;
@@ -1035,8 +1053,8 @@ public class SingleWebsiteSettings extends SiteSettingsPreferenceFragment
                             } else {
                                 resetSite();
                             }
-                            if (mWebsiteResetCallback != null) {
-                                mWebsiteResetCallback.run();
+                            if (mWebsiteSettingsObserver != null) {
+                                mWebsiteSettingsObserver.onPermissionsReset();
                             }
                         })
                 .setNegativeButton(R.string.cancel, null)

components/page_info/android/java/src/org/chromium/components/page_info/PageInfoController.java

@@ -496,6 +496,15 @@ public class PageInfoController implements PageInfoMainController, ModalDialogPr
         }
     }
 
+    @Override
+    public void refreshPermissions() {
+        mPermissionParamsListBuilder.clearPermissionEntries();
+        if (mNativePageInfoController != 0) {
+            PageInfoControllerJni.get().updatePermissions(
+                    mNativePageInfoController, PageInfoController.this);
+        }
+    }
+
     private boolean isSheet(Context context) {
         return !DeviceFormFactor.isNonMultiDisplayContextOnTablet(context)
                 && (mDelegate.getVrHandler() == null || !mDelegate.getVrHandler().isInVr());
@@ -569,6 +578,7 @@ public class PageInfoController implements PageInfoMainController, ModalDialogPr
         void destroy(long nativePageInfoControllerAndroid, PageInfoController caller);
         void recordPageInfoAction(
                 long nativePageInfoControllerAndroid, PageInfoController caller, int action);
+        void updatePermissions(long nativePageInfoControllerAndroid, PageInfoController caller);
     }
 
     @Override

components/page_info/android/java/src/org/chromium/components/page_info/PageInfoMainController.java

@@ -28,6 +28,11 @@ public interface PageInfoMainController {
      */
     void recordAction(@PageInfoAction int action);
 
+    /**
+     * Refreshes the permissions of the page info.
+     */
+    void refreshPermissions();
+
     /**
      * @return A BrowserContext for this dialog.
      */

components/page_info/android/java/src/org/chromium/components/page_info/PageInfoPermissionsController.java

@@ -20,7 +20,8 @@ import java.util.List;
 /**
  * Class for controlling the page info permissions section.
  */
-public class PageInfoPermissionsController implements PageInfoSubpageController {
+public class PageInfoPermissionsController
+        implements PageInfoSubpageController, SingleWebsiteSettings.Observer {
     private PageInfoMainController mMainController;
     private PageInfoRowView mRowView;
     private PageInfoControllerDelegate mDelegate;
@@ -54,17 +55,12 @@ public class PageInfoPermissionsController implements PageInfoSubpageController
                 mRowView.getContext(), SingleWebsiteSettings.class.getName(), fragmentArgs);
         mSubpageFragment.setSiteSettingsClient(mDelegate.getSiteSettingsClient());
         mSubpageFragment.setHideNonPermissionPreferences(true);
-        mSubpageFragment.setWebsiteResetCallback(this::onPermissionsDeleted);
+        mSubpageFragment.setWebsiteSettingsObserver(this);
         AppCompatActivity host = (AppCompatActivity) mRowView.getContext();
         host.getSupportFragmentManager().beginTransaction().add(mSubpageFragment, null).commitNow();
         return mSubpageFragment.requireView();
     }
 
-    private void onPermissionsDeleted() {
-        mMainController.recordAction(PageInfoAction.PAGE_INFO_PERMISSIONS_CLEARED);
-        mMainController.exitSubpage();
-    }
-
     @Override
     public void onSubpageRemoved() {
         assert mSubpageFragment != null;
@@ -139,4 +135,18 @@ public class PageInfoPermissionsController implements PageInfoSubpageController
         return resources.getQuantityString(resId, numPermissions - 2, perm1.name.toString(),
                 perm2.name.toString(), numPermissions - 2);
     }
+
+    // SingleWebsiteSettings.Observer methods
+
+    @Override
+    public void onPermissionsReset() {
+        mMainController.recordAction(PageInfoAction.PAGE_INFO_PERMISSIONS_CLEARED);
+        mMainController.refreshPermissions();
+        mMainController.exitSubpage();
+    }
+
+    @Override
+    public void onPermissionChanged() {
+        mMainController.recordAction(PageInfoAction.PAGE_INFO_PERMISSIONS_CHANGED);
+    }
 }

components/page_info/android/java/src/org/chromium/components/page_info/PermissionParamsListBuilder.java

@@ -77,6 +77,10 @@ public class PermissionParamsListBuilder {
         mEntries.add(new PageInfoPermissionEntry(name, type, value));
     }
 
+    public void clearPermissionEntries() {
+        mEntries.clear();
+    }
+
     public PageInfoView.PermissionParams build() {
         List<PageInfoView.PermissionRowParams> rowParams = new ArrayList<>();
         for (PermissionParamsListBuilder.PageInfoPermissionEntry permission : mEntries) {

components/page_info/android/page_info_controller_android.cc

@@ -80,6 +80,12 @@ void PageInfoControllerAndroid::RecordPageInfoAction(
       static_cast<PageInfo::PageInfoAction>(action));
 }
 
+void PageInfoControllerAndroid::UpdatePermissions(
+    JNIEnv* env,
+    const JavaParamRef<jobject>& obj) {
+  presenter_->UpdatePermissions();
+}
+
 void PageInfoControllerAndroid::SetIdentityInfo(
     const IdentityInfo& identity_info) {
   JNIEnv* env = base::android::AttachCurrentThread();

components/page_info/android/page_info_controller_android.h

@@ -29,6 +29,8 @@ class PageInfoControllerAndroid : public PageInfoUI {
   void RecordPageInfoAction(JNIEnv* env,
                             const base::android::JavaParamRef<jobject>& obj,
                             jint action);
+  void UpdatePermissions(JNIEnv* env,
+                         const base::android::JavaParamRef<jobject>& obj);
 
   // PageInfoUI implementations.
   void SetCookieInfo(const CookieInfoList& cookie_info_list) override;

components/page_info/page_info.cc

@@ -513,6 +513,11 @@ void PageInfo::RecordPageInfoAction(PageInfoAction action) {
   }
 }
 
+void PageInfo::UpdatePermissions() {
+  // Refresh the UI to reflect the new setting.
+  PresentSitePermissions();
+}
+
 void PageInfo::OnSitePermissionChanged(ContentSettingsType type,
                                        ContentSetting setting) {
   ContentSettingChangedViaPageInfo(type);

components/page_info/page_info.h

@@ -139,6 +139,7 @@ class PageInfo : public content::WebContentsObserver {
     PAGE_INFO_COOKIES_CLEARED = 13,
     PAGE_INFO_PERMISSION_DIALOG_OPENED = 14,
     PAGE_INFO_PERMISSIONS_CLEARED = 15,
+    PAGE_INFO_PERMISSIONS_CHANGED = 16,
     PAGE_INFO_COUNT
   };
 
@@ -200,6 +201,8 @@ class PageInfo : public content::WebContentsObserver {
 
   void RecordPageInfoAction(PageInfoAction action);
 
+  void UpdatePermissions();
+
   // This method is called when ever a permission setting is changed.
   void OnSitePermissionChanged(ContentSettingsType type, ContentSetting value);
 

tools/metrics/histograms/enums.xml

@@ -75394,6 +75394,7 @@ Called by update_scheduler_enums.py.-->
   <int value="13" label="Cookies deleted for site"/>
   <int value="14" label="Permission dialog opened"/>
   <int value="15" label="Permission deleted for site"/>
+  <int value="16" label="Permission changed for site"/>
 </enum>
 
 <enum name="WebSiteSettingsAllSitesAction">