Add UMA metrics to the site engagement service.

chrome/browser/engagement/site_engagement_helper.cc

 // Copyright 2015 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 "chrome/browser/engagement/site_engagement_helper.h"
 
 #include "base/time/time.h"
 #include "base/trace_event/trace_event.h"
 #include "chrome/browser/engagement/site_engagement_service.h"
 #include "chrome/browser/engagement/site_engagement_service_factory.h"
@@ skipping 29 matching lines @@
 // web_contents() will return nullptr if the observed contents have been
 // deleted; if the contents exist, record engagement for the site. Once the
 // timer finishes running, the callbacks detecting user input will be registered
 // again.
 bool SiteEngagementHelper::InputTracker::HandleKeyPressEvent(
     const content::NativeWebKeyboardEvent& event) {
   // Only respond to raw key down to avoid multiple triggering on a single input
   // (e.g. keypress is a key down then key up).
   if (event.type == blink::WebInputEvent::RawKeyDown) {
     PauseTracking(helper_->web_contents()->GetRenderViewHost());
-    helper_->RecordUserInput();
+    helper_->RecordUserInput(SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
   }
   return false;
 }
 
 bool SiteEngagementHelper::InputTracker::HandleMouseEvent(
     const blink::WebMouseEvent& event) {
   // Only respond to mouse down with a button or mouse move events (e.g. a click
   // is a mouse down and mouse up) to avoid cases where multiple events come in
   // before we can pause tracking.
   if ((event.button != blink::WebMouseEvent::ButtonNone &&
        event.type == blink::WebInputEvent::MouseDown) ||
       event.type == blink::WebInputEvent::MouseWheel) {
     PauseTracking(helper_->web_contents()->GetRenderViewHost());
-    helper_->RecordUserInput();
+    helper_->RecordUserInput(SiteEngagementMetrics::ENGAGEMENT_MOUSE);
   }
   return false;
 }
 
 void SiteEngagementHelper::InputTracker::StartTracking(
     content::RenderViewHost* host) {
   if (!callbacks_added_ && !g_disable_callback_registration_for_testing) {
     host->AddKeyPressEventCallback(key_press_event_callback_);
     host->AddMouseEventCallback(mouse_event_callback_);
     callbacks_added_ = true;
@@ skipping 43 matching lines @@
 
 void SiteEngagementHelper::RemoveObserverForTesting(Observer* observer) {
   observer_list_.RemoveObserver(observer);
 }
 
 SiteEngagementHelper::SiteEngagementHelper(content::WebContents* contents)
     : content::WebContentsObserver(contents),
       input_tracker_(new InputTracker(this)),
       record_engagement_(false) { }
 
-void SiteEngagementHelper::RecordUserInput() {
+void SiteEngagementHelper::RecordUserInput(
+    SiteEngagementMetrics::EngagementType type) {
   TRACE_EVENT0("SiteEngagement", "RecordUserInput");
   content::WebContents* contents = web_contents();
   if (contents) {
     Profile* profile =
         Profile::FromBrowserContext(contents->GetBrowserContext());
     SiteEngagementService* service =
         SiteEngagementServiceFactory::GetForProfile(profile);
 
     // Service is null in incognito.
     if (service) {
+      SiteEngagementMetrics::RecordEngagement(type);
       service->HandleUserInput(contents->GetVisibleURL());
       FOR_EACH_OBSERVER(Observer, observer_list_, OnInputRecorded(this));
     }
   }
 }
 
 void SiteEngagementHelper::DidNavigateMainFrame(
     const content::LoadCommittedDetails& details,
     const content::FrameNavigateParams& params) {
   content::WebContents* contents = web_contents();
   input_tracker_->StopTracking(contents->GetRenderViewHost());
 
   // Ignore all schemes except HTTP and HTTPS.
   record_engagement_ = params.url.SchemeIsHTTPOrHTTPS();
 
   if (!record_engagement_)
     return;
 
   Profile* profile =
       Profile::FromBrowserContext(contents->GetBrowserContext());
   SiteEngagementService* service =
       SiteEngagementServiceFactory::GetForProfile(profile);
 
-  if (service)
+  if (service) {
+    SiteEngagementMetrics::RecordEngagement(
+        SiteEngagementMetrics::ENGAGEMENT_NAVIGATION);

[calamity, 2015/09/25 07:08:33]

I think we should do this in HandleNavigation() in case we decide to separate
different navigations.

[dominickn, 2015/09/28 03:34:50]

It would be inconsistent to have the user input UMA logged in the helper but the
navigation UMA logged in the service. I think if we split out different
navigations we can simply do like the user input UMA does here and directly log
the transition type in the helper rather than sending it into the service.

[calamity, 2015/09/28 07:33:47]

Hmm, I'd prefer all our logging take place in the same place. In fact, even the
engagement type above ought to be passed into the SiteEngagementService.

I think this class should remain as much as possible a pure input to
SiteEngagementService rather than something that thinks about any sort of real
logic.

     service->HandleNavigation(params.url, params.transition);
+  }
 
   input_tracker_->StartTracking(contents->GetRenderViewHost());
 }
 
 void SiteEngagementHelper::RenderViewHostChanged(
     content::RenderViewHost* old_host,
     content::RenderViewHost* new_host) {
   // On changing the render view host, we need to re-register the callbacks
   // listening for user input.
   if (record_engagement_) {
@@ skipping 25 matching lines @@
 
 // static
 void SiteEngagementHelper::EnableCallbackRegistrationForTesting() {
   g_disable_callback_registration_for_testing = false;
 }
 
 // static
 void SiteEngagementHelper::DisableCallbackRegistrationForTesting() {
   g_disable_callback_registration_for_testing = true;
 }