Bug 1301452 - Test written for tab spinner probes r=mconley

MozReview-Commit-ID: C7oEA6ofntz --HG-- extra : rebase_source : a46a386a103082592b66a709f07a9fae0fe4c1fd
2016-09-16 15:55:55 -07:00 · 2016-09-16 15:55:55 -07:00 · 394e80dd4c
--- a/browser/base/content/test/tabs/browser.ini
+++ b/browser/base/content/test/tabs/browser.ini
@ -0,0 +1,2 @@
+[browser_tabSpinnerProbe.js]
+skip-if = !e10s # Tab spinner is e10s only.
--- a/browser/base/content/test/tabs/browser_tabSpinnerProbe.js
+++ b/browser/base/content/test/tabs/browser_tabSpinnerProbe.js
@ -0,0 +1,87 @@
+"use strict";
+
+/**
+ * Tests the FX_TAB_SWITCH_SPINNER_VISIBLE_MS and
+ * FX_TAB_SWITCH_SPINNER_VISIBLE_LONG_MS telemetry probes
+ */
+let gMinHangTime = 500; // ms
+let gMaxHangTime = 5 * 1000; // ms
+
+/**
+ * Make a data URI for a generic webpage with a script that hangs for a given
+ * amount of time.
+ * @param  {?Number} aHangMs Number of milliseconds that the hang should last.
+ *                   Defaults to 0.
+ * @return {String}  The data URI generated.
+ */
+function makeDataURI(aHangMs = 0) {
+  return `data:text/html,
+    <html>
+      <head>
+        <meta charset="utf-8"/>
+        <title>Tab Spinner Test</title>
+        <script>
+          function hang() {
+            let hangDuration = ${aHangMs};
+            if (hangDuration > 0) {
+              let startTime = window.performance.now();
+              while(window.performance.now() - startTime < hangDuration) {}
+            }
+          }
+        </script>
+      </head>
+      <body>
+        <h1 id='header'>Tab Spinner Test</h1>
+      </body>
+    </html>`;
+}
+
+/**
+ * Returns the sum of all values in an array.
+ * @param  {Array}  aArray An array of integers
+ * @return {Number} The sum of the integers in the array
+ */
+function sum(aArray) {
+  return aArray.reduce(function(previousValue, currentValue) {
+    return previousValue + currentValue;
+  });
+}
+
+/**
+ * A generator intended to be run as a Task. It tests one of the tab spinner
+ * telemetry probes.
+ * @param {String} aProbe The probe to test. Should be one of:
+ *                  - FX_TAB_SWITCH_SPINNER_VISIBLE_MS
+ *                  - FX_TAB_SWITCH_SPINNER_VISIBLE_LONG_MS
+ */
+function* testProbe(aProbe) {
+  info(`Testing probe: ${aProbe}`);
+  let histogram = Services.telemetry.getHistogramById(aProbe);
+  let buckets = histogram.snapshot().ranges.filter(function(value) {
+    return (value > gMinHangTime && value < gMaxHangTime);
+  });
+  let delayTime = buckets[0]; // Pick a bucket arbitrarily
+
+  // The tab spinner does not show up instantly. We need to hang for a little
+  // bit of extra time to account for the tab spinner delay.
+  delayTime += gBrowser.selectedTab.linkedBrowser.getTabBrowser()._getSwitcher().TAB_SWITCH_TIMEOUT;
+  let dataURI1 = makeDataURI(delayTime);
+  let dataURI2 = makeDataURI();
+
+  let tab1 = yield BrowserTestUtils.openNewForegroundTab(gBrowser, dataURI1);
+  histogram.clear();
+  // Queue a hang in the content process when the
+  // event loop breathes next.
+  ContentTask.spawn(tab1.linkedBrowser, null, function*() {
+    content.wrappedJSObject.hang();
+  });
+  let tab2 = yield BrowserTestUtils.openNewForegroundTab(gBrowser, dataURI2);
+  let snapshot = histogram.snapshot();
+  yield BrowserTestUtils.removeTab(tab2);
+  yield BrowserTestUtils.removeTab(tab1);
+  ok(sum(snapshot.counts) > 0,
+   `Spinner probe should now have a value in some bucket`);
+}
+
+add_task(testProbe.bind(null, "FX_TAB_SWITCH_SPINNER_VISIBLE_MS"));
+add_task(testProbe.bind(null, "FX_TAB_SWITCH_SPINNER_VISIBLE_LONG_MS"));
--- a/browser/base/moz.build
+++ b/browser/base/moz.build
@ -23,6 +23,7 @@ BROWSER_CHROME_MANIFESTS += [
    'content/test/referrer/browser.ini',
    'content/test/social/browser.ini',
    'content/test/tabPrompts/browser.ini',
+    'content/test/tabs/browser.ini',
    'content/test/urlbar/browser.ini',
    'content/test/webrtc/browser.ini',
 ]