Fixes bug in instant where we would end up incorrectly using the

chrome/browser/instant/instant_browsertest.cc

 // Copyright (c) 2011 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/command_line.h"
 #include "base/stringprintf.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/autocomplete/autocomplete_edit.h"
 #include "chrome/browser/content_settings/host_content_settings_map.h"
 #include "chrome/browser/instant/instant_controller.h"
@@ skipping 30 matching lines @@
 #define MAYBE_SetSuggestionsValidJson DISABLED_SetSuggestionsValidJson
 #define MAYBE_SetSuggestionsInvalidSuggestions \
     DISABLED_SetSuggestionsInvalidSuggestions
 #define MAYBE_SetSuggestionsEmptyJson DISABLED_SetSuggestionsEmptyJson
 #define MAYBE_SetSuggestionsEmptySuggestions \
     DISABLED_SetSuggestionsEmptySuggestions
 #define MAYBE_SetSuggestionsEmptySuggestion \
     DISABLED_SetSuggestionsEmptySuggestion
 #define MAYBE_ShowPreviewNonSearch DISABLED_ShowPreviewNonSearch
 #define MAYBE_NonSearchToSearch DISABLED_NonSearchToSearch
+#define MAYBE_SearchToNonSearch DISABLED_SearchToNonSearch
 #define MAYBE_ValidHeight DISABLED_ValidHeight
 #define MAYBE_OnSubmitEvent DISABLED_OnSubmitEvent
 #define MAYBE_OnCancelEvent DISABLED_OnCancelEvent
 #define MAYBE_InstantCompleteNever DISABLED_InstantCompleteNever
 #define MAYBE_InstantCompleteDelayed DISABLED_InstantCompleteDelayed
 #define MAYBE_DontCrashOnBlockedJS DISABLED_DontCrashOnBlockedJS
 #define MAYBE_DontPersistSearchbox DISABLED_DontPersistSearchbox
 #define MAYBE_PreloadsInstant DISABLED_PreloadsInstant
 #define MAYBE_ExperimentEnabled DISABLED_ExperimentEnabled
 #else
 #define MAYBE_OnChangeEvent OnChangeEvent
 #define MAYBE_SetSuggestionsArrayOfStrings SetSuggestionsArrayOfStrings
 #define MAYBE_SetSuggestionsEmptyArray SetSuggestionsEmptyArray
 #define MAYBE_SetSuggestionsValidJson SetSuggestionsValidJson
 #define MAYBE_SetSuggestionsInvalidSuggestions SetSuggestionsInvalidSuggestions
 #define MAYBE_SetSuggestionsEmptyJson SetSuggestionsEmptyJson
 #define MAYBE_SetSuggestionsEmptySuggestions SetSuggestionsEmptySuggestions
 #define MAYBE_SetSuggestionsEmptySuggestion SetSuggestionsEmptySuggestion
 #define MAYBE_ShowPreviewNonSearch ShowPreviewNonSearch
 #define MAYBE_NonSearchToSearch NonSearchToSearch
+#define MAYBE_SearchToNonSearch SearchToNonSearch
 #define MAYBE_ValidHeight ValidHeight
 #define MAYBE_OnSubmitEvent OnSubmitEvent
 #define MAYBE_OnCancelEvent OnCancelEvent
 #define MAYBE_InstantCompleteNever InstantCompleteNever
 #define MAYBE_InstantCompleteDelayed InstantCompleteDelayed
 #define MAYBE_DontCrashOnBlockedJS DontCrashOnBlockedJS
 #define MAYBE_DontPersistSearchbox DontPersistSearchbox
 #define MAYBE_PreloadsInstant PreloadsInstant
 #define MAYBE_ExperimentEnabled ExperimentEnabled
 #endif
@@ skipping 84 matching lines @@
     ASSERT_TRUE(preview_);
     ui_test_utils::WaitForNavigation(&preview_->controller());
   }
 
   // Wait for instant to load and ensure it is in the state we expect.
   void SetupPreview() {
     // Wait for the preview to navigate.
     WaitForPreviewToNavigate();
 
     ASSERT_FALSE(browser()->instant()->is_displayable());
-    ASSERT_TRUE(browser()->instant()->is_active());
+    ASSERT_TRUE(HasPreview());
 
     // When the page loads, the initial searchBox values are set and only a
     // resize will have been sent.
     ASSERT_EQ("true 0 0 0 true d false d false 1 1",
               GetSearchStateAsString(preview_, false));
   }
 
   void SetLocationBarText(const std::string& text) {
     ASSERT_NO_FATAL_FAILURE(FindLocationBar());
     ui_test_utils::WindowedNotificationObserver controller_shown_observer(
@@ skipping 50 matching lines @@
   bool GetBoolFromJavascript(TabContents* tab_contents,
                              const std::string& function,
                              bool* result) {
     std::string script = StringPrintf(
         "window.domAutomationController.send(%s)", function.c_str());
     return ui_test_utils::ExecuteJavaScriptAndExtractBool(
         tab_contents->render_view_host(),
         std::wstring(), UTF8ToWide(script), result);
   }
 
+  bool HasPreview() {
+    return browser()->instant()->GetPreviewContents() != NULL;
+  }
+
   // Returns the state of the search box as a string. This consists of the
   // following:
   // window.chrome.sv
   // window.onsubmitcalls
   // window.oncancelcalls
   // window.onchangecalls
   // 'true' if window.onresizecalls has been sent, otherwise false.
   // window.beforeLoadSearchBox.value
   // window.beforeLoadSearchBox.verbatim
   // window.chrome.searchBox.value
@@ skipping 242 matching lines @@
 }
 
 IN_PROC_BROWSER_TEST_F(InstantTest, MAYBE_ShowPreviewNonSearch) {
   ASSERT_TRUE(test_server()->Start());
   EnableInstant();
   GURL url(test_server()->GetURL("files/instant/empty.html"));
   ASSERT_NO_FATAL_FAILURE(FindLocationBar());
   location_bar_->location_entry()->SetUserText(UTF8ToUTF16(url.spec()));
 
   // The preview should not be active or showing.
-  ASSERT_FALSE(browser()->instant()->is_active());
+  ASSERT_FALSE(HasPreview());
   ASSERT_FALSE(browser()->instant()->is_displayable());
   ASSERT_FALSE(browser()->instant()->IsCurrent());
   ASSERT_EQ(NULL, browser()->instant()->GetPreviewContents());
 }
 
 // Transition from non-search to search and make sure everything is shown
 // correctly.
 IN_PROC_BROWSER_TEST_F(InstantTest, MAYBE_NonSearchToSearch) {
   ASSERT_TRUE(test_server()->Start());
   EnableInstant();
   GURL url(test_server()->GetURL("files/instant/empty.html"));
   ASSERT_NO_FATAL_FAILURE(FindLocationBar());
   location_bar_->location_entry()->SetUserText(UTF8ToUTF16(url.spec()));
   // The preview not should be active and not showing.
-  ASSERT_FALSE(browser()->instant()->is_active());
+  ASSERT_FALSE(HasPreview());
   ASSERT_FALSE(browser()->instant()->is_displayable());
   ASSERT_EQ(NULL, browser()->instant()->GetPreviewContents());
 
   // Now type in some search text.
   ASSERT_NO_FATAL_FAILURE(SetupInstantProvider("search.html"));
   location_bar_->location_entry()->SetUserText(ASCIIToUTF16("def"));
 
   // Wait for the preview to navigate.
   ASSERT_NO_FATAL_FAILURE(WaitForPreviewToNavigate());
 
   // The controller is still determining if the provider really supports
   // instant.
   TabContentsWrapper* current_tab = browser()->instant()->GetPreviewContents();
   ASSERT_TRUE(current_tab);
 
   // Instant should be active.
-  EXPECT_TRUE(browser()->instant()->is_active());
+  EXPECT_TRUE(HasPreview());
   EXPECT_FALSE(browser()->instant()->is_displayable());
 
   // Because we're waiting on the page, instant isn't current.
   ASSERT_FALSE(browser()->instant()->IsCurrent());
 
   // Bounce a message to the renderer so that we know the instant has gotten a
   // response back from the renderer as to whether the page supports instant.
   ASSERT_NO_FATAL_FAILURE(WaitForMessageToBeProcessedByRenderer(current_tab));
 
   // Reset the user text so that the page is told the text changed. We should be
   // able to nuke this once 66104 is fixed.
   location_bar_->location_entry()->SetUserText(ASCIIToUTF16("defg"));
 
   // Wait for the renderer to process it.
   ASSERT_NO_FATAL_FAILURE(WaitForMessageToBeProcessedByRenderer(current_tab));
 
   // We should have gotten a response back from the renderer that resulted in
   // committing.
-  ASSERT_TRUE(browser()->instant()->is_active());
+  ASSERT_TRUE(HasPreview());
   ASSERT_TRUE(browser()->instant()->is_displayable());
   TabContentsWrapper* new_tab = browser()->instant()->GetPreviewContents();
   ASSERT_TRUE(new_tab);
   RenderWidgetHostView* new_rwhv =
       new_tab->tab_contents()->GetRenderWidgetHostView();
   ASSERT_TRUE(new_rwhv);
   ASSERT_TRUE(new_rwhv->IsShowing());
 }
 
+// Transition from search to non-search and make sure instant isn't displayable.

[sreeram, 2011/10/14 20:07:32]

Perhaps add the bug reference (http://crbug.com/100368) as a comment as well?

+IN_PROC_BROWSER_TEST_F(InstantTest, MAYBE_SearchToNonSearch) {
+  ASSERT_TRUE(test_server()->Start());
+  EnableInstant();
+  GURL url(test_server()->GetURL("files/instant/empty.html"));
+  ASSERT_NO_FATAL_FAILURE(FindLocationBar());
+
+  // Type in some search text.
+  ASSERT_NO_FATAL_FAILURE(SetupInstantProvider("search.html"));
+  location_bar_->location_entry()->SetUserText(ASCIIToUTF16("def"));
+
+  // Load a non search url. Don't wait for the preview to navigate. It'll still
+  // end up loading in the background.
+  location_bar_->location_entry()->SetUserText(UTF8ToUTF16(url.spec()));
+
+  // Wait for the preview to navigate.
+  ASSERT_NO_FATAL_FAILURE(WaitForPreviewToNavigate());
+
+  // Send onchange so that the page sends up suggestions.
+  TabContentsWrapper* current_tab = browser()->instant()->GetPreviewContents();
+  ui_test_utils::ExecuteJavaScript(
+      current_tab->tab_contents()->render_view_host(), std::wstring(),
+      L"window.chrome.searchBox.onchange();");
+  ASSERT_NO_FATAL_FAILURE(WaitForMessageToBeProcessedByRenderer(current_tab));
+
+  // Instant should be active, but not displaying
+  EXPECT_TRUE(HasPreview());
+  EXPECT_FALSE(browser()->instant()->is_displayable());

[sreeram, 2011/10/14 20:07:32]

Nice test, thanks!

+}
+
 // Makes sure that if the server doesn't support the instant API we don't show
 // anything.
 IN_PROC_BROWSER_TEST_F(InstantTest, MAYBE_SearchServerDoesntSupportInstant) {
   ASSERT_TRUE(test_server()->Start());
   EnableInstant();
   ASSERT_NO_FATAL_FAILURE(SetupInstantProvider("empty.html"));
   ASSERT_NO_FATAL_FAILURE(FindLocationBar());
 
   ui_test_utils::WindowedNotificationObserver tab_closed_observer(
       content::NOTIFICATION_TAB_CLOSED,
       NotificationService::AllSources());
 
   location_bar_->location_entry()->SetUserText(ASCIIToUTF16("d"));
   ASSERT_TRUE(browser()->instant());
   // But because we're waiting to determine if the page really supports instant
   // we shouldn't be showing the preview.
   EXPECT_FALSE(browser()->instant()->is_displayable());
   // But instant should still be active.
-  EXPECT_TRUE(browser()->instant()->is_active());
+  EXPECT_TRUE(HasPreview());
 
   // When the response comes back that the page doesn't support instant the tab
   // should be closed.
   tab_closed_observer.Wait();
   EXPECT_FALSE(browser()->instant()->is_displayable());
-  EXPECT_TRUE(browser()->instant()->is_active());
+  EXPECT_FALSE(HasPreview());
   EXPECT_FALSE(browser()->instant()->IsCurrent());
 }
 
 // Verifies that Instant previews aren't shown for crash URLs.
 IN_PROC_BROWSER_TEST_F(InstantTest, CrashUrlCancelsInstant) {
   ASSERT_TRUE(test_server()->Start());
   EnableInstant();
   ASSERT_NO_FATAL_FAILURE(SetupInstantProvider("empty.html"));
   ASSERT_NO_FATAL_FAILURE(FindLocationBar());
   location_bar_->location_entry()->SetUserText(ASCIIToUTF16("chrome://crash"));
   ASSERT_TRUE(browser()->instant());
   EXPECT_FALSE(browser()->instant()->is_displayable());
 }
 
 // Verifies transitioning from loading a non-search string to a search string
 // with the provider not supporting instant works (meaning we don't display
 // anything).
 IN_PROC_BROWSER_TEST_F(InstantTest,
                        MAYBE_NonSearchToSearchDoesntSupportInstant) {
   ASSERT_TRUE(test_server()->Start());
   EnableInstant();
   ASSERT_NO_FATAL_FAILURE(SetupInstantProvider("empty.html"));
   GURL url(test_server()->GetURL("files/instant/empty.html"));
   ASSERT_NO_FATAL_FAILURE(FindLocationBar());
   location_bar_->location_entry()->SetUserText(UTF8ToUTF16(url.spec()));
   // The preview should not be showing or active.
   EXPECT_FALSE(browser()->instant()->is_displayable());
-  EXPECT_FALSE(browser()->instant()->is_active());
+  EXPECT_FALSE(HasPreview());
 
   ui_test_utils::WindowedNotificationObserver tab_closed_observer(
       content::NOTIFICATION_TAB_CLOSED,
       NotificationService::AllSources());
 
   // Now type in some search text.
   location_bar_->location_entry()->SetUserText(ASCIIToUTF16("d"));
 
   // Instant should be active.
-  ASSERT_TRUE(browser()->instant()->is_active());
+  ASSERT_TRUE(HasPreview());
   // Instant should not be current (it's still loading).
   EXPECT_FALSE(browser()->instant()->IsCurrent());
 
   // When the response comes back that the page doesn't support instant the tab
   // should be closed.
   tab_closed_observer.Wait();
   EXPECT_FALSE(browser()->instant()->is_displayable());
-  // But because the omnibox is still open, instant should be active.
-  EXPECT_TRUE(browser()->instant()->is_active());
-  EXPECT_FALSE(browser()->instant()->is_displayable());
+  EXPECT_FALSE(HasPreview());
   EXPECT_FALSE(browser()->instant()->IsCurrent());
   EXPECT_EQ(NULL, browser()->instant()->GetPreviewContents());
 }
 
 // Verifies the page was told a non-zero height.
 IN_PROC_BROWSER_TEST_F(InstantTest, MAYBE_ValidHeight) {
   ASSERT_TRUE(test_server()->Start());
   EnableInstant();
   ASSERT_NO_FATAL_FAILURE(SetupInstantProvider("search.html"));
   ASSERT_NO_FATAL_FAILURE(SetupLocationBar());
@@ skipping 24 matching lines @@
 
   ASSERT_TRUE(ui_test_utils::BringBrowserWindowToFront(browser()));
   ASSERT_NO_FATAL_FAILURE(SetupLocationBar());
   ASSERT_NO_FATAL_FAILURE(SetupPreview());
 
   ASSERT_NO_FATAL_FAILURE(SetLocationBarText("def"));
   ASSERT_NO_FATAL_FAILURE(SendKey(ui::VKEY_RETURN));
 
   // Check that the preview contents have been committed.
   ASSERT_FALSE(browser()->instant()->GetPreviewContents());
-  ASSERT_FALSE(browser()->instant()->is_active());
+  ASSERT_FALSE(HasPreview());
   TabContents* contents = browser()->GetSelectedTabContents();
   ASSERT_TRUE(contents);
 
   // We should have two entries. One corresponding to the page the user was
   // first on, and one for the search page.
   ASSERT_EQ(2, contents->controller().entry_count());
 
   // Check that the value is reflected and onsubmit is called.
   EXPECT_EQ("true 1 0 1 true d false defghi true 3 3",
             GetSearchStateAsString(preview_, true));
@@ skipping 12 matching lines @@
   ASSERT_TRUE(ui_test_utils::BringBrowserWindowToFront(browser()));
   ASSERT_NO_FATAL_FAILURE(SetupLocationBar());
   ASSERT_NO_FATAL_FAILURE(SetupPreview());
 
   ASSERT_NO_FATAL_FAILURE(SetLocationBarText("def"));
   ASSERT_NO_FATAL_FAILURE(ui_test_utils::ClickOnView(browser(),
                                                      VIEW_ID_TAB_CONTAINER));
 
   // Check that the preview contents has been committed.
   ASSERT_FALSE(browser()->instant()->GetPreviewContents());
-  ASSERT_FALSE(browser()->instant()->is_active());
+  ASSERT_FALSE(HasPreview());
   TabContents* contents = browser()->GetSelectedTabContents();
   ASSERT_TRUE(contents);
 
   // Check that the value is reflected and oncancel is called.
   EXPECT_EQ("true 0 1 1 true d false def false 3 3",
             GetSearchStateAsString(preview_, true));
 
   // Make sure the searchbox values were reset.
   EXPECT_EQ("true 0 1 1 true d false  false 0 0",
             GetSearchStateAsString(preview_, false));
@@ skipping 60 matching lines @@
 
   ASSERT_TRUE(ui_test_utils::BringBrowserWindowToFront(browser()));
   ASSERT_NO_FATAL_FAILURE(SetupLocationBar());
   ASSERT_NO_FATAL_FAILURE(SetupPreview());
 
   ASSERT_NO_FATAL_FAILURE(SetLocationBarText("def"));
   ASSERT_NO_FATAL_FAILURE(SendKey(ui::VKEY_RETURN));
 
   // Check that the preview contents have been committed.
   ASSERT_FALSE(browser()->instant()->GetPreviewContents());
-  ASSERT_FALSE(browser()->instant()->is_active());
+  ASSERT_FALSE(HasPreview());
 
   TabContents* contents = browser()->GetSelectedTabContents();
   ASSERT_TRUE(contents);
 
   // Navigate to a new URL. This should reset the searchbox values.
   ui_test_utils::NavigateToURL(
       browser(),
       GURL(test_server()->GetURL("files/instant/empty.html")));
   bool result;
   ASSERT_TRUE(GetBoolFromJavascript(
@@ skipping 26 matching lines @@
       NotificationService::AllSources());
 
   // Focusing the omnibox should cause instant to be preloaded.
   FindLocationBar();
   location_bar_->FocusLocation(false);
   TabContentsWrapper* tab_contents = browser()->instant()->GetPreviewContents();
   EXPECT_TRUE(tab_contents);
 
   instant_support_observer.Wait();
 
-  // However, instant should still not be active.
-  EXPECT_FALSE(browser()->instant()->is_active());
+  // Instant should have a preview, but not display it.
+  EXPECT_TRUE(HasPreview());
   EXPECT_FALSE(browser()->instant()->is_displayable());
 
   // Adding a new tab shouldn't delete (or recreate) the TabContentsWrapper.
   AddBlankTabAndShow(browser());
   EXPECT_EQ(tab_contents, browser()->instant()->GetPreviewContents());
 
   // Doing a search should still use the same loader for the preview.
   SetLocationBarText("def");
   EXPECT_EQ(tab_contents, browser()->instant()->GetPreviewContents());
 
   // Verify that the preview is in fact showing instant search.
-  EXPECT_TRUE(browser()->instant()->is_active());
+  EXPECT_TRUE(HasPreview());
   EXPECT_TRUE(browser()->instant()->is_displayable());
   EXPECT_TRUE(browser()->instant()->IsCurrent());
 }
 
 // Tests the INSTANT experiment of the field trial.
 class InstantFieldTrialInstantTest : public InstantTest {
  public:
   virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE {
     command_line->AppendSwitchASCII(switches::kInstantFieldTrial,
                                     switches::kInstantFieldTrialInstant);
   }
 };
 
 // Tests that instant is active, even without calling EnableInstant().
 IN_PROC_BROWSER_TEST_F(InstantFieldTrialInstantTest, MAYBE_ExperimentEnabled) {
   // Check that instant is enabled, despite not setting the preference.
   Profile* profile = browser()->profile();
   EXPECT_FALSE(profile->GetPrefs()->GetBoolean(prefs::kInstantEnabled));
   EXPECT_TRUE(InstantController::IsEnabled(profile));
 
   ASSERT_TRUE(test_server()->Start());
   SetupInstantProvider("search.html");
   SetupLocationBar();
   SetupPreview();
   SetLocationBarText("def");
 
   // Check that instant is active and showing a preview.
-  EXPECT_TRUE(browser()->instant()->is_active());
+  EXPECT_TRUE(HasPreview());
   EXPECT_TRUE(browser()->instant()->is_displayable());
   EXPECT_TRUE(browser()->instant()->IsCurrent());
 }
 
 // Tests the HIDDEN experiment of the field trial.
 class InstantFieldTrialHiddenTest : public InstantTest {
  public:
   virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE {
     command_line->AppendSwitchASCII(switches::kInstantFieldTrial,
                                     switches::kInstantFieldTrialHidden);
@@ skipping 13 matching lines @@
       chrome::NOTIFICATION_INSTANT_SUPPORT_DETERMINED,
       NotificationService::AllSources());
   SetupLocationBar();
   WaitForPreviewToNavigate();
   instant_support_observer.Wait();
 
   // Type into the omnibox, but don't press <Enter> yet.
   location_bar_->location_entry()->SetUserText(UTF8ToUTF16("def"));
 
   // Check that instant is active, but the preview is not showing.
-  EXPECT_TRUE(browser()->instant()->is_active());
+  EXPECT_TRUE(HasPreview());
   EXPECT_FALSE(browser()->instant()->is_displayable());
   EXPECT_FALSE(browser()->instant()->IsCurrent());
 
   TabContentsWrapper* tab_contents = browser()->instant()->GetPreviewContents();
   EXPECT_TRUE(tab_contents);
 
   // Press <Enter> in the omnibox, causing the preview to be committed.
   SendKey(ui::VKEY_RETURN);
 
   // The preview contents should now be the active tab contents.
   EXPECT_FALSE(browser()->instant()->GetPreviewContents());
-  EXPECT_FALSE(browser()->instant()->is_active());
+  EXPECT_FALSE(HasPreview());
   EXPECT_FALSE(browser()->instant()->is_displayable());
   EXPECT_FALSE(browser()->instant()->IsCurrent());
   EXPECT_EQ(tab_contents, browser()->GetSelectedTabContentsWrapper());
 }