customtabs: Don't send page load metrics by default.

Only sends page load metrics to sessions that are allowed to get them.

Bug: 842648
Change-Id: Ifc82941096d02f448af261656811aca4c9097b2b
Reviewed-on: https://chromium-review.googlesource.com/1057232
Commit-Queue: Benoit L <lizeb@chromium.org>
Reviewed-by: Bernhard Bauer <bauerb@chromium.org>
Cr-Commit-Position: refs/heads/master@{#558337}

chrome/android/java/src/org/chromium/chrome/browser/customtabs/ClientManager.java

@@ -148,6 +148,7 @@ class ClientManager {
         private long mLastMayLaunchUrlTimestamp;
         private boolean mCanUseHiddenTab;
         private boolean mAllowParallelRequest;
+        private boolean mShouldGetPageLoadMetrics;
 
         public SessionParams(Context context, int uid, DisconnectCallback callback,
                 PostMessageHandler postMessageHandler) {
@@ -654,6 +655,17 @@ class ClientManager {
         return params != null ? params.mAllowParallelRequest : false;
     }
 
+    public synchronized void setShouldGetPageLoadMetricsForSession(
+            CustomTabsSessionToken session, boolean allowed) {
+        SessionParams params = mSessionParams.get(session);
+        if (params != null) params.mShouldGetPageLoadMetrics = allowed;
+    }
+
+    public synchronized boolean shouldGetPageLoadMetrics(CustomTabsSessionToken session) {
+        SessionParams params = mSessionParams.get(session);
+        return params != null ? params.mShouldGetPageLoadMetrics : false;
+    }
+
     /**
      * Returns whether an origin is first-party with respect to a session, that is if the
      * application linked to the session has a relation with the provided origin. This does not

chrome/android/java/src/org/chromium/chrome/browser/customtabs/CustomTabsConnection.java

@@ -1094,9 +1094,12 @@ public class CustomTabsConnection {
      * @param metricName Name of the page load metric.
      * @param navigationStartTick Absolute navigation start time, as TimeTicks taken from native.
      * @param offsetMs Offset in ms from navigationStart for the page load metric.
+     *
+     * @return Whether the metric has been dispatched to the client.
      */
     boolean notifySinglePageLoadMetric(CustomTabsSessionToken session, String metricName,
             long navigationStartTick, long offsetMs) {
+        if (!mClientManager.shouldGetPageLoadMetrics(session)) return false;
         if (!mNativeTickOffsetUsComputed) {
             // Compute offset from time ticks to uptimeMillis.
             mNativeTickOffsetUsComputed = true;

chrome/android/javatests/src/org/chromium/chrome/browser/customtabs/CustomTabActivityTest.java

@@ -1326,77 +1326,22 @@ public class CustomTabActivityTest {
     }
 
     /**
-     * Tests that Time To First Contentful Paint and Load Event Start timings are sent.
+     * Tests that page load metrice are sent.
      */
     @Test
     @SmallTest
     @RetryOnFailure
-    public void testPageLoadMetricIsSent() throws Exception {
-        final AtomicReference<Long> firstContentfulPaintMs = new AtomicReference<>(-1L);
-        final AtomicReference<Long> activityStartTimeMs = new AtomicReference<>(-1L);
-        final AtomicReference<Long> loadEventStartMs = new AtomicReference<>(-1L);
-        final AtomicReference<Boolean> sawNetworkQualityEstimates = new AtomicReference<>(false);
-
-        CustomTabsCallback cb = new CustomTabsCallback() {
-            @Override
-            public void extraCallback(String callbackName, Bundle args) {
-                Assert.assertEquals(CustomTabsConnection.PAGE_LOAD_METRICS_CALLBACK, callbackName);
-
-                if (-1 != args.getLong(PageLoadMetrics.EFFECTIVE_CONNECTION_TYPE, -1)) {
-                    sawNetworkQualityEstimates.set(true);
-                }
-
-                long navigationStart = args.getLong(PageLoadMetrics.NAVIGATION_START, -1);
-                if (navigationStart == -1) {
-                    // Untested metric callback.
-                    return;
-                }
-                long current = SystemClock.uptimeMillis();
-                Assert.assertTrue(navigationStart <= current);
-                Assert.assertTrue(navigationStart >= activityStartTimeMs.get());
-
-                long firstContentfulPaint =
-                        args.getLong(PageLoadMetrics.FIRST_CONTENTFUL_PAINT, -1);
-                if (firstContentfulPaint > 0) {
-                    Assert.assertTrue(firstContentfulPaint <= (current - navigationStart));
-                    firstContentfulPaintMs.set(firstContentfulPaint);
-                }
-
-                long loadEventStart = args.getLong(PageLoadMetrics.LOAD_EVENT_START, -1);
-                if (loadEventStart > 0) {
-                    Assert.assertTrue(loadEventStart <= (current - navigationStart));
-                    loadEventStartMs.set(loadEventStart);
-                }
-            }
-        };
-
-        CustomTabsSession session = CustomTabsTestUtils.bindWithCallback(cb);
-        Intent intent = new CustomTabsIntent.Builder(session).build().intent;
-        intent.setData(Uri.parse(mTestPage));
-        intent.setComponent(new ComponentName(
-                InstrumentationRegistry.getTargetContext(), ChromeLauncherActivity.class));
-        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+    public void testPageLoadMetricsAreSent() throws Exception {
+        checkPageLoadMetrics(true);
+    }
 
-        activityStartTimeMs.set(SystemClock.uptimeMillis());
-        mCustomTabActivityTestRule.startCustomTabActivityWithIntent(intent);
-        CriteriaHelper.pollInstrumentationThread(new Criteria() {
-            @Override
-            public boolean isSatisfied() {
-                return firstContentfulPaintMs.get() > 0;
-            }
-        });
-        CriteriaHelper.pollInstrumentationThread(new Criteria() {
-            @Override
-            public boolean isSatisfied() {
-                return loadEventStartMs.get() > 0;
-            }
-        });
-        CriteriaHelper.pollInstrumentationThread(new Criteria() {
-            @Override
-            public boolean isSatisfied() {
-                return sawNetworkQualityEstimates.get();
-            }
-        });
+    /**
+     * Tests that page load metrics are not sent when the client is not whitelisted.
+     */
+    @Test
+    @SmallTest
+    public void testPageLoadMetricsAreNotSentByDefault() throws Exception {
+        checkPageLoadMetrics(false);
     }
 
     private static void assertSuffixedHistogramTotalCount(long expected, String histogramPrefix) {
@@ -2637,6 +2582,77 @@ public class CustomTabActivityTest {
         return newActivity;
     }
 
+    private void checkPageLoadMetrics(boolean allowMetrics)
+            throws InterruptedException, TimeoutException {
+        final AtomicReference<Long> firstContentfulPaintMs = new AtomicReference<>(-1L);
+        final AtomicReference<Long> activityStartTimeMs = new AtomicReference<>(-1L);
+        final AtomicReference<Long> loadEventStartMs = new AtomicReference<>(-1L);
+        final AtomicReference<Boolean> sawNetworkQualityEstimates = new AtomicReference<>(false);
+
+        CustomTabsCallback cb = new CustomTabsCallback() {
+            @Override
+            public void extraCallback(String callbackName, Bundle args) {
+                if (callbackName.equals(CustomTabsConnection.ON_WARMUP_COMPLETED)) return;
+
+                Assert.assertEquals(CustomTabsConnection.PAGE_LOAD_METRICS_CALLBACK, callbackName);
+                if (-1 != args.getLong(PageLoadMetrics.EFFECTIVE_CONNECTION_TYPE, -1)) {
+                    sawNetworkQualityEstimates.set(true);
+                }
+
+                long navigationStart = args.getLong(PageLoadMetrics.NAVIGATION_START, -1);
+                if (navigationStart == -1) {
+                    // Untested metric callback.
+                    return;
+                }
+                long current = SystemClock.uptimeMillis();
+                Assert.assertTrue(navigationStart <= current);
+                Assert.assertTrue(navigationStart >= activityStartTimeMs.get());
+
+                long firstContentfulPaint =
+                        args.getLong(PageLoadMetrics.FIRST_CONTENTFUL_PAINT, -1);
+                if (firstContentfulPaint > 0) {
+                    Assert.assertTrue(firstContentfulPaint <= (current - navigationStart));
+                    firstContentfulPaintMs.set(firstContentfulPaint);
+                }
+
+                long loadEventStart = args.getLong(PageLoadMetrics.LOAD_EVENT_START, -1);
+                if (loadEventStart > 0) {
+                    Assert.assertTrue(loadEventStart <= (current - navigationStart));
+                    loadEventStartMs.set(loadEventStart);
+                }
+            }
+        };
+
+        CustomTabsSession session = CustomTabsTestUtils.bindWithCallback(cb);
+        Intent intent = new CustomTabsIntent.Builder(session).build().intent;
+
+        if (allowMetrics) {
+            CustomTabsSessionToken token = CustomTabsSessionToken.getSessionTokenFromIntent(intent);
+            CustomTabsConnection connection = CustomTabsTestUtils.warmUpAndWait();
+            connection.mClientManager.setShouldGetPageLoadMetricsForSession(token, true);
+        }
+
+        intent.setData(Uri.parse(mTestPage));
+        intent.setComponent(new ComponentName(
+                InstrumentationRegistry.getTargetContext(), ChromeLauncherActivity.class));
+        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+
+        activityStartTimeMs.set(SystemClock.uptimeMillis());
+        mCustomTabActivityTestRule.startCustomTabActivityWithIntent(intent);
+        if (allowMetrics) {
+            CriteriaHelper.pollInstrumentationThread(() -> firstContentfulPaintMs.get() > 0);
+            CriteriaHelper.pollInstrumentationThread(() -> loadEventStartMs.get() > 0);
+            CriteriaHelper.pollInstrumentationThread(() -> sawNetworkQualityEstimates.get());
+        } else {
+            try {
+                CriteriaHelper.pollInstrumentationThread(() -> firstContentfulPaintMs.get() > 0);
+            } catch (AssertionError e) {
+                // Expected.
+            }
+            Assert.assertEquals(-1L, (long) firstContentfulPaintMs.get());
+        }
+    }
+
     private CustomTabsSessionToken warmUpAndLaunchUrlWithSession(Intent intentWithSession)
             throws Exception {
         CustomTabsConnection connection = CustomTabsTestUtils.warmUpAndWait();