[Media Controls] Add UMA for timeline scrubber

third_party/WebKit/Source/core/html/shadow/MediaControlElements.cpp

 /*
  * Copyright (C) 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
  * Copyright (C) 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
@@ skipping 17 matching lines @@
  */
 
 #include "core/html/shadow/MediaControlElements.h"
 
 #include "bindings/core/v8/ExceptionState.h"
 #include "core/InputTypeNames.h"
 #include "core/dom/ClientRect.h"
 #include "core/dom/TaskRunnerHelper.h"
 #include "core/dom/Text.h"
 #include "core/dom/shadow/ShadowRoot.h"
+#include "core/events/KeyboardEvent.h"
 #include "core/events/MouseEvent.h"
 #include "core/frame/LocalFrame.h"
 #include "core/frame/Settings.h"
 #include "core/frame/UseCounter.h"
 #include "core/html/HTMLAnchorElement.h"
 #include "core/html/HTMLLabelElement.h"
 #include "core/html/HTMLMediaSource.h"
 #include "core/html/HTMLSpanElement.h"
 #include "core/html/HTMLVideoElement.h"
 #include "core/html/TimeRanges.h"
 #include "core/html/shadow/MediaControls.h"
+#include "core/html/shadow/ShadowElementNames.h"
 #include "core/html/track/TextTrackList.h"
 #include "core/input/EventHandler.h"
+#include "core/layout/LayoutBoxModelObject.h"
 #include "core/layout/api/LayoutSliderItem.h"
+#include "core/page/ChromeClient.h"
 #include "core/page/Page.h"
 #include "platform/EventDispatchForbiddenScope.h"
 #include "platform/Histogram.h"
 #include "platform/RuntimeEnabledFeatures.h"
 #include "platform/text/PlatformLocale.h"
 #include "public/platform/Platform.h"
 #include "public/platform/UserMetricsAction.h"
+#include "public/platform/WebScreenInfo.h"
 
 namespace blink {
 
 using namespace HTMLNames;
 
 namespace {
 
 // This is the duration from mediaControls.css
 const double fadeOutDuration = 0.3;
 
@@ skipping 18 matching lines @@
 // Sliders (the volume control and timeline) need to capture some additional
 // events used when dragging the thumb.
 bool isUserInteractionEventForSlider(Event* event, LayoutObject* layoutObject) {
   // It is unclear if this can be converted to isUserInteractionEvent(), since
   // mouse* events seem to be eaten during a drag anyway.  crbug.com/516416 .
   if (isUserInteractionEvent(event))
     return true;
 
   // Some events are only captured during a slider drag.
   LayoutSliderItem slider = LayoutSliderItem(toLayoutSlider(layoutObject));
+  // TODO(crbug.com/695459#c1): LayoutSliderItem::inDragMode is incorrectly
+  // false for drags that start from the track instead of the thumb.
+  // Use SliderThumbElement::m_inDragMode and
+  // SliderContainerElement::m_touchStarted instead.
   if (!slider.isNull() && !slider.inDragMode())
     return false;
 
   const AtomicString& type = event->type();
   return type == EventTypeNames::mouseover ||
          type == EventTypeNames::mouseout ||
          type == EventTypeNames::mousemove ||
          type == EventTypeNames::pointerover ||
          type == EventTypeNames::pointerout ||
          type == EventTypeNames::pointermove;
@@ skipping 676 matching lines @@
 
 void MediaControlTimelineElement::defaultEventHandler(Event* event) {
   if (event->isMouseEvent() &&
       toMouseEvent(event)->button() !=
           static_cast<short>(WebPointerProperties::Button::Left))
     return;
 
   if (!isConnected() || !document().isActive())
     return;
 
-  if (event->type() == EventTypeNames::mousedown) {
-    Platform::current()->recordAction(
-        UserMetricsAction("Media.Controls.ScrubbingBegin"));
+  // TODO(crbug.com/706504): These should listen for pointerdown/up.
+  if (event->type() == EventTypeNames::mousedown)
     mediaControls().beginScrubbing();
+  if (event->type() == EventTypeNames::mouseup)
+    mediaControls().endScrubbing();
+
+  // Only respond to main button of primary pointer(s).
+  if (event->isPointerEvent() && toPointerEvent(event)->isPrimary() &&
+      toPointerEvent(event)->button() ==
+          static_cast<short>(WebPointerProperties::Button::Left)) {
+    if (event->type() == EventTypeNames::pointerdown) {
+      Platform::current()->recordAction(
+          UserMetricsAction("Media.Controls.ScrubbingBegin"));
+      mediaControls().beginScrubbing();
+      Element* thumb = userAgentShadowRoot()->getElementById(
+          ShadowElementNames::sliderThumb());
+      bool startedFromThumb = thumb && thumb == event->target()->toNode();
+      m_metrics.startGesture(startedFromThumb);
+    }
+    if (event->type() == EventTypeNames::pointerup) {
+      Platform::current()->recordAction(
+          UserMetricsAction("Media.Controls.ScrubbingEnd"));
+      mediaControls().endScrubbing();
+      m_metrics.recordEndGesture(timelineWidth(), mediaElement().duration());
+    }
   }
 
-  if (event->type() == EventTypeNames::mouseup) {
-    Platform::current()->recordAction(
-        UserMetricsAction("Media.Controls.ScrubbingEnd"));
-    mediaControls().endScrubbing();
+  if (event->type() == EventTypeNames::keydown) {
+    m_metrics.startKey();
+  }
+  if (event->type() == EventTypeNames::keyup && event->isKeyboardEvent()) {
+    m_metrics.recordEndKey(timelineWidth(), toKeyboardEvent(event)->keyCode());
   }
 
   MediaControlInputElement::defaultEventHandler(event);
 
   if (event->type() != EventTypeNames::input)
     return;
 
   double time = value().toDouble();
 
   double duration = mediaElement().duration();
   // Workaround for floating point error - it's possible for this element's max
   // attribute to be rounded to a value slightly higher than the duration. If
   // this happens and scrubber is dragged near the max, seek to duration.
   if (time > duration)
     time = duration;
 
+  m_metrics.onInput(mediaElement().currentTime(), time);
+
   // FIXME: This will need to take the timeline offset into consideration
   // once that concept is supported, see https://crbug.com/312699
   if (mediaElement().seekable()->contain(time))
     mediaElement().setCurrentTime(time);
 
   // Provide immediate feedback (without waiting for media to seek) to make it
   // easier for user to seek to a precise time.
   mediaControls().updateCurrentTimeDisplay();
 }
 
 bool MediaControlTimelineElement::willRespondToMouseClickEvents() {
   return isConnected() && document().isActive();
 }
 
 void MediaControlTimelineElement::setPosition(double currentTime) {
   setValue(String::number(currentTime));
 
   if (LayoutObject* layoutObject = this->layoutObject())
     layoutObject->setShouldDoFullPaintInvalidation();
 }
 
 void MediaControlTimelineElement::setDuration(double duration) {
   setFloatingPointAttribute(maxAttr, std::isfinite(duration) ? duration : 0);
 
   if (LayoutObject* layoutObject = this->layoutObject())
     layoutObject->setShouldDoFullPaintInvalidation();
 }
 
+void MediaControlTimelineElement::recordWidthOnFirstPlay() {
+  Frame* frame = document().frame();
+  if (!frame)
+    return;
+  bool isPortrait;
+  switch (frame->chromeClient().screenInfo().orientationType) {
+    case WebScreenOrientationPortraitPrimary:
+    case WebScreenOrientationPortraitSecondary:
+      isPortrait = true;
+      break;
+    case WebScreenOrientationLandscapePrimary:
+    case WebScreenOrientationLandscapeSecondary:
+      isPortrait = false;
+      break;
+    case WebScreenOrientationUndefined:
+      return;  // Skip UMA in the unlikely event we fail to detect orientation.
+  }
+  m_metrics.recordWidthOnFirstPlay(mediaElement().isFullscreen(), isPortrait,
+                                   timelineWidth());

[mlamouri (slow - plz ping), 2017/03/30 21:43:00]

I would have a slight preference to pass the orientationType value to this
method and let it do its own thing.

[johnme, 2017/03/31 13:47:23]

Done.

+}
+
 bool MediaControlTimelineElement::keepEventInNode(Event* event) {
   return isUserInteractionEventForSlider(event, layoutObject());
 }
 
+int MediaControlTimelineElement::timelineWidth() {
+  if (LayoutBoxModelObject* box = layoutBoxModelObject())
+    return box->offsetWidth().round();
+  return 0;
+}
+
 // ----------------------------
 
 MediaControlVolumeSliderElement::MediaControlVolumeSliderElement(
     MediaControls& mediaControls)
     : MediaControlInputElement(mediaControls, MediaVolumeSlider) {}
 
 MediaControlVolumeSliderElement* MediaControlVolumeSliderElement::create(
     MediaControls& mediaControls) {
   MediaControlVolumeSliderElement* slider =
       new MediaControlVolumeSliderElement(mediaControls);
@@ skipping 237 matching lines @@
 MediaControlCurrentTimeDisplayElement*
 MediaControlCurrentTimeDisplayElement::create(MediaControls& mediaControls) {
   MediaControlCurrentTimeDisplayElement* element =
       new MediaControlCurrentTimeDisplayElement(mediaControls);
   element->setShadowPseudoId(
       AtomicString("-webkit-media-controls-current-time-display"));
   return element;
 }
 
 }  // namespace blink