customtabs: Create a spare WebContents in warmup() on non low-end devices.

chrome/android/java/src/org/chromium/chrome/browser/customtabs/CustomTabsConnection.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.chrome.browser.customtabs;
 
 import android.app.ActivityManager;
 import android.app.Application;
 import android.content.Context;
 import android.content.Intent;
 import android.content.res.Resources;
 import android.graphics.Bitmap;
 import android.graphics.Point;
 import android.net.ConnectivityManager;
 import android.net.Uri;
 import android.os.AsyncTask;
 import android.os.Binder;
 import android.os.Build;
 import android.os.Bundle;
 import android.os.IBinder;
 import android.os.Process;
 import android.support.customtabs.CustomTabsIntent;
 import android.support.customtabs.ICustomTabsCallback;
 import android.support.customtabs.ICustomTabsService;
 import android.text.TextUtils;
 import android.view.WindowManager;
 
 import org.chromium.base.FieldTrialList;
 import org.chromium.base.Log;
+import org.chromium.base.SysUtils;
 import org.chromium.base.ThreadUtils;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.base.annotations.SuppressFBWarnings;
 import org.chromium.base.library_loader.ProcessInitException;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeApplication;
 import org.chromium.chrome.browser.IntentHandler;
 import org.chromium.chrome.browser.WarmupManager;
 import org.chromium.chrome.browser.WebContentsFactory;
 import org.chromium.chrome.browser.device.DeviceClassManager;
@@ skipping 81 matching lines @@
     public boolean newSession(ICustomTabsCallback callback) {
         ClientManager.DisconnectCallback onDisconnect = new ClientManager.DisconnectCallback() {
             @Override
             public void run(IBinder session) {
                 cancelPrerender(session);
             }
         };
         return mClientManager.newSession(callback, Binder.getCallingUid(), onDisconnect);
     }
 
+    /** Warmup activities that should only happen once. */
+    @SuppressFBWarnings("DM_EXIT")
+    private static void oneTimeInitialization(final ChromeApplication app) {

[pasko, 2015/10/29 13:38:58]

since the one time-ness check is outside this function, let's call it
Initialize().

[Benoit L, 2015/10/29 17:12:36]

Done.

+        ThreadUtils.assertOnUiThread();
+        try {
+            app.startBrowserProcessesAndLoadLibrariesSync(true);
+        } catch (ProcessInitException e) {
+            Log.e(TAG, "ProcessInitException while starting the browser process.");
+            // Cannot do anything without the native library, and cannot show a
+            // dialog to the user.
+            System.exit(-1);
+        }
+        final Context context = app.getApplicationContext();
+        new AsyncTask<Void, Void, Void>() {
+            @Override
+            protected Void doInBackground(Void... params) {
+                ChildProcessLauncher.warmUp(context);
+                return null;
+            }
+        }.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
+        ChromeBrowserInitializer.initNetworkChangeNotifier(context);
+        WarmupManager.getInstance().initializeViewHierarchy(
+                context, R.layout.custom_tabs_control_container);
+    }
+
     @Override
     public boolean warmup(long flags) {
+        return warmup(true);
+    }
+
+    /**
+     * Starts as much as possible in anticipation of a future navigation.
+     *
+     * @param mayCreatesparewebcontents true if warmup() can create a spare renderer.
+     * @return true for success.
+     */
+    private boolean warmup(final boolean mayCreateSpareWebContents) {
         // Here and in mayLaunchUrl(), don't do expensive work for background applications.
         if (!isCallerForegroundOrSelf()) return false;
         mClientManager.recordUidHasCalledWarmup(Binder.getCallingUid());
-        if (!mWarmupHasBeenCalled.compareAndSet(false, true)) return true;
+        final boolean firstTime = mWarmupHasBeenCalled.compareAndSet(false, true);

[Yusuf, 2015/10/29 16:35:27]

and lets call this !initialized

[Benoit L, 2015/10/29 17:12:36]

Done.

         // The call is non-blocking and this must execute on the UI thread, post a task.
         ThreadUtils.postOnUiThread(new Runnable() {
             @Override
-            @SuppressFBWarnings("DM_EXIT")
             public void run() {
-                ChromeApplication app = (ChromeApplication) mApplication;
-                try {
-                    app.startBrowserProcessesAndLoadLibrariesSync(true);
-                } catch (ProcessInitException e) {
-                    Log.e(TAG, "ProcessInitException while starting the browser process.");
-                    // Cannot do anything without the native library, and cannot show a
-                    // dialog to the user.
-                    System.exit(-1);
+                if (firstTime) oneTimeInitialization((ChromeApplication) mApplication);
+                if (mayCreateSpareWebContents && mPrerender == null && !SysUtils.isLowEndDevice()) {
+                    createSpareWebContents();
                 }
-                final Context context = app.getApplicationContext();
-                new AsyncTask<Void, Void, Void>() {
-                    @Override
-                    protected Void doInBackground(Void... params) {
-                        ChildProcessLauncher.warmUp(context);
-                        return null;
-                    }
-                }.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
-                ChromeBrowserInitializer.initNetworkChangeNotifier(context);
-                WarmupManager.getInstance().initializeViewHierarchy(app.getApplicationContext(),
-                        R.layout.custom_tabs_control_container);
             }
         });
         return true;
     }
 
     /**
      * Creates a spare {@link WebContents}, if none exists.
      *
      * Navigating to "about:blank" forces a lot of initialization to take place
      * here. This improves PLT. This navigation is never registered in the history, as
@@ skipping 11 matching lines @@
     }
 
     @Override
     public boolean mayLaunchUrl(ICustomTabsCallback callback, Uri url, final Bundle extras,
             List<Bundle> otherLikelyBundles) {
         // Don't do anything for unknown schemes. Not having a scheme is
         // allowed, as we allow "www.example.com".
         String scheme = url.normalizeScheme().getScheme();
         if (scheme != null && !scheme.equals("http") && !scheme.equals("https")) return false;
         // Things below need the browser process to be initialized.
-        if (!warmup(0)) return false; // Also does the foreground check.
+
+        // Forbids warmup() from creating a spare renderer, as prerendering wouldn't reuse
+        // it. Checking whether prerendering is enabled requires the native library to be loaded,
+        // which is not necessarily the case yet.
+        if (!warmup(false)) return false; // Also does the foreground check.
 
         final IBinder session = callback.asBinder();
         final String urlString = url.toString();
         final boolean noPrerendering =
                 extras != null ? extras.getBoolean(NO_PRERENDERING_KEY, false) : false;
         final int uid = Binder.getCallingUid();
         if (!mClientManager.updateStatsAndReturnWhetherAllowed(session, uid, urlString)) {
             return false;
         }
         ThreadUtils.postOnUiThread(new Runnable() {
@@ skipping 32 matching lines @@
      *
      * TODO(lizeb): Update this when crbug.com/521729 is fixed.
      */
     WebContents takeSpareWebContents() {
         ThreadUtils.assertOnUiThread();
         WebContents result = mSpareWebContents;
         mSpareWebContents = null;
         return result;
     }
 
+    private void destroySpareWebContents() {
+        ThreadUtils.assertOnUiThread();
+        WebContents webContents = takeSpareWebContents();
+        if (webContents != null) webContents.destroy();
+    }
+
     @Override
     public boolean updateVisuals(final ICustomTabsCallback callback, Bundle bundle) {
         final Bundle actionButtonBundle = IntentUtils.safeGetBundle(bundle,
                 CustomTabsIntent.EXTRA_ACTION_BUTTON_BUNDLE);
         if (actionButtonBundle == null) return false;
 
         final Bitmap bitmap = ActionButtonParams.tryParseBitmapFromBundle(mApplication,
                 actionButtonBundle);
         final String description = ActionButtonParams
                 .tryParseDescriptionFromBundle(actionButtonBundle);
@@ skipping 218 matching lines @@
         // incompatible with prerendering through this service. Remove this
         // limitation, or remove ChromePrerenderService.
         WarmupManager.getInstance().disallowPrerendering();
         // Ignores mayPrerender() for an empty URL, since it cancels an existing prerender.
         if (!mayPrerender() && !TextUtils.isEmpty(url)) return;
         if (!mWarmupHasBeenCalled.get()) return;
         // Last one wins and cancels the previous prerender.
         cancelPrerender(null);
         if (TextUtils.isEmpty(url)) return;
         if (!mClientManager.isPrerenderingAllowed(uid)) return;
+
+        // A prerender will be requested. Time to destroy the spare WebContents.
+        destroySpareWebContents();

[Yusuf, 2015/10/29 16:35:27]

since it is a spare one, can we just reuse that? is that any more efficient than
creating a new one?

[Benoit L, 2015/10/29 17:12:36]

Unfortunately, the prerender logic cannot use an existing renderer. I looked at
how to change that, but it does not seem trivial, so destroying the renderer
seems to be the better alternative for now.

+
         Intent extrasIntent = new Intent();
         if (extras != null) extrasIntent.putExtras(extras);
         if (IntentHandler.getExtraHeadersFromIntent(extrasIntent) != null) return;
         if (mExternalPrerenderHandler == null) {
             mExternalPrerenderHandler = new ExternalPrerenderHandler();
         }
         Point contentSize = estimateContentSize();
         Context context = mApplication.getApplicationContext();
         String referrer = IntentHandler.getReferrerUrlIncludingExtraHeaders(extrasIntent, context);
         if (referrer == null && getReferrerForSession(session) != null) {
@@ skipping 35 matching lines @@
         screenSize.x /= density;
         screenSize.y /= density;
         return screenSize;
     }
 
     @VisibleForTesting
     void resetThrottling(Context context, int uid) {
         mClientManager.resetThrottling(uid);
     }
 }