[PwdCheckAndroid] Add delay between check status header updates

This CL adds a delay to status updates whenever multiple updates are
notified to the mediator in a short time window.
The minimum time interval between updates is set to 1 second.

Bug: 1122026, 1092444
Change-Id: I64d9c95a11a5ed9b9d6fcf8941c260bf8b3a64ac
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2390642Reviewed-by: Ted Choc <tedchoc@chromium.org>
Reviewed-by: Friedrich [CET] <fhorschig@chromium.org>
Commit-Queue: Ioana Pandele <ioanap@chromium.org>
Cr-Commit-Position: refs/heads/master@{#805236}

chrome/browser/password_check/android/DEPS

 include_rules = [
   "+chrome/android",
   "+chrome/browser/ui/android",
+  "+content/public/android",
 ]
\ No newline at end of file

chrome/browser/password_check/android/internal/BUILD.gn

@@ -67,6 +67,7 @@ android_library("internal_java") {
     "//chrome/browser/ui/android/strings:ui_strings_grd",
     "//components/browser_ui/widget/android:java",
     "//components/embedder_support/android:util_java",
+    "//content/public/android:content_java",
     "//third_party/android_deps:androidx_annotation_annotation_java",
     "//third_party/android_deps:androidx_appcompat_appcompat_java",
     "//third_party/android_deps:androidx_appcompat_appcompat_resources_java",

chrome/browser/password_check/android/internal/java/src/org/chromium/chrome/browser/password_check/PasswordCheckMediator.java

@@ -25,12 +25,15 @@ import static org.chromium.chrome.browser.password_check.PasswordCheckProperties
 import android.content.DialogInterface;
 import android.util.Pair;
 
+import androidx.annotation.VisibleForTesting;
 import androidx.appcompat.app.AlertDialog;
 
+import org.chromium.base.task.PostTask;
 import org.chromium.chrome.browser.password_check.helper.PasswordCheckChangePasswordHelper;
 import org.chromium.chrome.browser.password_check.helper.PasswordCheckIconHelper;
 import org.chromium.chrome.browser.password_check.helper.PasswordCheckReauthenticationHelper;
 import org.chromium.chrome.browser.password_check.helper.PasswordCheckReauthenticationHelper.ReauthReason;
+import org.chromium.content_public.browser.UiThreadTaskTraits;
 import org.chromium.ui.modelutil.ListModel;
 import org.chromium.ui.modelutil.MVCListAdapter.ListItem;
 import org.chromium.ui.modelutil.PropertyModel;
@@ -46,6 +49,8 @@ import java.util.List;
  */
 class PasswordCheckMediator
         implements PasswordCheckCoordinator.CredentialEventHandler, PasswordCheck.Observer {
+    private static long sStatusUpdateDelayMillis = 1000; // 1 second
+
     private final PasswordCheckReauthenticationHelper mReauthenticationHelper;
     private final PasswordCheckChangePasswordHelper mChangePasswordDelegate;
     private PropertyModel mModel;
@@ -53,6 +58,7 @@ class PasswordCheckMediator
     private Runnable mLaunchCheckupInAccount;
     private HashSet<CompromisedCredential> mPreCheckSet;
     private final PasswordCheckIconHelper mIconHelper;
+    private long mLastStatusUpdate;
 
     PasswordCheckMediator(PasswordCheckChangePasswordHelper changePasswordDelegate,
             PasswordCheckReauthenticationHelper reauthenticationHelper,
@@ -106,6 +112,7 @@ class PasswordCheckMediator
                             .with(LAUNCH_ACCOUNT_CHECKUP_ACTION, mLaunchCheckupInAccount)
                             .with(RESTART_BUTTON_ACTION, this::startCheckManually)
                             .build()));
+            mLastStatusUpdate = System.currentTimeMillis();
         }
         if (items.size() > 1) items.removeRange(1, items.size() - 1);
 
@@ -120,6 +127,21 @@ class PasswordCheckMediator
 
     @Override
     public void onPasswordCheckStatusChanged(@PasswordCheckUIStatus int status) {
+        long currentTime = System.currentTimeMillis();
+        ListModel<ListItem> items = mModel.get(ITEMS);
+        if (items.size() > 0
+                && items.get(0).model.get(CHECK_STATUS) == PasswordCheckUIStatus.RUNNING
+                && mLastStatusUpdate + sStatusUpdateDelayMillis > currentTime) {
+            mLastStatusUpdate += sStatusUpdateDelayMillis;
+            PostTask.postDelayedTask(UiThreadTaskTraits.DEFAULT,
+                    () -> changePasswordCheckStatus(status), mLastStatusUpdate - currentTime);
+        } else {
+            mLastStatusUpdate = currentTime;
+            changePasswordCheckStatus(status);
+        }
+    }
+
+    private void changePasswordCheckStatus(@PasswordCheckUIStatus int status) {
         // There is no UI representation of a canceled check. This status can be sent when
         // the bridge and the password check UI are being torn down while a check is running.
         if (status == PasswordCheckUIStatus.CANCELED) return;
@@ -139,8 +161,9 @@ class PasswordCheckMediator
             header = items.get(0).model;
         }
         header.set(CHECK_STATUS, status);
-        header.set(
-                CHECK_PROGRESS, status == PasswordCheckUIStatus.RUNNING ? UNKNOWN_PROGRESS : null);
+        Pair<Integer, Integer> progress = header.get(CHECK_PROGRESS);
+        if (progress == null) progress = UNKNOWN_PROGRESS;
+        header.set(CHECK_PROGRESS, status == PasswordCheckUIStatus.RUNNING ? progress : null);
         Long checkTimestamp = null;
         Integer compromisedCredentialCount = null;
         if (status == PasswordCheckUIStatus.IDLE) {
@@ -164,7 +187,7 @@ class PasswordCheckMediator
         assert remainingInQueue >= 0;
 
         PropertyModel header = items.get(0).model;
-        header.set(CHECK_STATUS, PasswordCheckUIStatus.RUNNING);
+        assert header.get(CHECK_STATUS) == PasswordCheckUIStatus.RUNNING;
         header.set(
                 CHECK_PROGRESS, new Pair<>(alreadyProcessed, alreadyProcessed + remainingInQueue));
         header.set(CHECK_TIMESTAMP, null);
@@ -360,4 +383,9 @@ class PasswordCheckMediator
             return originComparisonResult == 0 ? usernameComparisonResult : originComparisonResult;
         });
     }
+
+    @VisibleForTesting
+    protected static void setStatusUpdateDelayMillis(long statusUpdateDelayMillis) {
+        sStatusUpdateDelayMillis = statusUpdateDelayMillis;
+    }
 }

chrome/browser/password_check/android/junit/src/org/chromium/chrome/browser/password_check/PasswordCheckControllerTest.java

@@ -129,6 +129,7 @@ public class PasswordCheckControllerTest {
                 mChangePasswordDelegate, mReauthenticationHelper, mIconHelper);
         PasswordCheckFactory.setPasswordCheckForTesting(mPasswordCheck);
         mMediator.initialize(mModel, mDelegate, PasswordCheckReferrer.PASSWORD_SETTINGS, () -> {});
+        PasswordCheckMediator.setStatusUpdateDelayMillis(0);
     }
 
     @Test