Add Sparse Histogram Support to metricsPrivate

chrome/browser/extensions/api/metrics_private/metrics_apitest.cc

 // Copyright (c) 2012 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 <map>
 
 #include "base/metrics/field_trial.h"
 #include "base/metrics/histogram.h"
 #include "base/metrics/statistics_recorder.h"
 #include "base/metrics/user_metrics.h"
@@ skipping 20 matching lines @@
   const char* name;
   base::HistogramType type;
   int min;
   int max;
   size_t buckets;
   int count;
 } g_histograms[] = {
       {"test.h.1", base::HISTOGRAM, 1, 100, 50, 1},          // custom
       {"test.h.2", base::LINEAR_HISTOGRAM, 1, 200, 50, 1},   // custom
       {"test.h.3", base::LINEAR_HISTOGRAM, 1, 101, 102, 2},  // percentage
+      {"test.sparse.1", base::SPARSE_HISTOGRAM, 0, 0, 0, 1},
+      {"test.sparse.2", base::SPARSE_HISTOGRAM, 0, 0, 0, 2},
+      {"test.sparse.3", base::SPARSE_HISTOGRAM, 0, 0, 0, 6},
       {"test.time", base::HISTOGRAM, 1, 10000, 50, 1},
       {"test.medium.time", base::HISTOGRAM, 1, 180000, 50, 1},
       {"test.long.time", base::HISTOGRAM, 1, 3600000, 50, 1},
       {"test.count", base::HISTOGRAM, 1, 1000000, 50, 1},
       {"test.medium.count", base::HISTOGRAM, 1, 10000, 50, 1},
       {"test.small.count", base::HISTOGRAM, 1, 100, 50, 1},
       {"test.bucketchange.linear", base::LINEAR_HISTOGRAM, 1, 100, 10, 2},
       {"test.bucketchange.log", base::HISTOGRAM, 1, 100, 10, 2}, };
 
+// Represents a bucket in a sparse histogram.
+struct Bucket {
+  int histogramValue;

[Ilya Sherman, 2014/03/26 23:52:13]

nit: Please use hacker_case.

[robliao, 2014/03/27 00:02:44]

Done.

+  int count;
+};
+
+// We expect the following sparse histograms.
+struct SparseHistogram {
+  const char* name;
+  int bucket_count;
+  Bucket buckets[10];
+} g_sparse_histograms[] = {
+  {"test.sparse.1", 1, {{42, 1}}},
+  {"test.sparse.2", 1, {{24, 2}}},
+  {"test.sparse.3", 3, {{1, 1}, {2, 2}, {3, 3}}}};
+
 // This class observes and collects user action notifications that are sent
 // by the tests, so that they can be examined afterwards for correctness.
 class UserActionObserver {
  public:
   UserActionObserver();
   ~UserActionObserver();
 
   void ValidateUserActions(const RecordedUserAction* recorded, int count);
 
  private:
@@ skipping 32 matching lines @@
 }
 
 void UserActionObserver::ValidateUserActions(const RecordedUserAction* recorded,
                                              int count) {
   for (int i = 0; i < count; ++i) {
     const RecordedUserAction& ua = recorded[i];
     EXPECT_EQ(ua.count, GetMetricCount(ua.name));
   }
 }
 
+void ValidateSparseHistogramSamples(
+    const char* name,
+    const scoped_ptr<base::HistogramSamples>& samples) {

[Ilya Sherman, 2014/03/26 23:52:13]

nit: Why pass the scoped_ptr, rather than the pointed-to object?

[robliao, 2014/03/27 00:02:44]

That would work too.
On 2014/03/26 23:52:13, Ilya Sherman wrote:

+  for (int i = 0; i  < arraysize(g_sparse_histograms); i++) {

[Ilya Sherman, 2014/03/26 23:52:13]

nit: ++i

[Ilya Sherman, 2014/03/26 23:52:13]

nit: "i  <" -> "i <" (one fewer spaces)

[robliao, 2014/03/27 00:02:44]

Done.

+    const SparseHistogram& sparse_histogram = g_sparse_histograms[i];
+    if (name == sparse_histogram.name) {

[Ilya Sherman, 2014/03/26 23:52:13]

Comparing C-strings is a pointer comparison, which is probably not what you
want.  The simplest fix is to change the type of the |name| parameter to be
std::string.

[robliao, 2014/03/27 00:02:44]

Oops, too much jumping between JS and C++>. Yup, I forgot the std::string.

Oddly enough, the code works (tested with bogus counts) and it shouldn't...
On 2014/03/26 23:52:13, Ilya Sherman wrote:

[Ilya Sherman, 2014/03/27 00:08:16]

Sometimes optimizing compilers are *too* helpful ;)

On 2014/03/27 00:02:44, robliao wrote:

[robliao, 2014/03/27 00:21:53]

I was thinking that, but these strings also come from JS Land at runtime.
On 2014/03/27 00:08:16, Ilya Sherman wrote:

+      for (int j = 0; j < sparse_histogram.bucket_count; j++) {

[Ilya Sherman, 2014/03/26 23:52:13]

nit: ++j

[robliao, 2014/03/27 00:02:44]

Done.

+        const Bucket& bucket = sparse_histogram.buckets[j];
+        EXPECT_EQ(bucket.count, samples->GetCount(bucket.histogramValue));
+      }
+    }
+  }
+}
+
 void ValidateHistograms(const RecordedHistogram* recorded,
                         int count) {
   base::StatisticsRecorder::Histograms histograms;
   base::StatisticsRecorder::GetHistograms(&histograms);
 
   // Code other than the tests tun here will record some histogram values, but
   // we will ignore those. This function validates that all the histogram we
   // expect to see are present in the list, and that their basic info is
   // correct.
   for (int i = 0; i < count; ++i) {
     const RecordedHistogram& r = recorded[i];
     size_t j = 0;
     for (j = 0; j < histograms.size(); ++j) {
       base::HistogramBase* histogram(histograms[j]);
-
       if (r.name == histogram->histogram_name()) {
-        EXPECT_EQ(r.type, histogram->GetHistogramType());
-        EXPECT_TRUE(
-            histogram->HasConstructionArguments(r.min, r.max, r.buckets));
         scoped_ptr<base::HistogramSamples> snapshot =
             histogram->SnapshotSamples();
         base::HistogramBase::Count sample_count = snapshot->TotalCount();
-        EXPECT_EQ(sample_count, r.count);
+        EXPECT_EQ(r.count, sample_count);
+
+        EXPECT_EQ(r.type, histogram->GetHistogramType());
+        if (r.type == base::SPARSE_HISTOGRAM) {
+          ValidateSparseHistogramSamples(r.name, snapshot);
+        } else {
+          EXPECT_TRUE(
+              histogram->HasConstructionArguments(r.min, r.max, r.buckets));
+        }
         break;
       }
     }
     EXPECT_LT(j, histograms.size());
   }
 }
 
 }  // anonymous namespace
 
 IN_PROC_BROWSER_TEST_F(ExtensionApiTest, Metrics) {
   UserActionObserver observer;
 
   base::FieldTrialList::CreateFieldTrial("apitestfieldtrial2", "group1");
 
   std::map<std::string, std::string> params;
   params["a"] = "aa";
   params["b"] = "bb";
   ASSERT_TRUE(chrome_variations::AssociateVariationParams(
       "apitestfieldtrial2", "group1", params));
 
   ASSERT_TRUE(RunComponentExtensionTest("metrics")) << message_;
 
   observer.ValidateUserActions(g_user_actions, arraysize(g_user_actions));
   ValidateHistograms(g_histograms, arraysize(g_histograms));
 }