[Paint Preview] Add Startup.Android.Cold.TimeToVisibleContent metric

this new metric records the minimum recorded value of Startup.Android.Cold.TimeToFirstContentfulPaint and Browser.PaintPreview.TabbedPlayer.TimeToFirstBitmap.
It represents the time it takes for a user to see content.

Bug: 1142922
Change-Id: Ic0f6571e3699d042a1a57bfcf9f9f54cba4cdc06
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2500323Reviewed-by: Mark Pearson <mpearson@chromium.org>
Reviewed-by: Calder Kitagawa <ckitagawa@chromium.org>
Reviewed-by: Yaron Friedman <yfriedman@chromium.org>
Commit-Queue: Yashar Dabiran <yashard@chromium.org>
Cr-Commit-Position: refs/heads/master@{#823285}

chrome/android/java/src/org/chromium/chrome/browser/ChromeTabbedActivity.java

@@ -1542,12 +1542,14 @@ public class ChromeTabbedActivity extends ChromeActivity<ChromeActivityComponent
 
         mInactivityTracker = new ChromeInactivityTracker(
                 ChromePreferenceKeys.TABBED_ACTIVITY_LAST_BACKGROUNDED_TIME_MS_PREF);
+        assert getActivityTabStartupMetricsTracker() != null;
         StartupPaintPreviewHelper.initialize(this, getTabModelSelector(),
                 shouldShowTabSwitcherOnStart(),
                 ()
                         -> getToolbarManager() == null
                         ? null
-                        : getToolbarManager().getProgressBarCoordinator());
+                        : getToolbarManager().getProgressBarCoordinator(),
+                getActivityTabStartupMetricsTracker()::recordVisibleContent);
     }
 
     @Override

chrome/android/java/src/org/chromium/chrome/browser/metrics/ActivityTabStartupMetricsTracker.java

@@ -20,6 +20,8 @@ import org.chromium.content_public.browser.WebContents;
  * startup.
  */
 public class ActivityTabStartupMetricsTracker {
+    private static final String UMA_HISTOGRAM_TABBED_SUFFIX = ".Tabbed";
+
     private final long mActivityStartTimeMs;
 
     // Event duration recorded from the |mActivityStartTimeMs|.
@@ -28,6 +30,7 @@ public class ActivityTabStartupMetricsTracker {
     private TabModelSelectorTabObserver mTabModelSelectorTabObserver;
     private PageLoadMetrics.Observer mPageLoadMetricsObserver;
     private boolean mShouldTrackStartupMetrics;
+    private boolean mVisibleContentRecorded;
 
     public ActivityTabStartupMetricsTracker(
             ObservableSupplier<TabModelSelector> tabModelSelectorSupplier) {
@@ -151,11 +154,31 @@ public class ActivityTabStartupMetricsTracker {
         if (mFirstCommitTimeMs == 0) return;
 
         if (UmaUtils.hasComeToForeground() && !UmaUtils.hasComeToBackground()) {
+            long durationMs = firstContentfulPaintMs - mActivityStartTimeMs;
             RecordHistogram.recordMediumTimesHistogram(
                     "Startup.Android.Cold.TimeToFirstContentfulPaint" + mHistogramSuffix,
-                    firstContentfulPaintMs - mActivityStartTimeMs);
+                    durationMs);
+            if (mHistogramSuffix.equals(UMA_HISTOGRAM_TABBED_SUFFIX)) {
+                recordVisibleContent(durationMs);
+            }
         }
         // This is the last event we track, so destroy this tracker and remove observers.
         destroy();
     }
+
+    /**
+     * Record the first Visible Content time.
+     * This metric reports the minimum value of
+     * Startup.Android.Cold.TimeToFirstContentfulPaint.Tabbed and
+     * Browser.PaintPreview.TabbedPlayer.TimeToFirstBitmap.
+     *
+     * @param durationMs duration in millis.
+     */
+    public void recordVisibleContent(long durationMs) {
+        if (mVisibleContentRecorded) return;
+
+        mVisibleContentRecorded = true;
+        RecordHistogram.recordMediumTimesHistogram(
+                "Startup.Android.Cold.TimeToVisibleContent", durationMs);
+    }
 }

chrome/android/java/src/org/chromium/chrome/browser/paint_preview/StartupPaintPreviewHelper.java

@@ -69,7 +69,8 @@ public class StartupPaintPreviewHelper {
      */
     public static void initialize(ChromeActivity<?> activity, TabModelSelector tabModelSelector,
             boolean willShowStartSurface,
-            Supplier<LoadProgressCoordinator> progressBarCoordinatorSupplier) {
+            Supplier<LoadProgressCoordinator> progressBarCoordinatorSupplier,
+            Callback<Long> visibleContentCallback) {
         if (!CachedFeatureFlags.isEnabled(ChromeFeatureList.PAINT_PREVIEW_SHOW_ON_STARTUP)) return;
 
         if (MultiWindowUtils.getInstance().areMultipleChromeInstancesRunning(activity)
@@ -77,7 +78,8 @@ public class StartupPaintPreviewHelper {
             sShouldShowOnRestore = false;
         }
         sWindowAndroidHelperMap.put(activity.getWindowAndroid(),
-                new PaintPreviewWindowAndroidHelper(activity, progressBarCoordinatorSupplier));
+                new PaintPreviewWindowAndroidHelper(
+                        activity, progressBarCoordinatorSupplier, visibleContentCallback));
 
         // TODO(crbug/1074428): verify this doesn't cause a memory leak if the user exits Chrome
         // prior to onTabStateInitialized being called.
@@ -137,7 +139,8 @@ public class StartupPaintPreviewHelper {
 
         StartupPaintPreview startupPaintPreview = new StartupPaintPreview(tab,
                 windowAndroidHelper.getBrowserControlsManager().getBrowserVisibilityDelegate(),
-                progressSimulatorCallback, progressPreventionCallback);
+                progressSimulatorCallback, progressPreventionCallback,
+                windowAndroidHelper.getVisibleContentCallback());
         startupPaintPreview.setActivityCreationTimestampMs(
                 windowAndroidHelper.getActivityCreationTime());
         startupPaintPreview.setShouldRecordFirstPaint(
@@ -166,13 +169,16 @@ public class StartupPaintPreviewHelper {
         private final WindowAndroid mWindowAndroid;
         private final BrowserControlsManager mBrowserControlsManager;
         private final Supplier<LoadProgressCoordinator> mProgressBarCoordinatorSupplier;
+        private final Callback<Long> mVisibleContentCallback;
 
         PaintPreviewWindowAndroidHelper(ChromeActivity<?> chromeActivity,
-                Supplier<LoadProgressCoordinator> progressBarCoordinatorSupplier) {
+                Supplier<LoadProgressCoordinator> progressBarCoordinatorSupplier,
+                Callback<Long> visibleContentCallback) {
             mWindowAndroid = chromeActivity.getWindowAndroid();
             mActivityCreationTime = chromeActivity.getOnCreateTimestampMs();
             mBrowserControlsManager = chromeActivity.getBrowserControlsManager();
             mProgressBarCoordinatorSupplier = progressBarCoordinatorSupplier;
+            mVisibleContentCallback = visibleContentCallback;
             ApplicationStatus.registerStateListenerForActivity(this, chromeActivity);
         }
 
@@ -188,6 +194,10 @@ public class StartupPaintPreviewHelper {
             return mBrowserControlsManager;
         }
 
+        Callback<Long> getVisibleContentCallback() {
+            return mVisibleContentCallback;
+        }
+
         @Override
         public void onActivityStateChange(Activity activity, @ActivityState int newState) {
             if (newState == ActivityState.DESTROYED) {

chrome/android/javatests/src/org/chromium/chrome/browser/metrics/StartupLoadingMetricsTest.java

@@ -50,6 +50,8 @@ public class StartupLoadingMetricsTest {
             "Startup.Android.Cold.TimeToFirstNavigationCommit";
     private static final String FIRST_CONTENTFUL_PAINT_HISTOGRAM =
             "Startup.Android.Cold.TimeToFirstContentfulPaint";
+    private static final String VISIBLE_CONTENT_HISTOGRAM =
+            "Startup.Android.Cold.TimeToVisibleContent";
 
     private static final String TABBED_SUFFIX = ChromeTabbedActivity.STARTUP_UMA_HISTOGRAM_SUFFIX;
     private static final String WEBAPK_SUFFIX =
@@ -111,6 +113,10 @@ public class StartupLoadingMetricsTest {
         Assert.assertEquals(expectedCount,
                 RecordHistogram.getHistogramTotalCountForTesting(
                         FIRST_CONTENTFUL_PAINT_HISTOGRAM + histogramSuffix));
+        if (histogramSuffix.equals(TABBED_SUFFIX)) {
+            Assert.assertEquals(expectedCount,
+                    RecordHistogram.getHistogramTotalCountForTesting(VISIBLE_CONTENT_HISTOGRAM));
+        }
     }
 
     /**

chrome/browser/paint_preview/android/java/src/org/chromium/chrome/browser/paint_preview/StartupPaintPreview.java

@@ -39,6 +39,7 @@ public class StartupPaintPreview implements PlayerManager.Listener {
     private Runnable mOnDismissed;
     private SnackbarManager.SnackbarController mSnackbarController;
     private TabObserver mStartupTabObserver;
+    private Callback<Long> mVisibleContentCallback;
 
     private boolean mFirstMeaningfulPaintHappened;
     private boolean mDidStartRestore;
@@ -54,7 +55,8 @@ public class StartupPaintPreview implements PlayerManager.Listener {
 
     public StartupPaintPreview(Tab tab,
             BrowserStateBrowserControlsVisibilityDelegate visibilityDelegate,
-            Runnable progressSimulatorCallback, Callback<Boolean> progressPreventionCallback) {
+            Runnable progressSimulatorCallback, Callback<Boolean> progressPreventionCallback,
+            Callback<Long> visibleContentCallback) {
         mTab = tab;
         mMetricsHelper = new StartupPaintPreviewMetrics();
         mTabbedPaintPreview = TabbedPaintPreview.get(mTab);
@@ -63,6 +65,7 @@ public class StartupPaintPreview implements PlayerManager.Listener {
         mTabbedPaintPreview.setProgressSimulatorNeededCallback(progressSimulatorCallback);
         mStartupTabObserver = new StartupPaintPreviewTabObserver();
         mTab.addObserver(mStartupTabObserver);
+        mVisibleContentCallback = visibleContentCallback;
     }
 
     /**
@@ -203,7 +206,8 @@ public class StartupPaintPreview implements PlayerManager.Listener {
     public void onFirstPaint() {
         if (!mTabbedPaintPreview.isAttached()) return;
 
-        mMetricsHelper.onFirstPaint(mActivityCreationTimestampMs, mShouldRecordFirstPaint);
+        mMetricsHelper.onFirstPaint(
+                mActivityCreationTimestampMs, mShouldRecordFirstPaint, mVisibleContentCallback);
     }
 
     @Override

chrome/browser/paint_preview/android/java/src/org/chromium/chrome/browser/paint_preview/StartupPaintPreviewMetrics.java

@@ -8,6 +8,7 @@ import android.os.SystemClock;
 
 import androidx.annotation.IntDef;
 
+import org.chromium.base.Callback;
 import org.chromium.base.metrics.RecordHistogram;
 import org.chromium.base.metrics.RecordUserAction;
 import org.chromium.base.supplier.Supplier;
@@ -64,12 +65,16 @@ public class StartupPaintPreviewMetrics {
         mShownTime = System.currentTimeMillis();
     }
 
-    void onFirstPaint(long activityOnCreateTimestamp, Supplier<Boolean> shouldRecordFirstPaint) {
+    void onFirstPaint(long activityOnCreateTimestamp, Supplier<Boolean> shouldRecordFirstPaint,
+            Callback<Long> visibleContentCallback) {
         mFirstPaintHappened = true;
         if (shouldRecordFirstPaint != null && shouldRecordFirstPaint.get()) {
+            long durationMs = SystemClock.elapsedRealtime() - activityOnCreateTimestamp;
             RecordHistogram.recordLongTimesHistogram(
-                    "Browser.PaintPreview.TabbedPlayer.TimeToFirstBitmap",
-                    SystemClock.elapsedRealtime() - activityOnCreateTimestamp);
+                    "Browser.PaintPreview.TabbedPlayer.TimeToFirstBitmap", durationMs);
+            if (visibleContentCallback != null) {
+                visibleContentCallback.onResult(durationMs);
+            }
         }
     }
 

chrome/browser/paint_preview/android/javatests/src/org/chromium/chrome/browser/paint_preview/StartupPaintPreviewTest.java

@@ -83,7 +83,7 @@ public class StartupPaintPreviewTest {
     public void testDisplayedCorrectly() throws ExecutionException {
         Tab tab = sActivityTestRule.getActivity().getActivityTab();
         StartupPaintPreview startupPaintPreview = TestThreadUtils.runOnUiThreadBlocking(
-                () -> new StartupPaintPreview(tab, null, null, null));
+                () -> new StartupPaintPreview(tab, null, null, null, null));
         TestThreadUtils.runOnUiThreadBlocking(() -> startupPaintPreview.show(null));
         TabbedPaintPreview tabbedPaintPreview =
                 TestThreadUtils.runOnUiThreadBlocking(() -> TabbedPaintPreview.get(tab));
@@ -95,7 +95,7 @@ public class StartupPaintPreviewTest {
     public void testSnackbarShow() throws ExecutionException {
         Tab tab = sActivityTestRule.getActivity().getActivityTab();
         StartupPaintPreview startupPaintPreview = TestThreadUtils.runOnUiThreadBlocking(
-                () -> new StartupPaintPreview(tab, null, null, null));
+                () -> new StartupPaintPreview(tab, null, null, null, null));
         TabbedPaintPreview tabbedPaintPreview =
                 TestThreadUtils.runOnUiThreadBlocking(() -> TabbedPaintPreview.get(tab));
         showAndWaitForInflation(startupPaintPreview, tabbedPaintPreview, null);
@@ -133,7 +133,7 @@ public class StartupPaintPreviewTest {
     public void testRemoveOnFirstMeaningfulPaint() throws ExecutionException {
         Tab tab = sActivityTestRule.getActivity().getActivityTab();
         StartupPaintPreview startupPaintPreview = TestThreadUtils.runOnUiThreadBlocking(
-                () -> new StartupPaintPreview(tab, null, null, null));
+                () -> new StartupPaintPreview(tab, null, null, null, null));
         TabbedPaintPreview tabbedPaintPreview =
                 TestThreadUtils.runOnUiThreadBlocking(() -> TabbedPaintPreview.get(tab));
         CallbackHelper dismissCallback = new CallbackHelper();
@@ -155,7 +155,7 @@ public class StartupPaintPreviewTest {
     public void testRemoveOnOfflinePage() throws ExecutionException {
         Tab tab = sActivityTestRule.getActivity().getActivityTab();
         StartupPaintPreview startupPaintPreview = TestThreadUtils.runOnUiThreadBlocking(
-                () -> new StartupPaintPreview(tab, null, null, null));
+                () -> new StartupPaintPreview(tab, null, null, null, null));
         TabbedPaintPreview tabbedPaintPreview =
                 TestThreadUtils.runOnUiThreadBlocking(() -> TabbedPaintPreview.get(tab));
         // Offline page callback always returns true.
@@ -179,7 +179,7 @@ public class StartupPaintPreviewTest {
     public void testRemoveOnActionbarClick() throws ExecutionException, UiObjectNotFoundException {
         Tab tab = sActivityTestRule.getActivity().getActivityTab();
         StartupPaintPreview startupPaintPreview = TestThreadUtils.runOnUiThreadBlocking(
-                () -> new StartupPaintPreview(tab, null, null, null));
+                () -> new StartupPaintPreview(tab, null, null, null, null));
         TabbedPaintPreview tabbedPaintPreview =
                 TestThreadUtils.runOnUiThreadBlocking(() -> TabbedPaintPreview.get(tab));
         CallbackHelper dismissCallback = new CallbackHelper();
@@ -207,7 +207,7 @@ public class StartupPaintPreviewTest {
     public void testRemoveOnNavigation() throws ExecutionException, UiObjectNotFoundException {
         Tab tab = sActivityTestRule.getActivity().getActivityTab();
         StartupPaintPreview startupPaintPreview = TestThreadUtils.runOnUiThreadBlocking(
-                () -> new StartupPaintPreview(tab, null, null, null));
+                () -> new StartupPaintPreview(tab, null, null, null, null));
         TabbedPaintPreview tabbedPaintPreview =
                 TestThreadUtils.runOnUiThreadBlocking(() -> TabbedPaintPreview.get(tab));
         CallbackHelper dismissCallback = new CallbackHelper();

tools/metrics/histograms/histograms_xml/startup/histograms.xml

@@ -82,6 +82,20 @@ reviews. Googlers can read more about this at go/gwsq-gerrit.
   </summary>
 </histogram>
 
+<histogram name="Startup.Android.Cold.TimeToVisibleContent" units="ms"
+    expires_after="2021-04-26">
+  <owner>yashard@chromium.org</owner>
+  <owner>ckitagawa@chromium.org</owner>
+  <summary>
+    Android: The time from the activity creation point to the moment the content
+    may first appear ready to a user. The intent is to capture readiness of
+    Chrome regardless of whether Chrome is launched into native UI or a web
+    page. The recorded value is the minimum of
+    'Startup.Android.Cold.TimeToFirstContentfulPaint.Tabbed' and
+    'Browser.PaintPreview.TabbedPlayer.TimeToFirstBitmap' metric values.
+  </summary>
+</histogram>
+
 <histogram base="true" name="Startup.Android.FeedContentFirstLoadedTime"
     units="ms" expires_after="2021-06-10">
 <!-- Name completed by histogram_suffixes name="JavaStartMode" -->