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.os.ConditionVariable;
 import android.test.suitebuilder.annotation.SmallTest;
 
 import org.chromium.base.test.util.Feature;
 import org.chromium.net.MetricsTestUtil.TestExecutor;
 import org.chromium.net.MetricsTestUtil.TestRequestFinishedListener;
 import org.chromium.net.impl.CronetMetrics;
 import org.chromium.net.test.EmbeddedTestServer;
 
 import java.util.ArrayList;
 import java.util.Date;
@@ skipping 16 matching lines @@
         mUrl = mTestServer.getURL("/echo?status=200");
     }
 
     @Override
     protected void tearDown() throws Exception {
         mTestServer.stopAndDestroyServer();
         super.tearDown();
     }
 
     static class DirectExecutor implements Executor {
+        private ConditionVariable mBlock = new ConditionVariable();
+
         @Override
         public void execute(Runnable task) {
             task.run();
+            mBlock.open();
+        }
+
+        public void blockUntilDone() {
+            mBlock.block();
         }
     }
 
     static class ThreadExecutor implements Executor {
         private List<Thread> mThreads = new ArrayList<Thread>();
 
         @Override
         public void execute(Runnable task) {
             Thread newThread = new Thread(task);
             mThreads.add(newThread);
             newThread.start();
         }
 
         public void joinAll() throws InterruptedException {
             for (Thread thread : mThreads) {
                 thread.join();
             }
         }
     }
 
     @SmallTest
+    @OnlyRunNativeCronet
     @Feature({"Cronet"})
     @SuppressWarnings("deprecation")
     public void testRequestFinishedListener() throws Exception {
         mTestFramework = startCronetTestFramework();
-        TestExecutor testExecutor = new TestExecutor();
-        TestRequestFinishedListener requestFinishedListener =
-                new TestRequestFinishedListener(testExecutor);
+        TestRequestFinishedListener requestFinishedListener = new TestRequestFinishedListener();
         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();
-        testExecutor.runAllTasks();
+        requestFinishedListener.blockUntilDone();
+        Date endTime = new Date();
 
         RequestFinishedInfo requestInfo = requestFinishedListener.getRequestInfo();
         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
+        MetricsTestUtil.checkTimingMetrics(metrics, startTime, endTime);
+        MetricsTestUtil.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();
+        DirectExecutor 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();
+        testExecutor.blockUntilDone();

[xunjieli, 2016/10/04 22:29:23]

Why don't we use requestFinishedListener.blockUntilDone() here?
Could you add a comment?

[mgersh, 2016/10/05 16:55:18]

The point of this test is to use a direct executor, and
TestRequestFinishedListener's blocking functionality doesn't work if you use the
constructor with an executor. This is a little weird and I'm planning to do some
cleanup in a future CL. Added a comment here, and a TODO in
TestRequestFinishedListener.

+        Date endTime = new Date();
 
         RequestFinishedInfo requestInfo = requestFinishedListener.getRequestInfo();
         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());
+        MetricsTestUtil.checkTimingMetrics(metrics, startTime, endTime);
+        MetricsTestUtil.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);
+        TestRequestFinishedListener firstListener = new TestRequestFinishedListener();
+        TestRequestFinishedListener secondListener = new TestRequestFinishedListener();
         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();
-        testExecutor.joinAll();
+        firstListener.blockUntilDone();
+        secondListener.blockUntilDone();
+        Date endTime = new Date();
 
         RequestFinishedInfo firstRequestInfo = firstListener.getRequestInfo();
         RequestFinishedInfo secondRequestInfo = secondListener.getRequestInfo();
         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());
+        MetricsTestUtil.checkTimingMetrics(firstMetrics, startTime, endTime);
+        MetricsTestUtil.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());
+        MetricsTestUtil.checkTimingMetrics(secondMetrics, startTime, endTime);
+        MetricsTestUtil.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);
+        TestRequestFinishedListener requestFinishedListener = new TestRequestFinishedListener();
         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();
         assertTrue(callback.mOnErrorCalled);
-        testExecutor.runAllTasks();
+        requestFinishedListener.blockUntilDone();
+        Date endTime = new Date();
 
         RequestFinishedInfo requestInfo = requestFinishedListener.getRequestInfo();
         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));
+        MetricsTestUtil.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.getRequestInfo());
         mTestFramework.mCronetEngine.shutdown();
     }
 
     @SmallTest
+    @OnlyRunNativeCronet
+    @Feature({"Cronet"})
+    public void testRequestFinishedListenerCanceledRequest() throws Exception {
+        mTestFramework = startCronetTestFramework();
+        TestRequestFinishedListener requestFinishedListener = new TestRequestFinishedListener();
+        mTestFramework.mCronetEngine.addRequestFinishedListener(requestFinishedListener);
+        TestUrlRequestCallback callback = new TestUrlRequestCallback() {
+            @Override
+            public void onResponseStarted(UrlRequest request, UrlResponseInfo info) {
+                super.onResponseStarted(request, info);
+                request.cancel();
+            }
+        };
+        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();
+        requestFinishedListener.blockUntilDone();
+        Date endTime = new Date();
+
+        RequestFinishedInfo requestInfo = requestFinishedListener.getRequestInfo();
+        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
+        MetricsTestUtil.checkTimingMetrics(metrics, startTime, endTime);
+        MetricsTestUtil.checkHasConnectTiming(metrics, startTime, endTime, false);
+        assertNull(metrics.getPushStart());
+        assertNull(metrics.getPushEnd());
+        // Check data use metrics
+        assertTrue(metrics.getReceivedBytesCount() > 0);
+        mTestFramework.mCronetEngine.shutdown();
+    }
+
+    @SmallTest
     @Feature({"Cronet"})
     public void testMetricsGetters() throws Exception {
         long requestStart = 1;
         long dnsStart = 2;
         long dnsEnd = -1;
         long connectStart = 4;
         long connectEnd = 5;
         long sslStart = 6;
         long sslEnd = 7;
         long sendingStart = 8;
@@ skipping 20 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());
     }
 }