Fix spurious visibility events when committing Instant.

chrome/browser/instant/instant_browsertest.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 "base/stringprintf.h"
 #include "chrome/browser/content_settings/host_content_settings_map.h"
 #include "chrome/browser/history/history_service_factory.h"
 #include "chrome/browser/instant/instant_controller.h"
 #include "chrome/browser/instant/instant_loader.h"
 #include "chrome/browser/instant/instant_model.h"
 #include "chrome/browser/instant/instant_model_observer.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/search_engines/template_url_service.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
 #include "chrome/browser/task_manager/task_manager.h"
 #include "chrome/browser/task_manager/task_manager_browsertest_util.h"
 #include "chrome/browser/ui/browser_commands.h"
 #include "chrome/browser/ui/browser_instant_controller.h"
 #include "chrome/browser/ui/browser_tabstrip.h"
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/browser/ui/omnibox/location_bar.h"
 #include "chrome/browser/ui/omnibox/omnibox_view.h"
 #include "chrome/browser/ui/tab_contents/tab_contents.h"
+#include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/test/base/in_process_browser_test.h"
 #include "chrome/test/base/ui_test_utils.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/test/browser_test_utils.h"
 #include "grit/generated_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 
@@ skipping 102 matching lines @@
 
   bool GetStringFromJS(content::RenderViewHost* rvh,
                        const std::string& script,
                        std::string* result) WARN_UNUSED_RESULT {
     return content::ExecuteJavaScriptAndExtractString(
         rvh, std::wstring(), WrapScript(script), result);
   }
 
   bool UpdateSearchState(TabContents* tab) WARN_UNUSED_RESULT {
     content::RenderViewHost* rvh = tab->web_contents()->GetRenderViewHost();
-    return GetIntFromJS(rvh, "onchangecalls", &onchangecalls_) &&
+    return GetIntFromJS(rvh, "onvisibilitycalls", &onvisibilitycalls_) &&
+           GetIntFromJS(rvh, "onchangecalls", &onchangecalls_) &&
            GetIntFromJS(rvh, "onsubmitcalls", &onsubmitcalls_) &&
            GetIntFromJS(rvh, "oncancelcalls", &oncancelcalls_) &&
            GetIntFromJS(rvh, "onresizecalls", &onresizecalls_) &&
            GetIntFromJS(rvh, "onfocuscalls", &onfocuscalls_) &&
            GetIntFromJS(rvh, "onblurcalls", &onblurcalls_) &&
            GetStringFromJS(rvh, "value", &value_) &&
            GetBoolFromJS(rvh, "verbatim", &verbatim_) &&
            GetIntFromJS(rvh, "height", &height_);
   }
 
   bool ExecuteScript(const std::string& script) WARN_UNUSED_RESULT {
     return content::ExecuteJavaScript(
         instant()->GetPreviewContents()->web_contents()->GetRenderViewHost(),
         std::wstring(), UTF8ToWide(script));
   }
 
   bool CheckVisibilityIs(TabContents* tab, bool expected) WARN_UNUSED_RESULT {
     bool actual = !expected;  // Purposely start with a mis-match.
     // We can only use ASSERT_*() in a method that returns void, hence this
     // convoluted check.
     return GetBoolFromJS(tab->web_contents()->GetRenderViewHost(),
                          "!document.webkitHidden", &actual) &&
            actual == expected;
   }
 
+  int onvisibilitycalls_;
   int onchangecalls_;
   int onsubmitcalls_;
   int oncancelcalls_;
   int onresizecalls_;
   int onfocuscalls_;
   int onblurcalls_;
 
   std::string value_;
   bool verbatim_;
   int height_;
@@ skipping 78 matching lines @@
 
   // Stash a reference to the preview, so we can refer to it after commit.
   TabContents* preview_tab = instant()->GetPreviewContents();
   EXPECT_TRUE(preview_tab);
 
   // The state of the searchbox before the commit.
   EXPECT_TRUE(UpdateSearchState(preview_tab));
   EXPECT_EQ("search", value_);
   EXPECT_FALSE(verbatim_);
   EXPECT_EQ(0, onsubmitcalls_);
+  EXPECT_EQ(1, onvisibilitycalls_);
 
   // Before the commit, the active tab is the NTP (i.e., not Instant).
   TabContents* active_tab = chrome::GetActiveTabContents(browser());
   EXPECT_NE(preview_tab, active_tab);
   EXPECT_EQ(1, active_tab->web_contents()->GetController().GetEntryCount());
   EXPECT_EQ(std::string(chrome::kAboutBlankURL),
             omnibox()->model()->PermanentURL().spec());
 
   // Commit the search by pressing Enter.
   browser()->window()->GetLocationBar()->AcceptInput();
@@ skipping 23 matching lines @@
   std::string value;
   EXPECT_TRUE(GetStringFromJS(preview_tab->web_contents()->GetRenderViewHost(),
                               "chrome.searchBox.value", &value));
   EXPECT_EQ("", value);
 
   // However, the page should've correctly received the committed query.
   EXPECT_TRUE(UpdateSearchState(preview_tab));
   EXPECT_EQ("search", value_);
   EXPECT_TRUE(verbatim_);
   EXPECT_EQ(1, onsubmitcalls_);
+  EXPECT_EQ(1, onvisibilitycalls_);
 }
 
 // Test that the oncancel event is dispatched upon clicking on the preview.
 IN_PROC_BROWSER_TEST_F(InstantTest, OnCancelEvent) {
   ASSERT_NO_FATAL_FAILURE(SetupInstant("instant.html"));
   EXPECT_TRUE(ui_test_utils::BringBrowserWindowToFront(browser()));
+  FocusOmniboxAndWaitForInstantSupport();
   SetOmniboxTextAndWaitForInstantToShow("search");
 
   // Stash a reference to the preview, so we can refer to it after commit.
   TabContents* preview_tab = instant()->GetPreviewContents();
   EXPECT_TRUE(preview_tab);
 
   // The state of the searchbox before the commit.
   EXPECT_TRUE(UpdateSearchState(preview_tab));
   EXPECT_EQ("search", value_);
   EXPECT_FALSE(verbatim_);
   EXPECT_EQ(0, oncancelcalls_);
+  EXPECT_EQ(1, onvisibilitycalls_);
 
   // Before the commit, the active tab is the NTP (i.e., not Instant).
   TabContents* active_tab = chrome::GetActiveTabContents(browser());
   EXPECT_NE(preview_tab, active_tab);
   EXPECT_EQ(1, active_tab->web_contents()->GetController().GetEntryCount());
   EXPECT_EQ(std::string(chrome::kAboutBlankURL),
             omnibox()->model()->PermanentURL().spec());
 
   // Commit the search by clicking on the preview.
   ui_test_utils::ClickOnView(browser(), VIEW_ID_TAB_CONTAINER);
@@ skipping 23 matching lines @@
   std::string value;
   EXPECT_TRUE(GetStringFromJS(preview_tab->web_contents()->GetRenderViewHost(),
                               "chrome.searchBox.value", &value));
   EXPECT_EQ("", value);
 
   // However, the page should've correctly received the committed query.
   EXPECT_TRUE(UpdateSearchState(preview_tab));
   EXPECT_EQ("search", value_);
   EXPECT_TRUE(verbatim_);
   EXPECT_EQ(1, oncancelcalls_);
+  EXPECT_EQ(1, onvisibilitycalls_);
 }
 
 // Test that the onreisze event is dispatched upon typing in the omnibox.
 IN_PROC_BROWSER_TEST_F(InstantTest, OnResizeEvent) {
   ASSERT_NO_FATAL_FAILURE(SetupInstant("instant.html"));
 
   // This makes Instant load the preview, along with an initial onresize() (see
   // SearchBoxExtension::PageSupportsInstant() for why).
   FocusOmniboxAndWaitForInstantSupport();
 
@@ skipping 483 matching lines @@
       base::Bind(&KeywordQueryDone, &run_loop3, &queries));
   run_loop3.Run();
   ASSERT_TRUE(queries.size());
   EXPECT_EQ(ASCIIToUTF16("search"), queries[0]);
 }
 
 // Test that creating a new window hides any currently showing Instant preview.
 IN_PROC_BROWSER_TEST_F(InstantTest, NewWindowDismissesInstant) {
   ASSERT_NO_FATAL_FAILURE(SetupInstant("instant.html"));
   EXPECT_TRUE(ui_test_utils::BringBrowserWindowToFront(browser()));
+  FocusOmniboxAndWaitForInstantSupport();
   SetOmniboxTextAndWaitForInstantToShow("search");
 
   Browser* previous_window = browser();
   EXPECT_TRUE(instant()->IsCurrent());
   EXPECT_TRUE(instant()->model()->is_ready());
 
   InstantTestModelObserver observer(instant()->model());
   chrome::NewEmptyWindow(browser()->profile());
   observer.WaitUntilDisplayStateChanged();
 
@@ skipping 79 matching lines @@
   // Check that a d with a dot above and below it is completed regardless of
   // how that is encoded.
   // U+1E0D = LATIN SMALL LETTER D WITH DOT BELOW
   // U+1E0B = LATIN SMALL LETTER D WITH DOT ABOVE
   EXPECT_TRUE(ExecuteScript("suggestion = [ { value: '\\u1e0d\\u0307oh' } ]"));
 
   instant()->Hide();
   SetOmniboxTextAndWaitForInstantToShow(WideToUTF8(L"\u1e0b\u0323"));
   EXPECT_EQ(WideToUTF16(L"\u1e0b\u0323oh"), omnibox()->GetText());
 }
+
+// Test that the preview can be committed onto a new tab.
+IN_PROC_BROWSER_TEST_F(InstantTest, CommitInNewTab) {
+  ASSERT_NO_FATAL_FAILURE(SetupInstant("instant.html"));
+  FocusOmniboxAndWaitForInstantSupport();
+  SetOmniboxTextAndWaitForInstantToShow("search");
+
+  // Stash a reference to the preview, so we can refer to it after commit.
+  TabContents* preview_tab = instant()->GetPreviewContents();
+  EXPECT_TRUE(preview_tab);
+
+  // The state of the searchbox before the commit.
+  EXPECT_TRUE(UpdateSearchState(preview_tab));
+  EXPECT_EQ("search", value_);
+  EXPECT_FALSE(verbatim_);
+  EXPECT_EQ(0, onsubmitcalls_);
+  EXPECT_EQ(1, onvisibilitycalls_);
+
+  // Before the commit, the active tab is the NTP (i.e., not Instant).
+  TabContents* active_tab = chrome::GetActiveTabContents(browser());
+  EXPECT_NE(preview_tab, active_tab);
+  EXPECT_EQ(1, active_tab->web_contents()->GetController().GetEntryCount());
+  EXPECT_EQ(std::string(chrome::kAboutBlankURL),
+            omnibox()->model()->PermanentURL().spec());
+
+  // Commit the search by pressing Alt-Enter.
+  omnibox()->model()->AcceptInput(NEW_FOREGROUND_TAB, false);
+
+  // After the commit, Instant should not be showing.
+  EXPECT_FALSE(instant()->IsCurrent());
+  EXPECT_FALSE(instant()->model()->is_ready());
+
+  // The old loader is deleted and a new one is created.
+  EXPECT_TRUE(instant()->GetPreviewContents());
+  EXPECT_NE(instant()->GetPreviewContents(), preview_tab);
+
+  // Check that we have two tabs and that the active tab is indeed what was once
+  // the preview. The preview tab should have just one navigation entry, for the
+  // Instant search that was committed.
+  EXPECT_EQ(2, browser()->tab_strip_model()->count());
+  EXPECT_EQ(preview_tab, chrome::GetActiveTabContents(browser()));
+  EXPECT_EQ(1, preview_tab->web_contents()->GetController().GetEntryCount());
+
+  // Check that the omnibox contains the Instant URL we loaded.
+  std::string instant_url = TemplateURLServiceFactory::GetForProfile(
+      browser()->profile())->GetDefaultSearchProvider()->instant_url_ref().
+      ReplaceSearchTerms(TemplateURLRef::SearchTermsArgs(string16()));
+  EXPECT_EQ(instant_url, omnibox()->model()->PermanentURL().spec());
+
+  // Check that the searchbox API values have been reset.
+  std::string value;
+  EXPECT_TRUE(GetStringFromJS(preview_tab->web_contents()->GetRenderViewHost(),
+                              "chrome.searchBox.value", &value));
+  EXPECT_EQ("", value);
+
+  // However, the page should've correctly received the committed query.
+  EXPECT_TRUE(UpdateSearchState(preview_tab));
+  EXPECT_EQ("search", value_);
+  EXPECT_TRUE(verbatim_);
+  EXPECT_EQ(1, onsubmitcalls_);
+  EXPECT_EQ(1, onvisibilitycalls_);
+}