[TooManyTabs] Add TabNavigationThrottle

chrome/browser/resource_coordinator/tab_manager_unittest.cc

 // Copyright (c) 2012 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.
 
 #include "chrome/browser/resource_coordinator/tab_manager.h"
 
 #include <algorithm>
 #include <map>
 #include <memory>
 #include <vector>
@@ skipping 21 matching lines @@
 #include "chrome/test/base/testing_profile.h"
 #include "components/variations/variations_associated_data.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/test/mock_render_process_host.h"
 #include "content/public/test/web_contents_tester.h"
 #include "content/test/test_web_contents.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "url/gurl.h"
 
+using content::NavigationHandle;
+using content::NavigationThrottle;
 using content::WebContents;
 using content::WebContentsTester;
 
 namespace resource_coordinator {
 namespace {
 
+const char kTestUrl[] = "http://www.example.com";
+
 class TabStripDummyDelegate : public TestTabStripModelDelegate {
  public:
   TabStripDummyDelegate() {}
 
   bool RunUnloadListenerBeforeClosing(WebContents* contents) override {
     return false;
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(TabStripDummyDelegate);
@@ skipping 49 matching lines @@
 
 class TabManagerTest : public ChromeRenderViewHostTestHarness {
  public:
   WebContents* CreateWebContents() {
     content::TestWebContents* web_contents =
         content::TestWebContents::Create(profile(), nullptr);
     // Commit an URL to allow discarding.
     web_contents->NavigateAndCommit(GURL("https://www.example.com"));
     return web_contents;
   }
+
+  std::unique_ptr<NavigationHandle> CreateTabAndNavigation() {
+    content::TestWebContents* web_contents =
+        content::TestWebContents::Create(profile(), nullptr);
+    return content::NavigationHandle::CreateNavigationHandleForTesting(
+        GURL(kTestUrl), web_contents->GetMainFrame());
+  }
+
+  // Simulate creating 3 tabs and their navigations.
+  void MaybeThrottleNavigations(TabManager* tab_manager) {
+    nav_handle1_ = CreateTabAndNavigation();
+    nav_handle2_ = CreateTabAndNavigation();
+    nav_handle3_ = CreateTabAndNavigation();
+    contents1_ = nav_handle1_->GetWebContents();
+    contents2_ = nav_handle2_->GetWebContents();
+    contents3_ = nav_handle3_->GetWebContents();
+
+    NavigationThrottle::ThrottleCheckResult result1 =
+        tab_manager->MaybeThrottleNavigation(nav_handle1_.get());
+    NavigationThrottle::ThrottleCheckResult result2 =
+        tab_manager->MaybeThrottleNavigation(nav_handle2_.get());
+    NavigationThrottle::ThrottleCheckResult result3 =
+        tab_manager->MaybeThrottleNavigation(nav_handle3_.get());
+
+    // First tab starts navigation right away because there is no tab loading.
+    EXPECT_EQ(content::NavigationThrottle::PROCEED, result1);
+
+    // The other 2 tabs's navigations are delayed.
+    EXPECT_EQ(content::NavigationThrottle::DEFER, result2);
+    EXPECT_EQ(content::NavigationThrottle::DEFER, result3);
+  }
+
+ protected:
+  std::unique_ptr<NavigationHandle> nav_handle1_;
+  std::unique_ptr<NavigationHandle> nav_handle2_;
+  std::unique_ptr<NavigationHandle> nav_handle3_;
+  WebContents* contents1_;
+  WebContents* contents2_;
+  WebContents* contents3_;
 };
 
 // TODO(georgesak): Add tests for protection to tabs with form input and
 // playing audio;
 
 // Tests the sorting comparator to make sure it's producing the desired order.
 TEST_F(TabManagerTest, Comparator) {
   TabStatsList test_list;
   const base::TimeTicks now = base::TimeTicks::Now();
 
@@ skipping 558 matching lines @@
 
   histograms.ExpectTotalCount(kHistogramName, 9);
   histograms.ExpectBucketCount(kHistogramName, TAB_IS_NOT_LOADING, 2);
   histograms.ExpectBucketCount(kHistogramName, TAB_IS_LOADING, 3);
   histograms.ExpectBucketCount(kHistogramName, TAB_IS_LOADED, 4);
 
   // Tabs with a committed URL must be closed explicitly to avoid DCHECK errors.
   tab_strip.CloseAllTabs();
 }
 
+TEST_F(TabManagerTest, MaybeThrottleNavigation) {
+  TabManager* tab_manager = g_browser_process->GetTabManager();
+  MaybeThrottleNavigations(tab_manager);
+  tab_manager->GetWebContentsData(contents1_)
+      ->DidStartNavigation(nav_handle1_.get());
+
+  // Tab 1 is loading. The other 2 tabs's navigations are delayed.
+  EXPECT_TRUE(tab_manager->IsTabLoadingForTest(contents1_));
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents2_));
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents3_));
+
+  EXPECT_FALSE(tab_manager->IsNavigationDelayedForTest(nav_handle1_.get()));
+  EXPECT_TRUE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+  EXPECT_TRUE(tab_manager->IsNavigationDelayedForTest(nav_handle3_.get()));
+}
+
+TEST_F(TabManagerTest, OnDidFinishNavigation) {
+  TabManager* tab_manager = g_browser_process->GetTabManager();
+  MaybeThrottleNavigations(tab_manager);
+  tab_manager->GetWebContentsData(contents1_)
+      ->DidStartNavigation(nav_handle1_.get());
+
+  EXPECT_TRUE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+  tab_manager->GetWebContentsData(contents2_)
+      ->DidFinishNavigation(nav_handle2_.get());
+  EXPECT_FALSE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+}
+
+TEST_F(TabManagerTest, OnDidStopLoading) {
+  TabManager* tab_manager = g_browser_process->GetTabManager();
+  MaybeThrottleNavigations(tab_manager);
+  tab_manager->GetWebContentsData(contents1_)
+      ->DidStartNavigation(nav_handle1_.get());
+
+  EXPECT_TRUE(tab_manager->IsTabLoadingForTest(contents1_));
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents2_));
+  EXPECT_TRUE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+
+  // Simulate tab 1 has finished loading.
+  tab_manager->GetWebContentsData(contents1_)->DidStopLoading();
+
+  // After tab 1 has finished loading, TabManager starts loading the next tab.
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents1_));
+  EXPECT_TRUE(tab_manager->IsTabLoadingForTest(contents2_));
+  EXPECT_FALSE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+}
+
+TEST_F(TabManagerTest, OnWebContentsDestroyed) {
+  TabManager* tab_manager = g_browser_process->GetTabManager();
+  MaybeThrottleNavigations(tab_manager);
+  tab_manager->GetWebContentsData(contents1_)
+      ->DidStartNavigation(nav_handle1_.get());
+
+  // Tab 2 is destroyed when its navigation is still delayed. Its states are
+  // cleaned up.
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents2_));
+  EXPECT_TRUE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+  tab_manager->OnWebContentsDestroyed(contents2_);
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents2_));
+  EXPECT_FALSE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+
+  // Tab 1 is destroyed when it is still loading. Its states are cleaned up and
+  // Tabmanager starts to load the next tab (tab 3).
+  EXPECT_TRUE(tab_manager->IsTabLoadingForTest(contents1_));
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents3_));
+  EXPECT_TRUE(tab_manager->IsNavigationDelayedForTest(nav_handle3_.get()));
+  tab_manager->GetWebContentsData(contents1_)->WebContentsDestroyed();
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents1_));
+  EXPECT_TRUE(tab_manager->IsTabLoadingForTest(contents3_));
+  EXPECT_FALSE(tab_manager->IsNavigationDelayedForTest(nav_handle3_.get()));
+}
+
+TEST_F(TabManagerTest, OnDelayedTabSelected) {
+  TabManager* tab_manager = g_browser_process->GetTabManager();
+  MaybeThrottleNavigations(tab_manager);
+  tab_manager->GetWebContentsData(contents1_)
+      ->DidStartNavigation(nav_handle1_.get());
+
+  EXPECT_TRUE(tab_manager->IsTabLoadingForTest(contents1_));
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents3_));
+  EXPECT_TRUE(tab_manager->IsNavigationDelayedForTest(nav_handle3_.get()));
+
+  // Simulate selecting tab 3, which should start loading immediately.
+  tab_manager->ActiveTabChanged(
+      contents1_, contents3_, 2,
+      TabStripModelObserver::CHANGE_REASON_USER_GESTURE);
+
+  EXPECT_TRUE(tab_manager->IsTabLoadingForTest(contents1_));
+  EXPECT_TRUE(tab_manager->IsTabLoadingForTest(contents3_));
+  EXPECT_FALSE(tab_manager->IsNavigationDelayedForTest(nav_handle3_.get()));
+
+  // Simulate tab 1 has finished loading. TabManager will NOT load the next tab
+  // (tab 2) because tab 3 is still loading.
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents2_));
+  EXPECT_TRUE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+  tab_manager->GetWebContentsData(contents1_)->DidStopLoading();
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents1_));
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents2_));
+  EXPECT_TRUE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+
+  // Simulate tab 3 has finished loading. TabManager starts loading the next tab
+  // (tab 2).
+  tab_manager->GetWebContentsData(contents3_)->DidStopLoading();
+  EXPECT_FALSE(tab_manager->IsTabLoadingForTest(contents3_));
+  EXPECT_TRUE(tab_manager->IsTabLoadingForTest(contents2_));
+  EXPECT_FALSE(tab_manager->IsNavigationDelayedForTest(nav_handle2_.get()));
+}
+
 }  // namespace resource_coordinator