chore: add entitlment validations and deactivate invalid entitlements

Author: abose

src/nls/root/strings.js

@@ -1681,5 +1681,6 @@ define({
     "PROMO_GET_APP_UPSELL_BUTTON": "Get {0}",
     "PROMO_PRO_ENDED_TITLE": "Your {0} Trial has ended",
     "PROMO_PRO_TRIAL_DAYS_LEFT": "Phoenix Pro Trial ({0} days left)",
-    "GET_PHOENIX_PRO": "Get Phoenix Pro"
+    "GET_PHOENIX_PRO": "Get Phoenix Pro",
+    "USER_FREE_PLAN_NAME": "Free Plan"
 });

src/services/login-service.js

@@ -28,12 +28,14 @@
 define(function (require, exports, module) {
     require("./setup-login-service"); // this adds loginService to KernalModeTrust
     require("./promotions");
+    require("./login-utils");
 
-    const Metrics = require("utils/Metrics");
-    const LoginUtils = require("./login-utils");
+    const Metrics = require("utils/Metrics"),
+        Strings = require("strings");
 
     const MS_IN_DAY = 10 * 24 * 60 * 60 * 1000;
     const TEN_MINUTES = 10 * 60 * 1000;
+    const FREE_PLAN_VALIDITY_DAYS = 10000;
 
     // the fallback salt is always a constant as this will only fail in rare circumstatnces and it needs to
     // be exactly same across versions of the app. Changing this will not affect the large majority of users and
@@ -351,8 +353,8 @@ define(function (require, exports, module) {
                 const current = await getEffectiveEntitlements(false); // Get effective entitlements
 
                 // Check if we need to refresh
-                const expiredPlanName = LoginUtils.validTillExpired(current, lastRecordedState);
-                const hasChanged = LoginUtils.haveEntitlementsChanged(current, lastRecordedState);
+                const expiredPlanName = KernalModeTrust.LoginUtils.validTillExpired(current, lastRecordedState);
+                const hasChanged = KernalModeTrust.LoginUtils.haveEntitlementsChanged(current, lastRecordedState);
 
                 if (expiredPlanName || hasChanged) {
                     console.log(`Entitlements monitor detected changes, Expired: ${expiredPlanName},` +
@@ -376,6 +378,37 @@ define(function (require, exports, module) {
         console.log('Entitlements monitor started (10-minute interval)');
     }
 
+    function _validateAndFilterEntitlements(entitlements) {
+        if (!entitlements) {
+            return;
+        }
+
+        const currentDate = Date.now();
+
+        if(entitlements.plan && (!entitlements.plan.validTill || currentDate > entitlements.plan.validTill)) {
+            entitlements.plan = {
+                ...entitlements.plan,
+                paidSubscriber: false,
+                name: Strings.USER_FREE_PLAN_NAME,
+                validTill: Date.now() + (FREE_PLAN_VALIDITY_DAYS * MS_IN_DAY)
+            };
+        }
+
+        const featureEntitlements = entitlements.entitlements;
+        if (!featureEntitlements) {
+            return;
+        }
+
+        for(const featureName in featureEntitlements) {
+            const feature = featureEntitlements[featureName];
+            if(feature && feature.validTill && currentDate > feature.validTill) {
+                feature.activated = false;
+                feature.upgradeToPlan = feature.upgradeToPlan || brackets.config.main_pro_plan;
+                feature.subscribeURL = feature.subscribeURL || brackets.config.purchase_url;
+            }
+        }
+    }
+
     /**
      * Get effective entitlements for determining feature availability throughout the app.
      * This is the primary API that should be used across Phoenix to check entitlements and enable/disable features.
@@ -479,13 +512,12 @@ define(function (require, exports, module) {
         // User has active trial
         if (serverEntitlements && serverEntitlements.plan) {
             // Logged-in user with trial
+            _validateAndFilterEntitlements(serverEntitlements); // will prune invalid entitlements
             if (serverEntitlements.plan.paidSubscriber) {
                 // Already a paid subscriber, return as-is
-                // todo we need to check and filter valid till for each fields that we are interested in.
                 return serverEntitlements;
             }
             // Enhance entitlements for trial user
-            // todo we need to prune and filter serverEntitlements valid till for each fields that we are interested in.
             // ie if any entitlement has valid till expired, we need to deactivate that entitlement
             return {
                 ...serverEntitlements,

src/services/login-utils.js

@@ -25,9 +25,15 @@
 
 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("Login utils should have access to KernalModeTrust. Cannot boot without trust ring");
+    }
+
     /**
      * Check if any validTill time has expired
-     * 
+     *
      * @param {Object|null} entitlements - Current entitlements object
      * @param {Object|null} lastRecordedEntitlement - Previously recorded entitlements
      * @returns {string|null} - Name of expired plan/entitlement or null if none expired
@@ -85,7 +91,7 @@ define(function (require, exports, module) {
 
     /**
      * Check if entitlements have changed from last recorded state
-     * 
+     *
      * @param {Object|null} current - Current entitlements object
      * @param {Object|null} last - Last recorded entitlements object
      * @returns {boolean} - True if entitlements have changed, false otherwise
@@ -129,7 +135,13 @@ define(function (require, exports, module) {
         return false;
     }
 
-    // Export functions
-    exports.validTillExpired = validTillExpired;
-    exports.haveEntitlementsChanged = haveEntitlementsChanged;
-});
+    KernalModeTrust.LoginUtils = {
+        validTillExpired,
+        haveEntitlementsChanged
+    };
+    // Test only Export functions
+    if(Phoenix.isTestWindow) {
+        exports.validTillExpired = validTillExpired;
+        exports.haveEntitlementsChanged = haveEntitlementsChanged;
+    }
+});

src/services/profile-menu.js

@@ -436,7 +436,7 @@ define(function (require, exports, module) {
             initials: profileData.profileIcon.initials,
             avatarColor: profileData.profileIcon.color,
             planClass: "user-plan-free",
-            planName: "Free Plan",
+            planName: Strings.USER_FREE_PLAN_NAME,
             titleText: "Ai Quota Used",
             usageText: "100 / 200 credits",
             usedPercent: 0,