Paint tab-loading throbbers into a ui::Layer.

chrome/browser/ui/views/tabs/tab_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/ui/views/tabs/tab.h"
 
 #include "base/i18n/rtl.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/ui/tabs/tab_utils.h"
 #include "chrome/browser/ui/views/tabs/media_indicator_button.h"
 #include "chrome/browser/ui/views/tabs/tab_controller.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "ui/base/models/list_selection_model.h"
 #include "ui/views/controls/button/image_button.h"
 #include "ui/views/controls/label.h"
 #include "ui/views/test/views_test_base.h"
 #include "ui/views/widget/widget.h"
 
 using views::Widget;
 
 class FakeTabController : public TabController {
  public:
-  FakeTabController() : immersive_style_(false), active_tab_(false) {
-  }
-  ~FakeTabController() override {}
+  FakeTabController() {}
 
   void set_immersive_style(bool value) { immersive_style_ = value; }
   void set_active_tab(bool value) { active_tab_ = value; }
+  void set_paint_throbber_to_layer(bool value) {
+    paint_throbber_to_layer_ = value;
+  }
 
   const ui::ListSelectionModel& GetSelectionModel() override {
     return selection_model_;
   }
   bool SupportsMultipleSelection() override { return false; }
   bool ShouldHideCloseButtonForInactiveTabs() override {
     return false;
   }
   void SelectTab(Tab* tab) override {}
   void ExtendSelectionTo(Tab* tab) override {}
@@ skipping 13 matching lines @@
       const ui::ListSelectionModel& original_selection) override {}
   void ContinueDrag(views::View* view, const ui::LocatedEvent& event) override {
   }
   bool EndDrag(EndDragReason reason) override { return false; }
   Tab* GetTabAt(Tab* tab, const gfx::Point& tab_in_tab_coordinates) override {
     return NULL;
   }
   void OnMouseEventInTab(views::View* source,
                          const ui::MouseEvent& event) override {}
   bool ShouldPaintTab(const Tab* tab, gfx::Rect* clip) override { return true; }
+  bool CanPaintThrobberToLayer() const override {
+    return paint_throbber_to_layer_;
+  }
   bool IsImmersiveStyle() const override { return immersive_style_; }
   void UpdateTabAccessibilityState(const Tab* tab,
                                    ui::AXViewState* state) override{};
 
  private:
   ui::ListSelectionModel selection_model_;
-  bool immersive_style_;
-  bool active_tab_;
+  bool immersive_style_ = false;
+  bool active_tab_ = false;
+  bool paint_throbber_to_layer_ = true;
 
   DISALLOW_COPY_AND_ASSIGN(FakeTabController);
 };
 
 class TabTest : public views::ViewsTestBase,
                 public ::testing::WithParamInterface<bool> {
  public:
   TabTest() {}
   virtual ~TabTest() {}
 
   bool testing_for_rtl_locale() const { return GetParam(); }
 
   void SetUp() override {
     if (testing_for_rtl_locale()) {
       original_locale_ = base::i18n::GetConfiguredLocale();
       base::i18n::SetICUDefaultLocale("he");
     }
     views::ViewsTestBase::SetUp();
   }
 
   void TearDown() override {
     views::ViewsTestBase::TearDown();
     if (testing_for_rtl_locale())
       base::i18n::SetICUDefaultLocale(original_locale_);
   }
 
+  static views::ImageButton* GetCloseButton(const Tab& tab) {
+    return tab.close_button_;
+  }
+
+  static views::View* GetThrobberView(const Tab& tab) {
+    // Reinterpret to keep the definition encapsulated (which works so long as
+    // multiple inheritance isn't involved).
+    return reinterpret_cast<views::View*>(tab.throbber_);
+  }
+
+  static gfx::Rect GetFaviconBounds(const Tab& tab) {
+    return tab.favicon_bounds_;
+  }
+
+  static void LayoutTab(Tab* tab) { tab->Layout(); }
+
   static void CheckForExpectedLayoutAndVisibilityOfElements(const Tab& tab) {
     // Check whether elements are visible when they are supposed to be, given
     // Tab size and TabRendererData state.
     if (tab.data_.pinned) {
       EXPECT_EQ(1, tab.IconCapacity());
       if (tab.data_.media_state != TAB_MEDIA_STATE_NONE) {
         EXPECT_FALSE(tab.ShouldShowIcon());
         EXPECT_TRUE(tab.ShouldShowMediaIndicator());
       } else {
         EXPECT_TRUE(tab.ShouldShowIcon());
@@ skipping 274 matching lines @@
 // shouldn't change the insets of the close button.
 TEST_P(TabTest, CloseButtonLayout) {
   if (testing_for_rtl_locale() && !base::i18n::IsRTL()) {
     LOG(WARNING) << "Testing of RTL locale not supported on current platform.";
     return;
   }
 
   FakeTabController tab_controller;
   Tab tab(&tab_controller);
   tab.SetBounds(0, 0, 100, 50);
-  tab.Layout();
-  gfx::Insets close_button_insets = tab.close_button_->GetInsets();
-  tab.Layout();
-  gfx::Insets close_button_insets_2 = tab.close_button_->GetInsets();
+  LayoutTab(&tab);
+  gfx::Insets close_button_insets = GetCloseButton(tab)->GetInsets();
+  LayoutTab(&tab);
+  gfx::Insets close_button_insets_2 = GetCloseButton(tab)->GetInsets();
   EXPECT_EQ(close_button_insets.top(), close_button_insets_2.top());
   EXPECT_EQ(close_button_insets.left(), close_button_insets_2.left());
   EXPECT_EQ(close_button_insets.bottom(), close_button_insets_2.bottom());
   EXPECT_EQ(close_button_insets.right(), close_button_insets_2.right());
 
   // Also make sure the close button is sized as large as the tab.
-  EXPECT_EQ(50, tab.close_button_->bounds().height());
+  EXPECT_EQ(50, GetCloseButton(tab)->bounds().height());
+}
+
+// Tests expected changes to the ThrobberView state when the WebContents loading
+// state changes or the animation timer (usually in BrowserView) triggers.
+TEST_P(TabTest, LayeredThrobber) {
+  if (testing_for_rtl_locale() && !base::i18n::IsRTL()) {
+    LOG(WARNING) << "Testing of RTL locale not supported on current platform.";
+    return;
+  }
+
+  Widget widget;
+  InitWidget(&widget);
+
+  FakeTabController tab_controller;
+  Tab tab(&tab_controller);
+  widget.GetContentsView()->AddChildView(&tab);
+  tab.SetBoundsRect(gfx::Rect(Tab::GetStandardSize()));
+
+  views::View* throbber = GetThrobberView(tab);
+  EXPECT_FALSE(throbber->visible());
+  EXPECT_EQ(TabRendererData::NETWORK_STATE_NONE, tab.data().network_state);
+  EXPECT_EQ(throbber->bounds(), GetFaviconBounds(tab));
+
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_NONE);
+  EXPECT_FALSE(throbber->visible());
+
+  // Simulate a "normal" tab load: should paint to a layer.
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_WAITING);
+  EXPECT_TRUE(tab_controller.CanPaintThrobberToLayer());
+  EXPECT_TRUE(throbber->visible());
+  EXPECT_TRUE(throbber->layer());
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_LOADING);
+  EXPECT_TRUE(throbber->visible());
+  EXPECT_TRUE(throbber->layer());
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_NONE);
+  EXPECT_FALSE(throbber->visible());
+
+  // Simulate a drag started and stopped during a load: layer painting stops
+  // temporarily.
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_WAITING);
+  EXPECT_TRUE(throbber->visible());
+  EXPECT_TRUE(throbber->layer());
+  tab_controller.set_paint_throbber_to_layer(false);
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_WAITING);
+  EXPECT_TRUE(throbber->visible());
+  EXPECT_FALSE(throbber->layer());
+  tab_controller.set_paint_throbber_to_layer(true);
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_WAITING);
+  EXPECT_TRUE(throbber->visible());
+  EXPECT_TRUE(throbber->layer());
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_NONE);
+  EXPECT_FALSE(throbber->visible());
+
+  // Simulate a tab load starting and stopping during tab dragging (or with
+  // stacked tabs): no layer painting.
+  tab_controller.set_paint_throbber_to_layer(false);
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_WAITING);
+  EXPECT_TRUE(throbber->visible());
+  EXPECT_FALSE(throbber->layer());
+  tab.UpdateLoadingAnimation(TabRendererData::NETWORK_STATE_NONE);
+  EXPECT_FALSE(throbber->visible());
 }
 
 // Test in both a LTR and a RTL locale.  Note: The fact that the UI code is
 // configured for an RTL locale does *not* change how the coordinates are
 // examined in the tests above because views::View and friends are supposed to
 // auto-mirror the widgets when painting.  Thus, what we're testing here is that
 // there's no code in Tab that will erroneously subvert this automatic
 // coordinate translation.  http://crbug.com/384179
 INSTANTIATE_TEST_CASE_P(, TabTest, ::testing::Values(false, true));