Add Telemetry.js (#1065)

* Add Telemetry.js

* Added toolOpened() and toolClosed()

* Remove close parameter from toolClosed()

* bump packages

Author: Mike Ratcliffe

packages/devtools-launchpad/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devtools-launchpad",
-  "version": "0.0.121",
+  "version": "0.0.123",
   "license": "MPL-2.0",
   "description":
     "The Launchpad makes it easy to build a developer tool for Firefox, Chrome, and Node.",
@@ -56,7 +56,7 @@
     "devtools-connection": "^0.0.9",
     "devtools-contextmenu": "^0.0.8",
     "devtools-mc-assets": "^0.0.5",
-    "devtools-modules": "^0.0.36",
+    "devtools-modules": "^0.0.37",
     "devtools-sprintf-js": "^1.0.3",
     "express": "^4.13.4",
     "express-static": "^1.2.5",

packages/devtools-modules/index.js

@@ -10,6 +10,7 @@ const KeyShortcuts = require("./src/key-shortcuts");
 const { ZoomKeys } = require("./src/zoom-keys");
 const EventEmitter = require("./src/utils/event-emitter");
 const SourceUtils = require("./src/source-utils");
+const Telemetry = require("./src/utils/telemetry")
 const { getUnicodeHostname, getUnicodeUrlPath, getUnicodeUrl } =
   require("./src/unicode-url");
 
@@ -22,6 +23,7 @@ module.exports = {
   ZoomKeys,
   EventEmitter,
   SourceUtils,
+  Telemetry,
   getUnicodeHostname,
   getUnicodeUrlPath,
   getUnicodeUrl,

packages/devtools-modules/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devtools-modules",
-  "version": "0.0.36",
+  "version": "0.0.37",
   "description": "DevTools Modules from M-C",
   "main": "index.js",
   "scripts": {

packages/devtools-modules/src/tests/telemetry.js

@@ -0,0 +1,120 @@
+const Telemetry = require("../utils/telemetry");
+const telemetry = new Telemetry();
+
+describe("telemetry shim", () => {
+  it("msSystemNow", () => {
+    expect(() => {
+      telemetry.msSystemNow;
+    }).not.toThrow();
+  });
+
+  it("start", () => {
+    expect(() => {
+      telemetry.start("foo", this);
+    }).not.toThrow();
+  });
+
+  it("startKeyed", () => {
+    expect(() => {
+      telemetry.startKeyed("foo", "bar", this);
+    }).not.toThrow();
+  });
+
+  it("finish", () => {
+    expect(() => {
+      telemetry.finish("foo", this);
+    }).not.toThrow();
+  });
+
+  it("finishKeyed", () => {
+    expect(() => {
+      telemetry.finishKeyed("foo", "bar", this);
+    }).not.toThrow();
+  });
+
+  it("getHistogramById", () => {
+    expect(() => {
+      telemetry.getHistogramById("foo").add(3);
+    }).not.toThrow();
+  });
+
+  it("getKeyedHistogramById", () => {
+    expect(() => {
+      telemetry.getKeyedHistogramById("foo").add("foo", 3);
+    }).not.toThrow();
+  });
+
+  it("scalarSet", () => {
+    expect(() => {
+      telemetry.scalarSet("foo", 3);
+    }).not.toThrow();
+  });
+
+  it("scalarAdd", () => {
+    expect(() => {
+      telemetry.scalarAdd("foo", 3);
+    }).not.toThrow();
+  });
+
+  it("keyedScalarAdd", () => {
+    expect(() => {
+      telemetry.keyedScalarAdd("foo", "bar", 3);
+    }).not.toThrow();
+  });
+
+  it("setEventRecordingEnabled", () => {
+    expect(() => {
+      telemetry.setEventRecordingEnabled("foo", true);
+    }).not.toThrow();
+  });
+
+  it("preparePendingEvent", () => {
+    expect(() => {
+      telemetry.preparePendingEvent(
+        "devtools.main", "open", "inspector", null, ["foo", "bar"]);
+    }).not.toThrow();
+  });
+
+  it("addEventProperty", () => {
+    expect(() => {
+      telemetry.addEventProperty(
+        "devtools.main", "open", "inspector", "foo", "1");
+    }).not.toThrow();
+  });
+
+  it("addEventProperties", () => {
+    expect(() => {
+      telemetry.addEventProperties("devtools.main", "open", "inspector", {
+        "foo": "1",
+        "bar": "2"
+      });
+    }).not.toThrow();
+  });
+
+  it("_sendPendingEvent", () => {
+    expect(() => {
+      telemetry._sendPendingEvent("devtools.main", "open", "inspector", null);
+    }).not.toThrow();
+  });
+
+  it("recordEvent", () => {
+    expect(() => {
+      telemetry.recordEvent("devtools.main", "open", "inspector", null, {
+        "foo": "1",
+        "bar": "2"
+      });
+    }).not.toThrow();
+  });
+
+  it("toolOpened", () => {
+    expect(() => {
+      telemetry.toolOpened("foo");
+    }).not.toThrow();
+  });
+
+  it("toolClosed", () => {
+    expect(() => {
+      telemetry.toolClosed("foo");
+    }).not.toThrow();
+  });
+});