Autoplay experiment metric fixes and additions.

third_party/WebKit/Source/core/html/HTMLMediaElement.cpp

 /*
  * Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 Apple 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.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 19 matching lines @@
 #include "bindings/core/v8/ScriptController.h"
 #include "bindings/core/v8/ScriptEventListener.h"
 #include "core/HTMLNames.h"
 #include "core/css/MediaList.h"
 #include "core/dom/Attribute.h"
 #include "core/dom/ElementTraversal.h"
 #include "core/dom/ExceptionCode.h"
 #include "core/dom/Fullscreen.h"
 #include "core/dom/shadow/ShadowRoot.h"
 #include "core/events/Event.h"
+#include "core/frame/FrameView.h"
 #include "core/frame/LocalFrame.h"
 #include "core/frame/Settings.h"
 #include "core/frame/UseCounter.h"
 #include "core/frame/csp/ContentSecurityPolicy.h"
 #include "core/html/HTMLMediaSource.h"
 #include "core/html/HTMLSourceElement.h"
 #include "core/html/HTMLTrackElement.h"
 #include "core/html/MediaError.h"
 #include "core/html/MediaFragmentURIParser.h"
 #include "core/html/TimeRanges.h"
@@ skipping 272 matching lines @@
     , m_seeking(false)
     , m_sentStalledEvent(false)
     , m_sentEndEvent(false)
     , m_closedCaptionsVisible(false)
     , m_havePreparedToPlay(false)
     , m_tracksAreReady(true)
     , m_processingPreferenceChange(false)
     , m_remoteRoutesAvailable(false)
     , m_playingRemotely(false)
     , m_isFinalizing(false)
-    , m_initialPlayWithoutUserGesture(false)
-    , m_autoplayMediaCounted(false)
     , m_inOverlayFullscreenVideo(false)
     , m_audioTracks(AudioTrackList::create(*this))
     , m_videoTracks(VideoTrackList::create(*this))
     , m_textTracks(nullptr)
     , m_audioSourceNode(nullptr)
-    , m_autoplayHelper(*this)
+    , m_autoplayHelperClient(adoptPtr(new AutoplayHelperClientImpl(this)))

[sof, 2016/02/16 08:40:06]

Could you add a static create() factory method & change this to

  , m_autoplayHelperClient(AutoplayHelperClientImpl::create(this))

[liberato (no reviews please), 2016/02/24 18:44:05]

Done.

+    , m_autoplayHelper(adoptPtr(new AutoplayExperimentHelper(*m_autoplayHelperClient)))

[sof, 2016/02/16 08:40:06]

Could you add a static create() factory method & change this to

  , m_autoplayHelper(AutoplayExperimentHelper::create(*m_autoplayHelperClient))

[liberato (no reviews please), 2016/02/24 18:44:05]

Done.

 {
 #if ENABLE(OILPAN)
     ThreadState::current()->registerPreFinalizer(this);
 #endif
     ASSERT(RuntimeEnabledFeatures::mediaEnabled());
 
     WTF_LOG(Media, "HTMLMediaElement::HTMLMediaElement(%p)", this);
 
     if (document.settings() && document.settings()->mediaPlaybackRequiresUserGesture())
         m_userGestureRequiredForPlay = true;
 
     setHasCustomStyleCallbacks();
     addElementToDocumentMap(this, &document);
 
     UseCounter::count(document, UseCounter::HTMLMediaElement);
 }
 
 HTMLMediaElement::~HTMLMediaElement()
 {
     WTF_LOG(Media, "HTMLMediaElement::~HTMLMediaElement(%p)", this);
 
+    if (m_autoplayHelper)

[sof, 2016/02/16 08:40:06]

I haven't looked at the details, but is this explicit clearing needed to handle
some finalization details?

[liberato (no reviews please), 2016/02/24 18:44:05]

yes.  destroying the helper calls into the client, with raw ptrs all around in
the non-oilpan case.

for oilpan, i've moved cleanup into dispose(), since it likes to unregister
event listeners, for example.

+        m_autoplayHelper.clear();
+
+    if (m_autoplayHelperClient)
+        m_autoplayHelperClient.clear();
+
 #if !ENABLE(OILPAN)
     // HTMLMediaElement and m_asyncEventQueue always become unreachable
     // together. So HTMLMediaElement and m_asyncEventQueue are destructed in
     // the same GC. We don't need to close it explicitly in Oilpan.
     m_asyncEventQueue->close();
 
     setShouldDelayLoadEvent(false);
 
     if (m_textTracks)
         m_textTracks->clearOwner();
@@ skipping 280 matching lines @@
     case WebMimeRegistry::IsSupported:
         canPlay = "probably";
         break;
     }
 
     WTF_LOG(Media, "HTMLMediaElement::canPlayType(%p, %s, %s) -> %s", this, mimeType.utf8().data(), keySystem.utf8().data(), canPlay.utf8().data());
 
     return canPlay;
 }
 
-void HTMLMediaElement::recordMetricsIfPausing()
-{
-    // If not playing, then nothing to record.
-    // TODO(liberato): test metrics.  this was m_paused.
-    if (m_paused)
-        return;
-
-    const bool bailout = isBailout();
-
-    // Record that play was paused.  We don't care if it was autoplay,
-    // play(), or the user manually started it.
-    recordAutoplayMetric(AnyPlaybackPaused);
-    if (bailout)
-        recordAutoplayMetric(AnyPlaybackBailout);
-
-    // If this was a gestureless play, then record that separately.
-    // These cover attr and play() gestureless starts.
-    if (m_initialPlayWithoutUserGesture) {
-        m_initialPlayWithoutUserGesture = false;
-
-        recordAutoplayMetric(AutoplayPaused);
-
-        if (bailout)
-            recordAutoplayMetric(AutoplayBailout);
-    }
-}
-
 void HTMLMediaElement::load()
 {
     WTF_LOG(Media, "HTMLMediaElement::load(%p)", this);
 
-    recordMetricsIfPausing();
-
-    if (UserGestureIndicator::processingUserGesture() && m_userGestureRequiredForPlay) {
-        recordAutoplayMetric(AutoplayEnabledThroughLoad);
-        m_userGestureRequiredForPlay = false;
-        // While usergesture-initiated load()s technically count as autoplayed,
-        // they don't feel like such to the users and hence we don't want to
-        // count them for the purposes of metrics.
-        m_autoplayMediaCounted = true;
-    }
+    m_autoplayHelper->loadMethodCalled();
 
     prepareForLoad();
     loadInternal();
     prepareToPlay();
 }
 
 void HTMLMediaElement::prepareForLoad()
 {
     WTF_LOG(Media, "HTMLMediaElement::prepareForLoad(%p)", this);
 
@@ skipping 202 matching lines @@
 
     LocalFrame* frame = document().frame();
     if (!frame) {
         mediaLoadingFailed(WebMediaPlayer::NetworkStateFormatError);
         return;
     }
 
     // The resource fetch algorithm
     setNetworkState(NETWORK_LOADING);
 
+    m_autoplayHelper->loadingStarted();
+
     // Set m_currentSrc *before* changing to the cache url, the fact that we are loading from the app
     // cache is an internal detail not exposed through the media element API.
     m_currentSrc = url;
 
     if (m_audioSourceNode)
         m_audioSourceNode->onCurrentSrcChanged(m_currentSrc);
 
     WTF_LOG(Media, "HTMLMediaElement::loadResource(%p) - m_currentSrc -> %s", this, urlForLoggingMedia(m_currentSrc).utf8().data());
 
     startProgressEventTimer();
 
     // Reset display mode to force a recalculation of what to show because we are resetting the player.
     setDisplayMode(Unknown);
 
     setPlayerPreload();
 
     if (fastHasAttribute(mutedAttr))
         m_muted = true;
     updateVolume();
 
     ASSERT(!m_mediaSource);
 
     bool attemptLoad = true;
 
     if (url.protocolIs(mediaSourceBlobProtocol)) {
         if (isMediaStreamURL(url.string())) {
-            m_userGestureRequiredForPlay = false;
+            m_autoplayHelper->removeUserGestureRequirement(GesturelessPlaybackEnabledByStream);
         } else {
             m_mediaSource = HTMLMediaSource::lookup(url.string());
 
             if (m_mediaSource) {
                 if (!m_mediaSource->attachToElement(this)) {
                     // Forget our reference to the MediaSource, so we leave it alone
                     // while processing remainder of load failure.
                     m_mediaSource = nullptr;
                     attemptLoad = false;
                 }
@@ skipping 562 matching lines @@
     }
 
     if (m_readyState == HAVE_ENOUGH_DATA && oldState < HAVE_ENOUGH_DATA && tracksAreReady) {
         if (oldState <= HAVE_CURRENT_DATA) {
             scheduleEvent(EventTypeNames::canplay);
             if (isPotentiallyPlaying)
                 scheduleEvent(EventTypeNames::playing);
         }
 
         // Check for autoplay, and record metrics about it if needed.
-        if (shouldAutoplay(RecordMetricsBehavior::DoRecord)) {
+        if (shouldAutoplay(RecordMetricsBehavior::RecordOnSandboxFailure)) {
             // If the autoplay experiment says that it's okay to play now,
             // then don't require a user gesture.
-            m_autoplayHelper.becameReadyToPlay();
+            m_autoplayHelper->becameReadyToPlay();
 
             if (!m_userGestureRequiredForPlay) {
                 m_paused = false;
                 invalidateCachedTime();
                 scheduleEvent(EventTypeNames::play);
                 scheduleEvent(EventTypeNames::playing);
                 m_autoplaying = false;
             }
         }
 
@@ skipping 118 matching lines @@
 
     m_lastSeekTime = time;
     m_sentEndEvent = false;
 
     // 10 - Queue a task to fire a simple event named seeking at the element.
     scheduleEvent(EventTypeNames::seeking);
 
     // 11 - Set the current playback position to the given new playback position.
     webMediaPlayer()->seek(time);
 
-    m_initialPlayWithoutUserGesture = false;
-
     // 14-17 are handled, if necessary, when the engine signals a readystate change or otherwise
     // satisfies seek completion and signals a time change.
 }
 
 void HTMLMediaElement::finishSeek()
 {
     WTF_LOG(Media, "HTMLMediaElement::finishSeek(%p)", this);
 
     // 14 - Set the seeking IDL attribute to false.
     m_seeking = false;
@@ skipping 161 matching lines @@
 }
 
 bool HTMLMediaElement::autoplay() const
 {
     return fastHasAttribute(autoplayAttr);
 }
 
 bool HTMLMediaElement::shouldAutoplay(const RecordMetricsBehavior recordMetrics)
 {
     if (m_autoplaying && m_paused && autoplay()) {
-        if (recordMetrics == RecordMetricsBehavior::DoRecord)
-            autoplayMediaEncountered();
-
         if (document().isSandboxed(SandboxAutomaticFeatures)) {
-            if (recordMetrics == RecordMetricsBehavior::DoRecord)
-                recordAutoplayMetric(AutoplayDisabledBySandbox);
+            if (recordMetrics == RecordMetricsBehavior::RecordOnSandboxFailure)
+                m_autoplayHelper->recordSandboxFailure();
             return false;
         }
 
         return true;
     }
 
     return false;
 }
 
 String HTMLMediaElement::preload() const
@@ skipping 54 matching lines @@
 
 WebMediaPlayer::Preload HTMLMediaElement::effectivePreloadType() const
 {
     return autoplay() ? WebMediaPlayer::PreloadAuto : preloadType();
 }
 
 void HTMLMediaElement::play()
 {
     WTF_LOG(Media, "HTMLMediaElement::play(%p)", this);
 
-    m_autoplayHelper.playMethodCalled();
+    m_autoplayHelper->playMethodCalled();
 
     if (!UserGestureIndicator::processingUserGesture()) {
-        autoplayMediaEncountered();
-
         if (m_userGestureRequiredForPlay) {
             recordAutoplayMetric(PlayMethodFailed);
             String message = ExceptionMessages::failedToExecute("play", "HTMLMediaElement", "API can only be initiated by a user gesture.");
             document().addConsoleMessage(ConsoleMessage::create(JSMessageSource, WarningMessageLevel, message));
             return;
         }
-    } else if (m_userGestureRequiredForPlay) {
-        if (m_autoplayMediaCounted)
-            recordAutoplayMetric(AutoplayManualStart);
-        m_userGestureRequiredForPlay = false;
+    } else {
+        // We ask the helper to remove the gesture requirement for us, so that
+        // it can record the reason.
+        m_autoplayHelper->removeUserGestureRequirement(GesturelessPlaybackEnabledByPlayMethod);
     }
 
     playInternal();
 }
 
 void HTMLMediaElement::playInternal()
 {
     WTF_LOG(Media, "HTMLMediaElement::playInternal(%p)", this);
 
     // Always return the buffering strategy to normal when not paused,
@@ skipping 20 matching lines @@
         if (m_readyState <= HAVE_CURRENT_DATA)
             scheduleEvent(EventTypeNames::waiting);
         else if (m_readyState >= HAVE_FUTURE_DATA)
             scheduleEvent(EventTypeNames::playing);
     }
     m_autoplaying = false;
 
     updatePlayState();
 }
 
-void HTMLMediaElement::autoplayMediaEncountered()
-{
-    if (!m_autoplayMediaCounted) {
-        m_autoplayMediaCounted = true;
-        recordAutoplayMetric(AutoplayMediaFound);
-
-        if (!m_userGestureRequiredForPlay)
-            m_initialPlayWithoutUserGesture = true;
-    }
-}
-
-bool HTMLMediaElement::isBailout() const
-{
-    // We count the user as having bailed-out on the video if they watched
-    // less than one minute and less than 50% of it.
-    const double playedTime = currentTime();
-    const double progress = playedTime / duration();
-    return (playedTime < 60) && (progress < 0.5);
-}
-
 void HTMLMediaElement::pause()
 {
     WTF_LOG(Media, "HTMLMediaElement::pause(%p)", this);
 
     // Only buffer aggressively on a user-initiated pause. Other types of pauses
     // (which go directly to pauseInternal()) should not cause this behavior.
     if (webMediaPlayer() && UserGestureIndicator::processingUserGesture())
         webMediaPlayer()->setBufferingStrategy(WebMediaPlayer::BufferingStrategy::Aggressive);
 
     pauseInternal();
 }
 
 void HTMLMediaElement::pauseInternal()
 {
     WTF_LOG(Media, "HTMLMediaElement::pauseInternal(%p)", this);
 
     if (m_networkState == NETWORK_EMPTY)
         scheduleDelayedAction(LoadMediaResource);
 
-    m_autoplayHelper.pauseMethodCalled();
+    m_autoplayHelper->pauseMethodCalled();
 
     m_autoplaying = false;
 
     if (!m_paused) {
-        recordMetricsIfPausing();
-
         m_paused = true;
         scheduleTimeupdateEvent(false);
         scheduleEvent(EventTypeNames::pause);
     }
 
     updatePlayState();
 }
 
 void HTMLMediaElement::requestRemotePlayback()
 {
@@ skipping 71 matching lines @@
 
 void HTMLMediaElement::setMuted(bool muted)
 {
     WTF_LOG(Media, "HTMLMediaElement::setMuted(%p, %s)", this, boolString(muted));
 
     if (m_muted == muted)
         return;
 
     m_muted = muted;
 
-    m_autoplayHelper.mutedChanged();
+    m_autoplayHelper->mutedChanged();
 
     updateVolume();
 
     scheduleEvent(EventTypeNames::volumechange);
 }
 
 void HTMLMediaElement::updateVolume()
 {
     if (webMediaPlayer())
         webMediaPlayer()->setVolume(effectiveMediaVolume());
@@ skipping 579 matching lines @@
         // If the media element has a loop attribute specified
         if (loop()) {
             m_sentEndEvent = false;
             //  then seek to the earliest possible position of the media resource and abort these steps.
             seek(0);
         } else {
             // If the media element has still ended playback, and the direction of playback is still
             // forwards, and paused is false,
             if (!m_paused) {
                 // changes paused to true and fires a simple event named pause at the media element.
+                m_autoplayHelper->playbackEnded();
                 m_paused = true;
                 scheduleEvent(EventTypeNames::pause);
             }
             // Queue a task to fire a simple event named ended at the media element.
             if (!m_sentEndEvent) {
                 m_sentEndEvent = true;
                 scheduleEvent(EventTypeNames::ended);
             }
-            recordMetricsIfPausing();
         }
     } else {
         m_sentEndEvent = false;
     }
 
     updatePlayState();
 }
 
 void HTMLMediaElement::durationChanged()
 {
@@ skipping 186 matching lines @@
     if (shouldBePlaying) {
         setDisplayMode(Video);
         invalidateCachedTime();
 
         if (!isPlaying) {
             // Set rate, muted before calling play in case they were set before the media engine was setup.
             // The media engine should just stash the rate and muted values since it isn't already playing.
             webMediaPlayer()->setRate(playbackRate());
             updateVolume();
             webMediaPlayer()->play();
+            m_autoplayHelper->playbackStarted();
         }
 
         if (mediaControls())
             mediaControls()->playbackStarted();
         startPlaybackProgressTimer();
         m_playing = true;
-        recordAutoplayMetric(AnyPlaybackStarted);
 
     } else { // Should not be playing right now
         if (isPlaying)
             webMediaPlayer()->pause();
+
         refreshCachedTime();
 
         m_playbackProgressTimer.stop();
         m_playing = false;
         double time = currentTime();
         if (time > m_lastSeekTime)
             addPlayedRange(m_lastSeekTime, time);
 
         if (couldPlayIfEnoughData())
             prepareToPlay();
@@ skipping 47 matching lines @@
         mediaControls()->refreshCastButtonVisibilityWithoutUpdate();
 
     if (layoutObject())
         layoutObject()->setShouldDoFullPaintInvalidation();
 }
 
 void HTMLMediaElement::stop()
 {
     WTF_LOG(Media, "HTMLMediaElement::stop(%p)", this);
 
-    recordMetricsIfPausing();
-
     // Close the async event queue so that no events are enqueued.
     cancelPendingEventsAndCallbacks();
     m_asyncEventQueue->close();
 
     // Stop the playback without generating events
     clearMediaPlayer(-1);
     m_readyState = HAVE_NOTHING;
     m_readyStateMaximum = HAVE_NOTHING;
     setNetworkState(NETWORK_EMPTY);
     setShouldDelayLoadEvent(false);
@@ skipping 448 matching lines @@
     visitor->trace(m_currentSourceNode);
     visitor->trace(m_nextChildNodeToConsider);
     visitor->trace(m_mediaSource);
     visitor->trace(m_audioTracks);
     visitor->trace(m_videoTracks);
     visitor->trace(m_cueTimeline);
     visitor->trace(m_textTracks);
     visitor->trace(m_textTracksWhenResourceSelectionBegan);
     visitor->trace(m_audioSourceProvider);
     visitor->template registerWeakMembers<HTMLMediaElement, &HTMLMediaElement::clearWeakMembers>(this);
-    visitor->trace(m_autoplayHelper);
     HeapSupplementable<HTMLMediaElement>::trace(visitor);
 #endif
     HTMLElement::trace(visitor);
     ActiveDOMObject::trace(visitor);
 }
 
 void HTMLMediaElement::createPlaceholderTracksIfNecessary()
 {
     if (!RuntimeEnabledFeatures::audioVideoTracksEnabled())
         return;
@@ skipping 24 matching lines @@
 bool HTMLMediaElement::isUserGestureRequiredForPlay() const
 {
     return m_userGestureRequiredForPlay;
 }
 
 void HTMLMediaElement::removeUserGestureRequirement()
 {
     m_userGestureRequiredForPlay = false;
 }
 
-void HTMLMediaElement::setInitialPlayWithoutUserGestures(bool value)
-{
-    m_initialPlayWithoutUserGesture = value;
-}
-
 void HTMLMediaElement::setNetworkState(NetworkState state)
 {
     if (m_networkState != state) {
         m_networkState = state;
         if (MediaControls* controls = mediaControls())
             controls->networkStateChanged();
     }
 }
 
 void HTMLMediaElement::notifyPositionMayHaveChanged(const IntRect& visibleRect)
 {
-    m_autoplayHelper.positionChanged(visibleRect);
+    m_autoplayHelper->positionChanged(visibleRect);
 }
 
 void HTMLMediaElement::updatePositionNotificationRegistration()
 {
-    m_autoplayHelper.updatePositionNotificationRegistration();
+    m_autoplayHelper->updatePositionNotificationRegistration();
 }
 
 // TODO(liberato): remove once autoplay gesture override experiment concludes.
 void HTMLMediaElement::triggerAutoplayViewportCheckForTesting()
 {
-    m_autoplayHelper.triggerAutoplayViewportCheckForTesting();
+    if (FrameView* view = document().view())
+        m_autoplayHelper->positionChanged(view->rootFrameToContents(view->computeVisibleArea()));
+    m_autoplayHelper->triggerAutoplayViewportCheckForTesting();
 }
 
 void HTMLMediaElement::clearWeakMembers(Visitor* visitor)
 {
     if (!Heap::isHeapObjectAlive(m_audioSourceNode))
         audioSourceProvider().setClient(nullptr);
 }
 
 void HTMLMediaElement::AudioSourceProviderImpl::wrap(WebAudioSourceProvider* provider)
 {
@@ skipping 48 matching lines @@
 DEFINE_TRACE(HTMLMediaElement::AudioClientImpl)
 {
     visitor->trace(m_client);
 }
 
 DEFINE_TRACE(HTMLMediaElement::AudioSourceProviderImpl)
 {
     visitor->trace(m_client);
 }
 
+HTMLMediaElement::AutoplayHelperClientImpl::~AutoplayHelperClientImpl()
+{
+}
+
+bool HTMLMediaElement::AutoplayHelperClientImpl::isLegacyViewportType()
+{
+    return m_element->document().viewportDescription().isLegacyViewportType();
+}
+
+PageVisibilityState HTMLMediaElement::AutoplayHelperClientImpl::pageVisibilityState() const
+{
+    return m_element->document().pageVisibilityState();
+}
+
+String HTMLMediaElement::AutoplayHelperClientImpl::autoplayExperimentMode() const
+{
+    String mode;
+    if (m_element->document().settings())
+        mode = m_element->document().settings()->autoplayExperimentMode();
+
+    return mode;
+}
+
+void HTMLMediaElement::AutoplayHelperClientImpl::setRequestPositionUpdates(bool request)
+{
+    if (LayoutObject* layoutObject = m_element->layoutObject()) {
+        LayoutMedia* layoutMedia = toLayoutMedia(layoutObject);
+        layoutMedia->setRequestPositionUpdates(request);
+    }
+}
+
+IntRect HTMLMediaElement::AutoplayHelperClientImpl::absoluteBoundingBoxRect() const
+{
+    IntRect result;
+    if (LayoutObject* object = m_element->layoutObject())
+        result = object->absoluteBoundingBoxRect();
+    return result;
+}
+
 } // namespace blink