Add User Actions and adding more details to UMA metrics for overscroll navigation

content/browser/renderer_host/overscroll_controller.cc

 // Copyright (c) 2012 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 "content/browser/renderer_host/overscroll_controller.h"
 
 #include "base/command_line.h"
 #include "base/logging.h"
 #include "content/browser/renderer_host/overscroll_controller_delegate.h"
 #include "content/public/browser/overscroll_configuration.h"
@@ skipping 106 matching lines @@
     scroll_state_ = STATE_UNKNOWN;
 
   if (DispatchEventCompletesAction(event)) {
     CompleteAction();
 
     // Let the event be dispatched to the renderer.
     return false;
   }
 
   if (overscroll_mode_ != OVERSCROLL_NONE && DispatchEventResetsState(event)) {
-    SetOverscrollMode(OVERSCROLL_NONE);
+    SetOverscrollMode(OVERSCROLL_NONE, OVERSCROLL_SOURCE_NONE);
 
     // Let the event be dispatched to the renderer.
     return false;
   }
 
   if (overscroll_mode_ != OVERSCROLL_NONE) {
     // Consume the event only if it updates the overscroll state.
     if (ProcessEventForOverscroll(event))
       return true;
   } else if (reset_scroll_state) {
@@ skipping 32 matching lines @@
   }
 }
 
 void OverscrollController::Reset() {
   overscroll_mode_ = OVERSCROLL_NONE;
   overscroll_delta_x_ = overscroll_delta_y_ = 0.f;
   scroll_state_ = STATE_UNKNOWN;
 }
 
 void OverscrollController::Cancel() {
-  SetOverscrollMode(OVERSCROLL_NONE);
+  SetOverscrollMode(OVERSCROLL_NONE, OVERSCROLL_SOURCE_NONE);
   overscroll_delta_x_ = overscroll_delta_y_ = 0.f;
   scroll_state_ = STATE_UNKNOWN;
 }
 
 bool OverscrollController::DispatchEventCompletesAction (
     const blink::WebInputEvent& event) const {
   if (overscroll_mode_ == OVERSCROLL_NONE)
     return false;
 
   // Complete the overscroll gesture if there was a mouse move or a scroll-end
@@ skipping 122 matching lines @@
       } else if (fabs(velocity_y) > kFlingVelocityThreshold) {
         if ((overscroll_mode_ == OVERSCROLL_NORTH && velocity_y < 0) ||
             (overscroll_mode_ == OVERSCROLL_SOUTH && velocity_y > 0)) {
           CompleteAction();
           event_processed = true;
           break;
         }
       }
 
       // Reset overscroll state if fling didn't complete the overscroll gesture.
-      SetOverscrollMode(OVERSCROLL_NONE);
+      SetOverscrollMode(OVERSCROLL_NONE, OVERSCROLL_SOURCE_NONE);
       break;
     }
 
     default:
       DCHECK(blink::WebInputEvent::isGestureEventType(event.type()) ||
              blink::WebInputEvent::isTouchEventType(event.type()))
           << "Received unexpected event: " << event.type();
   }
   return event_processed;
 }
 
 bool OverscrollController::ProcessOverscroll(float delta_x,
                                              float delta_y,
                                              bool is_touchpad) {
   if (scroll_state_ != STATE_CONTENT_SCROLLING)
     overscroll_delta_x_ += delta_x;
   overscroll_delta_y_ += delta_y;
 
   float horiz_threshold = GetOverscrollConfig(
       is_touchpad ? OVERSCROLL_CONFIG_HORIZ_THRESHOLD_START_TOUCHPAD
                   : OVERSCROLL_CONFIG_HORIZ_THRESHOLD_START_TOUCHSCREEN);
   float vert_threshold = GetOverscrollConfig(
       OVERSCROLL_CONFIG_VERT_THRESHOLD_START);
   if (fabs(overscroll_delta_x_) <= horiz_threshold &&
       fabs(overscroll_delta_y_) <= vert_threshold) {
-    SetOverscrollMode(OVERSCROLL_NONE);
+    SetOverscrollMode(OVERSCROLL_NONE, OVERSCROLL_SOURCE_NONE);
     return true;
   }
 
   // Compute the current overscroll direction. If the direction is different
   // from the current direction, then always switch to no-overscroll mode first
   // to make sure that subsequent scroll events go through to the page first.
   OverscrollMode new_mode = OVERSCROLL_NONE;
   const float kMinRatio = 2.5;
   if (fabs(overscroll_delta_x_) > horiz_threshold &&
       fabs(overscroll_delta_x_) > fabs(overscroll_delta_y_) * kMinRatio)
     new_mode = overscroll_delta_x_ > 0.f ? OVERSCROLL_EAST : OVERSCROLL_WEST;
   else if (fabs(overscroll_delta_y_) > vert_threshold &&
            fabs(overscroll_delta_y_) > fabs(overscroll_delta_x_) * kMinRatio)
     new_mode = overscroll_delta_y_ > 0.f ? OVERSCROLL_SOUTH : OVERSCROLL_NORTH;
 
   // The vertical oversrcoll currently does not have any UX effects other then
   // for the scroll end effect, so testing if it is enabled.
   if ((new_mode == OVERSCROLL_SOUTH || new_mode == OVERSCROLL_NORTH) &&
       !IsScrollEndEffectEnabled())
     new_mode = OVERSCROLL_NONE;
 
   if (overscroll_mode_ == OVERSCROLL_NONE)

[mohsen, 2017/02/21 20:47:58]

nit: Curly braces for multi-line block.

[mfomitchev, 2017/02/23 02:59:42]

Done.

-    SetOverscrollMode(new_mode);
+    SetOverscrollMode(
+        new_mode, is_touchpad ? OVERSCROLL_TOUCHPAD : OVERSCROLL_TOUCHSCREEN);

[mohsen, 2017/02/21 20:47:58]

Can the new_mode be NONE? If yes, can the source be non-NONE?

[mfomitchev, 2017/02/23 02:59:42]

Yes. The contract only enforces that source is non-NONE when mode is non-NONE.
It says nothing about source when mode is NONE. FWIW, I wish we could always
supply valid source, but it is a little tricky and there are some edge cases. It
doesn't seem worth the effort.

[mohsen, 2017/02/23 19:19:09]

Acknowledged.

   else if (new_mode != overscroll_mode_)
-    SetOverscrollMode(OVERSCROLL_NONE);
+    SetOverscrollMode(OVERSCROLL_NONE, OVERSCROLL_SOURCE_NONE);
 
   if (overscroll_mode_ == OVERSCROLL_NONE)
     return false;
 
   // Tell the delegate about the overscroll update so that it can update
   // the display accordingly (e.g. show history preview etc.).
   if (delegate_) {
     // Do not include the threshold amount when sending the deltas to the
     // delegate.
     float delegate_delta_x = overscroll_delta_x_;
@@ skipping 20 matching lines @@
   return false;
 }
 
 void OverscrollController::CompleteAction() {
   if (delegate_)
     delegate_->OnOverscrollComplete(overscroll_mode_);
   overscroll_mode_ = OVERSCROLL_NONE;
   overscroll_delta_x_ = overscroll_delta_y_ = 0.f;
 }
 
-void OverscrollController::SetOverscrollMode(OverscrollMode mode) {
+void OverscrollController::SetOverscrollMode(OverscrollMode mode,
+                                             OverscrollSource source) {
   if (overscroll_mode_ == mode)
     return;
   OverscrollMode old_mode = overscroll_mode_;
   overscroll_mode_ = mode;
   if (overscroll_mode_ == OVERSCROLL_NONE)
     overscroll_delta_x_ = overscroll_delta_y_ = 0.f;
   else
     scroll_state_ = STATE_OVERSCROLLING;
   if (delegate_)
-    delegate_->OnOverscrollModeChange(old_mode, overscroll_mode_);
+    delegate_->OnOverscrollModeChange(old_mode, overscroll_mode_, source);
 }
 
 }  // namespace content