michael@0: /* Any copyright is dedicated to the Public Domain.
michael@0:    http://creativecommons.org/publicdomain/zero/1.0/ */
michael@0: 
michael@0: const Cc = Components.classes;
michael@0: const Ci = Components.interfaces;
michael@0: const Cu = Components.utils;
michael@0: const INT_MAX = 0x7FFFFFFF;
michael@0: 
michael@0: const Telemetry = Cc["@mozilla.org/base/telemetry;1"].getService(Ci.nsITelemetry);
michael@0: Cu.import("resource://gre/modules/Services.jsm", this);
michael@0: 
michael@0: function test_expired_histogram() {
michael@0:   var histogram_id = "FOOBAR";
michael@0:   var test_expired_id = "TELEMETRY_TEST_EXPIRED";
michael@0:   var clone_id = "ExpiredClone";
michael@0:   var dummy = Telemetry.newHistogram(histogram_id, "28.0a1", 1, 2, 3, Telemetry.HISTOGRAM_EXPONENTIAL);
michael@0:   var dummy_clone = Telemetry.histogramFrom(clone_id, test_expired_id);
michael@0:   var rh = Telemetry.registeredHistograms([]);
michael@0: 
michael@0:   dummy.add(1);
michael@0:   dummy_clone.add(1);
michael@0: 
michael@0:   do_check_eq(Telemetry.histogramSnapshots["__expired__"], undefined);
michael@0:   do_check_eq(Telemetry.histogramSnapshots[histogram_id], undefined);
michael@0:   do_check_eq(Telemetry.histogramSnapshots[test_expired_id], undefined);
michael@0:   do_check_eq(Telemetry.histogramSnapshots[clone_id], undefined);
michael@0:   do_check_eq(rh[test_expired_id], undefined);
michael@0: }
michael@0: 
michael@0: function test_histogram(histogram_type, name, min, max, bucket_count) {
michael@0:   var h = Telemetry.newHistogram(name, "never", min, max, bucket_count, histogram_type);
michael@0:   var r = h.snapshot().ranges;
michael@0:   var sum = 0;
michael@0:   var log_sum = 0;
michael@0:   var log_sum_squares = 0;
michael@0:   for(var i=0;i<r.length;i++) {
michael@0:     var v = r[i];
michael@0:     sum += v;
michael@0:     if (histogram_type == Telemetry.HISTOGRAM_EXPONENTIAL) {
michael@0:       var log_v = Math.log(1+v);
michael@0:       log_sum += log_v;
michael@0:       log_sum_squares += log_v*log_v;
michael@0:     }
michael@0:     h.add(v);
michael@0:   }
michael@0:   var s = h.snapshot();
michael@0:   // verify properties
michael@0:   do_check_eq(sum, s.sum);
michael@0:   if (histogram_type == Telemetry.HISTOGRAM_EXPONENTIAL) {
michael@0:     // We do the log with float precision in C++ and double precision in
michael@0:     // JS, so there's bound to be tiny discrepancies.  Just check the
michael@0:     // integer part.
michael@0:     do_check_eq(Math.floor(log_sum), Math.floor(s.log_sum));
michael@0:     do_check_eq(Math.floor(log_sum_squares), Math.floor(s.log_sum_squares));
michael@0:     do_check_false("sum_squares_lo" in s);
michael@0:     do_check_false("sum_squares_hi" in s);
michael@0:   } else {
michael@0:     // Doing the math to verify sum_squares was reflected correctly is
michael@0:     // tedious in JavaScript.  Just make sure we have something.
michael@0:     do_check_neq(s.sum_squares_lo + s.sum_squares_hi, 0);
michael@0:     do_check_false("log_sum" in s);
michael@0:     do_check_false("log_sum_squares" in s);
michael@0:   }
michael@0: 
michael@0:   // there should be exactly one element per bucket
michael@0:   for each(var i in s.counts) {
michael@0:     do_check_eq(i, 1);
michael@0:   }
michael@0:   var hgrams = Telemetry.histogramSnapshots
michael@0:   gh = hgrams[name]
michael@0:   do_check_eq(gh.histogram_type, histogram_type);
michael@0: 
michael@0:   do_check_eq(gh.min, min)
michael@0:   do_check_eq(gh.max, max)
michael@0: 
michael@0:   // Check that booleans work with nonboolean histograms
michael@0:   h.add(false);
michael@0:   h.add(true);
michael@0:   var s = h.snapshot().counts;
michael@0:   do_check_eq(s[0], 2)
michael@0:   do_check_eq(s[1], 2)
michael@0: 
michael@0:   // Check that clearing works.
michael@0:   h.clear();
michael@0:   var s = h.snapshot();
michael@0:   for each(var i in s.counts) {
michael@0:     do_check_eq(i, 0);
michael@0:   }
michael@0:   do_check_eq(s.sum, 0);
michael@0:   if (histogram_type == Telemetry.HISTOGRAM_EXPONENTIAL) {
michael@0:     do_check_eq(s.log_sum, 0);
michael@0:     do_check_eq(s.log_sum_squares, 0);
michael@0:   } else {
michael@0:     do_check_eq(s.sum_squares_lo, 0);
michael@0:     do_check_eq(s.sum_squares_hi, 0);
michael@0:   }
michael@0: 
michael@0:   h.add(0);
michael@0:   h.add(1);
michael@0:   var c = h.snapshot().counts;
michael@0:   do_check_eq(c[0], 1);
michael@0:   do_check_eq(c[1], 1);
michael@0: }
michael@0: 
michael@0: function expect_fail(f) {
michael@0:   let failed = false;
michael@0:   try {
michael@0:     f();
michael@0:     failed = false;
michael@0:   } catch (e) {
michael@0:     failed = true;
michael@0:   }
michael@0:   do_check_true(failed);
michael@0: }
michael@0: 
michael@0: function expect_success(f) {
michael@0:   let succeeded = false;
michael@0:   try {
michael@0:     f();
michael@0:     succeeded = true;
michael@0:   } catch (e) {
michael@0:     succeeded = false;
michael@0:   }
michael@0:   do_check_true(succeeded);
michael@0: }
michael@0: 
michael@0: function test_boolean_histogram()
michael@0: {
michael@0:   var h = Telemetry.newHistogram("test::boolean histogram", "never", 99,1,4, Telemetry.HISTOGRAM_BOOLEAN);
michael@0:   var r = h.snapshot().ranges;
michael@0:   // boolean histograms ignore numeric parameters
michael@0:   do_check_eq(uneval(r), uneval([0, 1, 2]))
michael@0:   var sum = 0
michael@0:   for(var i=0;i<r.length;i++) {
michael@0:     var v = r[i];
michael@0:     sum += v;
michael@0:     h.add(v);
michael@0:   }
michael@0:   h.add(true);
michael@0:   h.add(false);
michael@0:   var s = h.snapshot();
michael@0:   do_check_eq(s.histogram_type, Telemetry.HISTOGRAM_BOOLEAN);
michael@0:   // last bucket should always be 0 since .add parameters are normalized to either 0 or 1
michael@0:   do_check_eq(s.counts[2], 0);
michael@0:   do_check_eq(s.sum, 3);
michael@0:   do_check_eq(s.counts[0], 2);
michael@0: }
michael@0: 
michael@0: function test_flag_histogram()
michael@0: {
michael@0:   var h = Telemetry.newHistogram("test::flag histogram", "never", 130, 4, 5, Telemetry.HISTOGRAM_FLAG);
michael@0:   var r = h.snapshot().ranges;
michael@0:   // Flag histograms ignore numeric parameters.
michael@0:   do_check_eq(uneval(r), uneval([0, 1, 2]))
michael@0:   // Should already have a 0 counted.
michael@0:   var c = h.snapshot().counts;
michael@0:   var s = h.snapshot().sum;
michael@0:   do_check_eq(uneval(c), uneval([1, 0, 0]));
michael@0:   do_check_eq(s, 1);
michael@0:   // Should switch counts.
michael@0:   h.add(2);
michael@0:   var c2 = h.snapshot().counts;
michael@0:   var s2 = h.snapshot().sum;
michael@0:   do_check_eq(uneval(c2), uneval([0, 1, 0]));
michael@0:   do_check_eq(s, 1);
michael@0:   // Should only switch counts once.
michael@0:   h.add(3);
michael@0:   var c3 = h.snapshot().counts;
michael@0:   var s3 = h.snapshot().sum;
michael@0:   do_check_eq(uneval(c3), uneval([0, 1, 0]));
michael@0:   do_check_eq(s3, 1);
michael@0:   do_check_eq(h.snapshot().histogram_type, Telemetry.FLAG_HISTOGRAM);
michael@0: }
michael@0: 
michael@0: function test_getHistogramById() {
michael@0:   try {
michael@0:     Telemetry.getHistogramById("nonexistent");
michael@0:     do_throw("This can't happen");
michael@0:   } catch (e) {
michael@0:     
michael@0:   }
michael@0:   var h = Telemetry.getHistogramById("CYCLE_COLLECTOR");
michael@0:   var s = h.snapshot();
michael@0:   do_check_eq(s.histogram_type, Telemetry.HISTOGRAM_EXPONENTIAL);
michael@0:   do_check_eq(s.min, 1);
michael@0:   do_check_eq(s.max, 10000);
michael@0: }
michael@0: 
michael@0: function compareHistograms(h1, h2) {
michael@0:   let s1 = h1.snapshot();
michael@0:   let s2 = h2.snapshot();
michael@0: 
michael@0:   do_check_eq(s1.histogram_type, s2.histogram_type);
michael@0:   do_check_eq(s1.min, s2.min);
michael@0:   do_check_eq(s1.max, s2.max);
michael@0:   do_check_eq(s1.sum, s2.sum);
michael@0:   if (s1.histogram_type == Telemetry.HISTOGRAM_EXPONENTIAL) {
michael@0:     do_check_eq(s1.log_sum, s2.log_sum);
michael@0:     do_check_eq(s1.log_sum_squares, s2.log_sum_squares);
michael@0:   } else {
michael@0:     do_check_eq(s1.sum_squares_lo, s2.sum_squares_lo);
michael@0:     do_check_eq(s1.sum_squares_hi, s2.sum_squares_hi);
michael@0:   }
michael@0: 
michael@0:   do_check_eq(s1.counts.length, s2.counts.length);
michael@0:   for (let i = 0; i < s1.counts.length; i++)
michael@0:     do_check_eq(s1.counts[i], s2.counts[i]);
michael@0: 
michael@0:   do_check_eq(s1.ranges.length, s2.ranges.length);
michael@0:   for (let i = 0; i < s1.ranges.length; i++)
michael@0:     do_check_eq(s1.ranges[i], s2.ranges[i]);
michael@0: }
michael@0: 
michael@0: function test_histogramFrom() {
michael@0:   // Test one histogram of each type.
michael@0:   let names = [
michael@0:       "CYCLE_COLLECTOR",      // EXPONENTIAL
michael@0:       "GC_REASON_2",          // LINEAR
michael@0:       "GC_RESET",             // BOOLEAN
michael@0:       "TELEMETRY_TEST_FLAG"   // FLAG
michael@0:   ];
michael@0: 
michael@0:   for each (let name in names) {
michael@0:     let [min, max, bucket_count] = [1, INT_MAX - 1, 10]
michael@0:     let original = Telemetry.getHistogramById(name);
michael@0:     let clone = Telemetry.histogramFrom("clone" + name, name);
michael@0:     compareHistograms(original, clone);
michael@0:   }
michael@0: 
michael@0:   // Additionally, set the flag on TELEMETRY_TEST_FLAG, and check it gets set on the clone.
michael@0:   let testFlag = Telemetry.getHistogramById("TELEMETRY_TEST_FLAG");
michael@0:   testFlag.add(1);
michael@0:   let clone = Telemetry.histogramFrom("FlagClone", "TELEMETRY_TEST_FLAG");
michael@0:   compareHistograms(testFlag, clone);
michael@0: }
michael@0: 
michael@0: function test_getSlowSQL() {
michael@0:   var slow = Telemetry.slowSQL;
michael@0:   do_check_true(("mainThread" in slow) && ("otherThreads" in slow));
michael@0: }
michael@0: 
michael@0: function test_addons() {
michael@0:   var addon_id = "testing-addon";
michael@0:   var fake_addon_id = "fake-addon";
michael@0:   var name1 = "testing-histogram1";
michael@0:   var register = Telemetry.registerAddonHistogram;
michael@0:   expect_success(function ()
michael@0:                  register(addon_id, name1, 1, 5, 6, Telemetry.HISTOGRAM_LINEAR));
michael@0:   // Can't register the same histogram multiple times.
michael@0:   expect_fail(function ()
michael@0: 	      register(addon_id, name1, 1, 5, 6, Telemetry.HISTOGRAM_LINEAR));
michael@0:   // Make sure we can't get at it with another name.
michael@0:   expect_fail(function () Telemetry.getAddonHistogram(fake_addon_id, name1));
michael@0: 
michael@0:   // Check for reflection capabilities.
michael@0:   var h1 = Telemetry.getAddonHistogram(addon_id, name1);
michael@0:   // Verify that although we've created storage for it, we don't reflect it into JS.
michael@0:   var snapshots = Telemetry.addonHistogramSnapshots;
michael@0:   do_check_false(name1 in snapshots[addon_id]);
michael@0:   h1.add(1);
michael@0:   h1.add(3);
michael@0:   var s1 = h1.snapshot();
michael@0:   do_check_eq(s1.histogram_type, Telemetry.HISTOGRAM_LINEAR);
michael@0:   do_check_eq(s1.min, 1);
michael@0:   do_check_eq(s1.max, 5);
michael@0:   do_check_eq(s1.counts[1], 1);
michael@0:   do_check_eq(s1.counts[3], 1);
michael@0: 
michael@0:   var name2 = "testing-histogram2";
michael@0:   expect_success(function ()
michael@0:                  register(addon_id, name2, 2, 4, 4, Telemetry.HISTOGRAM_LINEAR));
michael@0: 
michael@0:   var h2 = Telemetry.getAddonHistogram(addon_id, name2);
michael@0:   h2.add(2);
michael@0:   h2.add(3);
michael@0:   var s2 = h2.snapshot();
michael@0:   do_check_eq(s2.histogram_type, Telemetry.HISTOGRAM_LINEAR);
michael@0:   do_check_eq(s2.min, 2);
michael@0:   do_check_eq(s2.max, 4);
michael@0:   do_check_eq(s2.counts[1], 1);
michael@0:   do_check_eq(s2.counts[2], 1);
michael@0: 
michael@0:   // Check that we can register histograms for a different addon with
michael@0:   // identical names.
michael@0:   var extra_addon = "testing-extra-addon";
michael@0:   expect_success(function ()
michael@0: 		 register(extra_addon, name1, 0, 1, 2, Telemetry.HISTOGRAM_BOOLEAN));
michael@0: 
michael@0:   // Check that we can register flag histograms.
michael@0:   var flag_addon = "testing-flag-addon";
michael@0:   var flag_histogram = "flag-histogram";
michael@0:   expect_success(function() 
michael@0:                  register(flag_addon, flag_histogram, 0, 1, 2, Telemetry.HISTOGRAM_FLAG))
michael@0:   expect_success(function()
michael@0: 		 register(flag_addon, name2, 2, 4, 4, Telemetry.HISTOGRAM_LINEAR));
michael@0: 
michael@0:   // Check that we reflect registered addons and histograms.
michael@0:   snapshots = Telemetry.addonHistogramSnapshots;
michael@0:   do_check_true(addon_id in snapshots)
michael@0:   do_check_true(extra_addon in snapshots);
michael@0:   do_check_true(flag_addon in snapshots);
michael@0: 
michael@0:   // Check that we have data for our created histograms.
michael@0:   do_check_true(name1 in snapshots[addon_id]);
michael@0:   do_check_true(name2 in snapshots[addon_id]);
michael@0:   var s1_alt = snapshots[addon_id][name1];
michael@0:   var s2_alt = snapshots[addon_id][name2];
michael@0:   do_check_eq(s1_alt.min, s1.min);
michael@0:   do_check_eq(s1_alt.max, s1.max);
michael@0:   do_check_eq(s1_alt.histogram_type, s1.histogram_type);
michael@0:   do_check_eq(s2_alt.min, s2.min);
michael@0:   do_check_eq(s2_alt.max, s2.max);
michael@0:   do_check_eq(s2_alt.histogram_type, s2.histogram_type);
michael@0: 
michael@0:   // Even though we've registered it, it shouldn't show up until data is added to it.
michael@0:   do_check_false(name1 in snapshots[extra_addon]);
michael@0: 
michael@0:   // Flag histograms should show up automagically.
michael@0:   do_check_true(flag_histogram in snapshots[flag_addon]);
michael@0:   do_check_false(name2 in snapshots[flag_addon]);
michael@0: 
michael@0:   // Check that we can remove addon histograms.
michael@0:   Telemetry.unregisterAddonHistograms(addon_id);
michael@0:   snapshots = Telemetry.addonHistogramSnapshots;
michael@0:   do_check_false(addon_id in snapshots);
michael@0:   // Make sure other addons are unaffected.
michael@0:   do_check_true(extra_addon in snapshots);
michael@0: }
michael@0: 
michael@0: // Check that telemetry doesn't record in private mode
michael@0: function test_privateMode() {
michael@0:   var h = Telemetry.newHistogram("test::private_mode_boolean", "never", 1,2,3, Telemetry.HISTOGRAM_BOOLEAN);
michael@0:   var orig = h.snapshot();
michael@0:   Telemetry.canRecord = false;
michael@0:   h.add(1);
michael@0:   do_check_eq(uneval(orig), uneval(h.snapshot()));
michael@0:   Telemetry.canRecord = true;
michael@0:   h.add(1);
michael@0:   do_check_neq(uneval(orig), uneval(h.snapshot()));
michael@0: }
michael@0: 
michael@0: // Check that histograms that aren't flagged as needing extended stats
michael@0: // don't record extended stats.
michael@0: function test_extended_stats() {
michael@0:   var h = Telemetry.getHistogramById("GRADIENT_DURATION");
michael@0:   var s = h.snapshot();
michael@0:   do_check_eq(s.sum, 0);
michael@0:   do_check_eq(s.log_sum, 0);
michael@0:   do_check_eq(s.log_sum_squares, 0);
michael@0:   h.add(1);
michael@0:   s = h.snapshot();
michael@0:   do_check_eq(s.sum, 1);
michael@0:   do_check_eq(s.log_sum, 0);
michael@0:   do_check_eq(s.log_sum_squares, 0);
michael@0: }
michael@0: 
michael@0: function generateUUID() {
michael@0:   let str = Cc["@mozilla.org/uuid-generator;1"].getService(Ci.nsIUUIDGenerator).generateUUID().toString();
michael@0:   // strip {}
michael@0:   return str.substring(1, str.length - 1);
michael@0: }
michael@0: 
michael@0: function run_test()
michael@0: {
michael@0:   let kinds = [Telemetry.HISTOGRAM_EXPONENTIAL, Telemetry.HISTOGRAM_LINEAR]
michael@0:   for each (let histogram_type in kinds) {
michael@0:     let [min, max, bucket_count] = [1, INT_MAX - 1, 10]
michael@0:     test_histogram(histogram_type, "test::"+histogram_type, min, max, bucket_count);
michael@0: 
michael@0:     const nh = Telemetry.newHistogram;
michael@0:     expect_fail(function () nh("test::min", "never", 0, max, bucket_count, histogram_type));
michael@0:     expect_fail(function () nh("test::bucket_count", "never", min, max, 1, histogram_type));
michael@0:   }
michael@0: 
michael@0:   // Instantiate the storage for this histogram and make sure it doesn't
michael@0:   // get reflected into JS, as it has no interesting data in it.
michael@0:   let h = Telemetry.getHistogramById("NEWTAB_PAGE_PINNED_SITES_COUNT");
michael@0:   do_check_false("NEWTAB_PAGE_PINNED_SITES_COUNT" in Telemetry.histogramSnapshots);
michael@0: 
michael@0:   test_boolean_histogram();
michael@0:   test_getHistogramById();
michael@0:   test_histogramFrom();
michael@0:   test_getSlowSQL();
michael@0:   test_privateMode();
michael@0:   test_addons();
michael@0:   test_extended_stats();
michael@0:   test_expired_histogram();
michael@0: }