Send onsubmit query down to the instant extended overlay page when a navigation is performed from t…

chrome/browser/ui/search/instant_extended_browsertest.cc

 // Copyright 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 <sstream>
 
 #include "base/prefs/pref_service.h"
 #include "base/string_util.h"
 #include "base/stringprintf.h"
 #include "base/utf_string_conversions.h"
@@ skipping 430 matching lines @@
   std::string result;
   EXPECT_TRUE(GetStringFromJS(instant()->GetOverlayContents(),
                               "window.chrome.searchBox.value",
                               &result));
   EXPECT_EQ("hello", result);
 
   EXPECT_TRUE(HasUserInputInProgress());
   // TODO(beaudoin): Figure out why this fails.
   // EXPECT_FALSE(HasTemporaryText());
 
-
   // Commit the search by pressing Enter.
   browser()->window()->GetLocationBar()->AcceptInput();
   EXPECT_EQ("hello", GetOmniboxText());
 }
 
+
+// This test simulates a search provider using the InstantExtended API to
+// navigate through the suggested results and back to the original user query.
+IN_PROC_BROWSER_TEST_F(InstantExtendedTest,
+                       NavigateToURLSuggestionHitEnterAndLookForSubmit) {
+  ASSERT_NO_FATAL_FAILURE(SetupInstant(browser()));
+  FocusOmniboxAndWaitForInstantExtendedSupport();
+
+  // Create an observer to wait for the instant tab to support Instant.
+  content::WindowedNotificationObserver observer(
+      chrome::NOTIFICATION_INSTANT_TAB_SUPPORT_DETERMINED,
+      content::NotificationService::AllSources());
+
+  // Do a search and commit it.
+  SetOmniboxTextAndWaitForOverlayToShow("hello k");
+  EXPECT_EQ(ASCIIToUTF16("hello k"), omnibox()->GetText());
+  browser()->window()->GetLocationBar()->AcceptInput();
+  observer.Wait();
+
+  SetOmniboxText("http");
+  EXPECT_EQ("http", GetOmniboxText());
+
+  SendDownArrow();
+  EXPECT_EQ("result 1", GetOmniboxText());
+  SendDownArrow();
+  EXPECT_EQ("result 2", GetOmniboxText());
+  SendDownArrow();
+  EXPECT_EQ("http://www.google.com", GetOmniboxText());
+
+  EXPECT_TRUE(HasUserInputInProgress());
+
+  int submit_count = 0;
+  GetIntFromJS(instant()->instant_tab()->contents(), "submitCount",
+               &submit_count);
+  // Note the commit count is initially 1 due to the AcceptInput() call above.
+  EXPECT_EQ(1, submit_count);
+
+  // Commit the search by pressing Enter.
+  browser()->window()->GetLocationBar()->AcceptInput();
+
+  // Make sure a submit message got sent.
+  GetIntFromJS(instant()->instant_tab()->contents(), "submitCount",

[sreeram, 2013/04/08 16:20:38]

I'm mildly worried that this is brittle. If in the future, AcceptInput() does
enough things to cause the current WebContents to navigate, or even just for
instant_tab_ to be reset to NULL, then this will fail. I don't see an easy
solution, though. Do you?

[robertshield, 2013/04/09 14:49:29]

Maybe. I could examine the IPCs being sent, by sticking an OutgoingMessageFilter
on the associated RPH's channel proxy.

This should be robust against changes to AcceptInput causing instant_tab_ to go
away. Let me try that and see.

[sreeram, 2013/04/09 16:39:41]

Here are some alternatives:

1. Get a handle to the RVH before AcceptInput, and hope that it stays alive long
enough for you to ExecuteScript on it. This is the simplest; while also
potentially brittle, I think we'll find out quickly if it breaks.

2. Add a beforeunload/unload listener to the page so that the navigation is
forced to wait for it. So, for example, change the document title in
beforeunload before popping up the "Stay or Leave?" dialog. Here,
WaitForAppModalDialog() and check that the title has been changed to what you
expect.

3. Don't add a beforeunload, but add an unload listener. From the unload, set a
cookie, which you can check for here. (cf:
chrome/browser/fast_shutdown_browsertest.cc).

+               &submit_count);

[sreeram, 2013/04/08 16:20:38]

Use UpdateSearchState() and verify both the submitCount as well as
searchbox.value. (The important thing is to make just 1 call to execute script.
If you perform two, you'll very likely run into the issue mentioned above, where
the WebContents has already navigated, and instant_tab_ is null. Try it and
confirm my hypothesis.)

+  EXPECT_EQ(2, submit_count);
+}
+
 // This test simulates a search provider using the InstantExtended API to
 // navigate through the suggested results and hitting escape to get back to the
 // original user query.
 IN_PROC_BROWSER_TEST_F(InstantExtendedTest, NavigateSuggestionsAndHitEscape) {
   ASSERT_NO_FATAL_FAILURE(SetupInstant(browser()));
   FocusOmniboxAndWaitForInstantExtendedSupport();
 
   SetOmniboxTextAndWaitForOverlayToShow("hello");
   EXPECT_EQ("hello", GetOmniboxText());
 
@@ skipping 962 matching lines @@
   ASSERT_NO_FATAL_FAILURE(SetupInstant(browser()));
 
   EXPECT_EQ(instant_url(), instant()->ntp_->contents()->GetURL());
 
   // The second argument says to use only the local overlay.
   instant()->SetInstantEnabled(false, true);
 
   EXPECT_EQ(GURL(chrome::kChromeSearchLocalNtpUrl),
             instant()->ntp_->contents()->GetURL());
 }