Refactor 'Telemetry enabled' checking code to clarify the expected bo…

…olean result
mozilla-services · Jan 24, 2018 · c8b1747 · c8b1747
1 parent 90fbe9a
commit c8b1747
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/addon/bootstrap.js b/addon/bootstrap.js
@@ -211,7 +211,7 @@ function handleMessage(msg, sender, sendReply) {
     return;
   }
 
-  if (msg.funcName === "getTelemetryPref") {
+  if (msg.funcName === "isTelemetryEnabled") {
     let telemetryEnabled = getBoolPref(TELEMETRY_ENABLED_PREF);
     sendReply({type: "success", value: telemetryEnabled});
   } else if (msg.funcName === "isUploadDisabled") {

diff --git a/addon/webextension/background/analytics.js b/addon/webextension/background/analytics.js
@@ -6,7 +6,7 @@ this.analytics = (function() {
   let exports = {};
 
   let telemetryPrefKnown = false;
-  let telemetryPref;
+  let telemetryEnabled;
 
   const EVENT_BATCH_DURATION = 1000; // ms for setTimeout
   let pendingEvents = [];
@@ -79,7 +79,7 @@ this.analytics = (function() {
       log.warn("sendEvent called before we were able to refresh");
       return Promise.resolve();
     }
-    if (!telemetryPref) {
+    if (!telemetryEnabled) {
       log.info(`Cancelled sendEvent ${eventCategory}/${action}/${label || 'none'} ${JSON.stringify(options)}`);
       return Promise.resolve();
     }
@@ -129,24 +129,24 @@ this.analytics = (function() {
   };
 
   exports.refreshTelemetryPref = function() {
-    return communication.sendToBootstrap("getTelemetryPref").then((result) => {
+    return communication.sendToBootstrap("isTelemetryEnabled").then((result) => {
       telemetryPrefKnown = true;
       if (result === communication.NO_BOOTSTRAP) {
-        telemetryPref = true;
+        telemetryEnabled = true;
       } else {
-        telemetryPref = result;
+        telemetryEnabled = result;
       }
     }, (error) => {
       // If there's an error reading the pref, we should assume that we shouldn't send data
       telemetryPrefKnown = true;
-      telemetryPref = false;
+      telemetryEnabled = false;
       throw error;
     });
   };
 
-  exports.getTelemetryPrefSync = function() {
+  exports.isTelemetryEnabled = function() {
     catcher.watchPromise(exports.refreshTelemetryPref());
-    return !!telemetryPref;
+    return telemetryEnabled;
   };
 
   let timingData = new Map();

diff --git a/addon/webextension/background/senderror.js b/addon/webextension/background/senderror.js
@@ -88,7 +88,7 @@ this.senderror = (function() {
   };
 
   exports.reportError = function(e) {
-    if (!analytics.getTelemetryPrefSync()) {
+    if (!analytics.isTelemetryEnabled()) {
       log.error("Telemetry disabled. Not sending critical error:", e);
       return;
     }