Record whether and why the media default controls are being shown.

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 93 matching lines @@
 using namespace HTMLNames;
 
 using WeakMediaElementSet = WillBeHeapHashSet<RawPtrWillBeWeakMember<HTMLMediaElement>>;
 using DocumentElementSetMap = WillBeHeapHashMap<RawPtrWillBeWeakMember<Document>, WeakMediaElementSet>;
 
 namespace {
 
 // URL protocol used to signal that the media source API is being used.
 const char mediaSourceBlobProtocol[] = "blob";
 
+enum MediaControlsShow {
+    MediaControlsShowAttribute = 0,
+    MediaControlsShowFullscreen,
+    MediaControlsShowNoScript,
+    MediaControlsShowNotShown,
+    MediaControlsShowMax
+};
+
 #if !LOG_DISABLED
 String urlForLoggingMedia(const KURL& url)
 {
     static const unsigned maximumURLLengthForLogging = 128;
 
     if (url.string().length() < maximumURLLengthForLogging)
         return url.string();
     return url.string().substring(0, maximumURLLengthForLogging) + "...";
 }
 
@@ skipping 1947 matching lines @@
 {
     return fastHasAttribute(loopAttr);
 }
 
 void HTMLMediaElement::setLoop(bool b)
 {
     WTF_LOG(Media, "HTMLMediaElement::setLoop(%p, %s)", this, boolString(b));
     setBooleanAttribute(loopAttr, b);
 }
 
-bool HTMLMediaElement::shouldShowControls() const
+bool HTMLMediaElement::shouldShowControls(const RecordMetricsBehavior recordMetrics) const
 {
+    DEFINE_STATIC_LOCAL(EnumerationHistogram, showControlsHistogram, ("Media.Controls.Show", MediaControlsShowMax));
+
+    if (fastHasAttribute(controlsAttr)) {
+        if (recordMetrics == RecordMetricsBehavior::DoRecord)
+            showControlsHistogram.count(MediaControlsShowAttribute);
+        return true;
+    }
+
+    if (isFullscreen()) {
+        if (recordMetrics == RecordMetricsBehavior::DoRecord)
+            showControlsHistogram.count(MediaControlsShowFullscreen);
+        return true;
+    }
+
     LocalFrame* frame = document().frame();
+    if (frame && !frame->script().canExecuteScripts(NotAboutToExecuteScript)) {
+        if (recordMetrics == RecordMetricsBehavior::DoRecord)
+            showControlsHistogram.count(MediaControlsShowNoScript);
+        return true;
+    }
 
-    // always show controls when scripting is disabled
-    if (frame && !frame->script().canExecuteScripts(NotAboutToExecuteScript))
-        return true;
-
-    // Always show controls when in full screen mode.
-    if (isFullscreen())
-        return true;
-
-    return fastHasAttribute(controlsAttr);
+    if (recordMetrics == RecordMetricsBehavior::DoRecord)
+        showControlsHistogram.count(MediaControlsShowNotShown);
+    return false;
 }
 
 double HTMLMediaElement::volume() const
 {
     return m_volume;
 }
 
 void HTMLMediaElement::setVolume(double vol, ExceptionState& exceptionState)
 {
     WTF_LOG(Media, "HTMLMediaElement::setVolume(%p, %f)", this, vol);
@@ skipping 1235 matching lines @@
 void HTMLMediaElement::configureMediaControls()
 {
     if (!inDocument()) {
         if (mediaControls())
             mediaControls()->hide();
         return;
     }
 
     ensureMediaControls();
     mediaControls()->reset();
-    if (shouldShowControls())
+
+    if (shouldShowControls(RecordMetricsBehavior::DoRecord))
         mediaControls()->show();
     else
         mediaControls()->hide();
 }
 
 CueTimeline& HTMLMediaElement::cueTimeline()
 {
     if (!m_cueTimeline)
         m_cueTimeline = adoptPtrWillBeNoop(new CueTimeline(*this));
     return *m_cueTimeline;
@@ skipping 268 matching lines @@
 {
     visitor->trace(m_client);
 }
 
 DEFINE_TRACE(HTMLMediaElement::AudioSourceProviderImpl)
 {
     visitor->trace(m_client);
 }
 
 } // namespace blink