Implement timing metrics for UrlRequest

components/cronet/android/test/javatests/src/org/chromium/net/RequestFinishedInfoTest.java

 // Copyright 2016 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.
 
 package org.chromium.net;
 
 import static org.chromium.base.CollectionUtil.newHashSet;
 
 import android.test.suitebuilder.annotation.SmallTest;
 
@@ skipping 66 matching lines @@
             newThread.start();
         }
 
         public void joinAll() throws InterruptedException {
             for (Thread thread : mThreads) {
                 thread.join();
             }
         }
     }
 
-    private static class TestRequestFinishedListener extends RequestFinishedInfo.Listener {
-        private RequestFinishedInfo mRequestInfo;
+    static class TestRequestFinishedListener extends RequestFinishedInfo.Listener {

[xunjieli, 2016/09/20 21:53:33]

Instead of making these classes packet protected, can we move them to a new
class something like MetricsTestUtil.java? 

[mgersh, 2016/09/30 23:47:14]

Done.

+        RequestFinishedInfo mRequestInfo;
 
         public TestRequestFinishedListener(Executor executor) {
             super(executor);
         }
 
         @Override
         public void onRequestFinished(RequestFinishedInfo requestInfo) {
             assertNull("onRequestFinished called repeatedly", mRequestInfo);
             assertNotNull(requestInfo);
             mRequestInfo = requestInfo;
         }
+
+        public void reset() {
+            mRequestInfo = null;
+        }
+    }
+
+    /**
+     * Check existence of all the timing metrics that apply to most test requests,
+     * except those that come from net::LoadTimingInfo::ConnectTiming.
+     * Also check some timing differences, focusing on things we can't check with asserts in the
+     * CronetMetrics constructor.
+     * Don't check push times here.
+     */
+    static void checkTimingMetrics(
+            RequestFinishedInfo.Metrics metrics, Date startTime, Date endTime) {
+        assertNotNull(metrics.getRequestStart());
+        assertTrue(metrics.getRequestStart().after(startTime));
+        assertNotNull(metrics.getSendingStart());
+        assertTrue(metrics.getSendingStart().after(startTime));
+        assertNotNull(metrics.getSendingEnd());
+        assertTrue(metrics.getSendingEnd().before(endTime));
+        assertNotNull(metrics.getResponseStart());
+        assertTrue(metrics.getResponseStart().after(startTime));
+        assertNotNull(metrics.getResponseEnd());
+        assertTrue(metrics.getResponseEnd().before(endTime));
+        // Entire request should take more than 0 ms
+        assertTrue(metrics.getResponseEnd().getTime() - metrics.getRequestStart().getTime() > 0);
+    }
+
+    static void checkHasConnectTiming(
+            RequestFinishedInfo.Metrics metrics, Date startTime, Date endTime, boolean isSsl) {
+        assertNotNull(metrics.getDnsStart());
+        assertTrue(metrics.getDnsStart().after(startTime));
+        assertNotNull(metrics.getDnsEnd());
+        assertTrue(metrics.getDnsEnd().before(endTime));
+        assertNotNull(metrics.getConnectStart());
+        assertTrue(metrics.getConnectStart().after(startTime));
+        assertNotNull(metrics.getConnectEnd());
+        assertTrue(metrics.getConnectEnd().before(endTime));
+        if (isSsl) {
+            assertNotNull(metrics.getSslStart());
+            assertTrue(metrics.getSslStart().after(startTime));
+            assertNotNull(metrics.getSslEnd());
+            assertTrue(metrics.getSslEnd().before(endTime));
+        } else {
+            assertNull(metrics.getSslStart());
+            assertNull(metrics.getSslEnd());
+        }
+    }
+
+    static void checkNoConnectTiming(RequestFinishedInfo.Metrics metrics) {

[xunjieli, 2016/09/20 21:53:33]

It will be great if you can move these to a standalone Java file, so they can be
reused. It's a bit uncommon to reuse methods from a Test file.

[mgersh, 2016/09/30 23:47:14]

Done.

+        assertNull(metrics.getDnsStart());
+        assertNull(metrics.getDnsEnd());
+        assertNull(metrics.getSslStart());
+        assertNull(metrics.getSslEnd());
+        assertNull(metrics.getConnectStart());
+        assertNull(metrics.getConnectEnd());
     }
 
     @SmallTest
+    @OnlyRunNativeCronet
     @Feature({"Cronet"})
     @SuppressWarnings("deprecation")
     public void testRequestFinishedListener() throws Exception {
         mTestFramework = startCronetTestFramework();
         TestExecutor testExecutor = new TestExecutor();
         TestRequestFinishedListener requestFinishedListener =
                 new TestRequestFinishedListener(testExecutor);
         mTestFramework.mCronetEngine.addRequestFinishedListener(requestFinishedListener);
         TestUrlRequestCallback callback = new TestUrlRequestCallback();
         UrlRequest.Builder urlRequestBuilder = new UrlRequest.Builder(
                 mUrl, callback, callback.getExecutor(), mTestFramework.mCronetEngine);
+        Date startTime = new Date();
         urlRequestBuilder.addRequestAnnotation("request annotation")
                 .addRequestAnnotation(this)
                 .build()
                 .start();
         callback.blockForDone();
+        Date endTime = new Date();
         testExecutor.runAllTasks();
 
         RequestFinishedInfo requestInfo = requestFinishedListener.mRequestInfo;
         assertNotNull("RequestFinishedInfo.Listener must be called", requestInfo);
         assertEquals(mUrl, requestInfo.getUrl());
         assertNotNull(requestInfo.getResponseInfo());
         assertEquals(newHashSet("request annotation", this), // Use sets for unordered comparison.
                 new HashSet<Object>(requestInfo.getAnnotations()));
         RequestFinishedInfo.Metrics metrics = requestInfo.getMetrics();
         assertNotNull("RequestFinishedInfo.getMetrics() must not be null", metrics);
+        // Check old (deprecated) timing metrics
         assertTrue(metrics.getTotalTimeMs() > 0);
         assertTrue(metrics.getTotalTimeMs() >= metrics.getTtfbMs());
+        // Check new timing metrics
+        checkTimingMetrics(metrics, startTime, endTime);
+        checkHasConnectTiming(metrics, startTime, endTime, false);
+        assertNull(metrics.getPushStart());
+        assertNull(metrics.getPushEnd());
+        // Check data use metrics
         assertTrue(metrics.getReceivedBytesCount() > 0);
         mTestFramework.mCronetEngine.shutdown();
     }
 
     @SmallTest
+    @OnlyRunNativeCronet
     @Feature({"Cronet"})
     @SuppressWarnings("deprecation")
     public void testRequestFinishedListenerDirectExecutor() throws Exception {
         mTestFramework = startCronetTestFramework();
         Executor testExecutor = new DirectExecutor();
         TestRequestFinishedListener requestFinishedListener =
                 new TestRequestFinishedListener(testExecutor);
         mTestFramework.mCronetEngine.addRequestFinishedListener(requestFinishedListener);
         TestUrlRequestCallback callback = new TestUrlRequestCallback();
         UrlRequest.Builder urlRequestBuilder = new UrlRequest.Builder(
                 mUrl, callback, callback.getExecutor(), mTestFramework.mCronetEngine);
+        Date startTime = new Date();
         urlRequestBuilder.addRequestAnnotation("request annotation")
                 .addRequestAnnotation(this)
                 .build()
                 .start();
         callback.blockForDone();
+        Date endTime = new Date();
 
         RequestFinishedInfo requestInfo = requestFinishedListener.mRequestInfo;
         assertNotNull("RequestFinishedInfo.Listener must be called", requestInfo);
         assertEquals(mUrl, requestInfo.getUrl());
         assertNotNull(requestInfo.getResponseInfo());
         assertEquals(newHashSet("request annotation", this), // Use sets for unordered comparison.
                 new HashSet<Object>(requestInfo.getAnnotations()));
         RequestFinishedInfo.Metrics metrics = requestInfo.getMetrics();
         assertNotNull("RequestFinishedInfo.getMetrics() must not be null", metrics);
         assertTrue(metrics.getTotalTimeMs() > 0);
         assertTrue(metrics.getTotalTimeMs() >= metrics.getTtfbMs());
+        checkTimingMetrics(metrics, startTime, endTime);
+        checkHasConnectTiming(metrics, startTime, endTime, false);
         assertTrue(metrics.getReceivedBytesCount() > 0);
         mTestFramework.mCronetEngine.shutdown();
     }
 
     @SmallTest
+    @OnlyRunNativeCronet
     @Feature({"Cronet"})
     @SuppressWarnings("deprecation")
     public void testRequestFinishedListenerDifferentThreads() throws Exception {
         mTestFramework = startCronetTestFramework();
         ThreadExecutor testExecutor = new ThreadExecutor();
         TestRequestFinishedListener firstListener = new TestRequestFinishedListener(testExecutor);
         TestRequestFinishedListener secondListener = new TestRequestFinishedListener(testExecutor);
         mTestFramework.mCronetEngine.addRequestFinishedListener(firstListener);
         mTestFramework.mCronetEngine.addRequestFinishedListener(secondListener);
         TestUrlRequestCallback callback = new TestUrlRequestCallback();
         UrlRequest.Builder urlRequestBuilder = new UrlRequest.Builder(
                 mUrl, callback, callback.getExecutor(), mTestFramework.mCronetEngine);
+        Date startTime = new Date();
         urlRequestBuilder.addRequestAnnotation("request annotation")
                 .addRequestAnnotation(this)
                 .build()
                 .start();
         callback.blockForDone();
+        Date endTime = new Date();
         testExecutor.joinAll();
 
         RequestFinishedInfo firstRequestInfo = firstListener.mRequestInfo;
         RequestFinishedInfo secondRequestInfo = secondListener.mRequestInfo;
         assertNotNull("First RequestFinishedInfo.Listener must be called", firstRequestInfo);
         assertNotNull("Second RequestFinishedInfo.Listener must be called", secondRequestInfo);
         assertEquals(mUrl, firstRequestInfo.getUrl());
         assertEquals(mUrl, secondRequestInfo.getUrl());
         assertNotNull(firstRequestInfo.getResponseInfo());
         assertNotNull(secondRequestInfo.getResponseInfo());
         assertEquals(newHashSet("request annotation", this), // Use sets for unordered comparison.
                 new HashSet<Object>(firstRequestInfo.getAnnotations()));
         assertEquals(newHashSet("request annotation", this),
                 new HashSet<Object>(secondRequestInfo.getAnnotations()));
         RequestFinishedInfo.Metrics firstMetrics = firstRequestInfo.getMetrics();
         assertNotNull("RequestFinishedInfo.getMetrics() must not be null", firstMetrics);
         assertTrue(firstMetrics.getTotalTimeMs() > 0);
         assertTrue(firstMetrics.getTotalTimeMs() >= firstMetrics.getTtfbMs());
+        checkTimingMetrics(firstMetrics, startTime, endTime);
+        checkHasConnectTiming(firstMetrics, startTime, endTime, false);
         assertTrue(firstMetrics.getReceivedBytesCount() > 0);
         RequestFinishedInfo.Metrics secondMetrics = secondRequestInfo.getMetrics();
         assertNotNull("RequestFinishedInfo.getMetrics() must not be null", secondMetrics);
         assertTrue(secondMetrics.getTotalTimeMs() > 0);
         assertTrue(secondMetrics.getTotalTimeMs() >= secondMetrics.getTtfbMs());
+        checkTimingMetrics(secondMetrics, startTime, endTime);
+        checkHasConnectTiming(secondMetrics, startTime, endTime, false);
         assertTrue(secondMetrics.getReceivedBytesCount() > 0);
         mTestFramework.mCronetEngine.shutdown();
     }
 
     @SmallTest
+    @OnlyRunNativeCronet
     @Feature({"Cronet"})
     @SuppressWarnings("deprecation")
     public void testRequestFinishedListenerFailedRequest() throws Exception {
         String connectionRefusedUrl = "http://127.0.0.1:3";
         mTestFramework = startCronetTestFramework();
         TestExecutor testExecutor = new TestExecutor();
         TestRequestFinishedListener requestFinishedListener =
                 new TestRequestFinishedListener(testExecutor);
         mTestFramework.mCronetEngine.addRequestFinishedListener(requestFinishedListener);
         TestUrlRequestCallback callback = new TestUrlRequestCallback();
         UrlRequest.Builder urlRequestBuilder = new UrlRequest.Builder(connectionRefusedUrl,
                 callback, callback.getExecutor(), mTestFramework.mCronetEngine);
+        Date startTime = new Date();
         urlRequestBuilder.build().start();
         callback.blockForDone();
+        Date endTime = new Date();
         assertTrue(callback.mOnErrorCalled);
         testExecutor.runAllTasks();
 
         RequestFinishedInfo requestInfo = requestFinishedListener.mRequestInfo;
         assertNotNull("RequestFinishedInfo.Listener must be called", requestInfo);
         assertEquals(connectionRefusedUrl, requestInfo.getUrl());
         assertTrue(requestInfo.getAnnotations().isEmpty());
         RequestFinishedInfo.Metrics metrics = requestInfo.getMetrics();
         assertNotNull("RequestFinishedInfo.getMetrics() must not be null", metrics);
         // The failure is occasionally fast enough that time reported is 0, so just check for null
         assertNotNull(metrics.getTotalTimeMs());
         assertNull(metrics.getTtfbMs());
+
+        // Check the timing metrics
+        assertNotNull(metrics.getRequestStart());
+        assertTrue(metrics.getRequestStart().after(startTime));
+        checkNoConnectTiming(metrics);
+        assertNull(metrics.getSendingStart());
+        assertNull(metrics.getSendingEnd());
+        assertNull(metrics.getResponseStart());
+        assertNotNull(metrics.getResponseEnd());
+        assertTrue(metrics.getResponseEnd().before(endTime));
+        // Entire request should take more than 0 ms
+        assertTrue(metrics.getResponseEnd().getTime() - metrics.getRequestStart().getTime() > 0);
+
         assertTrue(metrics.getReceivedBytesCount() == null || metrics.getReceivedBytesCount() == 0);
         mTestFramework.mCronetEngine.shutdown();
     }
 
     @SmallTest
+    @OnlyRunNativeCronet
     @Feature({"Cronet"})
     @SuppressWarnings("deprecation")
     public void testRequestFinishedListenerRemoved() throws Exception {
         mTestFramework = startCronetTestFramework();
         TestExecutor testExecutor = new TestExecutor();
         TestRequestFinishedListener requestFinishedListener =
                 new TestRequestFinishedListener(testExecutor);
         mTestFramework.mCronetEngine.addRequestFinishedListener(requestFinishedListener);
-        mTestFramework.mCronetEngine.removeRequestFinishedListener(requestFinishedListener);
         TestUrlRequestCallback callback = new TestUrlRequestCallback();
         UrlRequest.Builder urlRequestBuilder = new UrlRequest.Builder(
                 mUrl, callback, callback.getExecutor(), mTestFramework.mCronetEngine);
-        urlRequestBuilder.build().start();
+        UrlRequest request = urlRequestBuilder.build();
+        mTestFramework.mCronetEngine.removeRequestFinishedListener(requestFinishedListener);
+        request.start();
         callback.blockForDone();
         testExecutor.runAllTasks();
 
         assertNull("RequestFinishedInfo.Listener must not be called",
                 requestFinishedListener.mRequestInfo);
         mTestFramework.mCronetEngine.shutdown();
     }
 
     @SmallTest
     @Feature({"Cronet"})
@@ skipping 29 matching lines @@
         assertEquals(new Date(sslEnd), metrics.getSslEnd());
         assertEquals(new Date(pushStart), metrics.getPushStart());
         assertEquals(new Date(pushEnd), metrics.getPushEnd());
         assertEquals(new Date(responseStart), metrics.getResponseStart());
         assertEquals(new Date(responseEnd), metrics.getResponseEnd());
         assertEquals(socketReused, metrics.getSocketReused());
         assertEquals(sentBytesCount, (long) metrics.getSentBytesCount());
         assertEquals(receivedBytesCount, (long) metrics.getReceivedBytesCount());
     }
 }