Adding Rappor metrics for disabling cross-origin autoplay with sound experiment

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

 // Copyright 2016 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 "core/html/AutoplayUmaHelper.h"
 
 #include "core/dom/Document.h"
 #include "core/dom/ElementVisibilityObserver.h"
 #include "core/events/Event.h"
 #include "core/frame/Settings.h"
 #include "core/html/HTMLMediaElement.h"
 #include "platform/Histogram.h"
+#include "public/platform/Platform.h"
 #include "wtf/CurrentTime.h"
 
 namespace blink {
 
 namespace {
 
 const int32_t maxOffscreenDurationUmaMS = 60 * 60 * 1000;
 const int32_t offscreenDurationUmaBucketCount = 50;
 
 }  // namespace
@@ skipping 64 matching lines @@
     } else if (dataSaverEnabled) {
       blockedMutedVideoHistogram.count(AutoplayBlockedReasonDataSaver);
     } else if (blockedBySetting) {
       blockedMutedVideoHistogram.count(AutoplayBlockedReasonSetting);
     }
   }
 
   m_element->addEventListener(EventTypeNames::playing, this, false);
 }
 
+void AutoplayUmaHelper::recordCrossOriginAutoplayResult(
+    CrossOriginAutoplayResult result) {
+  if (!m_element->isHTMLVideoElement())
+    return;
+  if (!m_element->isInCrossOriginFrame())
+    return;
+
+  // Record each metric only once per element, since the metric focuses on the
+  // site distribution. If a page calls play() multiple times, it will be
+  // recorded only once.
+  if (m_recordedCrossOriginAutoplayResults.count(result))
+    return;
+
+  switch (result) {
+    case CrossOriginAutoplayResult::AutoplayAllowed:
+      // Record metric
+      Platform::current()->recordRapporURL(
+          "Media.Autoplay.CrossOrigin.Allowed.ChildFrame",
+          m_element->document().url());
+      Platform::current()->recordRapporURL(
+          "Media.Autoplay.CrossOrigin.Allowed.TopLevelFrame",
+          m_element->document().topDocument().url());
+      m_recordedCrossOriginAutoplayResults.insert(result);
+      break;
+    case CrossOriginAutoplayResult::AutoplayBlocked:
+      Platform::current()->recordRapporURL(
+          "Media.Autoplay.CrossOrigin.Blocked.ChildFrame",
+          m_element->document().url());
+      Platform::current()->recordRapporURL(
+          "Media.Autoplay.CrossOrigin.Blocked.TopLevelFrame",
+          m_element->document().topDocument().url());
+      m_recordedCrossOriginAutoplayResults.insert(result);
+      break;
+    case CrossOriginAutoplayResult::PlayedWithGesture:
+      // Record this metric only when the video has been blocked from autoplay
+      // previously. This is to record the sites having videos that are blocked
+      // to autoplay but the user starts the playback by gesture.
+      if (!m_recordedCrossOriginAutoplayResults.count(
+              CrossOriginAutoplayResult::AutoplayBlocked)) {
+        return;
+      }
+      Platform::current()->recordRapporURL(
+          "Media.Autoplay.CrossOrigin.PlayedWithGesture.ChildFrame",

[mlamouri (slow - plz ping), 2016/12/08 17:17:06]

Should the rapport name be "PlayedWithGestureAfterBlock" then?

[Zhiqiang Zhang (Slow), 2016/12/08 17:35:29]

Done.

+          m_element->document().url());
+      Platform::current()->recordRapporURL(
+          "Media.Autoplay.CrossOrigin.PlayedWithGesture."
+          "TopLevelFrame",
+          m_element->document().topDocument().url());
+      m_recordedCrossOriginAutoplayResults.insert(result);
+      break;
+    default:
+      NOTREACHED();
+  }
+}
+
 void AutoplayUmaHelper::recordAutoplayUnmuteStatus(
     AutoplayUnmuteActionStatus status) {
   DEFINE_STATIC_LOCAL(
       EnumerationHistogram, autoplayUnmuteHistogram,
       ("Media.Video.Autoplay.Muted.UnmuteAction",
        static_cast<int>(AutoplayUnmuteActionStatus::NumberOfStatus)));
 
   autoplayUnmuteHistogram.count(static_cast<int>(status));
 }
 
@@ skipping 153 matching lines @@
 
 DEFINE_TRACE(AutoplayUmaHelper) {
   EventListener::trace(visitor);
   ContextLifecycleObserver::trace(visitor);
   visitor->trace(m_element);
   visitor->trace(m_mutedVideoPlayMethodVisibilityObserver);
   visitor->trace(m_mutedVideoOffscreenDurationVisibilityObserver);
 }
 
 }  // namespace blink