[iOS] Set focus source of omnibox edit model directly.

Exposes a getter and setter for focus_source_ on OmniboxEditModel and
uses them directly to track the focus source (omnibox or fakebox),
instead of relying on a workaround for Linux and using caret visibility
as a proxy.

Bug: 807600
Cq-Include-Trybots: master.tryserver.chromium.mac:ios-simulator-cronet;master.tryserver.chromium.mac:ios-simulator-full-configs
Change-Id: I6e23c77ca7c8cac39e07cc45c351b076a9183d1c
Reviewed-on: https://chromium-review.googlesource.com/894325
Commit-Queue: Stepan Khapugin <stkhapugin@chromium.org>
Reviewed-by: Gauthier Ambard <gambard@chromium.org>
Reviewed-by: Justin Cohen <justincohen@chromium.org>
Reviewed-by: Justin Donnelly <jdonnelly@chromium.org>
Cr-Commit-Position: refs/heads/master@{#537350}

components/omnibox/browser/omnibox_edit_model.h

@@ -234,6 +234,11 @@ class OmniboxEditModel {
     return focus_state_ == OMNIBOX_FOCUS_VISIBLE;
   }
 
+  FocusSource focus_source() const { return focus_source_; }
+  void set_focus_source(FocusSource focus_source) {
+    focus_source_ = focus_source;
+  }
+
   // Accessors for keyword-related state (see comments on keyword_ and
   // is_keyword_hint_).
   const base::string16& keyword() const { return keyword_; }

ios/chrome/browser/ui/content_suggestions/BUILD.gn

@@ -238,8 +238,10 @@ source_set("eg_tests") {
     "//ios/chrome/browser/reading_list",
     "//ios/chrome/browser/ui",
     "//ios/chrome/browser/ui/content_suggestions/cells:cells_ui",
+    "//ios/chrome/browser/ui/location_bar:location_bar",
     "//ios/chrome/browser/ui/ntp:ntp_controller",
     "//ios/chrome/test/app:test_support",
+    "//ios/chrome/test/base:base",
     "//ios/chrome/test/earl_grey:test_support",
     "//ios/testing:ios_test_support",
     "//ios/testing/earl_grey:earl_grey_support",

ios/chrome/browser/ui/content_suggestions/ntp_home_egtest.mm

@@ -24,6 +24,7 @@
 #import "ios/chrome/browser/ui/content_suggestions/ntp_home_constant.h"
 #import "ios/chrome/browser/ui/content_suggestions/ntp_home_provider_test_singleton.h"
 #import "ios/chrome/browser/ui/content_suggestions/ntp_home_test_utils.h"
+#import "ios/chrome/browser/ui/location_bar/location_bar_coordinator.h"
 #import "ios/chrome/browser/ui/ntp/new_tab_page_controller.h"
 #include "ios/chrome/browser/ui/ui_util.h"
 #import "ios/chrome/browser/ui/uikit_ui_util.h"
@@ -31,6 +32,7 @@
 #import "ios/chrome/test/app/chrome_test_util.h"
 #import "ios/chrome/test/app/history_test_util.h"
 #import "ios/chrome/test/app/tab_test_util.h"
+#include "ios/chrome/test/base/scoped_block_swizzler.h"
 #include "ios/chrome/test/earl_grey/accessibility_util.h"
 #import "ios/chrome/test/earl_grey/chrome_earl_grey.h"
 #import "ios/chrome/test/earl_grey/chrome_earl_grey_ui.h"
@@ -77,7 +79,7 @@ std::unique_ptr<net::test_server::HttpResponse> StandardResponse(
 // Mock provider from the singleton.
 @property(nonatomic, assign, readonly) MockContentSuggestionsProvider* provider;
 // Article category, used by the singleton.
-@property(nonatomic, assign, readonly) Category category;
+@property(nonatomic, assign, readonly) ntp_snippets::Category category;
 
 @end
 
@@ -150,8 +152,8 @@ std::unique_ptr<net::test_server::HttpResponse> StandardResponse(
   return [[ContentSuggestionsTestSingleton sharedInstance] provider];
 }
 
-- (Category)category {
-  return Category::FromKnownCategory(KnownCategories::ARTICLES);
+- (ntp_snippets::Category)category {
+  return ntp_snippets::Category::FromKnownCategory(KnownCategories::ARTICLES);
 }
 
 #pragma mark - Tests
@@ -400,6 +402,32 @@ std::unique_ptr<net::test_server::HttpResponse> StandardResponse(
   [ChromeEarlGrey waitForWebViewContainingText:kPageLoadedString];
 }
 
+// Tests that tapping the fake omnibox logs correctly.
+// It is important for ranking algorithm of omnibox that requests from fakebox
+// and real omnibox are marked appropriately.
+- (void)testTapFakeOmniboxLogsCorrectly {
+  if (!IsIPadIdiom()) {
+    // This logging only happens on iPad, since on iPhone there is no real
+    // omnibox on NTP, only fakebox.
+    return;
+  }
+
+  // Swizzle the method that needs to be called for correct logging.
+  __block BOOL tapped = NO;
+  ScopedBlockSwizzler swizzler([LocationBarCoordinator class],
+                               @selector(focusOmniboxFromFakebox), ^() {
+                                 tapped = YES;
+                               });
+
+  // Tap the fake omnibox.
+  [[EarlGrey selectElementWithMatcher:grey_accessibilityID(
+                                          FakeOmniboxAccessibilityID())]
+      performAction:grey_tap()];
+
+  // Check that the page is loaded.
+  GREYAssertTrue(tapped, @"The tap on the fakebox was not correctly logged.");
+}
+
 // Tests that tapping the fake omnibox moves the collection.
 - (void)testTapFakeOmniboxScroll {
   // Get the collection and its layout.

ios/chrome/browser/ui/location_bar/location_bar_coordinator.h

@@ -55,8 +55,7 @@ class WebStateList;
 // Indicates if the omnibox currently displays a popup with suggestions.
 - (BOOL)showingOmniboxPopup;
 
-// Focuses the omnibox and sets the caret visibility as if it was called from
-// the fakebox on NTP.
+// Focuses omnibox with fakebox as the focus event source.
 - (void)focusOmniboxFromFakebox;
 
 // Indicates when the omnibox is the first responder.

ios/chrome/browser/ui/location_bar/location_bar_coordinator.mm

@@ -153,13 +153,8 @@
 
 - (void)focusOmniboxFromFakebox {
   OmniboxEditModel* model = _locationBarController->GetLocationEntry()->model();
-  // Setting the caret visibility to false causes OmniboxEditModel to indicate
-  // that omnibox interaction was initiated from the fakebox. Note that
-  // SetCaretVisibility is a no-op unless OnSetFocus is called first.  Only
-  // set fakebox on iPad, where there is a distinction between the omnibox
-  // and the fakebox on the NTP.
-  model->OnSetFocus(false);
-  model->SetCaretVisibility(false);
+  model->set_focus_source(OmniboxEditModel::FocusSource::FAKEBOX);
+  [self focusOmnibox];
 }
 
 - (BOOL)isOmniboxFirstResponder {

ios/chrome/browser/ui/omnibox/omnibox_view_ios.mm

@@ -367,16 +367,13 @@ void OmniboxViewIOS::OnDidBeginEditing() {
   [field_ setText:[field_ text]];
   OnBeforePossibleChange();
   // In the case where the user taps the fakebox on the Google landing page,
-  // the WebToolbarController invokes OnSetFocus before calling
-  // becomeFirstResponder on OmniboxTextFieldIOS (which leads to this method
-  // beting invoked) so there is no need to call OnSetFocus again. In fact,
-  // calling OnSetFocus again here would reset the caret visibility to true and
-  // it would be impossible to tell that the omnibox was focused by a tap in the
-  // fakebox instead of the omnibox.
-  if (!model()->has_focus()) {
-    model()->OnSetFocus(false);
+  // the focus source is already set to FAKEBOX. Otherwise, set it to OMNIBOX.
+  if (model()->focus_source() != OmniboxEditModel::FocusSource::FAKEBOX) {
+    model()->set_focus_source(OmniboxEditModel::FocusSource::OMNIBOX);
   }
 
+  model()->OnSetFocus(false);
+
   // If the omnibox is displaying a URL and the popup is not showing, set the
   // field into pre-editing state.  If the omnibox is displaying search terms,
   // leave the default behavior of positioning the cursor at the end of the

ios/chrome/browser/ui/toolbar/adaptive/primary_toolbar_coordinator.mm

@@ -123,9 +123,9 @@
     // On iPhone there is no visible omnibox, so there's no need to indicate
     // interaction was initiated from the fakebox.
     [self.locationBarCoordinator focusOmniboxFromFakebox];
+  } else {
+    [self.locationBarCoordinator focusOmnibox];
   }
-
-  [self.locationBarCoordinator focusOmnibox];
 }
 
 - (void)onFakeboxBlur {

ios/chrome/browser/ui/toolbar/clean/toolbar_coordinator.mm

@@ -288,10 +288,9 @@
     [self.locationBarCoordinator focusOmniboxFromFakebox];
   } else {
     [self expandOmniboxAnimated:NO];
+    [self.locationBarCoordinator focusOmnibox];
   }
 
-  [self.locationBarCoordinator focusOmnibox];
-
   if ([self.locationBarCoordinator omniboxPopupHasAutocompleteResults]) {
     [self onFakeboxAnimationComplete];
   }