disable telemetry until forced (#295)

Author: linuxwolf

src/background/telemetry.js

@@ -14,6 +14,9 @@ const TELEMETRY_CATEGORY = "lockboxv1";
 //  which seems like a code smell, while the action / middleware approach solves
 //  this nicely.
 
+let enabled = false;
+function getTelemetryEnabled() { return enabled; }
+
 function registerEvents() {
   const events = {
     "startup": {
@@ -146,6 +149,10 @@ function registerScalars() {
 
 async function recordEvent({ method, object, extra = null, value = null }) {
   let result;
+  if (!enabled) {
+    return result;
+  }
+
   // Note: 'extra' objects must have string values. Replace null with empty
   // string, and convert numbers to strings.
   if (extra) {
@@ -178,14 +185,19 @@ async function recordEvent({ method, object, extra = null, value = null }) {
 }
 
 function scalarSet({ name, value }) {
-  return browser.telemetry.scalarSet(`${TELEMETRY_CATEGORY}.${name}`, value);
+  return enabled && browser.telemetry.scalarSet(`${TELEMETRY_CATEGORY}.${name}`, value);
 }
 
 function scalarAdd({ name, value }) {
-  return browser.telemetry.scalarAdd(`${TELEMETRY_CATEGORY}.${name}`, value);
+  return enabled && browser.telemetry.scalarAdd(`${TELEMETRY_CATEGORY}.${name}`, value);
 }
 
-export function initializeTelemetry() {
+export function initializeTelemetry(force) {
+  if (!enabled && !force) {
+    return;
+  }
+
+  enabled = true;
   registerEvents();
   registerScalars();
 
@@ -195,5 +207,5 @@ export function initializeTelemetry() {
   });
 }
 
-const exported = { recordEvent, scalarSet, scalarAdd };
+const exported = { getTelemetryEnabled, recordEvent, scalarSet, scalarAdd };
 export default exported;

test/unit/background/telemetry-test.js

@@ -31,8 +31,13 @@ describe("background > telemetry", () => {
     spyEmbeddedRecordEvent.restore();
   });
 
-  it("registers for telemetry", () => {
+  it("does not register for telemetry unless forced", () => {
     initializeTelemetry();
+    expect(spyEvents).to.not.have.been.called;
+    expect(spyScalars).to.not.have.been.called;
+  });
+  it("registers for telemetry", () => {
+    initializeTelemetry(true);
     expect(spyEvents).to.have.been.calledWith("lockboxv1", {
       "startup": {
         methods: ["startup"],
@@ -140,7 +145,7 @@ describe("background > telemetry", () => {
 
     let caught = false;
     try {
-      initializeTelemetry();
+      initializeTelemetry(true);
     } catch (e) {
       caught = true;
     }