Implement media playing engagement detection for the site engagement service.

chrome/browser/engagement/site_engagement_helper_unittest.cc

 // Copyright 2015 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 "base/command_line.h"
 #include "base/test/histogram_tester.h"
 #include "base/timer/mock_timer.h"
 #include "base/values.h"
 #include "chrome/browser/engagement/site_engagement_helper.h"
 #include "chrome/browser/engagement/site_engagement_service.h"
@@ skipping 11 matching lines @@
   // be called in tests.
   scoped_ptr<SiteEngagementHelper> CreateHelper(
       content::WebContents* web_contents) {
     scoped_ptr<SiteEngagementHelper> helper(
         new SiteEngagementHelper(web_contents));
     DCHECK(helper.get());
 
     return helper.Pass();
   }
 
-  void StartTracking(SiteEngagementHelper* helper) {
-    helper->input_tracker_.StartTracking();
+  void TrackingStarted(SiteEngagementHelper* helper) {
+    helper->input_tracker_.TrackingStarted();
+    helper->media_tracker_.TrackingStarted();
   }
 
   // Simulate a user interaction event and handle it.
   void HandleUserInput(SiteEngagementHelper* helper,
                        blink::WebInputEvent::Type type) {
     helper->input_tracker_.DidGetUserInteraction(type);
   }
 
   // Simulate a user interaction event and handle it. Reactivates tracking
   // immediately.
   void HandleUserInputAndRestartTracking(SiteEngagementHelper* helper,
-                       blink::WebInputEvent::Type type) {
+                                         blink::WebInputEvent::Type type) {
     helper->input_tracker_.DidGetUserInteraction(type);
-    helper->input_tracker_.StartTracking();
+    helper->input_tracker_.TrackingStarted();
+  }
+
+  void HandleMediaPlaying(SiteEngagementHelper* helper, bool is_hidden) {
+    helper->RecordMediaPlaying(is_hidden);
+  }
+
+  void MediaStartedPlaying(SiteEngagementHelper* helper) {
+    helper->media_tracker_.MediaStartedPlaying();
+  }
+
+  void MediaPaused(SiteEngagementHelper* helper) {
+    helper->media_tracker_.MediaPaused();
   }
 
   // Set a pause timer on the input tracker for test purposes.
   void SetInputTrackerPauseTimer(SiteEngagementHelper* helper,
                                  scoped_ptr<base::Timer> timer) {
     helper->input_tracker_.SetPauseTimerForTesting(timer.Pass());
   }
 
   bool IsTracking(SiteEngagementHelper* helper) {
     return helper->input_tracker_.is_tracking();
@@ skipping 15 matching lines @@
     content::WebContents* web_contents =
       browser()->tab_strip_model()->GetActiveWebContents();
 
     scoped_ptr<SiteEngagementHelper> helper(CreateHelper(web_contents));
     SiteEngagementService* service =
       SiteEngagementServiceFactory::GetForProfile(browser()->profile());
     DCHECK(service);
 
     // Check that navigation triggers engagement.
     NavigateWithDisposition(url1, CURRENT_TAB);
-    StartTracking(helper.get());
+    TrackingStarted(helper.get());
 
     EXPECT_DOUBLE_EQ(0.5, service->GetScore(url1));
     EXPECT_EQ(0, service->GetScore(url2));
 
     // Simulate a user input trigger and ensure it is treated correctly.
     HandleUserInputAndRestartTracking(helper.get(), type);
 
     EXPECT_DOUBLE_EQ(0.55, service->GetScore(url1));
     EXPECT_EQ(0, service->GetScore(url2));
 
     // Simulate three inputs , and ensure they are treated correctly.
     HandleUserInputAndRestartTracking(helper.get(), type);
     HandleUserInputAndRestartTracking(helper.get(), type);
     HandleUserInputAndRestartTracking(helper.get(), type);
 
     EXPECT_DOUBLE_EQ(0.7, service->GetScore(url1));
     EXPECT_EQ(0, service->GetScore(url2));
 
     // Simulate inputs for a different link.
     NavigateWithDisposition(url2, CURRENT_TAB);
-    StartTracking(helper.get());
+    TrackingStarted(helper.get());
 
     EXPECT_DOUBLE_EQ(0.7, service->GetScore(url1));
     EXPECT_DOUBLE_EQ(0.5, service->GetScore(url2));
     EXPECT_DOUBLE_EQ(1.2, service->GetTotalEngagementPoints());
 
     HandleUserInputAndRestartTracking(helper.get(), type);
     EXPECT_DOUBLE_EQ(0.7, service->GetScore(url1));
     EXPECT_DOUBLE_EQ(0.55, service->GetScore(url2));
     EXPECT_DOUBLE_EQ(1.25, service->GetTotalEngagementPoints());
   }
 };
 
 TEST_F(SiteEngagementHelperTest, KeyPressEngagementAccumulation) {
   UserInputAccumulation(blink::WebInputEvent::RawKeyDown);
 }
 
 TEST_F(SiteEngagementHelperTest, MouseDownEventEngagementAccumulation) {
   UserInputAccumulation(blink::WebInputEvent::MouseDown);
 }
 
 TEST_F(SiteEngagementHelperTest, MouseWheelEventEngagementAccumulation) {
   UserInputAccumulation(blink::WebInputEvent::MouseWheel);
 }
 
 TEST_F(SiteEngagementHelperTest, GestureEngagementAccumulation) {
   UserInputAccumulation(blink::WebInputEvent::GestureTapDown);
 }
 
+TEST_F(SiteEngagementHelperTest, MediaEngagementAccumulation) {
+  AddTab(browser(), GURL("about:blank"));
+  GURL url1("https://www.google.com/");
+  GURL url2("http://www.google.com/");
+  content::WebContents* web_contents =
+    browser()->tab_strip_model()->GetActiveWebContents();
+
+  scoped_ptr<SiteEngagementHelper> helper(CreateHelper(web_contents));
+  SiteEngagementService* service =
+    SiteEngagementServiceFactory::GetForProfile(browser()->profile());
+  DCHECK(service);
+
+  NavigateWithDisposition(url1, CURRENT_TAB);
+  TrackingStarted(helper.get());
+
+  EXPECT_DOUBLE_EQ(0.5, service->GetScore(url1));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  // Simulate a foreground media input and ensure it is treated correctly.
+  HandleMediaPlaying(helper.get(), false);
+
+  EXPECT_DOUBLE_EQ(0.52, service->GetScore(url1));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  // Simulate continual media playing, and ensure it is treated correctly.
+  HandleMediaPlaying(helper.get(), false);
+  HandleMediaPlaying(helper.get(), false);
+  HandleMediaPlaying(helper.get(), false);
+
+  EXPECT_DOUBLE_EQ(0.58, service->GetScore(url1));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  // Simulate backgrounding the media.
+  HandleMediaPlaying(helper.get(), true);
+  HandleMediaPlaying(helper.get(), true);
+
+  EXPECT_DOUBLE_EQ(0.60, service->GetScore(url1));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  // Simulate inputs for a different link.
+  NavigateWithDisposition(url2, CURRENT_TAB);
+  TrackingStarted(helper.get());
+
+  EXPECT_DOUBLE_EQ(0.6, service->GetScore(url1));
+  EXPECT_DOUBLE_EQ(0.5, service->GetScore(url2));
+  EXPECT_DOUBLE_EQ(1.1, service->GetTotalEngagementPoints());
+
+  HandleMediaPlaying(helper.get(), false);
+  HandleMediaPlaying(helper.get(), false);
+  EXPECT_DOUBLE_EQ(0.6, service->GetScore(url1));
+  EXPECT_DOUBLE_EQ(0.54, service->GetScore(url2));
+  EXPECT_DOUBLE_EQ(1.14, service->GetTotalEngagementPoints());
+}
+
+TEST_F(SiteEngagementHelperTest, MediaEngagement) {
+  AddTab(browser(), GURL("about:blank"));
+  GURL url1("https://www.google.com/");
+  GURL url2("http://www.google.com/");
+  content::WebContents* web_contents =
+    browser()->tab_strip_model()->GetActiveWebContents();
+
+  scoped_ptr<SiteEngagementHelper> helper(CreateHelper(web_contents));
+  SiteEngagementService* service =
+    SiteEngagementServiceFactory::GetForProfile(browser()->profile());
+  DCHECK(service);
+
+  NavigateWithDisposition(url1, CURRENT_TAB);
+  // Start media playing before tracking begins
+  MediaStartedPlaying(helper.get());
+  TrackingStarted(helper.get());
+
+  EXPECT_DOUBLE_EQ(0.52, service->GetScore(url1));
+  EXPECT_EQ(0, service->GetScore(url2));
+}
+
 TEST_F(SiteEngagementHelperTest, MixedInputEngagementAccumulation) {
   AddTab(browser(), GURL("about:blank"));
   GURL url1("https://www.google.com/");
   GURL url2("http://www.google.com/");
   content::WebContents* web_contents =
     browser()->tab_strip_model()->GetActiveWebContents();
 
   scoped_ptr<SiteEngagementHelper> helper(CreateHelper(web_contents));
   SiteEngagementService* service =
     SiteEngagementServiceFactory::GetForProfile(browser()->profile());
   DCHECK(service);
 
   base::HistogramTester histograms;
 
   // Histograms should start off empty.
   histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                               0);
 
   NavigateWithDisposition(url1, CURRENT_TAB);
-  StartTracking(helper.get());
+  TrackingStarted(helper.get());
 
   EXPECT_DOUBLE_EQ(0.5, service->GetScore(url1));
   EXPECT_EQ(0, service->GetScore(url2));
   histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                               1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_NAVIGATION, 1);
 
   HandleUserInputAndRestartTracking(helper.get(),
                                     blink::WebInputEvent::RawKeyDown);
@@ skipping 17 matching lines @@
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_MOUSE, 1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_TOUCH_GESTURE,
                                2);
 
   HandleUserInputAndRestartTracking(helper.get(),
                                     blink::WebInputEvent::MouseWheel);
   HandleUserInputAndRestartTracking(helper.get(),
                                     blink::WebInputEvent::MouseDown);
+  HandleMediaPlaying(helper.get(), true);
   HandleUserInputAndRestartTracking(helper.get(),
                                     blink::WebInputEvent::GestureTapDown);
+  HandleMediaPlaying(helper.get(), false);
 
-  EXPECT_DOUBLE_EQ(0.9, service->GetScore(url1));
+  EXPECT_DOUBLE_EQ(0.93, service->GetScore(url1));
   EXPECT_EQ(0, service->GetScore(url2));
   histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram,
-                              9);
+                              11);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_MOUSE, 2);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_WHEEL, 1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_TOUCH_GESTURE,
                                3);
+  histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
+                               SiteEngagementMetrics::ENGAGEMENT_MEDIA_VISIBLE,
+                               1);
+  histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
+                               SiteEngagementMetrics::ENGAGEMENT_MEDIA_HIDDEN,
+                               1);
 
   NavigateWithDisposition(url2, CURRENT_TAB);
-  StartTracking(helper.get());
+  TrackingStarted(helper.get());
 
-  EXPECT_DOUBLE_EQ(0.9, service->GetScore(url1));
+  EXPECT_DOUBLE_EQ(0.93, service->GetScore(url1));
   EXPECT_DOUBLE_EQ(0.5, service->GetScore(url2));
-  EXPECT_DOUBLE_EQ(1.4, service->GetTotalEngagementPoints());
+  EXPECT_DOUBLE_EQ(1.43, service->GetTotalEngagementPoints());
 
   HandleUserInputAndRestartTracking(helper.get(),
                                     blink::WebInputEvent::GestureTapDown);
   HandleUserInputAndRestartTracking(helper.get(),
                                     blink::WebInputEvent::RawKeyDown);
 
-  EXPECT_DOUBLE_EQ(0.9, service->GetScore(url1));
+  EXPECT_DOUBLE_EQ(0.93, service->GetScore(url1));
   EXPECT_DOUBLE_EQ(0.6, service->GetScore(url2));
-  EXPECT_DOUBLE_EQ(1.5, service->GetTotalEngagementPoints());
+  EXPECT_DOUBLE_EQ(1.53, service->GetTotalEngagementPoints());
   histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram,
-                              12);
+                              14);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_NAVIGATION, 2);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_KEYPRESS, 3);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_TOUCH_GESTURE,
                                4);
 }
 
 TEST_F(SiteEngagementHelperTest, CheckTimerAndCallbacks) {
@@ skipping 127 matching lines @@
   // When the timer fires, callbacks are added.
   input_tracker_timer->Fire();
   EXPECT_FALSE(input_tracker_timer->IsRunning());
   EXPECT_TRUE(IsTracking(helper.get()));
 
   // Navigation should start the initial delay timer again.
   NavigateWithDisposition(url1, CURRENT_TAB);
   EXPECT_TRUE(input_tracker_timer->IsRunning());
   EXPECT_FALSE(IsTracking(helper.get()));
 }