refactor: isPowerUser APi to metrics from health extension

Author: abose

src/extensions/default/HealthData/HealthDataManager.js

@@ -36,9 +36,29 @@ define(function (require, exports, module) {
         TEN_SECOND          = 10 * ONE_SECOND,
         ONE_MINUTE          = 60000,
         MAX_DAYS_TO_KEEP_COUNTS = 60,
-        // 'healthDataUsage' key is used in other places tho private to phoenix. search for other usage before rename
         USAGE_COUNTS_KEY    = "healthDataUsage";
 
+    /**
+     * A power user is someone who has used Phoenix at least 3 days or 8 hours in the last two weeks
+     * @returns {boolean}
+     */
+    function isPowerUser() {
+        let usageData = PreferencesManager.getViewState(USAGE_COUNTS_KEY) || {},
+            dateKeys = Object.keys(usageData),
+            dateBefore14Days = new Date(),
+            totalUsageMinutes = 0,
+            totalUsageDays = 0;
+        dateBefore14Days.setUTCDate(dateBefore14Days.getUTCDate()-14);
+        for(let dateKey of dateKeys){
+            let date = new Date(dateKey);
+            if(date >= dateBefore14Days) {
+                totalUsageDays ++;
+                totalUsageMinutes = totalUsageMinutes + usageData[dateKey];
+            }
+        }
+        return totalUsageDays >= 3 || (totalUsageMinutes/60) >= 8;
+    }
+
     let healthDataDisabled;
 
     prefs.definePreference("healthDataTracking", "boolean", true, {
@@ -85,7 +105,9 @@ define(function (require, exports, module) {
     }
 
     AppInit.appReady(function () {
-        Metrics.init();
+        Metrics.init({
+            isPowerUserFn: isPowerUser
+        });
         healthDataDisabled = !prefs.get("healthDataTracking");
         Metrics.setDisabled(healthDataDisabled);
         SendToAnalytics.sendPlatformMetrics();

src/extensionsIntegrated/Phoenix/guided-tour.js

@@ -28,7 +28,6 @@ define(function (require, exports, module) {
         Metrics = require("utils/Metrics"),
         Dialogs = require("widgets/Dialogs"),
         Mustache = require("thirdparty/mustache/mustache"),
-        PreferencesManager = require("preferences/PreferencesManager"),
         SurveyTemplate = require("text!./html/survey-template.html"),
         NOTIFICATION_BACKOFF = 10000,
         GUIDED_TOUR_LOCAL_STORAGE_KEY = "guidedTourActions";
@@ -41,8 +40,7 @@ define(function (require, exports, module) {
         POWER_USER_SURVEY_TIME = 10000, // 10 seconds to allow the survey to preload, but not
         // enough time to break user workflow
         ONE_MONTH_IN_DAYS = 30,
-        POWER_USER_SURVEY_INTERVAL_DAYS = 35,
-        USAGE_COUNTS_KEY    = "healthDataUsage"; // private to phoenix, set from health data extension
+        POWER_USER_SURVEY_INTERVAL_DAYS = 35;
 
     const userAlreadyDidAction = PhStore.getItem(GUIDED_TOUR_LOCAL_STORAGE_KEY)
         ? JSON.parse(PhStore.getItem(GUIDED_TOUR_LOCAL_STORAGE_KEY)) : {
@@ -240,24 +238,6 @@ define(function (require, exports, module) {
         }, delayOverride || GENERAL_SURVEY_TIME);
     }
 
-    // a power user is someone who has used Phoenix at least 3 days or 8 hours in the last two weeks
-    function _isPowerUser() {
-        let usageData = PreferencesManager.getViewState(USAGE_COUNTS_KEY) || {},
-            dateKeys = Object.keys(usageData),
-            dateBefore14Days = new Date(),
-            totalUsageMinutes = 0,
-            totalUsageDays = 0;
-        dateBefore14Days.setUTCDate(dateBefore14Days.getUTCDate()-14);
-        for(let dateKey of dateKeys){
-            let date = new Date(dateKey);
-            if(date >= dateBefore14Days) {
-                totalUsageDays ++;
-                totalUsageMinutes = totalUsageMinutes + usageData[dateKey];
-            }
-        }
-        return totalUsageDays >= 3 || (totalUsageMinutes/60) >= 8;
-    }
-
     function addSurveyIframe(surveyURL) {
         const $surveyFrame = $('<iframe>', {
             src: surveyURL,
@@ -296,7 +276,7 @@ define(function (require, exports, module) {
     }
 
     function _showPowerUserSurvey(surveyURL, intervalOverride) {
-        if(_isPowerUser()) {
+        if(Metrics.isPowerUser()) {
             const intervalDays = intervalOverride || POWER_USER_SURVEY_INTERVAL_DAYS;
             Metrics.countEvent(Metrics.EVENT_TYPE.USER, "power", "user", 1);
             let lastShownDate = userAlreadyDidAction.lastShownPowerSurveyDate;

src/utils/Metrics.js

@@ -46,7 +46,8 @@ define(function (require, exports, module) {
         loggedDataForAudit = new Map();
 
     let isFirstUseDay;
-    let userID;
+    let userID, isPowerUserFn;
+    let cachedIsPowerUser = false;
 
     function _setUserID() {
         const userIDKey = "phoenixUserPseudoID";
@@ -70,9 +71,11 @@ define(function (require, exports, module) {
         dayAfterFirstUse.setUTCDate(firstUseDay.getUTCDate() + 1);
         let today = new Date();
         isFirstUseDay = today < dayAfterFirstUse;
+        if(!isFirstUseDay){
+            setTimeout(_setFirstDayFlag, ONE_DAY);
+        }
     }
     _setFirstDayFlag();
-    setInterval(_setFirstDayFlag, ONE_DAY);
 
     /**
      * This section outlines the properties and methods available in this module
@@ -260,13 +263,20 @@ define(function (require, exports, module) {
      * and paid plans for GA starts at 100,000 USD.
      * @private
      */
-    function init(){
+    function init(initOptions = {}){
         if(initDone || window.testEnvironment){
             return;
         }
         _initGoogleAnalytics();
         _initCoreAnalytics();
         initDone = true;
+        if (initOptions.isPowerUserFn) {
+            isPowerUserFn = initOptions.isPowerUserFn;
+            cachedIsPowerUser = isPowerUserFn();  // only call once to avoid heavy computations repeatedly
+            setInterval(()=>{
+                cachedIsPowerUser = isPowerUserFn();
+            }, ONE_DAY);
+        }
     }
 
     // some events generate too many ga events that ga can't handle. ignore them.
@@ -351,7 +361,10 @@ define(function (require, exports, module) {
      * @type {function}
      */
     function countEvent(eventType, eventCategory, eventSubCategory, count= 1) {
-        if(!isFirstUseDay){
+        if(cachedIsPowerUser){
+            // emit power user metrics too
+            _countEvent(`P-${eventType}`, eventCategory, eventSubCategory, count);
+        } else if(!isFirstUseDay){
             // emit repeat user metrics too
             _countEvent(`R-${eventType}`, eventCategory, eventSubCategory, count);
         }
@@ -379,7 +392,10 @@ define(function (require, exports, module) {
      * @type {function}
      */
     function valueEvent(eventType, eventCategory, eventSubCategory, value) {
-        if(!isFirstUseDay){
+        if(cachedIsPowerUser){
+            // emit power user metrics too
+            _valueEvent(`P-${eventType}`, eventCategory, eventSubCategory, value);
+        } else if(!isFirstUseDay){
             // emit repeat user metrics too
             _valueEvent(`R-${eventType}`, eventCategory, eventSubCategory, value);
         }
@@ -452,6 +468,16 @@ define(function (require, exports, module) {
         return "10000+";
     }
 
+    /**
+     * A power user is someone who has used Phoenix at least 3 days or 8 hours in the last two weeks
+     * @returns {boolean}
+     */
+    function isPowerUser() {
+        if(!isPowerUserFn) {
+            throw new Error("PowerUser fn is not initialized in Metrics.");
+        }
+        return isPowerUserFn();
+    }
 
     // Define public API
     exports.init               = init;
@@ -464,6 +490,7 @@ define(function (require, exports, module) {
     exports.logPerformanceTime = logPerformanceTime;
     exports.flushMetrics       = flushMetrics;
     exports.getRangeName       = getRangeName;
+    exports.isPowerUser        = isPowerUser;
     exports.EVENT_TYPE = EVENT_TYPE;
     exports.AUDIT_TYPE_COUNT = AUDIT_TYPE_COUNT;
     exports.AUDIT_TYPE_VALUE = AUDIT_TYPE_VALUE;