test: integ tests for KernalModeTrust.Entitlements APIs

Author: abose

test/spec/login-browser-integ-test.js

@@ -39,6 +39,7 @@ define(function (require, exports, module) {
             LoginServiceExports,
             LoginBrowserExports,
             ProDialogsExports,
+            EntitlementsExports,
             originalOpen,
             originalFetch;
 
@@ -64,7 +65,8 @@ define(function (require, exports, module) {
                 function () {
                     return testWindow._test_login_service_exports &&
                            testWindow._test_login_browser_exports &&
-                           testWindow._test_pro_dlg_login_exports;
+                           testWindow._test_pro_dlg_login_exports &&
+                           testWindow._test_entitlements_exports;
                 },
                 "Test exports to be available",
                 5000
@@ -74,6 +76,7 @@ define(function (require, exports, module) {
             LoginServiceExports = testWindow._test_login_service_exports;
             LoginBrowserExports = testWindow._test_login_browser_exports;
             ProDialogsExports = testWindow._test_pro_dlg_login_exports;
+            EntitlementsExports = testWindow._test_entitlements_exports;
 
             // Store original functions for restoration
             originalOpen = testWindow.open;
@@ -87,7 +90,8 @@ define(function (require, exports, module) {
                 "Profile button to be available",
                 3000
             );
-            LoginShared.setup(testWindow, LoginServiceExports, setupProUserMock, performFullLoginFlow);
+            LoginShared.setup(testWindow, LoginServiceExports, setupProUserMock, performFullLoginFlow,
+                EntitlementsExports);
             VIEW_TRIAL_DAYS_LEFT = LoginShared.VIEW_TRIAL_DAYS_LEFT;
             VIEW_PHOENIX_PRO = LoginShared.VIEW_PHOENIX_PRO;
             VIEW_PHOENIX_FREE = LoginShared.VIEW_PHOENIX_FREE;

test/spec/login-desktop-integ-test.js

@@ -46,6 +46,7 @@ define(function (require, exports, module) {
             LoginServiceExports,
             LoginDesktopExports,
             ProDialogsExports,
+            EntitlementsExports,
             originalOpenURLInDefaultBrowser,
             originalCopyToClipboard,
             originalFetch;
@@ -71,7 +72,8 @@ define(function (require, exports, module) {
             await awaitsFor(
                 function () {
                     return testWindow._test_login_service_exports &&
-                        testWindow._test_login_desktop_exports;
+                        testWindow._test_login_desktop_exports &&
+                        testWindow._test_entitlements_exports;
                 },
                 "Test exports to be available",
                 5000
@@ -81,6 +83,7 @@ define(function (require, exports, module) {
             LoginServiceExports = testWindow._test_login_service_exports;
             LoginDesktopExports = testWindow._test_login_desktop_exports;
             ProDialogsExports = testWindow._test_pro_dlg_login_exports;
+            EntitlementsExports = testWindow._test_entitlements_exports;
 
             // Store original functions for restoration
             originalOpenURLInDefaultBrowser = testWindow.Phoenix.app.openURLInDefaultBrowser;
@@ -95,7 +98,8 @@ define(function (require, exports, module) {
                 "Profile button to be available",
                 3000
             );
-            LoginShared.setup(testWindow, LoginServiceExports, setupProUserMock, performFullLoginFlow);
+            LoginShared.setup(testWindow, LoginServiceExports, setupProUserMock, performFullLoginFlow,
+                EntitlementsExports);
             VIEW_TRIAL_DAYS_LEFT = LoginShared.VIEW_TRIAL_DAYS_LEFT;
             VIEW_PHOENIX_PRO = LoginShared.VIEW_PHOENIX_PRO;
             VIEW_PHOENIX_FREE = LoginShared.VIEW_PHOENIX_FREE;

test/spec/login-shared.js

@@ -2,7 +2,7 @@
 /*global expect, it, awaitsFor*/
 
 define(function (require, exports, module) {
-    let testWindow, LoginServiceExports, setupProUserMock, performFullLoginFlow;
+    let testWindow, LoginServiceExports, setupProUserMock, performFullLoginFlow, EntitlementsExports;
 
     async function setupTrialState(daysRemaining) {
         const PromotionExports = testWindow._test_promo_login_exports;
@@ -169,11 +169,76 @@ define(function (require, exports, module) {
         verifyProfileIconBlanked();
     }
 
-    function setup(_testWindow, _LoginServiceExports, _setupProUserMock, _performFullLoginFlow) {
+    // Entitlements test utility functions
+    async function verifyPlanEntitlements(expectedPlan, _testDescription) {
+        const planDetails = await EntitlementsExports.getPlanDetails();
+
+        if (expectedPlan) {
+            expect(planDetails).toBeDefined();
+            if (expectedPlan.paidSubscriber !== undefined) {
+                expect(planDetails.paidSubscriber).toBe(expectedPlan.paidSubscriber);
+            }
+            if (expectedPlan.name) {
+                expect(planDetails.name).toBe(expectedPlan.name);
+            }
+            if (expectedPlan.validTill !== undefined) {
+                expect(planDetails.validTill).toBeDefined();
+            }
+        } else {
+            expect(planDetails).toBeDefined(); // Should always return something (fallback)
+        }
+    }
+
+    async function verifyIsInProTrialEntitlement(expected, _testDescription) {
+        const isInTrial = await EntitlementsExports.isInProTrial();
+        expect(isInTrial).toBe(expected);
+    }
+
+    async function verifyTrialRemainingDaysEntitlement(expected, _testDescription) {
+        const remainingDays = await EntitlementsExports.getTrialRemainingDays();
+        if (typeof expected === 'number') {
+            expect(remainingDays).toBe(expected);
+        } else {
+            expect(remainingDays).toBeGreaterThanOrEqual(0);
+        }
+    }
+
+    async function verifyRawEntitlements(expected, _testDescription) {
+        const rawEntitlements = await EntitlementsExports.getRawEntitlements();
+
+        if (expected === null) {
+            expect(rawEntitlements).toBeNull();
+        } else if (expected) {
+            expect(rawEntitlements).toBeDefined();
+            if (expected.plan) {
+                expect(rawEntitlements.plan).toBeDefined();
+            }
+            if (expected.entitlements) {
+                expect(rawEntitlements.entitlements).toBeDefined();
+            }
+        }
+    }
+
+    async function verifyLiveEditEntitlement(expected, _testDescription) {
+        const liveEditEntitlement = await EntitlementsExports.getLiveEditEntitlement();
+
+        expect(liveEditEntitlement).toBeDefined();
+        expect(liveEditEntitlement.activated).toBe(expected.activated);
+
+        if (expected.subscribeURL) {
+            expect(liveEditEntitlement.subscribeURL).toBe(expected.subscribeURL);
+        }
+        if (expected.upgradeToPlan) {
+            expect(liveEditEntitlement.upgradeToPlan).toBe(expected.upgradeToPlan);
+        }
+    }
+
+    function setup(_testWindow, _LoginServiceExports, _setupProUserMock, _performFullLoginFlow, _EntitlementsExports) {
         testWindow = _testWindow;
         LoginServiceExports = _LoginServiceExports;
         setupProUserMock = _setupProUserMock;
         performFullLoginFlow = _performFullLoginFlow;
+        EntitlementsExports = _EntitlementsExports;
     }
 
     function setupSharedTests() {
@@ -286,10 +351,18 @@ define(function (require, exports, module) {
             // Verify initial state (no pro branding)
             await verifyProBranding(false, "no pro branding to start with");
 
+            // Verify entitlements API consistency for logged out state
+            await verifyIsInProTrialEntitlement(false, "no trial for logged out user with expired trial");
+            await verifyTrialRemainingDaysEntitlement(0, "no trial days remaining");
+
             // Perform login
             await performFullLoginFlow();
             await verifyProBranding(true, "pro branding to appear after pro user login");
 
+            // Verify entitlements API consistency for logged in pro user
+            await verifyIsInProTrialEntitlement(false, "pro user should not be in trial");
+            await verifyPlanEntitlements({ paidSubscriber: true }, "pro user should have paid subscriber plan");
+
             // Check profile popup shows pro status (not trial)
             const $profileButton = testWindow.$("#user-profile-button");
             $profileButton.trigger('click');
@@ -308,6 +381,10 @@ define(function (require, exports, module) {
             // 1. No server entitlements (logged out)
             // 2. Trial is expired (0 days remaining)
             await verifyProBranding(false, "Pro branding to disappear after logout");
+
+            // Verify entitlements API consistency after logout
+            await verifyRawEntitlements(null, "no raw entitlements when logged out");
+            await verifyIsInProTrialEntitlement(false, "no trial after logout");
         });
 
         it("should show trial branding for user without pro subscription (active trial)", async function () {
@@ -320,12 +397,21 @@ define(function (require, exports, module) {
             // Verify initial state shows pro branding due to trial
             await verifyProBranding(true, "Trial branding to appear initially");
 
+            // Verify entitlements API consistency for trial user before login
+            await verifyIsInProTrialEntitlement(true, "user should be in trial initially");
+            await verifyTrialRemainingDaysEntitlement(15, "should have 15 trial days remaining");
+            await verifyLiveEditEntitlement({ activated: true }, "live edit should be active during trial");
+
             // Perform login
             await performFullLoginFlow();
 
             // Verify pro branding remains after login
             await verifyProBranding(true, "after trial user login");
 
+            // Verify entitlements API consistency for logged in trial user
+            await verifyIsInProTrialEntitlement(true, "user should still be in trial after login");
+            await verifyPlanEntitlements({ paidSubscriber: true }, "trial user should have paidSubscriber true");
+
             // Check profile popup shows trial status
             const $profileButton = testWindow.$("#user-profile-button");
             $profileButton.trigger('click');
@@ -342,6 +428,10 @@ define(function (require, exports, module) {
             // Verify pro branding remains after logout (trial continues)
             await verifyProBranding(true, "Trial branding to remain after logout");
 
+            // Verify entitlements API consistency after logout (trial still active)
+            await verifyIsInProTrialEntitlement(true, "trial should persist after logout");
+            await verifyRawEntitlements(null, "no raw entitlements when logged out");
+
             // Check profile popup still shows trial status
             $profileButton.trigger('click');
             await popupToAppear(SIGNIN_POPUP);
@@ -516,6 +606,49 @@ define(function (require, exports, module) {
             // Close popup
             $profileButton.trigger('click');
         });
+
+        it("should test entitlements event forwarding", async function () {
+            console.log("Entitlements: Testing event forwarding");
+
+            let entitlementsEventFired = false;
+
+            // Set up event listeners
+            const entitlementsService = EntitlementsExports.EntitlementsService;
+
+            const entitlementsHandler = () => {
+                entitlementsEventFired = true;
+            };
+
+            entitlementsService.on(entitlementsService.EVENT_ENTITLEMENTS_CHANGED, entitlementsHandler);
+
+            try {
+                // Setup basic user mock
+                setupProUserMock(false);
+
+                // Perform full login flow
+                await performFullLoginFlow();
+                expect(LoginServiceExports.LoginService.isLoggedIn()).toBe(true);
+
+                // Wait for events to fire
+                await awaitsFor(()=> entitlementsEventFired, "Entitlements events to fire");
+
+                expect(entitlementsEventFired).toBe(true);
+
+                // Perform a full logout flow and see if entitlement changes are detected
+                entitlementsEventFired = false;
+                await performFullLogoutFlow();
+                expect(LoginServiceExports.LoginService.isLoggedIn()).toBe(false);
+                verifyProfileIconBlanked();
+
+                // Wait for events to fire
+                await awaitsFor(()=> entitlementsEventFired, "Entitlements events to fire");
+
+            } finally {
+                // Cleanup event listeners
+                entitlementsService.off(entitlementsService.EVENT_ENTITLEMENTS_CHANGED, entitlementsHandler);
+                await cleanupTrialState();
+            }
+        });
     }
 
     exports.setup = setup;