Remove unnecessary spin in ToolTipController

ui/views/corewm/tooltip_controller_unittest.cc

 // Copyright (c) 2013 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 "ui/views/corewm/tooltip_controller.h"
 
 #include "base/macros.h"
 #include "base/strings/utf_string_conversions.h"
 #include "build/build_config.h"
 #include "ui/aura/client/cursor_client.h"
@@ skipping 169 matching lines @@
 
 TEST_F(TooltipControllerTest, ViewTooltip) {
   // TODO: these tests use GetContext(). That should go away for aura-mus
   // client. http://crbug.com/663781.
   if (IsMus())
     return;
 
   view_->set_tooltip_text(ASCIIToUTF16("Tooltip Text"));
   EXPECT_EQ(base::string16(), helper_->GetTooltipText());
   EXPECT_EQ(NULL, helper_->GetTooltipWindow());
+
+  // Mouse event will trigger tooltip update so tooltip becomes visible.
   generator_->MoveMouseToCenterOf(GetWindow());
 
   EXPECT_EQ(GetWindow(), GetRootWindow()->GetEventHandlerForPoint(
       generator_->current_location()));
   base::string16 expected_tooltip = ASCIIToUTF16("Tooltip Text");
   EXPECT_EQ(expected_tooltip, aura::client::GetTooltipText(GetWindow()));
-  EXPECT_EQ(base::string16(), helper_->GetTooltipText());
+  EXPECT_EQ(expected_tooltip, helper_->GetTooltipText());
   EXPECT_EQ(GetWindow(), helper_->GetTooltipWindow());
 
-  // Fire tooltip timer so tooltip becomes visible.
-  helper_->FireTooltipTimer();
-
   EXPECT_TRUE(helper_->IsTooltipVisible());
   generator_->MoveMouseBy(1, 0);
 
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_EQ(expected_tooltip, aura::client::GetTooltipText(GetWindow()));
   EXPECT_EQ(expected_tooltip, helper_->GetTooltipText());
   EXPECT_EQ(GetWindow(), helper_->GetTooltipWindow());
 }
 
 #if defined(OS_CHROMEOS)
 // crbug.com/664370.
 TEST_F(TooltipControllerTest, MaxWidth) {
   // TODO: these tests use GetContext(). That should go away for mus client.
   // http://crbug.com/663781.
   if (IsMus())
     return;
 
   base::string16 text = base::ASCIIToUTF16(
       "Really really realy long long long long  long tooltips that exceeds max "
       "width");
   view_->set_tooltip_text(text);
   gfx::Point center = GetWindow()->bounds().CenterPoint();
+
+  // Mouse event will trigger tooltip update so tooltip becomes visible.
   generator_->MoveMouseTo(center);
 
-  // Fire tooltip timer so tooltip becomes visible.
-  helper_->FireTooltipTimer();
-
   EXPECT_TRUE(helper_->IsTooltipVisible());
   gfx::RenderText* render_text =
       test::TooltipAuraTestApi(tooltip_aura_).GetRenderText();
 
   int max = helper_->controller()->GetMaxWidth(center);
   EXPECT_EQ(max, render_text->display_rect().width());
 }
 #endif
 
 TEST_F(TooltipControllerTest, TooltipsInMultipleViews) {
   // TODO: these tests use GetContext(). That should go away for aura-mus
   // client. http://crbug.com/663781.
   if (IsMus())
     return;
 
   view_->set_tooltip_text(ASCIIToUTF16("Tooltip Text"));
   EXPECT_EQ(base::string16(), helper_->GetTooltipText());
   EXPECT_EQ(NULL, helper_->GetTooltipWindow());
 
   PrepareSecondView();
   aura::Window* window = GetWindow();
   aura::Window* root_window = GetRootWindow();
 
-  // Fire tooltip timer so tooltip becomes visible.
+  // Mouse event will trigger tooltip update so tooltip becomes visible.
   generator_->MoveMouseRelativeTo(window, view_->bounds().CenterPoint());
-  helper_->FireTooltipTimer();
   EXPECT_TRUE(helper_->IsTooltipVisible());
   for (int i = 0; i < 49; ++i) {
     generator_->MoveMouseBy(1, 0);
     EXPECT_TRUE(helper_->IsTooltipVisible());
     EXPECT_EQ(window, root_window->GetEventHandlerForPoint(
             generator_->current_location()));
     base::string16 expected_tooltip = ASCIIToUTF16("Tooltip Text");
     EXPECT_EQ(expected_tooltip, aura::client::GetTooltipText(window));
     EXPECT_EQ(expected_tooltip, helper_->GetTooltipText());
     EXPECT_EQ(window, helper_->GetTooltipWindow());
@@ skipping 13 matching lines @@
 TEST_F(TooltipControllerTest, EnableOrDisableTooltips) {
   // TODO: these tests use GetContext(). That should go away for aura-mus
   // client. http://crbug.com/663781.
   if (IsMus())
     return;
 
   view_->set_tooltip_text(ASCIIToUTF16("Tooltip Text"));
   EXPECT_EQ(base::string16(), helper_->GetTooltipText());
   EXPECT_EQ(NULL, helper_->GetTooltipWindow());
 
+  // Mouse event will trigger tooltip update so tooltip becomes visible.
   generator_->MoveMouseRelativeTo(GetWindow(), view_->bounds().CenterPoint());
-  base::string16 expected_tooltip = ASCIIToUTF16("Tooltip Text");
-
-  // Fire tooltip timer so tooltip becomes visible.
-  helper_->FireTooltipTimer();
   EXPECT_TRUE(helper_->IsTooltipVisible());
 
   // Disable tooltips and check again.
   helper_->controller()->SetTooltipsEnabled(false);
   EXPECT_FALSE(helper_->IsTooltipVisible());
-  helper_->FireTooltipTimer();
+  helper_->UpdateIfRequired();
   EXPECT_FALSE(helper_->IsTooltipVisible());
 
   // Enable tooltips back and check again.
   helper_->controller()->SetTooltipsEnabled(true);
   EXPECT_FALSE(helper_->IsTooltipVisible());
-  helper_->FireTooltipTimer();
+  helper_->UpdateIfRequired();
   EXPECT_TRUE(helper_->IsTooltipVisible());
 }
 
 // Verifies tooltip isn't shown if tooltip text consists entirely of whitespace.
 TEST_F(TooltipControllerTest, DontShowEmptyTooltips) {
   // TODO: these tests use GetContext(). That should go away for aura-mus
   // client. http://crbug.com/663781.
   if (IsMus())
     return;
 
   view_->set_tooltip_text(ASCIIToUTF16("                     "));
   EXPECT_EQ(base::string16(), helper_->GetTooltipText());
   EXPECT_EQ(NULL, helper_->GetTooltipWindow());
 
+  // Mouse event will trigger tooltip update so tooltip becomes visible.
   generator_->MoveMouseRelativeTo(GetWindow(), view_->bounds().CenterPoint());
-
-  helper_->FireTooltipTimer();
   EXPECT_FALSE(helper_->IsTooltipVisible());
 }
 
 TEST_F(TooltipControllerTest, TooltipHidesOnKeyPressAndStaysHiddenUntilChange) {
   // TODO: these tests use GetContext(). That should go away for aura-mus
   // client. http://crbug.com/663781.
   if (IsMus())
     return;
 
   view_->set_tooltip_text(ASCIIToUTF16("Tooltip Text for view 1"));
   EXPECT_EQ(base::string16(), helper_->GetTooltipText());
   EXPECT_EQ(NULL, helper_->GetTooltipWindow());
 
   TooltipTestView* view2 = PrepareSecondView();
   view2->set_tooltip_text(ASCIIToUTF16("Tooltip Text for view 2"));
 
   aura::Window* window = GetWindow();
 
-  // Fire tooltip timer so tooltip becomes visible.
+  // Mouse event will trigger tooltip update so tooltip becomes visible.
   generator_->MoveMouseRelativeTo(window, view_->bounds().CenterPoint());
-  helper_->FireTooltipTimer();
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_TRUE(helper_->IsTooltipShownTimerRunning());
 
   generator_->PressKey(ui::VKEY_1, 0);
   EXPECT_FALSE(helper_->IsTooltipVisible());
-  EXPECT_FALSE(helper_->IsTooltipTimerRunning());
   EXPECT_FALSE(helper_->IsTooltipShownTimerRunning());
 
   // Moving the mouse inside |view1| should not change the state of the tooltip
   // or the timers.
   for (int i = 0; i < 49; i++) {
     generator_->MoveMouseBy(1, 0);
     EXPECT_FALSE(helper_->IsTooltipVisible());
-    EXPECT_FALSE(helper_->IsTooltipTimerRunning());
     EXPECT_FALSE(helper_->IsTooltipShownTimerRunning());
     EXPECT_EQ(window,
               GetRootWindow()->GetEventHandlerForPoint(
                   generator_->current_location()));
     base::string16 expected_tooltip = ASCIIToUTF16("Tooltip Text for view 1");
     EXPECT_EQ(expected_tooltip, aura::client::GetTooltipText(window));
     EXPECT_EQ(expected_tooltip, helper_->GetTooltipText());
     EXPECT_EQ(window, helper_->GetTooltipWindow());
   }
 
-  // Now we move the mouse on to |view2|. It should re-start the tooltip timer.
+  // Now we move the mouse on to |view2|. It should update the tooltip.
   generator_->MoveMouseBy(1, 0);
-  EXPECT_TRUE(helper_->IsTooltipTimerRunning());
-  helper_->FireTooltipTimer();
+  helper_->UpdateIfRequired();
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_TRUE(helper_->IsTooltipShownTimerRunning());
   base::string16 expected_tooltip = ASCIIToUTF16("Tooltip Text for view 2");
   EXPECT_EQ(expected_tooltip, aura::client::GetTooltipText(window));
   EXPECT_EQ(expected_tooltip, helper_->GetTooltipText());
   EXPECT_EQ(window, helper_->GetTooltipWindow());
 }
 
 TEST_F(TooltipControllerTest, TooltipHidesOnTimeoutAndStaysHiddenUntilChange) {
   // TODO: these tests use GetContext(). That should go away for aura-mus
   // client. http://crbug.com/663781.
   if (IsMus())
     return;
 
   view_->set_tooltip_text(ASCIIToUTF16("Tooltip Text for view 1"));
   EXPECT_EQ(base::string16(), helper_->GetTooltipText());
   EXPECT_EQ(NULL, helper_->GetTooltipWindow());
 
   TooltipTestView* view2 = PrepareSecondView();
   view2->set_tooltip_text(ASCIIToUTF16("Tooltip Text for view 2"));
 
   aura::Window* window = GetWindow();
 
-  // Fire tooltip timer so tooltip becomes visible.
+  // Update tooltip so tooltip becomes visible.
   generator_->MoveMouseRelativeTo(window, view_->bounds().CenterPoint());
-  helper_->FireTooltipTimer();
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_TRUE(helper_->IsTooltipShownTimerRunning());
 
   helper_->FireTooltipShownTimer();
   EXPECT_FALSE(helper_->IsTooltipVisible());
-  EXPECT_FALSE(helper_->IsTooltipTimerRunning());
   EXPECT_FALSE(helper_->IsTooltipShownTimerRunning());
 
   // Moving the mouse inside |view1| should not change the state of the tooltip
   // or the timers.
   for (int i = 0; i < 49; ++i) {
     generator_->MoveMouseBy(1, 0);
     EXPECT_FALSE(helper_->IsTooltipVisible());
-    EXPECT_FALSE(helper_->IsTooltipTimerRunning());
     EXPECT_FALSE(helper_->IsTooltipShownTimerRunning());
     EXPECT_EQ(window, GetRootWindow()->GetEventHandlerForPoint(
                   generator_->current_location()));
     base::string16 expected_tooltip = ASCIIToUTF16("Tooltip Text for view 1");
     EXPECT_EQ(expected_tooltip, aura::client::GetTooltipText(window));
     EXPECT_EQ(expected_tooltip, helper_->GetTooltipText());
     EXPECT_EQ(window, helper_->GetTooltipWindow());
   }
 
-  // Now we move the mouse on to |view2|. It should re-start the tooltip timer.
+  // Now we move the mouse on to |view2|. It should update the tooltip.
   generator_->MoveMouseBy(1, 0);
-  EXPECT_TRUE(helper_->IsTooltipTimerRunning());
-  helper_->FireTooltipTimer();
+  helper_->UpdateIfRequired();
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_TRUE(helper_->IsTooltipShownTimerRunning());
   base::string16 expected_tooltip = ASCIIToUTF16("Tooltip Text for view 2");
   EXPECT_EQ(expected_tooltip, aura::client::GetTooltipText(window));
   EXPECT_EQ(expected_tooltip, helper_->GetTooltipText());
   EXPECT_EQ(window, helper_->GetTooltipWindow());
 }
 
 // Verifies a mouse exit event hides the tooltips.
 TEST_F(TooltipControllerTest, HideOnExit) {
   // TODO: these tests use GetContext(). That should go away for aura-mus
   // client. http://crbug.com/663781.
   if (IsMus())
     return;
 
   view_->set_tooltip_text(ASCIIToUTF16("Tooltip Text"));
   generator_->MoveMouseToCenterOf(GetWindow());
   base::string16 expected_tooltip = ASCIIToUTF16("Tooltip Text");
   EXPECT_EQ(expected_tooltip, aura::client::GetTooltipText(GetWindow()));
-  EXPECT_EQ(base::string16(), helper_->GetTooltipText());
+  EXPECT_EQ(expected_tooltip, helper_->GetTooltipText());
   EXPECT_EQ(GetWindow(), helper_->GetTooltipWindow());
 
-  // Fire tooltip timer so tooltip becomes visible.
-  helper_->FireTooltipTimer();
-
   EXPECT_TRUE(helper_->IsTooltipVisible());
   generator_->SendMouseExit();
   EXPECT_FALSE(helper_->IsTooltipVisible());
 }
 
 TEST_F(TooltipControllerTest, ReshowOnClickAfterEnterExit) {
   // TODO: these tests use GetContext(). That should go away for aura-mus
   // client. http://crbug.com/663781.
   if (IsMus())
     return;
@@ skipping 10 matching lines @@
   v2->SetBoundsRect(view_bounds);
   const base::string16 v1_tt(ASCIIToUTF16("v1"));
   const base::string16 v2_tt(ASCIIToUTF16("v2"));
   v1->set_tooltip_text(v1_tt);
   v2->set_tooltip_text(v2_tt);
 
   gfx::Point v1_point(1, 1);
   View::ConvertPointToWidget(v1, &v1_point);
   generator_->MoveMouseRelativeTo(GetWindow(), v1_point);
 
-  // Fire tooltip timer so tooltip becomes visible.
-  helper_->FireTooltipTimer();
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_EQ(v1_tt, helper_->GetTooltipText());
 
   // Press the mouse, move to v2 and back to v1.
   generator_->ClickLeftButton();
 
   gfx::Point v2_point(1, 1);
   View::ConvertPointToWidget(v2, &v2_point);
   generator_->MoveMouseRelativeTo(GetWindow(), v2_point);
   generator_->MoveMouseRelativeTo(GetWindow(), v1_point);
 
-  helper_->FireTooltipTimer();
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_EQ(v1_tt, helper_->GetTooltipText());
 }
 
 namespace {
 
 // Returns the index of |window| in its parent's children.
 int IndexInParent(const aura::Window* window) {
   aura::Window::Windows::const_iterator i =
       std::find(window->parent()->children().begin(),
@@ skipping 44 matching lines @@
 
   view_->GetWidget()->SetCapture(view_);
   RunPendingMessages();
   view_->set_tooltip_text(ASCIIToUTF16("Tooltip Text"));
   generator_->MoveMouseToCenterOf(GetWindow());
   base::string16 expected_tooltip = ASCIIToUTF16("Tooltip Text");
   EXPECT_EQ(expected_tooltip, aura::client::GetTooltipText(GetWindow()));
   EXPECT_EQ(base::string16(), helper_->GetTooltipText());
   EXPECT_EQ(GetWindow(), helper_->GetTooltipWindow());
 
-  // Fire tooltip timer so tooltip becomes visible.
-  helper_->FireTooltipTimer();
-
   EXPECT_TRUE(helper_->IsTooltipVisible());
   view_->GetWidget()->ReleaseCapture();
   EXPECT_FALSE(helper_->IsTooltipVisible());
   EXPECT_TRUE(helper_->GetTooltipWindow() == NULL);
 }
 
 // Disabled on linux as DesktopScreenX11::GetWindowAtScreenPoint() doesn't
 // consider z-order.
 // Disabled on Windows due to failing bots. http://crbug.com/604479
 #if (defined(OS_LINUX) && !defined(OS_CHROMEOS)) || defined(OS_WIN)
@@ skipping 25 matching lines @@
 
   widget_->SetCapture(view_);
   EXPECT_TRUE(widget_->HasCapture());
   widget2->Show();
   EXPECT_GE(IndexInParent(widget2->GetNativeWindow()),
             IndexInParent(widget_->GetNativeWindow()));
 
   generator_->MoveMouseRelativeTo(widget_->GetNativeWindow(),
                                   view_->bounds().CenterPoint());
 
-  EXPECT_TRUE(helper_->IsTooltipTimerRunning());
-  helper_->FireTooltipTimer();
   // Even though the mouse is over a window with a tooltip it shouldn't be
   // picked up because the windows don't have the same value for
   // |TooltipManager::kGroupingPropertyKey|.
   EXPECT_TRUE(helper_->GetTooltipText().empty());
 
   // Now make both the windows have same transient value for
   // kGroupingPropertyKey. In this case the tooltip should be picked up from
   // |widget2| (because the mouse is over it).
   const int grouping_key = 1;
   widget_->SetNativeWindowProperty(TooltipManager::kGroupingPropertyKey,
                                    reinterpret_cast<void*>(grouping_key));
   widget2->SetNativeWindowProperty(TooltipManager::kGroupingPropertyKey,
                                    reinterpret_cast<void*>(grouping_key));
   generator_->MoveMouseBy(1, 10);
-  EXPECT_TRUE(helper_->IsTooltipTimerRunning());
-  helper_->FireTooltipTimer();
   EXPECT_EQ(tooltip_text2, helper_->GetTooltipText());
 
   widget2.reset();
 }
 
 namespace {
 
 class TestTooltip : public Tooltip {
  public:
   TestTooltip() : is_visible_(false) {}
@@ skipping 65 matching lines @@
 };
 
 TEST_F(TooltipControllerTest2, VerifyLeadingTrailingWhitespaceStripped) {
   aura::test::TestWindowDelegate test_delegate;
   std::unique_ptr<aura::Window> window(
       CreateNormalWindow(100, root_window(), &test_delegate));
   window->SetBounds(gfx::Rect(0, 0, 300, 300));
   base::string16 tooltip_text(ASCIIToUTF16(" \nx  "));
   aura::client::SetTooltipText(window.get(), &tooltip_text);
   generator_->MoveMouseToCenterOf(window.get());
-  helper_->FireTooltipTimer();
   EXPECT_EQ(ASCIIToUTF16("x"), test_tooltip_->tooltip_text());
 }
 
 // Verifies that tooltip is hidden and tooltip window closed upon cancel mode.
 TEST_F(TooltipControllerTest2, CloseOnCancelMode) {
   aura::test::TestWindowDelegate test_delegate;
   std::unique_ptr<aura::Window> window(
       CreateNormalWindow(100, root_window(), &test_delegate));
   window->SetBounds(gfx::Rect(0, 0, 300, 300));
   base::string16 tooltip_text(ASCIIToUTF16("Tooltip Text"));
   aura::client::SetTooltipText(window.get(), &tooltip_text);
   generator_->MoveMouseToCenterOf(window.get());
 
-  // Fire tooltip timer so tooltip becomes visible.
-  helper_->FireTooltipTimer();
   EXPECT_TRUE(helper_->IsTooltipVisible());
 
   // Send OnCancelMode event and verify that tooltip becomes invisible and
   // the tooltip window is closed.
   ui::CancelModeEvent event;
   helper_->controller()->OnCancelMode(&event);
   EXPECT_FALSE(helper_->IsTooltipVisible());
   EXPECT_TRUE(helper_->GetTooltipWindow() == NULL);
 }
 
@@ skipping 108 matching lines @@
   v1->SetBoundsRect(view_bounds);
   v1_1->SetBounds(0, 0, 3, 3);
   view_bounds.set_y(view_bounds.height());
   v2->SetBoundsRect(view_bounds);
   v2_2->SetBounds(view_bounds.width() - 3, view_bounds.height() - 3, 3, 3);
   v2_1->SetBounds(0, 0, 3, 3);
 
   // Test whether a toolbar appears on v1
   gfx::Point center = v1->bounds().CenterPoint();
   generator_->MoveMouseRelativeTo(GetWindow(), center);
-  helper_->FireTooltipTimer();
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_EQ(reference_string, helper_->GetTooltipText());
   gfx::Point tooltip_bounds1 = test_tooltip_->location();
 
   // Test whether the toolbar changes position on mouse over v2
   center = v2->bounds().CenterPoint();
   generator_->MoveMouseRelativeTo(GetWindow(), center);
-  helper_->FireTooltipTimer();
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_EQ(reference_string, helper_->GetTooltipText());
   gfx::Point tooltip_bounds2 = test_tooltip_->location();
 
   EXPECT_NE(tooltip_bounds1, gfx::Point());
   EXPECT_NE(tooltip_bounds2, gfx::Point());
   EXPECT_NE(tooltip_bounds1, tooltip_bounds2);
 
   // Test if the toolbar does not change position on encountering a contained
   // view with the same tooltip text
   center = v2_1->GetLocalBounds().CenterPoint();
   views::View::ConvertPointToTarget(v2_1, view_, &center);
   generator_->MoveMouseRelativeTo(GetWindow(), center);
-  helper_->FireTooltipTimer();
   gfx::Point tooltip_bounds2_1 = test_tooltip_->location();
 
   EXPECT_NE(tooltip_bounds2, tooltip_bounds2_1);
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_EQ(reference_string, helper_->GetTooltipText());
 
   // Test if the toolbar changes position on encountering a contained
   // view with a different tooltip text
   center = v2_2->GetLocalBounds().CenterPoint();
   views::View::ConvertPointToTarget(v2_2, view_, &center);
   generator_->MoveMouseRelativeTo(GetWindow(), center);
-  helper_->FireTooltipTimer();
   gfx::Point tooltip_bounds2_2 = test_tooltip_->location();
 
   EXPECT_NE(tooltip_bounds2_1, tooltip_bounds2_2);
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_EQ(alternative_string, helper_->GetTooltipText());
 
   // Test if moving from a view that is contained by a larger view, both with
   // the same tooltip text, does not change tooltip's position.
   center = v1_1->GetLocalBounds().CenterPoint();
   views::View::ConvertPointToTarget(v1_1, view_, &center);
   generator_->MoveMouseRelativeTo(GetWindow(), center);
-  helper_->FireTooltipTimer();
   gfx::Point tooltip_bounds1_1 = test_tooltip_->location();
 
   EXPECT_TRUE(helper_->IsTooltipVisible());
   EXPECT_EQ(reference_string, helper_->GetTooltipText());
 
   center = v1->bounds().CenterPoint();
   generator_->MoveMouseRelativeTo(GetWindow(), center);
-  helper_->FireTooltipTimer();
   tooltip_bounds1 = test_tooltip_->location();
 
   EXPECT_NE(tooltip_bounds1_1, tooltip_bounds1);
   EXPECT_EQ(reference_string, helper_->GetTooltipText());
 }
 
 }  // namespace test
 }  // namespace corewm
 }  // namespace views