Reduce the site engagement service public interface.

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 "chrome/browser/engagement/site_engagement_helper.h"
 
 #include "base/memory/ptr_util.h"
 #include "base/test/histogram_tester.h"
 #include "base/timer/mock_timer.h"
 #include "base/values.h"
+#include "chrome/browser/engagement/site_engagement_score.h"
 #include "chrome/browser/engagement/site_engagement_service.h"
 #include "chrome/browser/engagement/site_engagement_service_factory.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/test/base/chrome_render_view_host_test_harness.h"
 #include "chrome/test/base/testing_profile.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/page_navigator.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/test/web_contents_tester.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 class SiteEngagementHelperTest : public ChromeRenderViewHostTestHarness {
  public:
   void SetUp() override {
     ChromeRenderViewHostTestHarness::SetUp();
     SiteEngagementScore::SetParamValuesForTesting();
   }
 
-  SiteEngagementHelper* GetHelper(content::WebContents* web_contents) {
-    SiteEngagementHelper::CreateForWebContents(web_contents);
-    SiteEngagementHelper* helper =
-        SiteEngagementHelper::FromWebContents(web_contents);
+  SiteEngagementService::Helper* GetHelper(content::WebContents* web_contents) {
+    SiteEngagementService::Helper::CreateForWebContents(web_contents);
+    SiteEngagementService::Helper* helper =
+        SiteEngagementService::Helper::FromWebContents(web_contents);
 
     DCHECK(helper);
     return helper;
   }
 
-  void TrackingStarted(SiteEngagementHelper* helper) {
+  void TrackingStarted(SiteEngagementService::Helper* helper) {
     helper->input_tracker_.TrackingStarted();
     helper->media_tracker_.TrackingStarted();
   }
 
   // Simulate a user interaction event and handle it.
-  void HandleUserInput(SiteEngagementHelper* helper,
+  void HandleUserInput(SiteEngagementService::Helper* 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,
+  void HandleUserInputAndRestartTracking(SiteEngagementService::Helper* helper,
                                          blink::WebInputEvent::Type type) {
     helper->input_tracker_.DidGetUserInteraction(type);
     helper->input_tracker_.TrackingStarted();
   }
 
-  void HandleMediaPlaying(SiteEngagementHelper* helper, bool is_hidden) {
+  void HandleMediaPlaying(SiteEngagementService::Helper* helper,
+                          bool is_hidden) {
     helper->RecordMediaPlaying(is_hidden);
   }
 
-  void MediaStartedPlaying(SiteEngagementHelper* helper) {
+  void MediaStartedPlaying(SiteEngagementService::Helper* helper) {
     helper->media_tracker_.MediaStartedPlaying(
         content::WebContentsObserver::MediaPlayerId(nullptr, 1));
   }
 
-  void MediaStoppedPlaying(SiteEngagementHelper* helper) {
+  void MediaStoppedPlaying(SiteEngagementService::Helper* helper) {
     helper->media_tracker_.MediaStoppedPlaying(
         content::WebContentsObserver::MediaPlayerId(nullptr, 1));
   }
 
   // Set a pause timer on the input tracker for test purposes.
-  void SetInputTrackerPauseTimer(SiteEngagementHelper* helper,
+  void SetInputTrackerPauseTimer(SiteEngagementService::Helper* helper,
                                  std::unique_ptr<base::Timer> timer) {
     helper->input_tracker_.SetPauseTimerForTesting(std::move(timer));
   }
 
   // Set a pause timer on the input tracker for test purposes.
-  void SetMediaTrackerPauseTimer(SiteEngagementHelper* helper,
+  void SetMediaTrackerPauseTimer(SiteEngagementService::Helper* helper,
                                  std::unique_ptr<base::Timer> timer) {
     helper->media_tracker_.SetPauseTimerForTesting(std::move(timer));
   }
 
-  bool IsTrackingInput(SiteEngagementHelper* helper) {
+  bool IsTrackingInput(SiteEngagementService::Helper* helper) {
     return helper->input_tracker_.is_tracking();
   }
 
   void Navigate(const GURL& url) {
     controller().LoadURL(url, content::Referrer(), ui::PAGE_TRANSITION_TYPED,
                          std::string());
     int pending_id = controller().GetPendingEntry()->GetUniqueID();
     content::WebContentsTester::For(web_contents())
         ->TestDidNavigate(web_contents()->GetMainFrame(), 1, pending_id, true,
                           url, ui::PAGE_TRANSITION_TYPED);
   }
 
   void UserInputAccumulation(const blink::WebInputEvent::Type type) {
     GURL url1("https://www.google.com/");
     GURL url2("http://www.google.com/");
     content::WebContents* contents = web_contents();
 
-    SiteEngagementHelper* helper = GetHelper(contents);
+    SiteEngagementService::Helper* helper = GetHelper(contents);
     SiteEngagementService* service =
         SiteEngagementServiceFactory::GetForProfile(profile());
     DCHECK(service);
 
     // Check that navigation triggers engagement.
     Navigate(url1);
     TrackingStarted(helper);
 
     EXPECT_DOUBLE_EQ(0.5, service->GetScore(url1));
     EXPECT_EQ(0, service->GetScore(url2));
@@ skipping 41 matching lines @@
 
 TEST_F(SiteEngagementHelperTest, GestureEngagementAccumulation) {
   UserInputAccumulation(blink::WebInputEvent::GestureTapDown);
 }
 
 TEST_F(SiteEngagementHelperTest, MediaEngagementAccumulation) {
   GURL url1("https://www.google.com/");
   GURL url2("http://www.google.com/");
   content::WebContents* contents = web_contents();
 
-  SiteEngagementHelper* helper = GetHelper(contents);
+  SiteEngagementService::Helper* helper = GetHelper(contents);
   SiteEngagementService* service =
       SiteEngagementServiceFactory::GetForProfile(profile());
   DCHECK(service);
 
   Navigate(url1);
   TrackingStarted(helper);
 
   EXPECT_DOUBLE_EQ(0.5, service->GetScore(url1));
   EXPECT_EQ(0, service->GetScore(url2));
 
@@ skipping 32 matching lines @@
   EXPECT_DOUBLE_EQ(0.54, service->GetScore(url2));
   EXPECT_DOUBLE_EQ(1.14, service->GetTotalEngagementPoints());
 }
 
 TEST_F(SiteEngagementHelperTest, MediaEngagement) {
   GURL url1("https://www.google.com/");
   GURL url2("http://www.google.com/");
   content::WebContents* contents = web_contents();
 
   base::MockTimer* media_tracker_timer = new base::MockTimer(true, false);
-  SiteEngagementHelper* helper = GetHelper(contents);
+  SiteEngagementService::Helper* helper = GetHelper(contents);
   SetMediaTrackerPauseTimer(helper, base::WrapUnique(media_tracker_timer));
   SiteEngagementService* service =
       SiteEngagementServiceFactory::GetForProfile(profile());
   DCHECK(service);
 
   Navigate(url1);
   MediaStartedPlaying(helper);
 
   EXPECT_DOUBLE_EQ(0.50, service->GetScore(url1));
   EXPECT_EQ(0, service->GetScore(url2));
@@ skipping 51 matching lines @@
   EXPECT_DOUBLE_EQ(0.55, service->GetScore(url1));
   EXPECT_EQ(0.53, service->GetScore(url2));
   EXPECT_TRUE(media_tracker_timer->IsRunning());
 }
 
 TEST_F(SiteEngagementHelperTest, MixedInputEngagementAccumulation) {
   GURL url1("https://www.google.com/");
   GURL url2("http://www.google.com/");
   content::WebContents* contents = web_contents();
 
-  SiteEngagementHelper* helper = GetHelper(contents);
+  SiteEngagementService::Helper* helper = GetHelper(contents);
   SiteEngagementService* service =
       SiteEngagementServiceFactory::GetForProfile(profile());
   DCHECK(service);
 
   base::HistogramTester histograms;
 
   // Histograms should start off empty.
   histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                               0);
 
@@ skipping 92 matching lines @@
       SiteEngagementMetrics::ENGAGEMENT_FIRST_DAILY_ENGAGEMENT, 2);
 }
 
 TEST_F(SiteEngagementHelperTest, CheckTimerAndCallbacks) {
   GURL url1("https://www.google.com/");
   GURL url2("http://www.google.com/");
   content::WebContents* contents = web_contents();
 
   base::MockTimer* input_tracker_timer = new base::MockTimer(true, false);
   base::MockTimer* media_tracker_timer = new base::MockTimer(true, false);
-  SiteEngagementHelper* helper = GetHelper(contents);
+  SiteEngagementService::Helper* helper = GetHelper(contents);
   SetInputTrackerPauseTimer(helper, base::WrapUnique(input_tracker_timer));
   SetMediaTrackerPauseTimer(helper, base::WrapUnique(media_tracker_timer));
 
   SiteEngagementService* service =
       SiteEngagementServiceFactory::GetForProfile(profile());
   DCHECK(service);
 
   Navigate(url1);
   EXPECT_DOUBLE_EQ(0.5, service->GetScore(url1));
   EXPECT_EQ(0, service->GetScore(url2));
@@ skipping 87 matching lines @@
 // Ensure that navigation and tab activation/hiding does not trigger input
 // tracking until after a delay. We must manually call WasShown/WasHidden as
 // they are not triggered automatically in this test environment.
 TEST_F(SiteEngagementHelperTest, ShowAndHide) {
   GURL url1("https://www.google.com/");
   GURL url2("http://www.google.com/");
   content::WebContents* contents = web_contents();
 
   base::MockTimer* input_tracker_timer = new base::MockTimer(true, false);
   base::MockTimer* media_tracker_timer = new base::MockTimer(true, false);
-  SiteEngagementHelper* helper = GetHelper(contents);
+  SiteEngagementService::Helper* helper = GetHelper(contents);
   SetInputTrackerPauseTimer(helper, base::WrapUnique(input_tracker_timer));
   SetMediaTrackerPauseTimer(helper, base::WrapUnique(media_tracker_timer));
 
   Navigate(url1);
   input_tracker_timer->Fire();
 
   // Hiding the tab should stop input tracking. Media tracking remains inactive.
   contents->WasHidden();
   EXPECT_FALSE(input_tracker_timer->IsRunning());
   EXPECT_FALSE(media_tracker_timer->IsRunning());
@@ skipping 30 matching lines @@
   EXPECT_TRUE(IsTrackingInput(helper));
 }
 
 // Ensure tracking behavior is correct for multiple navigations in a single tab.
 TEST_F(SiteEngagementHelperTest, SingleTabNavigation) {
   GURL url1("https://www.google.com/");
   GURL url2("https://www.example.com/");
   content::WebContents* contents = web_contents();
 
   base::MockTimer* input_tracker_timer = new base::MockTimer(true, false);
-  SiteEngagementHelper* helper = GetHelper(contents);
+  SiteEngagementService::Helper* helper = GetHelper(contents);
   SetInputTrackerPauseTimer(helper, base::WrapUnique(input_tracker_timer));
 
   // Navigation should start the initial delay timer.
   Navigate(url1);
   EXPECT_TRUE(input_tracker_timer->IsRunning());
   EXPECT_FALSE(IsTrackingInput(helper));
 
   // Navigating before the timer fires should simply reset the timer.
   Navigate(url2);
   EXPECT_TRUE(input_tracker_timer->IsRunning());
   EXPECT_FALSE(IsTrackingInput(helper));
 
   // When the timer fires, callbacks are added.
   input_tracker_timer->Fire();
   EXPECT_FALSE(input_tracker_timer->IsRunning());
   EXPECT_TRUE(IsTrackingInput(helper));
 
   // Navigation should start the initial delay timer again.
   Navigate(url1);
   EXPECT_TRUE(input_tracker_timer->IsRunning());
   EXPECT_FALSE(IsTrackingInput(helper));
 }