Construct the site engagement helper with a site engagement service.

chrome/browser/engagement/site_engagement_service_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_service.h"
 
 #include <utility>
 
 #include "base/files/scoped_temp_dir.h"
 #include "base/macros.h"
@@ skipping 216 matching lines @@
 
   // The https and http versions of www.google.com should be separate.
   GURL url1("https://www.google.com/");
   GURL url2("http://www.google.com/");
   GURL url3("http://drive.google.com/");
 
   EXPECT_EQ(0, service->GetScore(url1));
   EXPECT_EQ(0, service->GetScore(url2));
   EXPECT_EQ(0, service->GetScore(url3));
 
-  service->HandleNavigation(url1, ui::PAGE_TRANSITION_TYPED);
+  NavigateAndCommit(url1);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED);
   EXPECT_EQ(0.5, service->GetScore(url1));
   EXPECT_EQ(0.5, service->GetTotalEngagementPoints());
 
-  service->HandleNavigation(url2, ui::PAGE_TRANSITION_GENERATED);
-  service->HandleNavigation(url2, ui::PAGE_TRANSITION_KEYWORD_GENERATED);
+  NavigateAndCommit(url2);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_GENERATED);
+  service->HandleNavigation(web_contents(),
+                            ui::PAGE_TRANSITION_KEYWORD_GENERATED);
   EXPECT_EQ(1, service->GetScore(url2));
   EXPECT_EQ(1.5, service->GetTotalEngagementPoints());
 
-  service->HandleNavigation(url2, ui::PAGE_TRANSITION_AUTO_BOOKMARK);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_AUTO_BOOKMARK);
   EXPECT_EQ(1.5, service->GetScore(url2));
   EXPECT_EQ(2, service->GetTotalEngagementPoints());
 
-  service->HandleNavigation(url3, ui::PAGE_TRANSITION_TYPED);
+  NavigateAndCommit(url3);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED);
   EXPECT_EQ(0.5, service->GetScore(url3));
   EXPECT_EQ(2.5, service->GetTotalEngagementPoints());
 
-  service->HandleNavigation(url1, ui::PAGE_TRANSITION_GENERATED);
-  service->HandleNavigation(url1, ui::PAGE_TRANSITION_TYPED);
+  NavigateAndCommit(url1);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_GENERATED);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED);
   EXPECT_EQ(1.5, service->GetScore(url1));
   EXPECT_EQ(3.5, service->GetTotalEngagementPoints());
 }
 
 TEST_F(SiteEngagementServiceTest, GetTotalUserInputPoints) {
   SiteEngagementService* service = SiteEngagementService::Get(profile());
   ASSERT_TRUE(service);
 
   // The https and http versions of www.google.com should be separate.
   GURL url1("https://www.google.com/");
   GURL url2("http://www.google.com/");
   GURL url3("http://drive.google.com/");
 
   EXPECT_EQ(0, service->GetScore(url1));
   EXPECT_EQ(0, service->GetScore(url2));
   EXPECT_EQ(0, service->GetScore(url3));
 
-  service->HandleUserInput(url1, SiteEngagementMetrics::ENGAGEMENT_MOUSE);
+  NavigateAndCommit(url1);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_MOUSE);
   EXPECT_DOUBLE_EQ(0.05, service->GetScore(url1));
   EXPECT_DOUBLE_EQ(0.05, service->GetTotalEngagementPoints());
 
-  service->HandleUserInput(url2, SiteEngagementMetrics::ENGAGEMENT_MOUSE);
-  service->HandleUserInput(url2, SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
+  NavigateAndCommit(url2);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_MOUSE);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
   EXPECT_DOUBLE_EQ(0.1, service->GetScore(url2));
   EXPECT_DOUBLE_EQ(0.15, service->GetTotalEngagementPoints());
 
-  service->HandleUserInput(url3, SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
+  NavigateAndCommit(url3);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
   EXPECT_DOUBLE_EQ(0.05, service->GetScore(url3));
   EXPECT_DOUBLE_EQ(0.2, service->GetTotalEngagementPoints());
 
-  service->HandleUserInput(url1, SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
-  service->HandleUserInput(url1, SiteEngagementMetrics::ENGAGEMENT_MOUSE);
+  NavigateAndCommit(url1);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_MOUSE);
   EXPECT_DOUBLE_EQ(0.15, service->GetScore(url1));
   EXPECT_DOUBLE_EQ(0.3, service->GetTotalEngagementPoints());
 
-  service->HandleUserInput(url2, SiteEngagementMetrics::ENGAGEMENT_SCROLL);
-  service->HandleUserInput(url3,
+  NavigateAndCommit(url2);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_SCROLL);
+  NavigateAndCommit(url3);
+  service->HandleUserInput(web_contents(),
                            SiteEngagementMetrics::ENGAGEMENT_TOUCH_GESTURE);
   EXPECT_DOUBLE_EQ(0.15, service->GetScore(url2));
   EXPECT_DOUBLE_EQ(0.1, service->GetScore(url3));
   EXPECT_DOUBLE_EQ(0.4, service->GetTotalEngagementPoints());
 }
 
 TEST_F(SiteEngagementServiceTest, LastShortcutLaunch) {
   base::SimpleTestClock* clock = new base::SimpleTestClock();
   std::unique_ptr<SiteEngagementService> service(
       new SiteEngagementService(profile(), base::WrapUnique(clock)));
@@ skipping 122 matching lines @@
   for (const std::string& histogram_name : engagement_bucket_histogram_names)
     histograms.ExpectTotalCount(histogram_name, 0);
 
   clock->SetNow(clock->Now() + base::TimeDelta::FromMinutes(60));
 
   // The https and http versions of www.google.com should be separate.
   GURL url1("https://www.google.com/");
   GURL url2("http://www.google.com/");
   GURL url3("http://drive.google.com/");
 
-  service->HandleNavigation(url1, ui::PAGE_TRANSITION_TYPED);
-  service->HandleUserInput(url1, SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
-  service->HandleUserInput(url1, SiteEngagementMetrics::ENGAGEMENT_MOUSE);
-  service->HandleMediaPlaying(url2, true);
+  NavigateAndCommit(url1);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_MOUSE);
+  NavigateAndCommit(url2);
+  service->HandleMediaPlaying(web_contents(), true);
 
   histograms.ExpectTotalCount(SiteEngagementMetrics::kTotalEngagementHistogram,
                               2);
   histograms.ExpectTotalCount(SiteEngagementMetrics::kTotalOriginsHistogram, 2);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 0,
                                1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 1,
                                1);
   histograms.ExpectTotalCount(SiteEngagementMetrics::kMeanEngagementHistogram,
                               2);
@@ skipping 25 matching lines @@
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_MEDIA_HIDDEN,
                                1);
   histograms.ExpectBucketCount(
       SiteEngagementMetrics::kEngagementTypeHistogram,
       SiteEngagementMetrics::ENGAGEMENT_FIRST_DAILY_ENGAGEMENT, 2);
 
   // Navigations are still logged within the 1 hour refresh period
   clock->SetNow(clock->Now() + base::TimeDelta::FromMinutes(59));
 
-  service->HandleNavigation(url2, ui::PAGE_TRANSITION_GENERATED);
-  service->HandleNavigation(url2, ui::PAGE_TRANSITION_AUTO_BOOKMARK);
+  NavigateAndCommit(url2);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_GENERATED);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_AUTO_BOOKMARK);
 
   histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                               8);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_NAVIGATION, 3);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_KEYPRESS, 1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_MOUSE, 1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_MEDIA_HIDDEN,
                                1);
   histograms.ExpectBucketCount(
       SiteEngagementMetrics::kEngagementTypeHistogram,
       SiteEngagementMetrics::ENGAGEMENT_FIRST_DAILY_ENGAGEMENT, 2);
 
   // Update the hourly histograms again.
   clock->SetNow(clock->Now() + base::TimeDelta::FromMinutes(1));
 
-  service->HandleNavigation(url3, ui::PAGE_TRANSITION_TYPED);
-  service->HandleUserInput(url2,
+  NavigateAndCommit(url3);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED);
+  service->HandleMediaPlaying(web_contents(), false);
+  NavigateAndCommit(url2);
+  service->HandleUserInput(web_contents(),
                            SiteEngagementMetrics::ENGAGEMENT_TOUCH_GESTURE);
-  service->HandleMediaPlaying(url3, false);
 
   histograms.ExpectTotalCount(SiteEngagementMetrics::kTotalEngagementHistogram,
                               3);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 0,
                                1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 1,
                                1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 3,
                                1);
   histograms.ExpectTotalCount(SiteEngagementMetrics::kMeanEngagementHistogram,
@@ skipping 29 matching lines @@
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_MEDIA_VISIBLE,
                                1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_MEDIA_HIDDEN,
                                1);
   histograms.ExpectBucketCount(
       SiteEngagementMetrics::kEngagementTypeHistogram,
       SiteEngagementMetrics::ENGAGEMENT_FIRST_DAILY_ENGAGEMENT, 3);
 
-  service->HandleNavigation(url1, ui::PAGE_TRANSITION_GENERATED);
-  service->HandleNavigation(url1, ui::PAGE_TRANSITION_TYPED);
-  service->HandleUserInput(url2, SiteEngagementMetrics::ENGAGEMENT_SCROLL);
-  service->HandleUserInput(url1, SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
-  service->HandleUserInput(url3, SiteEngagementMetrics::ENGAGEMENT_MOUSE);
+  NavigateAndCommit(url1);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_GENERATED);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED);
+  NavigateAndCommit(url2);

[calamity, 2016/06/09 03:32:20]

I'm surprised these don't trigger navigation engagement. Any explanation for why
this works?

[dominickn, 2016/06/09 03:45:57]

This test harness doesn't call TabHelpers::AttachTabHelpers, so the site
engagement helper is never created and engagement on navigation isn't triggered.

This is why tests like ScoreIncrementsOnPageRequest in this file manually create
the helper.

[calamity, 2016/06/09 03:48:06]

Acknowledged.

+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_SCROLL);
+  NavigateAndCommit(url1);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_KEYPRESS);
+  NavigateAndCommit(url3);
+  service->HandleUserInput(web_contents(),
+                           SiteEngagementMetrics::ENGAGEMENT_MOUSE);
 
   histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                               17);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_NAVIGATION, 6);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_KEYPRESS, 2);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_MOUSE, 2);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_TOUCH_GESTURE,
                                1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram,
                                SiteEngagementMetrics::ENGAGEMENT_SCROLL, 1);
   histograms.ExpectBucketCount(
       SiteEngagementMetrics::kEngagementTypeHistogram,
       SiteEngagementMetrics::ENGAGEMENT_FIRST_DAILY_ENGAGEMENT, 3);
 
   // Advance an origin to the max for a day and advance the clock an hour before
   // the last increment before max. Expect the histogram to be updated.
+  NavigateAndCommit(url1);
   for (int i = 0; i < 6; ++i)
-    service->HandleNavigation(url1, ui::PAGE_TRANSITION_TYPED);
+    service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED);
 
   clock->SetNow(clock->Now() + base::TimeDelta::FromMinutes(60));
-  service->HandleNavigation(url1, ui::PAGE_TRANSITION_TYPED);
+  service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED);
 
   histograms.ExpectTotalCount(SiteEngagementMetrics::kTotalEngagementHistogram,
                               4);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 0,
                                1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 1,
                                1);
   histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 3,
                                2);
   histograms.ExpectTotalCount(SiteEngagementMetrics::kMeanEngagementHistogram,
@@ skipping 467 matching lines @@
                                0, 2);
 
   // Add more points and ensure no more samples are present.
   service->AddPoints(origin1, 0.01);
   service->AddPoints(origin2, 0.01);
   histograms.ExpectTotalCount(SiteEngagementMetrics::kScoreDecayedFromHistogram,
                               4);
   histograms.ExpectTotalCount(SiteEngagementMetrics::kScoreDecayedToHistogram,
                               4);
 }