Add code to record URL Omnibox entry in VR

For VR UKM Metrics recording.

Bug: 808584
Cq-Include-Trybots: luci.chromium.try:linux_optional_gpu_tests_rel;master.tryserver.chromium.android:android_optional_gpu_tests_rel;master.tryserver.chromium.linux:linux_optional_gpu_tests_rel;master.tryserver.chromium.linux:linux_vr;master.tryserver.chromium.mac:mac_optional_gpu_tests_rel;master.tryserver.chromium.win:win_optional_gpu_tests_rel
Change-Id: I98418d91b0df01c265683362349cff6365d375c8
Reviewed-on: https://chromium-review.googlesource.com/959440
Commit-Queue: Anna Offenwanger <offenwanger@chromium.org>
Reviewed-by: Robert Kaplow <rkaplow@chromium.org>
Reviewed-by: Christopher Grant <cjgrant@chromium.org>
Reviewed-by: Tibor Goldschwendt <tiborg@chromium.org>
Cr-Commit-Position: refs/heads/master@{#543789}

chrome/browser/android/vr/vr_gl_thread.cc

@@ -209,10 +209,11 @@ void VrGLThread::OnContentPaused(bool enabled) {
       base::BindOnce(&VrShell::OnContentPaused, weak_vr_shell_, enabled));
 }
 
-void VrGLThread::Navigate(GURL gurl) {
+void VrGLThread::Navigate(GURL gurl, NavigationMethod method) {
   DCHECK(OnGlThread());
   main_thread_task_runner_->PostTask(
-      FROM_HERE, base::BindOnce(&VrShell::Navigate, weak_vr_shell_, gurl));
+      FROM_HERE,
+      base::BindOnce(&VrShell::Navigate, weak_vr_shell_, gurl, method));
 }
 
 void VrGLThread::NavigateBack() {

chrome/browser/android/vr/vr_gl_thread.h

@@ -79,7 +79,7 @@ class VrGLThread : public base::android::JavaHandlerThread,
   // UiBrowserInterface implementation (UI calling to VrShell).
   void ExitPresent() override;
   void ExitFullscreen() override;
-  void Navigate(GURL gurl) override;
+  void Navigate(GURL gurl, NavigationMethod method) override;
   void NavigateBack() override;
   void ExitCct() override;
   void CloseHostedDialog() override;

chrome/browser/android/vr/vr_shell.cc

@@ -331,8 +331,18 @@ void VrShell::OnContentPaused(bool paused) {
     device->Focus();
 }
 
-void VrShell::Navigate(GURL url) {
+void VrShell::Navigate(GURL url, NavigationMethod method) {
   JNIEnv* env = base::android::AttachCurrentThread();
+
+  // Record metrics.
+  if (method == NavigationMethod::kOmniboxSuggestionSelected ||
+      method == NavigationMethod::kOmniboxUrlEntry) {
+    SessionMetricsHelper* metrics_helper =
+        SessionMetricsHelper::FromWebContents(web_contents_);
+    if (metrics_helper)
+      metrics_helper->RecordUrlRequested(url, method);
+  }
+
   Java_VrShellImpl_loadUrl(
       env, j_vr_shell_,
       base::android::ConvertUTF8ToJavaString(env, url.spec()));
@@ -1016,7 +1026,7 @@ void VrShell::OnVoiceResults(const base::string16& result) {
   SessionMetricsHelper* metrics_helper =
       SessionMetricsHelper::FromWebContents(web_contents_);
   if (metrics_helper && input_was_url)
-    metrics_helper->RecordUrlRequestedByVoice(url);
+    metrics_helper->RecordUrlRequested(url, NavigationMethod::kVoiceSearch);
 
   Java_VrShellImpl_loadUrl(
       env, j_vr_shell_,

chrome/browser/android/vr/vr_shell.h

@@ -21,6 +21,7 @@
 #include "chrome/browser/vr/exit_vr_prompt_choice.h"
 #include "chrome/browser/vr/speech_recognizer.h"
 #include "chrome/browser/vr/ui.h"
+#include "chrome/browser/vr/ui_browser_interface.h"
 #include "chrome/browser/vr/ui_unsupported_mode.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "device/vr/android/gvr/cardboard_gamepad_data_provider.h"
@@ -122,7 +123,7 @@ class VrShell : device::GvrGamepadDataProvider,
                     jboolean incognito,
                     jint id);
   void OnContentPaused(bool paused);
-  void Navigate(GURL url);
+  void Navigate(GURL url, NavigationMethod method);
   void NavigateBack();
   void ExitCct();
   void CloseHostedDialog();

chrome/browser/vr/metrics/session_metrics_helper.cc

@@ -300,8 +300,10 @@ void SessionMetricsHelper::RecordVoiceSearchStarted() {
   num_voice_search_started_++;
 }
 
-void SessionMetricsHelper::RecordUrlRequestedByVoice(GURL url) {
-  url_requested_by_voice_ = url;
+void SessionMetricsHelper::RecordUrlRequested(GURL url,
+                                              NavigationMethod method) {
+  last_requested_url_ = url;
+  last_url_request_method_ = method;
 }
 
 void SessionMetricsHelper::SetVrMode(Mode new_mode) {
@@ -558,13 +560,21 @@ void SessionMetricsHelper::DidFinishNavigation(
                 ukm::GetSourceIdForWebContentsDocument(web_contents())));
 
     // Check that the completed navigation is indeed the one that was requested
-    // by voice, in case that one was incomplete and another was begun. Check
-    // against the first entry for the navigation, as redirects might have
-    // changed what the URL looks like.
-    if (url_requested_by_voice_ == handle->GetRedirectChain().front()) {
-      page_session_tracker_->ukm_entry()->SetWasVoiceSearchNavigation(1);
+    // by either voice or omnibox entry, in case the requested navigation was
+    // incomplete when another was begun. Check against the first entry for the
+    // navigation, as redirects might have changed what the URL looks like.
+    if (last_requested_url_ == handle->GetRedirectChain().front()) {
+      switch (last_url_request_method_) {
+        case kOmniboxUrlEntry:
+        case kOmniboxSuggestionSelected:
+          page_session_tracker_->ukm_entry()->SetWasOmniboxNavigation(1);
+          break;
+        case kVoiceSearch:
+          page_session_tracker_->ukm_entry()->SetWasVoiceSearchNavigation(1);
+          break;
+      }
     }
-    url_requested_by_voice_ = GURL();
+    last_requested_url_ = GURL();
 
     if (mode_ == Mode::kWebXrVrPresentation) {
       presentation_session_tracker_ = std::make_unique<

chrome/browser/vr/metrics/session_metrics_helper.h

@@ -9,6 +9,7 @@
 
 #include "base/time/time.h"
 #include "chrome/browser/vr/mode.h"
+#include "chrome/browser/vr/ui_browser_interface.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "services/metrics/public/cpp/ukm_builders.h"
 #include "services/metrics/public/cpp/ukm_source_id.h"
@@ -118,7 +119,7 @@ class SessionMetricsHelper : public content::WebContentsObserver {
   void SetWebVREnabled(bool is_webvr_presenting);
   void SetVRActive(bool is_vr_enabled);
   void RecordVoiceSearchStarted();
-  void RecordUrlRequestedByVoice(GURL url);
+  void RecordUrlRequested(GURL url, NavigationMethod method);
 
  private:
   SessionMetricsHelper(content::WebContents* contents,
@@ -165,7 +166,8 @@ class SessionMetricsHelper : public content::WebContentsObserver {
   bool is_vr_enabled_ = false;
   bool started_with_autopresentation_ = false;
 
-  GURL url_requested_by_voice_;
+  GURL last_requested_url_;
+  NavigationMethod last_url_request_method_;
 
   int num_videos_playing_ = 0;
   int num_session_navigation_ = 0;

chrome/browser/vr/test/mock_ui_browser_interface.h

@@ -18,7 +18,7 @@ class MockUiBrowserInterface : public UiBrowserInterface {
 
   MOCK_METHOD0(ExitPresent, void());
   MOCK_METHOD0(ExitFullscreen, void());
-  MOCK_METHOD1(Navigate, void(GURL gurl));
+  MOCK_METHOD2(Navigate, void(GURL gurl, NavigationMethod method));
   MOCK_METHOD0(NavigateBack, void());
   MOCK_METHOD0(ExitCct, void());
   MOCK_METHOD0(CloseHostedDialog, void());

chrome/browser/vr/testapp/vr_test_context.cc

@@ -459,7 +459,7 @@ void VrTestContext::SetVoiceSearchActive(bool active) {
 void VrTestContext::ExitPresent() {}
 void VrTestContext::ExitFullscreen() {}
 
-void VrTestContext::Navigate(GURL gurl) {
+void VrTestContext::Navigate(GURL gurl, NavigationMethod method) {
   ToolbarState state(gurl, security_state::SecurityLevel::HTTP_SHOW_WARNING,
                      &toolbar::kHttpIcon, base::string16(), true, false);
   ui_->SetToolbarState(state);

chrome/browser/vr/testapp/vr_test_context.h

@@ -53,7 +53,7 @@ class VrTestContext : public vr::UiBrowserInterface {
   void SetVoiceSearchActive(bool active) override;
   void StartAutocomplete(const AutocompleteRequest& request) override;
   void StopAutocomplete() override;
-  void Navigate(GURL gurl) override;
+  void Navigate(GURL gurl, NavigationMethod method) override;
 
   void set_window_size(const gfx::Size& size) { window_size_ = size; }
 

chrome/browser/vr/ui_browser_interface.h

@@ -13,6 +13,13 @@
 
 namespace vr {
 
+// A actions which can trigger the navigate function.
+enum NavigationMethod {
+  kOmniboxUrlEntry,
+  kOmniboxSuggestionSelected,
+  kVoiceSearch,
+};
+
 // An interface for the VR UI to communicate with VrShell. Many of the functions
 // in this interface are proxies to methods on VrShell.
 class UiBrowserInterface {
@@ -21,7 +28,7 @@ class UiBrowserInterface {
 
   virtual void ExitPresent() = 0;
   virtual void ExitFullscreen() = 0;
-  virtual void Navigate(GURL gurl) = 0;
+  virtual void Navigate(GURL gurl, NavigationMethod method) = 0;
   virtual void NavigateBack() = 0;
   virtual void ExitCct() = 0;
   virtual void CloseHostedDialog() = 0;

chrome/browser/vr/ui_scene_creator.cc

@@ -188,7 +188,8 @@ void OnSuggestionModelAdded(UiScene* scene,
       kNone, kPhaseForeground,
       base::BindRepeating(
           [](UiBrowserInterface* b, Ui* ui, Model* m, SuggestionBinding* e) {
-            b->Navigate(e->model()->destination);
+            b->Navigate(e->model()->destination,
+                        NavigationMethod::kOmniboxSuggestionSelected);
             ui->OnUiRequestedNavigation();
           },
           base::Unretained(browser), base::Unretained(ui),
@@ -1998,7 +1999,8 @@ void UiSceneCreator::CreateOmnibox() {
       [](Model* model, UiBrowserInterface* browser, Ui* ui,
          const EditedText& text) {
         if (!model->omnibox_suggestions.empty()) {
-          browser->Navigate(model->omnibox_suggestions.front().destination);
+          browser->Navigate(model->omnibox_suggestions.front().destination,
+                            NavigationMethod::kOmniboxUrlEntry);
           ui->OnUiRequestedNavigation();
         }
       },

chrome/browser/vr/ui_unittest.cc

@@ -997,7 +997,9 @@ TEST_F(UiTest, OmniboxSuggestionNavigates) {
   ASSERT_NE(suggestions, nullptr);
   UiElement* suggestion = suggestions->children().front().get();
   ASSERT_NE(suggestion, nullptr);
-  EXPECT_CALL(*browser_, Navigate(gurl)).Times(1);
+  EXPECT_CALL(*browser_,
+              Navigate(gurl, NavigationMethod::kOmniboxSuggestionSelected))
+      .Times(1);
   suggestion->OnHoverEnter({0, 0});
   suggestion->OnButtonDown({0, 0});
   suggestion->OnButtonUp({0, 0});

tools/metrics/ukm/ukm.xml

@@ -3169,6 +3169,12 @@ be describing additional metrics about the same event.
       Deprecated.
     </summary>
   </metric>
+  <metric name="WasOmniboxNavigation">
+    <summary>
+      A boolean that is set to 1 if this page was entered into the omnibox,
+      either manually or using autocomplete.
+    </summary>
+  </metric>
   <metric name="WasVoiceSearchNavigation">
     <summary>
       A boolean that is set to 1 if this page was specifically requested and