UMA for the Stale Previews timestamp

chrome/browser/previews/previews_infobar_delegate.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 "chrome/browser/previews/previews_infobar_delegate.h"
 
 #include "base/feature_list.h"
 #include "base/metrics/field_trial_params.h"
 #include "base/metrics/histogram.h"
+#include "base/metrics/histogram_macros.h"
 #include "base/optional.h"
 #include "base/strings/string16.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/android/android_theme_resources.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/infobars/infobar_service.h"
 #include "chrome/browser/net/spdyproxy/data_reduction_proxy_chrome_settings.h"
 #include "chrome/browser/net/spdyproxy/data_reduction_proxy_chrome_settings_factory.h"
 #include "chrome/browser/previews/previews_infobar_tab_helper.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/data_reduction_proxy/core/browser/data_reduction_proxy_pingback_client.h"
 #include "components/data_reduction_proxy/core/browser/data_reduction_proxy_service.h"
 #include "components/data_reduction_proxy/core/common/data_reduction_proxy_params.h"
 #include "components/infobars/core/infobar.h"
 #include "components/network_time/network_time_tracker.h"
 #include "components/previews/core/previews_features.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/web_contents.h"
 #include "ui/base/l10n/l10n_util.h"
 
 #if defined(OS_ANDROID)
 #include "chrome/browser/ui/android/infobars/previews_infobar.h"
 #endif
 
 namespace {
 
+const char kMinStalenessParamName[] = "min_staleness_in_minutes";
+const char kMaxStalenessParamName[] = "max_staleness_in_minutes";
+const int kMinStalenessParamDefaultValue = 2;
+const int kMaxStalenessParamDefaultValue = 1440;
+
 void RecordPreviewsInfoBarAction(
     previews::PreviewsType previews_type,
     PreviewsInfoBarDelegate::PreviewsInfoBarAction action) {
   int32_t max_limit =
       static_cast<int32_t>(PreviewsInfoBarDelegate::INFOBAR_INDEX_BOUNDARY);
   base::LinearHistogram::FactoryGet(
       base::StringPrintf("Previews.InfoBarAction.%s",
                          GetStringNameForType(previews_type).c_str()),
       1, max_limit, max_limit + 1,
       base::HistogramBase::kUmaTargetedHistogramFlag)
       ->Add(static_cast<int32_t>(action));
 }
 
+void RecordStaleness(PreviewsInfoBarDelegate::PreviewsInfoBarTimestamp value) {
+  UMA_HISTOGRAM_ENUMERATION("Previews.InfoBarTimestamp", value,
+                            PreviewsInfoBarDelegate::TIMESTAMP_INDEX_BOUNDARY);
+}
+
 // Sends opt out information to the pingback service based on a key value in the
 // infobar tab helper. Sending this information in the case of a navigation that
 // should not send a pingback (or is not a server preview) will not alter the
 // pingback.
 void ReportPingbackInformation(content::WebContents* web_contents) {
   auto* data_reduction_proxy_settings =
       DataReductionProxyChromeSettingsFactory::GetForBrowserContext(
           web_contents->GetBrowserContext());
   PreviewsInfoBarTabHelper* infobar_tab_helper =
       PreviewsInfoBarTabHelper::FromWebContents(web_contents);
@@ skipping 178 matching lines @@
 
 base::string16 PreviewsInfoBarDelegate::GetTimestampText() const {
   if (previews_freshness_.is_null())
     return base::string16();
   if (!base::FeatureList::IsEnabled(
           previews::features::kStalePreviewsTimestamp)) {
     return base::string16();
   }
 
   int min_staleness_in_minutes = base::GetFieldTrialParamByFeatureAsInt(
-      previews::features::kStalePreviewsTimestamp, "min_staleness_in_minutes",
-      0);
+      previews::features::kStalePreviewsTimestamp, kMinStalenessParamName,
+      kMinStalenessParamDefaultValue);
   int max_staleness_in_minutes = base::GetFieldTrialParamByFeatureAsInt(
-      previews::features::kStalePreviewsTimestamp, "max_staleness_in_minutes",
-      0);
+      previews::features::kStalePreviewsTimestamp, kMaxStalenessParamName,
+      kMaxStalenessParamDefaultValue);
 
-  if (min_staleness_in_minutes == 0 || max_staleness_in_minutes == 0)
+  if (min_staleness_in_minutes <= 0 || max_staleness_in_minutes <= 0) {
+    NOTREACHED();
     return base::string16();
+  }
 
   base::Time network_time;
   if (g_browser_process->network_time_tracker()->GetNetworkTime(&network_time,
                                                                 nullptr) !=
       network_time::NetworkTimeTracker::NETWORK_TIME_AVAILABLE) {
     // When network time has not been initialized yet, simply rely on the
     // machine's current time.
     network_time = base::Time::Now();
   }
 
+  if (network_time < previews_freshness_) {
+    RecordStaleness(TIMESTAMP_NOT_SHOWN_STALENESS_NEGATIVE);
+    return base::string16();
+  }
+
   int staleness_in_minutes = (network_time - previews_freshness_).InMinutes();
-  // TODO(megjablon): record metrics for out of bounds staleness.
-  if (staleness_in_minutes < min_staleness_in_minutes)
+  if (staleness_in_minutes < min_staleness_in_minutes) {
+    RecordStaleness(TIMESTAMP_NOT_SHOWN_PREVIEW_NOT_STALE);
     return base::string16();
-  if (staleness_in_minutes > max_staleness_in_minutes)
+  }
+  if (staleness_in_minutes > max_staleness_in_minutes) {
+    RecordStaleness(TIMESTAMP_NOT_SHOWN_STALENESS_GREATER_THAN_MAX);
     return base::string16();
+  }
+
+  RecordStaleness(TIMESTAMP_SHOWN);
 
   if (staleness_in_minutes < 60) {
     return l10n_util::GetStringFUTF16(
         IDS_PREVIEWS_INFOBAR_TIMESTAMP_MINUTES,
         base::IntToString16(staleness_in_minutes));
   } else if (staleness_in_minutes < 120) {
     return l10n_util::GetStringUTF16(IDS_PREVIEWS_INFOBAR_TIMESTAMP_ONE_HOUR);
   } else {
     return l10n_util::GetStringFUTF16(
         IDS_PREVIEWS_INFOBAR_TIMESTAMP_HOURS,
         base::IntToString16(staleness_in_minutes / 60));
   }
 }