Media Engagement: Do not record playback if no sound was made

If no sound was made then do not record significant playback

BUG=729998

Change-Id: I348649bfa2fefc2556717e011609ffa7813672a8
Reviewed-on: https://chromium-review.googlesource.com/537253Reviewed-by: John Abd-El-Malek <jam@chromium.org>
Reviewed-by: Chrome Cunningham <chcunningham@chromium.org>
Reviewed-by: Mounir Lamouri <mlamouri@chromium.org>
Commit-Queue: Becca Hughes <beccahughes@chromium.org>
Cr-Commit-Position: refs/heads/master@{#485573}

chrome/browser/media/media_engagement_contents_observer.cc

@@ -143,6 +143,11 @@ bool MediaEngagementContentsObserver::IsSignificantPlayer(
 void MediaEngagementContentsObserver::OnSignificantMediaPlaybackTime() {
   DCHECK(!significant_playback_recorded_);
 
+  // Do not record significant playback if the tab did not make
+  // a sound in the last two seconds.
+  if (!web_contents()->WasRecentlyAudible())
+    return;
+
   significant_playback_recorded_ = true;
 
   if (committed_origin_.unique())

chrome/browser/media/media_engagement_contents_observer_unittest.cc

@@ -13,6 +13,7 @@
 #include "chrome/test/base/testing_profile.h"
 #include "content/public/browser/navigation_handle.h"
 #include "content/public/browser/web_contents.h"
+#include "content/public/test/web_contents_tester.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 class MediaEngagementContentsObserverTest
@@ -22,6 +23,8 @@ class MediaEngagementContentsObserverTest
     scoped_feature_list_.InitFromCommandLine("media-engagement", std::string());
 
     ChromeRenderViewHostTestHarness::SetUp();
+    SetContents(content::WebContentsTester::CreateTestWebContents(
+        browser_context(), nullptr));
 
     MediaEngagementService* service = MediaEngagementService::Get(profile());
     ASSERT_TRUE(service);
@@ -31,7 +34,7 @@ class MediaEngagementContentsObserverTest
     playback_timer_ = new base::MockTimer(true, false);
     contents_observer_->SetTimerForTest(base::WrapUnique(playback_timer_));
 
-    ASSERT_FALSE(GetStoredPlayerStatesCount());
+    SimulateInaudible();
   }
 
   bool IsTimerRunning() const { return playback_timer_->IsRunning(); }
@@ -123,6 +126,16 @@ class MediaEngagementContentsObserverTest
     contents_observer_->committed_origin_ = url::Origin(url);
   }
 
+  void SimulateAudible() {
+    content::WebContentsTester::For(web_contents())
+        ->SetWasRecentlyAudible(true);
+  }
+
+  void SimulateInaudible() {
+    content::WebContentsTester::For(web_contents())
+        ->SetWasRecentlyAudible(false);
+  }
+
  private:
   // contents_observer_ auto-destroys when WebContents is destroyed.
   MediaEngagementContentsObserver* contents_observer_;
@@ -175,8 +188,8 @@ TEST_F(MediaEngagementContentsObserverTest, AreConditionsMet) {
 
   web_contents()->SetAudioMuted(true);
   EXPECT_FALSE(AreConditionsMet());
-
   web_contents()->SetAudioMuted(false);
+
   SimulateIsHidden();
   EXPECT_FALSE(AreConditionsMet());
 
@@ -255,6 +268,7 @@ TEST_F(MediaEngagementContentsObserverTest,
        SignificantPlaybackRecordedWhenTimerFires) {
   SimulatePlaybackStarted(0);
   SimulateIsVisible();
+  SimulateAudible();
   web_contents()->SetAudioMuted(false);
   SimulateResizeEvent(0, MediaEngagementContentsObserver::kSignificantSize);
   EXPECT_TRUE(IsTimerRunning());
@@ -271,10 +285,21 @@ TEST_F(MediaEngagementContentsObserverTest, InteractionsRecorded) {
   Navigate(url);
   ExpectScores(url, 0.0, 1, 0);
 
+  SimulateAudible();
   SimulateSignificantPlaybackTime();
   ExpectScores(url, 0.0, 1, 1);
 }
 
+TEST_F(MediaEngagementContentsObserverTest,
+       SignificantPlaybackNotRecordedIfAudioSilent) {
+  SimulatePlaybackStarted(0);
+  SimulateIsVisible();
+  SimulateInaudible();
+  web_contents()->SetAudioMuted(false);
+  EXPECT_FALSE(IsTimerRunning());
+  EXPECT_FALSE(WasSignificantPlaybackRecorded());
+}
+
 TEST_F(MediaEngagementContentsObserverTest, DoNotRecordAudiolessTrack) {
   EXPECT_EQ(0u, GetSignificantActivePlayersCount());
 

content/public/test/web_contents_tester.h

@@ -154,6 +154,9 @@ class WebContentsTester {
 
   // Sets the return value of GetLastCommittedUrl() of TestWebContents.
   virtual void SetLastCommittedURL(const GURL& url) = 0;
+
+  // Override WasRecentlyAudible for testing.
+  virtual void SetWasRecentlyAudible(bool audible) = 0;
 };
 
 }  // namespace content

content/test/test_web_contents.cc

@@ -429,4 +429,8 @@ void TestWebContents::SaveFrameWithHeaders(const GURL& url,
   save_frame_headers_ = headers;
 }
 
+void TestWebContents::SetWasRecentlyAudible(bool audible) {
+  audio_stream_monitor()->set_was_recently_audible_for_testing(audible);
+}
+
 }  // namespace content

content/test/test_web_contents.h

@@ -92,6 +92,7 @@ class TestWebContents : public WebContentsImpl, public WebContentsTester {
       const std::vector<SkBitmap>& bitmaps,
       const std::vector<gfx::Size>& original_bitmap_sizes) override;
   void SetLastCommittedURL(const GURL& url) override;
+  void SetWasRecentlyAudible(bool audible) override;
 
   // True if a cross-site navigation is pending.
   bool CrossProcessNavigationPending();