customtabs: Update the benchmark app for hidden tab benchmarking.

tools/android/customtabs_benchmark/java/src/org/chromium/customtabs/test/MainActivity.java

 // Copyright 2015 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.customtabs.test;
 
 import android.app.Activity;
 import android.content.ComponentName;
 import android.content.Intent;
 import android.net.Uri;
 import android.os.Bundle;
 import android.os.Handler;
+import android.os.IBinder;
 import android.os.Looper;
 import android.os.SystemClock;
 import android.support.customtabs.CustomTabsCallback;
 import android.support.customtabs.CustomTabsClient;
 import android.support.customtabs.CustomTabsIntent;
 import android.support.customtabs.CustomTabsServiceConnection;
 import android.support.customtabs.CustomTabsSession;
+import android.support.v4.app.BundleCompat;
 import android.util.Log;
 import android.view.View;
 import android.widget.Button;
 import android.widget.CheckBox;
 import android.widget.EditText;
 import android.widget.RadioButton;
 
 /** Activity used to benchmark Custom Tabs PLT.
  *
  * This activity contains benchmark code for two modes:
  * 1. Comparison between a basic use of Custom Tabs and a basic use of WebView.
  * 2. Custom Tabs benchmarking under various scenarios.
  *
  * The two modes are not merged into one as the metrics we can extract in the two cases
  * are constrained for the first one by what WebView provides.
  */
 public class MainActivity extends Activity implements View.OnClickListener {
     static final String TAG = "CUSTOMTABSBENCH";
     private static final String DEFAULT_URL = "https://www.android.com";
     private static final String DEFAULT_PACKAGE = "com.google.android.apps.chrome";
     private static final int NONE = -1;
     // Common key between the benchmark modes.
     private static final String URL_KEY = "url";
 
     // Keys for the WebView / Custom Tabs comparison.
     static final String INTENT_SENT_EXTRA = "intent_sent_ms";
     private static final String USE_WEBVIEW_KEY = "use_webview";
     private static final String WARMUP_KEY = "warmup";
 
-    // Keep in sync with the same constants in CustomTabsConnection.
-    private static final String DEBUG_OVERRIDE_KEY =
-            "android.support.customtabs.maylaunchurl.DEBUG_OVERRIDE";
-    private static final int NO_OVERRIDE = 0;
-    private static final int NO_PRERENDERING = 1;
-    private static final int PREFETCH_ONLY = 2;
-    // Only for reporting.
-    private static final int NO_STATE_PREFETCH = 3;
+    // extraCommand related constants.
+    private static final String SET_PRERENDER_ON_CELLULAR = "setPrerenderOnCellularForSession";
+    private static final String SET_SPECULATION_MODE = "setSpeculationModeForSession";
+    private static final String SET_IGNORE_URL_FRAGMENTS_FOR_SESSION =
+            "setIgnoreUrlFragmentsForSession";
+    private static final int NO_SPECULATION = 0;
+    private static final int PRERENDER = 2;
+    private static final int HIDDEN_TAB = 3;
 
     private final Handler mHandler = new Handler(Looper.getMainLooper());
 
     private EditText mUrlEditText;
     private RadioButton mChromeRadioButton;
     private RadioButton mWebViewRadioButton;
     private CheckBox mWarmupCheckbox;
     private long mIntentSentMs;
 
     @Override
@@ skipping 143 matching lines @@
         return System.currentTimeMillis();
     }
 
     /** Start the second benchmark mode.
      *
      * NOTE: Methods below are for the second mode.
      */
     private void startCustomTabsBenchmark(Intent intent) {
         String url = intent.getStringExtra(URL_KEY);
         if (url == null) url = DEFAULT_URL;
+        String speculatedUrl = intent.getStringExtra("speculated_url");
+        if (speculatedUrl == null) speculatedUrl = url;
         String packageName = intent.getStringExtra("package_name");
         if (packageName == null) packageName = DEFAULT_PACKAGE;
         boolean warmup = intent.getBooleanExtra("warmup", false);
         int delayToMayLaunchUrl = intent.getIntExtra("delay_to_may_launch_url", NONE);
         int delayToLaunchUrl = intent.getIntExtra("delay_to_launch_url", NONE);
-
-        int speculationMode = 0;
-        String speculationModeValue = intent.getStringExtra("speculation_mode");
-        switch (speculationModeValue) {
-            case "prerender":
-                speculationMode = NO_OVERRIDE;
-                break;
-            case "disabled":
-                speculationMode = NO_PRERENDERING;
-                break;
-            case "speculative_prefetch":
-                speculationMode = PREFETCH_ONLY;
-                break;
-            case "no_state_prefetch":
-                speculationMode = NO_STATE_PREFETCH;
-                break;
-            default:
-                throw new IllegalArgumentException(
-                        "Invalid prerender mode: " + speculationModeValue);
-        }
-
+        String speculationMode = intent.getStringExtra("speculation_mode");
+        if (speculationMode == null) speculationMode = "prerender";
         int timeoutSeconds = intent.getIntExtra("timeout", NONE);
 
-        launchCustomTabs(packageName, url, warmup, speculationMode, delayToMayLaunchUrl,
-                delayToLaunchUrl, timeoutSeconds);
+        launchCustomTabs(packageName, speculatedUrl, url, warmup, speculationMode,
+                delayToMayLaunchUrl, delayToLaunchUrl, timeoutSeconds);
     }
 
     private final class CustomCallback extends CustomTabsCallback {
         private final boolean mWarmup;
-        private final int mSpeculationMode;
+        private final String mSpeculationMode;
         private final int mDelayToMayLaunchUrl;
         private final int mDelayToLaunchUrl;
         private long mIntentSentMs = NONE;
         private long mPageLoadStartedMs = NONE;
         private long mPageLoadFinishedMs = NONE;
         private long mFirstContentfulPaintMs = NONE;
 
-        public CustomCallback(boolean warmup, int speculationMode, int delayToMayLaunchUrl,
+        public CustomCallback(boolean warmup, String speculationMode, int delayToMayLaunchUrl,
                 int delayToLaunchUrl) {
             mWarmup = warmup;
             mSpeculationMode = speculationMode;
             mDelayToMayLaunchUrl = delayToMayLaunchUrl;
             mDelayToLaunchUrl = delayToLaunchUrl;
         }
 
         public void recordIntentHasBeenSent() {
             mIntentSentMs = SystemClock.uptimeMillis();
         }
@@ skipping 45 matching lines @@
         public void logMetricsAndFinishDelayed(int delayMs) {
             mHandler.postDelayed(new Runnable() {
                 @Override
                 public void run() {
                     logMetricsAndFinish();
                 }
             }, delayMs);
         }
     }
 
-    private void onCustomTabsServiceConnected(CustomTabsClient client, final Uri uri,
-            final CustomCallback cb, boolean warmup, final int prerenderMode,
+    private static void forceSpeculationMode(
+            CustomTabsClient client, IBinder sessionBinder, String speculationMode) {
+        // The same bundle can be used for all calls, as the commands only look for their own
+        // arguments in it.
+        Bundle params = new Bundle();
+        BundleCompat.putBinder(params, "session", sessionBinder);
+        params.putBoolean("ignoreFragments", true);
+        params.putBoolean("prerender", true);
+
+        int speculationModeValue = 0;
+        switch (speculationMode) {
+            case "disabled":
+                speculationModeValue = NO_SPECULATION;
+                break;
+            case "prerender":
+                speculationModeValue = PRERENDER;
+                break;
+            case "hidden_tab":
+                speculationModeValue = HIDDEN_TAB;
+                break;
+            default:
+                throw new RuntimeException("Invalid speculation mode");
+        }
+        params.putInt("speculationMode", speculationModeValue);
+
+        boolean ok = client.extraCommand(SET_PRERENDER_ON_CELLULAR, params) != null;
+        if (!ok) throw new RuntimeException("Cannot set cellular prerendering");
+        ok = client.extraCommand(SET_IGNORE_URL_FRAGMENTS_FOR_SESSION, params) != null;
+        if (!ok) throw new RuntimeException("Cannot set ignoreFragments");
+        ok = client.extraCommand(SET_SPECULATION_MODE, params) != null;
+        if (!ok) throw new RuntimeException("Cannot set the speculation mode");
+    }
+
+    private void onCustomTabsServiceConnected(CustomTabsClient client, final Uri speculatedUri,
+            final Uri uri, final CustomCallback cb, boolean warmup, String speculationMode,
             int delayToMayLaunchUrl, final int delayToLaunchUrl, final int timeoutSeconds) {
         final CustomTabsSession session = client.newSession(cb);
         final CustomTabsIntent intent = (new CustomTabsIntent.Builder(session)).build();
+
+        IBinder sessionBinder =
+                BundleCompat.getBinder(intent.intent.getExtras(), CustomTabsIntent.EXTRA_SESSION);
+        assert sessionBinder != null;
+        forceSpeculationMode(client, sessionBinder, speculationMode);
+
         final Runnable launchRunnable = new Runnable() {
             @Override
             public void run() {
                 intent.launchUrl(MainActivity.this, uri);
                 cb.recordIntentHasBeenSent();
                 if (timeoutSeconds != NONE) cb.logMetricsAndFinishDelayed(timeoutSeconds * 1000);
             }
         };
         Runnable mayLaunchRunnable = new Runnable() {
             @Override
             public void run() {
-                Bundle extras = new Bundle();
-                if (prerenderMode == NO_PRERENDERING) {
-                    extras.putInt(DEBUG_OVERRIDE_KEY, NO_PRERENDERING);
-                } else if (prerenderMode != NO_STATE_PREFETCH) {
-                    extras.putInt(DEBUG_OVERRIDE_KEY, prerenderMode);
-                }
-
-                session.mayLaunchUrl(uri, extras, null);
+                session.mayLaunchUrl(speculatedUri, null, null);
                 mHandler.postDelayed(launchRunnable, delayToLaunchUrl);
             }
         };
 
         if (warmup) client.warmup(0);
         if (delayToMayLaunchUrl != NONE) {
             mHandler.postDelayed(mayLaunchRunnable, delayToMayLaunchUrl);
         } else {
             mHandler.postDelayed(launchRunnable, delayToLaunchUrl);
         }
     }
 
-    private void launchCustomTabs(String packageName, String url, final boolean warmup,
-            final int speculationMode, final int delayToMayLaunchUrl, final int delayToLaunchUrl,
-            final int timeoutSeconds) {
+    private void launchCustomTabs(String packageName, String speculatedUrl, String url,
+            final boolean warmup, final String speculationMode, final int delayToMayLaunchUrl,
+            final int delayToLaunchUrl, final int timeoutSeconds) {
         final CustomCallback cb =
                 new CustomCallback(warmup, speculationMode, delayToMayLaunchUrl, delayToLaunchUrl);
+        final Uri speculatedUri = Uri.parse(speculatedUrl);
         final Uri uri = Uri.parse(url);
         CustomTabsClient.bindCustomTabsService(
                 this, packageName, new CustomTabsServiceConnection() {
                     @Override
                     public void onCustomTabsServiceConnected(
                             ComponentName name, final CustomTabsClient client) {
-                        MainActivity.this.onCustomTabsServiceConnected(client, uri, cb, warmup,
-                                speculationMode, delayToMayLaunchUrl, delayToLaunchUrl,
+                        MainActivity.this.onCustomTabsServiceConnected(client, speculatedUri, uri,
+                                cb, warmup, speculationMode, delayToMayLaunchUrl, delayToLaunchUrl,
                                 timeoutSeconds);
                     }
 
                     @Override
                     public void onServiceDisconnected(ComponentName name) {}
                 });
     }
 }