Add tab persistence support for CustomTabs.

BUG=606513

Review-Url: https://codereview.chromium.org/2296833002
Cr-Commit-Position: refs/heads/master@{#415786}

base/android/java/src/org/chromium/base/ApiCompatibilityUtils.java

@@ -43,6 +43,17 @@ public class ApiCompatibilityUtils {
     private ApiCompatibilityUtils() {
     }
 
+    /**
+     * @see Long#compare(long, long)
+     */
+    public static int compareLong(long lhs, long rhs) {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
+            return Long.compare(lhs, rhs);
+        } else {
+            return lhs < rhs ? -1 : (lhs == rhs ? 0 : 1);
+        }
+    }
+
     /**
      * Returns true if view's layout direction is right-to-left.
      *

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

@@ -58,7 +58,6 @@ import org.chromium.chrome.browser.tabmodel.TabModel.TabLaunchType;
 import org.chromium.chrome.browser.tabmodel.TabModelObserver;
 import org.chromium.chrome.browser.tabmodel.TabModelSelectorImpl;
 import org.chromium.chrome.browser.tabmodel.TabPersistencePolicy;
-import org.chromium.chrome.browser.tabmodel.TabbedModeTabPersistencePolicy;
 import org.chromium.chrome.browser.toolbar.ToolbarControlContainer;
 import org.chromium.chrome.browser.util.ColorUtils;
 import org.chromium.chrome.browser.util.FeatureUtilities;
@@ -264,11 +263,8 @@ public class CustomTabActivity extends ChromeActivity {
     @Override
     public void postInflationStartup() {
         super.postInflationStartup();
-        // TODO(tedchoc): Replace with an actual CCT implementation for the persistence policy.
-        //                Currently, this relies on checks for CUSTOM_TABS_SELECTOR_INDEX in the
-        //                main TabPersitentStore that ignores certain actions.
-        TabPersistencePolicy persistencePolicy = new TabbedModeTabPersistencePolicy(
-                this, TabModelSelectorImpl.CUSTOM_TABS_SELECTOR_INDEX);
+        TabPersistencePolicy persistencePolicy = new CustomTabTabPersistencePolicy(
+                getTaskId(), getSavedInstanceState() != null);
         setTabModelSelector(new TabModelSelectorImpl(
                 this, persistencePolicy, getWindowAndroid(), false));
 

chrome/android/java/src/org/chromium/chrome/browser/tab/Tab.java

@@ -1627,6 +1627,7 @@ public class Tab implements ViewGroup.OnHierarchyChangeListener,
 
         reparentingParams.finalizeTabReparenting();
         mIsDetachedForReparenting = false;
+        mIsTabStateDirty = true;
 
         for (TabObserver observer : mObservers) {
             observer.onReparentingFinished(this);

chrome/android/java/src/org/chromium/chrome/browser/tabmodel/TabModelSelectorImpl.java

@@ -227,6 +227,17 @@ public class TabModelSelectorImpl extends TabModelSelectorBase implements TabMod
         };
     }
 
+    /**
+     * Exposed to allow tests to initialize the selector with different tab models.
+     * @param normalModel The normal tab model.
+     * @param incognitoModel The incognito tab model.
+     */
+    @VisibleForTesting
+    public void initializeForTesting(TabModel normalModel, TabModel incognitoModel) {
+        initialize(isIncognitoSelected(), normalModel, incognitoModel);
+        mActiveState = true;
+    }
+
     @Override
     public void setCloseAllTabsDelegate(CloseAllTabsDelegate delegate) {
         mCloseAllTabsDelegate = delegate;

chrome/android/java/src/org/chromium/chrome/browser/tabmodel/TabPersistencePolicy.java

@@ -43,18 +43,21 @@ public interface TabPersistencePolicy {
     String getStateToBeMergedFileName();
 
     /**
-     * Performs any necessary migration required before accessing the tab information.
+     * Performs any necessary initialization required before accessing the tab information.  This
+     * can include cleanups or migrations that must occur before the tab state information can be
+     * read reliably.
      *
      * @param executor The executor that any asynchronous tasks should be run on.
-     * @return Whether any migration is necessary.
+     * @return Whether any blocking initialization is necessary.
      */
-    boolean performMigration(Executor executor);
+    boolean performInitialization(Executor executor);
 
     /**
-     * Waits for the task that migrates all state files to their new location to
-     * finish.
+     * Waits for the any pending initialization to finish.
+     *
+     * @see #performInitialization(Executor)
      */
-    void waitForMigrationToFinish();
+    void waitForInitializationToFinish();
 
     /**
      * @return Whether a merge is currently in progress.

chrome/android/java/src/org/chromium/chrome/browser/tabmodel/TabPersistentStore.java

@@ -219,11 +219,12 @@ public class TabPersistentStore extends TabPersister {
         mPreferences = ContextUtils.getAppSharedPreferences();
 
         assert isStateFile(policy.getStateFileName()) : "State file name is not valid";
-        boolean needsMigration = mPersistencePolicy.performMigration(AsyncTask.SERIAL_EXECUTOR);
+        boolean needsInitialization = mPersistencePolicy.performInitialization(
+                AsyncTask.SERIAL_EXECUTOR);
 
         if (mPersistencePolicy.isMergeInProgress()) return;
 
-        Executor executor = needsMigration
+        Executor executor = needsInitialization
                 ? AsyncTask.SERIAL_EXECUTOR : AsyncTask.THREAD_POOL_EXECUTOR;
 
         mPrefetchTabListTask =
@@ -247,7 +248,7 @@ public class TabPersistentStore extends TabPersister {
      */
     @VisibleForTesting
     public void waitForMigrationToFinish() {
-        mPersistencePolicy.waitForMigrationToFinish();
+        mPersistencePolicy.waitForInitializationToFinish();
     }
 
     /**
@@ -998,7 +999,7 @@ public class TabPersistentStore extends TabPersister {
      * @param forMerge Whether this state file was read as part of a merge.
      * @return The next available tab ID based on the maximum ID referenced in this state file.
      */
-    protected static int readSavedStateFile(
+    public static int readSavedStateFile(
             DataInputStream stream, @Nullable OnTabStateReadCallback callback,
             @Nullable SparseBooleanArray tabIds, boolean forMerge) throws IOException {
         if (stream == null) return 0;
@@ -1366,10 +1367,20 @@ public class TabPersistentStore extends TabPersister {
         return TabPersistencePolicy.SAVED_STATE_FILE_PREFIX + uniqueId;
     }
 
+    /**
+     * Parses the state file name and returns the unique ID encoded into it.
+     * @param stateFileName The state file name to be parsed.
+     * @return The unique ID used when generating the file name.
+     */
+    public static String getStateFileUniqueId(String stateFileName) {
+        assert isStateFile(stateFileName);
+        return stateFileName.substring(TabPersistencePolicy.SAVED_STATE_FILE_PREFIX.length());
+    }
+
     /**
      * @return Whether the specified filename matches the expected pattern of the tab state files.
      */
-    private static boolean isStateFile(String fileName) {
+    public static boolean isStateFile(String fileName) {
         return fileName.startsWith(TabPersistencePolicy.SAVED_STATE_FILE_PREFIX);
     }
 

chrome/android/java/src/org/chromium/chrome/browser/tabmodel/TabbedModeTabPersistencePolicy.java

@@ -143,7 +143,7 @@ public class TabbedModeTabPersistencePolicy implements TabPersistencePolicy {
     }
 
     @Override
-    public boolean performMigration(Executor executor) {
+    public boolean performInitialization(Executor executor) {
         ThreadUtils.assertOnUiThread();
 
         final boolean hasRunLegacyMigration =
@@ -291,7 +291,7 @@ public class TabbedModeTabPersistencePolicy implements TabPersistencePolicy {
     }
 
     @Override
-    public void waitForMigrationToFinish() {
+    public void waitForInitializationToFinish() {
         if (sMigrationTask == null) return;
         try {
             sMigrationTask.get();

chrome/android/java_sources.gni

@@ -269,6 +269,7 @@ chrome_java_sources = [
   "java/src/org/chromium/chrome/browser/customtabs/CustomTabObserver.java",
   "java/src/org/chromium/chrome/browser/customtabs/CustomTabsConnection.java",
   "java/src/org/chromium/chrome/browser/customtabs/CustomTabsConnectionService.java",
+  "java/src/org/chromium/chrome/browser/customtabs/CustomTabTabPersistencePolicy.java",
   "java/src/org/chromium/chrome/browser/customtabs/RequestThrottler.java",
   "java/src/org/chromium/chrome/browser/customtabs/SeparateTaskCustomTabActivity.java",
   "java/src/org/chromium/chrome/browser/customtabs/SeparateTaskCustomTabActivity0.java",
@@ -1157,6 +1158,7 @@ chrome_test_java_sources = [
   "javatests/src/org/chromium/chrome/browser/customtabs/CustomTabExternalNavigationTest.java",
   "javatests/src/org/chromium/chrome/browser/customtabs/CustomTabsConnectionTest.java",
   "javatests/src/org/chromium/chrome/browser/customtabs/CustomTabsTestUtils.java",
+  "javatests/src/org/chromium/chrome/browser/customtabs/CustomTabTabPersistencePolicyTest.java",
   "javatests/src/org/chromium/chrome/browser/customtabs/RequestThrottlerTest.java",
   "javatests/src/org/chromium/chrome/browser/document/LauncherActivityTest.java",
   "javatests/src/org/chromium/chrome/browser/dom_distiller/DistillabilityServiceTest.java",