Add onfocuschange to the Extended Search API, with associated isFocused attribute.

chrome/browser/ui/search/instant_extended_interactive_uitest.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/command_line.h"
 #include "base/metrics/field_trial.h"
 #include "base/prefs/pref_service.h"
 #include "base/string_util.h"
@@ skipping 96 matching lines @@
 class InstantExtendedTest : public InProcessBrowserTest,
                             public InstantTestBase {
  public:
   InstantExtendedTest()
       : on_most_visited_change_calls_(0),
         most_visited_items_count_(0),
         first_most_visited_item_id_(0),
         on_native_suggestions_calls_(0),
         on_change_calls_(0),
         submit_count_(0),
-        on_esc_key_press_event_calls_(0) {
+        on_esc_key_press_event_calls_(0),
+        on_focus_changed_calls_(0),
+        is_focused_(false) {
   }
  protected:
   virtual void SetUpInProcessBrowserTestFixture() OVERRIDE {
     chrome::EnableInstantExtendedAPIForTesting();
     ASSERT_TRUE(https_test_server().Start());
     GURL instant_url = https_test_server().GetURL(
         "files/instant_extended.html?strk=1&");
     InstantTestBase::Init(instant_url);
   }
 
@@ skipping 32 matching lines @@
                         &first_most_visited_item_id_) &&
            GetIntFromJS(contents, "onNativeSuggestionsCalls",
                         &on_native_suggestions_calls_) &&
            GetIntFromJS(contents, "onChangeCalls",
                         &on_change_calls_) &&
            GetIntFromJS(contents, "submitCount",
                         &submit_count_) &&
            GetStringFromJS(contents, "apiHandle.value",
                            &query_value_) &&
            GetIntFromJS(contents, "onEscKeyPressedCalls",
-                        &on_esc_key_press_event_calls_);
+                        &on_esc_key_press_event_calls_) &&
+           GetIntFromJS(contents, "onFocusChangedCalls",
+                       &on_focus_changed_calls_) &&
+           GetBoolFromJS(contents, "isFocused",
+                         &is_focused_);
   }
 
   TemplateURL* GetDefaultSearchProviderTemplateURL() {
     TemplateURLService* template_url_service =
         TemplateURLServiceFactory::GetForProfile(browser()->profile());
     if (template_url_service)
       return template_url_service->GetDefaultSearchProvider();
     return NULL;
   }
 
@@ skipping 31 matching lines @@
   }
 
   int on_most_visited_change_calls_;
   int most_visited_items_count_;
   int first_most_visited_item_id_;
   int on_native_suggestions_calls_;
   int on_change_calls_;
   int submit_count_;
   int on_esc_key_press_event_calls_;
   std::string query_value_;
+  int on_focus_changed_calls_;
+  bool is_focused_;
 };
 
 // Test class used to verify chrome-search: scheme and access policy from the
 // Instant overlay.  This is a subclass of |ExtensionBrowserTest| because it
 // loads a theme that provides a background image.
 class InstantPolicyTest : public ExtensionBrowserTest, public InstantTestBase {
  public:
   InstantPolicyTest() {}
 
  protected:
@@ skipping 1787 matching lines @@
                               &query));
   EXPECT_EQ("", query);
   EXPECT_EQ("", GetOmniboxText());
 
   EXPECT_TRUE(UpdateSearchState(contents));
   EXPECT_LT(0, on_change_calls_);
   EXPECT_EQ(0, submit_count_);
   EXPECT_LT(0, on_esc_key_press_event_calls_);
 }
 
+IN_PROC_BROWSER_TEST_F(InstantExtendedTest, FocusApiRespondsToFocusChange) {
+  ASSERT_NO_FATAL_FAILURE(SetupInstant(browser()));
+  EXPECT_FALSE(is_focused_);
+  EXPECT_EQ(0, on_focus_changed_calls_);
+
+  // Focus the Omnibox.

[samarth, 2013/05/22 04:40:56]

super nit: lower-case "omnibox" (and below)

[Donn Denman, 2013/05/22 17:37:36]

Done.

+  FocusOmniboxAndWaitForInstantOverlaySupport();
+  EXPECT_TRUE(UpdateSearchState(instant()->GetOverlayContents()));

[samarth, 2013/05/22 04:40:56]

nit: EXPECT -> ASSERT here and for other calls to UpdateSearchState.

[Donn Denman, 2013/05/22 17:37:36]

Ah, that makes the code much more readable!  Done.

Q: all of the other tests in this file use EXPECT for UpdateSearchState either. 
Should I go ahead and change them as well?

[samarth, 2013/05/23 21:06:33]

Yeah, in general, any failed check that would make the rest of the test
pointless to run should be an ASSERT, so yeah, I think all the others qualify.
I'd just update them in a follow-up CL, in case I'm wrong :)

+  EXPECT_TRUE(is_focused_);
+  EXPECT_EQ(1, on_focus_changed_calls_);
+
+  // Now unfocus the omnibox.
+  ui_test_utils::ClickOnView(browser(), VIEW_ID_TAB_CONTAINER);
+  EXPECT_TRUE(UpdateSearchState(instant()->GetOverlayContents()));
+  EXPECT_FALSE(is_focused_);
+  EXPECT_EQ(2, on_focus_changed_calls_);
+
+  // Focus the Omnibox again.
+  // The first focus may have worked only due to initial-state anomalies.
+  FocusOmniboxAndWaitForInstantOverlaySupport();

[samarth, 2013/05/22 04:40:56]

Hmm, I'm surprised that this works.  In particular, waiting for
InstantOverlaySupport shouldn't be necessary and in fact should cause this test
to hang (because instant support for the overlay has been established).  You can
just call FocusOmnibox() here.

[Donn Denman, 2013/05/22 17:37:36]

Done.

+  EXPECT_TRUE(UpdateSearchState(instant()->GetOverlayContents()));
+  EXPECT_TRUE(is_focused_);
+  EXPECT_EQ(3, on_focus_changed_calls_);
+}
+
+IN_PROC_BROWSER_TEST_F(InstantExtendedTest, FocusApiIgnoresRedundantFocus) {
+  ASSERT_NO_FATAL_FAILURE(SetupInstant(browser()));
+  EXPECT_FALSE(is_focused_);
+  EXPECT_EQ(0, on_focus_changed_calls_);
+
+  // Focus the Omnibox.
+  FocusOmniboxAndWaitForInstantOverlaySupport();
+  EXPECT_TRUE(UpdateSearchState(instant()->GetOverlayContents()));
+  EXPECT_TRUE(is_focused_);
+  EXPECT_EQ(1, on_focus_changed_calls_);
+
+  // When we focus the omnibox again, nothing should change.
+  FocusOmniboxAndWaitForInstantOverlaySupport();
+  EXPECT_TRUE(UpdateSearchState(instant()->GetOverlayContents()));
+  EXPECT_TRUE(is_focused_);
+  EXPECT_EQ(1, on_focus_changed_calls_);
+
+  // Now unfocus the omnibox.
+  ui_test_utils::ClickOnView(browser(), VIEW_ID_TAB_CONTAINER);
+  EXPECT_TRUE(UpdateSearchState(instant()->GetOverlayContents()));
+  EXPECT_FALSE(is_focused_);
+  EXPECT_EQ(2, on_focus_changed_calls_);
+
+  // When we unfocus again, nothing should change.
+  ui_test_utils::ClickOnView(browser(), VIEW_ID_TAB_CONTAINER);
+  EXPECT_TRUE(UpdateSearchState(instant()->GetOverlayContents()));
+  EXPECT_FALSE(is_focused_);
+  EXPECT_EQ(2, on_focus_changed_calls_);
+}
+
 IN_PROC_BROWSER_TEST_F(InstantExtendedTest, OnDefaultSearchProviderChanged) {
   InstantService* instant_service =
       InstantServiceFactory::GetForProfile(browser()->profile());
   ASSERT_NE(static_cast<InstantService*>(NULL), instant_service);
 
   // Setup Instant.
   ASSERT_NO_FATAL_FAILURE(SetupInstant(browser()));
   FocusOmniboxAndWaitForInstantOverlayAndNTPSupport();
   EXPECT_EQ(1, instant_service->GetInstantProcessCount());
 
@@ skipping 374 matching lines @@
   EXPECT_TRUE(instant()->ntp()->IsLocal());
 
   // Overlay contents should be preloaded.
   ASSERT_NE(static_cast<InstantOverlay*>(NULL), instant()->overlay());
   EXPECT_TRUE(instant()->overlay()->IsLocal());
 
   // Instant tab contents should be preloaded.
   ASSERT_NE(static_cast<InstantTab*>(NULL), instant()->instant_tab());
   EXPECT_TRUE(instant()->instant_tab()->IsLocal());
 }