[Feed] implement search history service to check if the url is visited

Also change the feed_logging_metrics.h into class for future features,
Like hook up all the UMA with Feed internal page.

Bug: 867767

Change-Id: I5559207df16d9c431208bd65cf20326a22116202
Reviewed-on: https://chromium-review.googlesource.com/c/1258250
Commit-Queue: Gang Wu <gangwu@chromium.org>
Reviewed-by: Sky Malice <skym@chromium.org>
Cr-Commit-Position: refs/heads/master@{#596389}

components/feed/core/feed_logging_metrics.cc

@@ -17,7 +17,6 @@
 #include "ui/base/mojo/window_open_disposition.mojom.h"
 
 namespace feed {
-namespace metrics {
 
 namespace {
 
@@ -70,16 +69,23 @@ int ToUMAScore(float score) {
 
 }  // namespace
 
-void OnPageShown(const int suggestions_count) {
+FeedLoggingMetrics::FeedLoggingMetrics(
+    HistoryURLCheckCallback history_url_check_callback)
+    : history_url_check_callback_(std::move(history_url_check_callback)),
+      weak_ptr_factory_(this) {}
+
+FeedLoggingMetrics::~FeedLoggingMetrics() = default;
+
+void FeedLoggingMetrics::OnPageShown(const int suggestions_count) {
   UMA_HISTOGRAM_EXACT_LINEAR(
       "NewTabPage.ContentSuggestions.CountOnNtpOpenedIfVisible",
       suggestions_count, kMaxSuggestionsTotal);
 }
 
-void OnSuggestionShown(int position,
-                       base::Time publish_date,
-                       float score,
-                       base::Time fetch_date) {
+void FeedLoggingMetrics::OnSuggestionShown(int position,
+                                           base::Time publish_date,
+                                           float score,
+                                           base::Time fetch_date) {
   UMA_HISTOGRAM_EXACT_LINEAR("NewTabPage.ContentSuggestions.Shown", position,
                              kMaxSuggestionsTotal);
 
@@ -106,10 +112,10 @@ void OnSuggestionShown(int position,
   }
 }
 
-void OnSuggestionOpened(int position,
-                        base::Time publish_date,
-                        float score,
-                        WindowOpenDisposition disposition) {
+void FeedLoggingMetrics::OnSuggestionOpened(int position,
+                                            base::Time publish_date,
+                                            float score,
+                                            WindowOpenDisposition disposition) {
   UMA_HISTOGRAM_EXACT_LINEAR("NewTabPage.ContentSuggestions.Opened", position,
                              kMaxSuggestionsTotal);
 
@@ -134,9 +140,9 @@ void OnSuggestionOpened(int position,
   base::RecordAction(base::UserMetricsAction("Suggestions.Content.Opened"));
 }
 
-void OnSuggestionMenuOpened(int position,
-                            base::Time publish_date,
-                            float score) {
+void FeedLoggingMetrics::OnSuggestionMenuOpened(int position,
+                                                base::Time publish_date,
+                                                float score) {
   UMA_HISTOGRAM_EXACT_LINEAR("NewTabPage.ContentSuggestions.MenuOpened",
                              position, kMaxSuggestionsTotal);
 
@@ -150,23 +156,19 @@ void OnSuggestionMenuOpened(int position,
       ToUMAScore(score), 11);
 }
 
-void OnSuggestionDismissed(int position, bool visited) {
-  if (visited) {
-    UMA_HISTOGRAM_EXACT_LINEAR("NewTabPage.ContentSuggestions.DismissedVisited",
-                               position, kMaxSuggestionsTotal);
-  } else {
-    UMA_HISTOGRAM_EXACT_LINEAR(
-        "NewTabPage.ContentSuggestions.DismissedUnvisited", position,
-        kMaxSuggestionsTotal);
-  }
+void FeedLoggingMetrics::OnSuggestionDismissed(int position, const GURL& url) {
+  history_url_check_callback_.Run(
+      url, base::BindOnce(&FeedLoggingMetrics::CheckURLVisitedDone,
+                          weak_ptr_factory_.GetWeakPtr(), position));
 }
 
-void OnSuggestionArticleVisited(base::TimeDelta visit_time) {
+void FeedLoggingMetrics::OnSuggestionArticleVisited(
+    base::TimeDelta visit_time) {
   base::UmaHistogramLongTimes(
       "NewTabPage.ContentSuggestions.VisitDuration.Articles", visit_time);
 }
 
-void OnMoreButtonShown(int position) {
+void FeedLoggingMetrics::OnMoreButtonShown(int position) {
   // The "more" card can appear in addition to the actual suggestions, so add
   // one extra bucket to this histogram.
   UMA_HISTOGRAM_EXACT_LINEAR(
@@ -174,7 +176,7 @@ void OnMoreButtonShown(int position) {
       kMaxSuggestionsForArticle + 1);
 }
 
-void OnMoreButtonClicked(int position) {
+void FeedLoggingMetrics::OnMoreButtonClicked(int position) {
   // The "more" card can appear in addition to the actual suggestions, so add
   // one extra bucket to this histogram.
   UMA_HISTOGRAM_EXACT_LINEAR(
@@ -182,5 +184,15 @@ void OnMoreButtonClicked(int position) {
       kMaxSuggestionsForArticle + 1);
 }
 
-}  // namespace metrics
+void FeedLoggingMetrics::CheckURLVisitedDone(int position, bool visited) {
+  if (visited) {
+    UMA_HISTOGRAM_EXACT_LINEAR("NewTabPage.ContentSuggestions.DismissedVisited",
+                               position, kMaxSuggestionsTotal);
+  } else {
+    UMA_HISTOGRAM_EXACT_LINEAR(
+        "NewTabPage.ContentSuggestions.DismissedUnvisited", position,
+        kMaxSuggestionsTotal);
+  }
+}
+
 }  // namespace feed

components/feed/core/feed_logging_metrics.h

@@ -5,6 +5,11 @@
 #ifndef COMPONENTS_FEED_CORE_FEED_LOGGING_METRICS_H_
 #define COMPONENTS_FEED_CORE_FEED_LOGGING_METRICS_H_
 
+#include "base/callback.h"
+#include "base/macros.h"
+#include "base/memory/weak_ptr.h"
+#include "url/gurl.h"
+
 namespace base {
 class Time;
 class TimeDelta;
@@ -13,35 +18,59 @@ class TimeDelta;
 enum class WindowOpenDisposition;
 
 namespace feed {
-namespace metrics {
 
-// |suggestions_count| contains how many cards show to users. It does not depend
-// on whether the user actually saw the cards.
-void OnPageShown(const int suggestions_count);
+// FeedLoggingMetrics is a central place to report all the UMA metrics for Feed.
+class FeedLoggingMetrics {
+ public:
+  // Return whether the URL is visited when calling checking URL visited.
+  using CheckURLVisitCallback = base::OnceCallback<void(bool)>;
+
+  // Calling this callback when need to check whether url is visited, and will
+  // tell CheckURLVisitCallback the result.
+  using HistoryURLCheckCallback =
+      base::RepeatingCallback<void(GURL, CheckURLVisitCallback)>;
+
+  explicit FeedLoggingMetrics(HistoryURLCheckCallback callback);
+  ~FeedLoggingMetrics();
+
+  // |suggestions_count| contains how many cards show to users. It does not
+  // depend on whether the user actually saw the cards.
+  void OnPageShown(const int suggestions_count);
+
+  // Should only be called once per NTP for each suggestion.
+  void OnSuggestionShown(int position,
+                         base::Time publish_date,
+                         float score,
+                         base::Time fetch_date);
+
+  void OnSuggestionOpened(int position,
+                          base::Time publish_date,
+                          float score,
+                          WindowOpenDisposition disposition);
+
+  void OnSuggestionMenuOpened(int position,
+                              base::Time publish_date,
+                              float score);
+
+  void OnSuggestionDismissed(int position, const GURL& url);
 
-// Should only be called once per NTP for each suggestion.
-void OnSuggestionShown(int position,
-                       base::Time publish_date,
-                       float score,
-                       base::Time fetch_date);
+  void OnSuggestionArticleVisited(base::TimeDelta visit_time);
 
-void OnSuggestionOpened(int position,
-                        base::Time publish_date,
-                        float score,
-                        WindowOpenDisposition disposition);
+  // Should only be called once per NTP for each "more" button.
+  void OnMoreButtonShown(int position);
 
-void OnSuggestionMenuOpened(int position, base::Time publish_date, float score);
+  void OnMoreButtonClicked(int position);
 
-void OnSuggestionDismissed(int position, bool visited);
+ private:
+  void CheckURLVisitedDone(int position, bool visited);
 
-void OnSuggestionArticleVisited(base::TimeDelta visit_time);
+  const HistoryURLCheckCallback history_url_check_callback_;
 
-// Should only be called once per NTP for each "more" button.
-void OnMoreButtonShown(int position);
+  base::WeakPtrFactory<FeedLoggingMetrics> weak_ptr_factory_;
 
-void OnMoreButtonClicked(int position);
+  DISALLOW_COPY_AND_ASSIGN(FeedLoggingMetrics);
+};
 
-}  // namespace metrics
 }  // namespace feed
 
 #endif  // COMPONENTS_FEED_CORE_FEED_LOGGING_METRICS_H_

components/feed/core/feed_logging_metrics_unittest.cc

-// Copyright 2017 The Chromium Authors. All rights reserved.
+// Copyright 2018 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.
 
@@ -11,9 +11,10 @@
 #include "ui/base/mojo/window_open_disposition.mojom.h"
 
 namespace feed {
-namespace metrics {
 namespace {
 
+GURL VISITED_URL("http://visited_url.com");
+
 using testing::ElementsAre;
 using testing::IsEmpty;
 
@@ -28,21 +29,49 @@ enum FeedActionType {
   DOWNLOAD = 5,
 };
 
-TEST(FeedLoggingMetricsTest, ShouldLogOnSuggestionsShown) {
+void CheckURLVisit(GURL url,
+                   FeedLoggingMetrics::CheckURLVisitCallback callback) {
+  if (url == VISITED_URL) {
+    std::move(callback).Run(true);
+  } else {
+    std::move(callback).Run(false);
+  }
+}
+
+}  // namespace
+
+class FeedLoggingMetricsTest : public testing::Test {
+ public:
+  FeedLoggingMetricsTest() {
+    feed_logging_metrics_ = std::make_unique<FeedLoggingMetrics>(
+        base::BindRepeating(&CheckURLVisit));
+  }
+
+  FeedLoggingMetrics* feed_logging_metrics() {
+    return feed_logging_metrics_.get();
+  }
+
+ private:
+  std::unique_ptr<FeedLoggingMetrics> feed_logging_metrics_;
+
+  DISALLOW_COPY_AND_ASSIGN(FeedLoggingMetricsTest);
+};
+
+TEST_F(FeedLoggingMetricsTest, ShouldLogOnSuggestionsShown) {
   base::HistogramTester histogram_tester;
-  OnSuggestionShown(/*position=*/1, base::Time::Now(),
-                    /*score=*/0.01f,
-                    base::Time::Now() - base::TimeDelta::FromHours(2));
+  feed_logging_metrics()->OnSuggestionShown(
+      /*position=*/1, base::Time::Now(),
+      /*score=*/0.01f, base::Time::Now() - base::TimeDelta::FromHours(2));
   // Test corner cases for score.
-  OnSuggestionShown(/*position=*/2, base::Time::Now(),
-                    /*score=*/0.0f,
-                    base::Time::Now() - base::TimeDelta::FromHours(2));
-  OnSuggestionShown(/*position=*/3, base::Time::Now(),
-                    /*score=*/1.0f,
-                    base::Time::Now() - base::TimeDelta::FromHours(2));
-  OnSuggestionShown(/*position=*/4, base::Time::Now(),
-                    /*score=*/8.0f,
-                    base::Time::Now() - base::TimeDelta::FromHours(2));
+  feed_logging_metrics()->OnSuggestionShown(
+      /*position=*/2, base::Time::Now(),
+      /*score=*/0.0f, base::Time::Now() - base::TimeDelta::FromHours(2));
+  feed_logging_metrics()->OnSuggestionShown(
+      /*position=*/3, base::Time::Now(),
+      /*score=*/1.0f, base::Time::Now() - base::TimeDelta::FromHours(2));
+  feed_logging_metrics()->OnSuggestionShown(
+      /*position=*/4, base::Time::Now(),
+      /*score=*/8.0f, base::Time::Now() - base::TimeDelta::FromHours(2));
 
   EXPECT_THAT(
       histogram_tester.GetAllSamples("NewTabPage.ContentSuggestions.Shown"),
@@ -59,24 +88,28 @@ TEST(FeedLoggingMetricsTest, ShouldLogOnSuggestionsShown) {
                   base::Bucket(/*min=*/11, /*count=*/1)));
 }
 
-TEST(FeedLoggingMetricsTest, ShouldLogOnPageShown) {
+TEST_F(FeedLoggingMetricsTest, ShouldLogOnPageShown) {
   base::HistogramTester histogram_tester;
-  OnPageShown(/*content_count=*/10);
+  feed_logging_metrics()->OnPageShown(/*content_count=*/10);
   EXPECT_THAT(histogram_tester.GetAllSamples(
                   "NewTabPage.ContentSuggestions.CountOnNtpOpenedIfVisible"),
               ElementsAre(base::Bucket(/*min=*/10, /*count=*/1)));
 }
 
-TEST(FeedLoggingMetricsTest, ShouldLogPrefetchedSuggestionsWhenOpened) {
+TEST_F(FeedLoggingMetricsTest, ShouldLogPrefetchedSuggestionsWhenOpened) {
   base::HistogramTester histogram_tester;
-  OnSuggestionOpened(/*position=*/11, base::Time::Now(),
-                     /*score=*/1.0f, WindowOpenDisposition::CURRENT_TAB);
-  OnSuggestionOpened(/*position=*/13, base::Time::Now(),
-                     /*score=*/1.0f, WindowOpenDisposition::CURRENT_TAB);
-  OnSuggestionOpened(/*position=*/15, base::Time::Now(),
-                     /*score=*/1.0f, WindowOpenDisposition::CURRENT_TAB);
-  OnSuggestionOpened(/*position=*/23, base::Time::Now(),
-                     /*score=*/1.0f, WindowOpenDisposition::CURRENT_TAB);
+  feed_logging_metrics()->OnSuggestionOpened(
+      /*position=*/11, base::Time::Now(),
+      /*score=*/1.0f, WindowOpenDisposition::CURRENT_TAB);
+  feed_logging_metrics()->OnSuggestionOpened(
+      /*position=*/13, base::Time::Now(),
+      /*score=*/1.0f, WindowOpenDisposition::CURRENT_TAB);
+  feed_logging_metrics()->OnSuggestionOpened(
+      /*position=*/15, base::Time::Now(),
+      /*score=*/1.0f, WindowOpenDisposition::CURRENT_TAB);
+  feed_logging_metrics()->OnSuggestionOpened(
+      /*position=*/23, base::Time::Now(),
+      /*score=*/1.0f, WindowOpenDisposition::CURRENT_TAB);
 
   EXPECT_THAT(
       histogram_tester.GetAllSamples("NewTabPage.ContentSuggestions.Opened"),
@@ -86,6 +119,21 @@ TEST(FeedLoggingMetricsTest, ShouldLogPrefetchedSuggestionsWhenOpened) {
                   base::Bucket(/*min=*/23, /*count=*/1)));
 }
 
-}  // namespace
-}  // namespace metrics
+TEST_F(FeedLoggingMetricsTest, ShouldLogOnSuggestionDismissedIfVisited) {
+  base::HistogramTester histogram_tester;
+  feed_logging_metrics()->OnSuggestionDismissed(/*position=*/10, VISITED_URL);
+  EXPECT_THAT(histogram_tester.GetAllSamples(
+                  "NewTabPage.ContentSuggestions.DismissedVisited"),
+              ElementsAre(base::Bucket(/*min=*/10, /*count=*/1)));
+}
+
+TEST_F(FeedLoggingMetricsTest, ShouldLogOnSuggestionDismissedIfNotVisited) {
+  base::HistogramTester histogram_tester;
+  feed_logging_metrics()->OnSuggestionDismissed(/*position=*/10,
+                                                GURL("http://non_visited.com"));
+  EXPECT_THAT(histogram_tester.GetAllSamples(
+                  "NewTabPage.ContentSuggestions.DismissedVisited"),
+              IsEmpty());
+}
+
 }  // namespace feed