Add a mechanism for collecting Rappor samples on a daily interval.

components/metrics/daily_interval.cc

Index: components/metrics/daily_interval.cc
diff --git a/components/metrics/daily_interval.cc b/components/metrics/daily_interval.cc
new file mode 100644
index 0000000000000000000000000000000000000000..e15ced9e4124f54aebbe04e18ab3853c5a5bf66d
--- /dev/null
+++ b/components/metrics/daily_interval.cc
@@ -0,0 +1,91 @@
+// Copyright 2014 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/metrics/daily_interval.h"
+
+#include "base/i18n/time_formatting.h"
+#include "base/metrics/histogram.h"
+#include "base/prefs/pref_registry_simple.h"
+#include "base/prefs/pref_service.h"
+
+namespace metrics {
+
+namespace {
+
+enum IntervalType {
+  FIRST_RUN,
+  DAY_ELAPSED,
+  CLOCK_CHANGED,
+  NUM_INTERVAL_TYPES
+};
+
+void RecordIntervalTypeHistogram(const char* pref_name, IntervalType t) {

[Alexei Svitkine (slow), 2014/09/08 15:34:20]

Nit: pass |pref_name| by const std::string& (just to this function) and then in
the code below, you can just do:

base::Histogram::FactoryGet(
    "DailyInterval.IntervalType." + pref_name,

[Steven Holte, 2014/09/12 21:23:31]

Changed this to a parameter to the DailyInterval constructor, to allow more
sensible metric names.

+  std::string metric_name("DailyInterval.IntervalType.");
+  metric_name += pref_name;
+  base::Histogram::FactoryGet(
+      metric_name,
+      1,
+      NUM_INTERVAL_TYPES,
+      NUM_INTERVAL_TYPES + 1,
+      base::HistogramBase::kUmaTargetedHistogramFlag)->Add(t);
+}
+
+}  // namespace
+
+DailyInterval::DailyInterval(PrefService* pref_service, const char* pref_name)
+    : pref_service_(pref_service), pref_name_(pref_name) {
+}
+
+DailyInterval::~DailyInterval() {
+}
+
+// static
+void DailyInterval::RegisterPref(PrefRegistrySimple* registry,
+                                 const char* pref_name) {
+  registry->RegisterInt64Pref(pref_name, base::Time().ToInternalValue());
+}
+
+void DailyInterval::AddObserver(DailyObserver* observer) {
+  DVLOG(2) << "DailyInterval observer added.";
+  DCHECK(last_fired_.is_null());
+  observers_.AddObserver(observer);
+}
+
+void DailyInterval::CheckInterval() {
+  base::Time now = base::Time::Now();
+  if (last_fired_.is_null()) {
+    // The first time we call CheckInterval, we read the time stored in prefs.
+    last_fired_ = base::Time::FromInternalValue(
+        pref_service_->GetInt64(pref_name_));
+    DVLOG(1) << "DailyInterval time loaded: "
+             << base::TimeFormatShortDateAndTime(last_fired_);
+    if (last_fired_.is_null()) {
+      DVLOG(1) << "DailyInterval first run.";
+      RecordIntervalTypeHistogram(pref_name_, FIRST_RUN);
+      OnInterval(now);
+      return;
+    }
+  }
+  int days_elapsed = (now - last_fired_).InDays();
+  if (days_elapsed > 1) {

[Alexei Svitkine (slow), 2014/09/08 15:34:20]

Shouldn't this be >=? otherwise it's a 2-day interval, no?

(Or add a comment if it really should be >1 so that readers of the code like
myself aren't confused.)

If it should be >=, add a test to exercise this.

[Steven Holte, 2014/09/12 21:23:31]

Done.  Also editted test to be more precise.

+    DVLOG(1) << "DailyInterval day elapsed.";
+    RecordIntervalTypeHistogram(pref_name_, DAY_ELAPSED);
+    OnInterval(now);
+  } else if (days_elapsed <= -1) {
+    // The "last fired" time is more than a day in the future, so the clock
+    // must have been changed.
+    DVLOG(1) << "DailyInterval clock change detected.";
+    RecordIntervalTypeHistogram(pref_name_, CLOCK_CHANGED);
+    OnInterval(now);
+  }
+}
+
+void DailyInterval::OnInterval(base::Time now) {
+  DCHECK(!now.is_null());
+  last_fired_ = now;
+  pref_service_->SetInt64(pref_name_, last_fired_.ToInternalValue());
+  FOR_EACH_OBSERVER(DailyObserver, observers_, OnDailyInterval());
+}
+
+}  // namespace metrics