Implement an observer interface for the 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 79 matching lines @@
 std::unique_ptr<KeyedService> BuildTestHistoryService(
     content::BrowserContext* context) {
   std::unique_ptr<history::HistoryService> service(
       new history::HistoryService());
   service->Init(history::TestHistoryDatabaseParamsForPath(g_temp_history_dir));
   return std::move(service);
 }
 
 }  // namespace
 
+class ObserverTester : public SiteEngagementObserver {
+ public:
+  ObserverTester(SiteEngagementService* service,
+                 content::WebContents* web_contents,
+                 const GURL& url,
+                 double score,
+                 bool is_hidden)
+      : SiteEngagementObserver(service),
+        web_contents_(web_contents),
+        url_(url),
+        score_(score),
+        is_hidden_(is_hidden),
+        callback_called_(false),
+        run_loop_() {}
+
+  void OnEngagementIncreased(content::WebContents* web_contents,
+                             const GURL& url,
+                             double score,
+                             bool is_hidden) override {
+    EXPECT_EQ(web_contents_, web_contents);
+    EXPECT_EQ(url_, url);
+    EXPECT_DOUBLE_EQ(score_, score);
+    EXPECT_EQ(is_hidden_, is_hidden);
+    set_callback_called(true);
+    run_loop_.Quit();
+  }
+
+  void Wait() { run_loop_.Run(); }
+
+  bool callback_called() { return callback_called_; }
+  void set_callback_called(bool callback_called) {
+    callback_called_ = callback_called;
+  }
+
+ private:
+  content::WebContents* web_contents_;
+  GURL url_;
+  double score_;
+  bool is_hidden_;
+  bool callback_called_;
+  base::RunLoop run_loop_;
+
+  DISALLOW_COPY_AND_ASSIGN(ObserverTester);
+};
+
 class SiteEngagementServiceTest : public ChromeRenderViewHostTestHarness {
  public:
   void SetUp() override {
     ChromeRenderViewHostTestHarness::SetUp();
     ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
     g_temp_history_dir = temp_dir_.path();
     HistoryServiceFactory::GetInstance()->SetTestingFactory(
         profile(), &BuildTestHistoryService);
     SiteEngagementScore::SetParamValuesForTesting();
   }
@@ skipping 899 matching lines @@
   EXPECT_TRUE(service->IsEngagementAtLeast(
       url2, SiteEngagementService::ENGAGEMENT_LEVEL_LOW));
   EXPECT_TRUE(service->IsEngagementAtLeast(
       url2, SiteEngagementService::ENGAGEMENT_LEVEL_MEDIUM));
   EXPECT_TRUE(service->IsEngagementAtLeast(
       url2, SiteEngagementService::ENGAGEMENT_LEVEL_HIGH));
   EXPECT_TRUE(service->IsEngagementAtLeast(
       url2, SiteEngagementService::ENGAGEMENT_LEVEL_MAX));
 }
 
+TEST_F(SiteEngagementServiceTest, Observers) {
+  SiteEngagementService* service = SiteEngagementService::Get(profile());
+
+  GURL url_score_1("http://www.google.com/maps");
+  GURL url_score_2("http://www.google.com/drive");
+  GURL url_score_3("http://www.google.com/");
+  GURL url_not_called("https://www.google.com/");
+
+  // Create an observer and Observe(nullptr).
+  ObserverTester tester_not_called(service, web_contents(), url_not_called, 1,
+                                   true);
+  tester_not_called.Observe(nullptr);
+
+  {
+    // Create an observer for navigation.
+    ObserverTester tester(service, web_contents(), url_score_1, 0.5, false);
+    NavigateAndCommit(url_score_1);
+    service->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED);
+    tester.Wait();
+    EXPECT_TRUE(tester.callback_called());
+    EXPECT_FALSE(tester_not_called.callback_called());
+    tester.Observe(nullptr);
+  }
+
+  {
+    // Update observer for a user input.
+    ObserverTester tester(service, web_contents(), url_score_2, 0.55, false);
+    NavigateAndCommit(url_score_2);
+    service->HandleUserInput(web_contents(),
+                             SiteEngagementMetrics::ENGAGEMENT_MOUSE);
+    tester.Wait();
+    EXPECT_TRUE(tester.callback_called());
+    EXPECT_FALSE(tester_not_called.callback_called());
+    tester.Observe(nullptr);
+  }
+
+  // Add two observers for media playing in the foreground.
+  {
+    ObserverTester tester_1(service, web_contents(), url_score_3, 0.57, false);
+    ObserverTester tester_2(service, web_contents(), url_score_3, 0.57, false);
+    NavigateAndCommit(url_score_3);
+    service->HandleMediaPlaying(web_contents(), false);
+    tester_1.Wait();
+    tester_2.Wait();
+
+    EXPECT_TRUE(tester_1.callback_called());
+    EXPECT_TRUE(tester_2.callback_called());
+    EXPECT_FALSE(tester_not_called.callback_called());
+    tester_1.Observe(nullptr);
+    tester_2.Observe(nullptr);
+  }
+
+  // Add an observer for media playing in the background.
+  {
+    ObserverTester tester(service, web_contents(), url_score_3, 0.58, true);
+    service->HandleMediaPlaying(web_contents(), true);
+    tester.Wait();
+
+    EXPECT_TRUE(tester.callback_called());
+    EXPECT_FALSE(tester_not_called.callback_called());
+    tester.Observe(nullptr);
+  }
+}
+
 TEST_F(SiteEngagementServiceTest, ScoreDecayHistograms) {
   base::SimpleTestClock* clock = new base::SimpleTestClock();
   std::unique_ptr<SiteEngagementService> service(
       new SiteEngagementService(profile(), base::WrapUnique(clock)));
 
   base::Time current_day = GetReferenceTime();
   clock->SetNow(current_day);
   base::HistogramTester histograms;
   GURL origin1("http://www.google.com/");
   GURL origin2("http://drive.google.com/");
@@ skipping 69 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);
 }