Adding UMA to track previews opt outs and blacklist eligibility

components/previews/core/previews_black_list.cc

 // Copyright 2016 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 "components/previews/core/previews_black_list.h"
 
 #include "base/bind.h"
 #include "base/memory/ptr_util.h"
+#include "base/metrics/histogram.h"

[tbansal1, 2016/11/09 17:50:51]

include base/metrics/histogram_macros.h instead of base/metrics/histogram.h?

[RyanSturm, 2016/11/09 18:48:29]

Done.

 #include "base/optional.h"
 #include "base/time/clock.h"
 #include "components/previews/core/previews_black_list_item.h"
 #include "components/previews/core/previews_experiments.h"
 #include "url/gurl.h"
 
 namespace previews {
 
 namespace {
 
@@ skipping 47 matching lines @@
   }
 }
 
 PreviewsBlackList::~PreviewsBlackList() {}
 
 void PreviewsBlackList::AddPreviewNavigation(const GURL& url,
                                              bool opt_out,
                                              PreviewsType type) {
   DCHECK(thread_checker_.CalledOnValidThread());
   DCHECK(url.has_host());
+  switch (type) {
+    case PreviewsType::OFFLINE:
+      UMA_HISTOGRAM_BOOLEAN("Previews.OptOut.UserOptedOut.Offline", opt_out);

[tbansal1, 2016/11/09 17:50:51]

May be add a test for this?

[RyanSturm, 2016/11/09 18:48:29]

Done.

+      break;
+    default:
+      NOTREACHED();
+  }
   if (opt_out) {
     last_opt_out_time_ = clock_->Now();
   }
   // If the |black_list_item_map_| has been loaded from |opt_out_store_|,
   // synchronous operations will be accurate. Otherwise, queue the task to run
   // asynchronously.
   if (loaded_) {
     AddPreviewNavigationSync(url, opt_out, type);
   } else {
     QueuePendingTask(base::Bind(&PreviewsBlackList::AddPreviewNavigationSync,
@@ skipping 15 matching lines @@
       GetOrCreateBlackListItemForMap(black_list_item_map_.get(), host_name);
   item->AddPreviewNavigation(opt_out, now);
   DCHECK_LE(black_list_item_map_->size(),
             params::MaxInMemoryHostsInBlackList());
   host_indifferent_black_list_item_->AddPreviewNavigation(opt_out, now);
   if (!opt_out_store_)
     return;
   opt_out_store_->AddPreviewNavigation(opt_out, host_name, type, now);
 }
 
-bool PreviewsBlackList::IsLoadedAndAllowed(const GURL& url,
-                                           PreviewsType type) const {
+PreviewsEligibilityReason PreviewsBlackList::IsLoadedAndAllowed(
+    const GURL& url,
+    PreviewsType type) const {
   DCHECK(thread_checker_.CalledOnValidThread());
   DCHECK(url.has_host());
   if (!loaded_)
-    return false;
+    return PreviewsEligibilityReason::BLACKLIST_DATA_NOT_LOADED;
   DCHECK(black_list_item_map_);
   if (last_opt_out_time_ &&
       clock_->Now() <
           last_opt_out_time_.value() + params::SingleOptOutDuration()) {
-    return false;
+    return PreviewsEligibilityReason::USER_RECENTLY_OPTED_OUT;
   }
   if (host_indifferent_black_list_item_->IsBlackListed(clock_->Now()))
-    return false;
+    return PreviewsEligibilityReason::USER_BLACKLISTED;
   PreviewsBlackListItem* black_list_item =
       GetBlackListItemFromMap(*black_list_item_map_, url.host());
-  return !black_list_item || !black_list_item->IsBlackListed(clock_->Now());
+  if (black_list_item && black_list_item->IsBlackListed(clock_->Now()))
+    return PreviewsEligibilityReason::HOST_BLACKLISTED;
+  return PreviewsEligibilityReason::ALLOWED;
 }
 
 void PreviewsBlackList::ClearBlackList(base::Time begin_time,
                                        base::Time end_time) {
   DCHECK(thread_checker_.CalledOnValidThread());
   DCHECK_LE(begin_time, end_time);
   // If the |black_list_item_map_| has been loaded from |opt_out_store_|,
   // synchronous operations will be accurate. Otherwise, queue the task to run
   // asynchronously.
   if (loaded_) {
@@ skipping 72 matching lines @@
 // static
 std::unique_ptr<PreviewsBlackListItem>
 PreviewsBlackList::CreateHostIndifferentBlackListItem() {
   return base::MakeUnique<PreviewsBlackListItem>(
       params::MaxStoredHistoryLengthForHostIndifferentBlackList(),
       params::HostIndifferentBlackListOptOutThreshold(),
       params::HostIndifferentBlackListPerHostDuration());
 }
 
 }  // namespace previews