chore: power user survey for subscribers and ligged in users support

Author: abose

src/extensionsIntegrated/Phoenix/guided-tour.js

@@ -18,7 +18,15 @@
  *
  */
 
+/*global logger*/
+
 define(function (require, exports, module) {
+    const KernalModeTrust = window.KernalModeTrust;
+    if(!KernalModeTrust){
+        // integrated extensions will have access to kernal mode, but not external extensions
+        throw new Error("Guided Tour should have access to KernalModeTrust. Cannot boot without trust ring");
+    }
+
     const NotificationUI = require("widgets/NotificationUI"),
         Commands = require("command/Commands"),
         Strings = require("strings"),
@@ -244,6 +252,23 @@ define(function (require, exports, module) {
         PhStore.setItem(GUIDED_TOUR_LOCAL_STORAGE_KEY, JSON.stringify(userAlreadyDidAction));
     }
 
+    async function _resolvePowerUserSurveyURL(surveyJson) {
+        try {
+            const isLoggedIn = KernalModeTrust.EntitlementsManager.isLoggedIn();
+            if(!isLoggedIn) {
+                return surveyJson.powerUser;
+            }
+            const paidSubscriber = await KernalModeTrust.EntitlementsManager.isPaidSubscriber();
+            if(paidSubscriber && surveyJson.PowerUserPaid) {
+                return surveyJson.PowerUserPaid;
+            }
+            return surveyJson.PowerUserLoggedIn || surveyJson.powerUser;
+        } catch (e) {
+            logger.reportError(e, "Error resolving power user survey URL");
+        }
+        return surveyJson.powerUser;
+    }
+
     async function _showSurveys() {
         try {
             if(!navigator.onLine){
@@ -258,6 +283,8 @@ define(function (require, exports, module) {
                     newUserShowDelayMS: surveyJSON.browser.newUserShowDelayMS || surveyJSON.newUserShowDelayMS,
                     newUserUseDialog: surveyJSON.browser.newUserUseDialog || surveyJSON.newUserUseDialog,
                     powerUser: surveyJSON.browser.powerUser || surveyJSON.powerUser,
+                    PowerUserPaid: surveyJSON.browser.PowerUserPaid || surveyJSON.PowerUserPaid,
+                    PowerUserLoggedIn: surveyJSON.browser.PowerUserLoggedIn || surveyJSON.PowerUserLoggedIn,
                     powerUserTitle: surveyJSON.browser.powerUserTitle || surveyJSON.powerUserTitle,
                     powerUserShowIntervalDays: surveyJSON.browser.powerUserShowIntervalDays
                         || surveyJSON.powerUserShowIntervalDays,
@@ -266,7 +293,8 @@ define(function (require, exports, module) {
             }
             surveyJSON.newUser && _showFirstUseSurvey(surveyJSON.newUser, surveyJSON.newUserShowDelayMS,
                 surveyJSON.newUserTitle, surveyJSON.newUserUseDialog);
-            surveyJSON.powerUser && _showRepeatUserSurvey(surveyJSON.powerUser, surveyJSON.powerUserShowIntervalDays,
+            const powerUserSurveyURL = await _resolvePowerUserSurveyURL(surveyJSON);
+            surveyJSON.powerUser && _showRepeatUserSurvey(powerUserSurveyURL, surveyJSON.powerUserShowIntervalDays,
                 surveyJSON.powerUserTitle, surveyJSON.powerUserUseDialog);
         } catch (e) {
             console.error("Error fetching survey link", surveyLinksURL, e);

src/services/EntitlementsManager.js

@@ -109,6 +109,19 @@ define(function (require, exports, module) {
         };
     }
 
+    /**
+     * Determines if the current user is a paid subscriber. A paid subscriber is a user who has paid $ for any pro-plan.
+     *
+     * @return {Promise<boolean>} A promise that resolves to a boolean indicating whether the user is a paid subscriber.
+     */
+    async function isPaidSubscriber() {
+        if(!LoginService.isLoggedIn()){
+            return false;
+        }
+        const planDetails = await getPlanDetails();
+        return !!planDetails.paidSubscriber;
+    }
+
     /**
      * Check if user is in a pro trial. IF the user is in pro trail, then `plan.isSubscriber` will always be true.
      * @returns {Promise<boolean>} True if user is in pro trial, false otherwise
@@ -339,6 +352,7 @@ define(function (require, exports, module) {
             EntitlementsService: EntitlementsManager,
             isLoggedIn,
             getPlanDetails,
+            isPaidSubscriber,
             isInProTrial,
             getTrialRemainingDays,
             getRawEntitlements,
@@ -355,6 +369,7 @@ define(function (require, exports, module) {
     EntitlementsManager.isLoggedIn = isLoggedIn;
     EntitlementsManager.loginToAccount = loginToAccount;
     EntitlementsManager.getPlanDetails = getPlanDetails;
+    EntitlementsManager.isPaidSubscriber = isPaidSubscriber;
     EntitlementsManager.isInProTrial = isInProTrial;
     EntitlementsManager.getTrialRemainingDays = getTrialRemainingDays;
     EntitlementsManager.getRawEntitlements = getRawEntitlements;