chore: support for pro flags in app notifications

Author: abose

src/assets/notifications/dev/root/banner.json

@@ -1,8 +1,9 @@
 {
   "WELCOME_DEVELOPER": {
+    "PRO_EDITION_ONLY" : false,
     "DANGER_SHOW_ON_EVERY_BOOT" : false,
     "HTML_CONTENT": "<div>Welcome to Phoenix Code dev community! Click here to <a class='notification_ack' href='https://discord.com/invite/rBpTBPttca'> chat with our Discord Community.</a></div>",
     "FOR_VERSIONS": ">=3.0.0",
     "PLATFORM" : "all"
   }
-}
+}

src/extensionsIntegrated/InAppNotifications/banner.js

@@ -80,6 +80,7 @@ define(function (require, exports, module) {
      * A sample notifications is as follows:
      * {
      *   "SAMPLE_NOTIFICATION_NAME": {
+     *     "PRO_EDITION_ONLY" : false,
      *     "DANGER_SHOW_ON_EVERY_BOOT" : false,
      *     "HTML_CONTENT": "<div>hello world <a class='notification_ack'>Click to acknowledge.</a></div>",
      *     "FOR_VERSIONS": "1.x || >=2.5.0 || 5.0.0 - 7.2.3",
@@ -91,16 +92,17 @@ define(function (require, exports, module) {
      *  or there is an html element with class `notification_ack`.
      *
      * 1. `SAMPLE_NOTIFICATION_NAME` : This is a unique ID. It is used to check if the notification was shown to user.
-     * 2. `DANGER_SHOW_ON_EVERY_BOOT` : (Default false) Setting this to true will cause the
+     * 2. `PRO_EDITION_ONLY` : (Default false) Setting this to true will not show the notification on community editions
+     * 3. `DANGER_SHOW_ON_EVERY_BOOT` : (Default false) Setting this to true will cause the
      *    notification to be shown on every boot. This is bad ux and only be used if there is a critical security issue
      *    that we want the version not to be used.
-     * 3. `HTML_CONTENT`: The actual html content to show to the user. It can have an optional `notification_ack` class.
+     * 4. `HTML_CONTENT`: The actual html content to show to the user. It can have an optional `notification_ack` class.
      *     Setting this class will cause the notification to be shown once a day until the user explicitly clicks
      *     on any html element with class `notification_ack` or explicitly click the close button.
      *     If such a class is not present, then the notification is shown only once ever.
-     * 4. `FOR_VERSIONS` : [Semver compatible version filter](https://www.npmjs.com/package/semver).
+     * 5. `FOR_VERSIONS` : [Semver compatible version filter](https://www.npmjs.com/package/semver).
      *     The notification will be shown to all versions satisfying this.
-     * 5. `PLATFORM`: A comma seperated list of all platforms in which the message will be shown.
+     * 6. `PLATFORM`: A comma seperated list of all platforms in which the message will be shown.
      *     allowed values are: `mac,win,linux,allDesktop,firefox,chrome,safari,allBrowser,all`
      * @param notifications
      * @returns {false|*}
@@ -113,6 +115,7 @@ define(function (require, exports, module) {
 
         const _InAppBannerShownAndDone = PreferencesManager.getViewState(
             IN_APP_NOTIFICATIONS_BANNER_SHOWN_STATE);
+        const isProEdition = Phoenix.pro && Phoenix.pro.commitID;
 
         for(const notificationID of Object.keys(notifications)){
             if(!_InAppBannerShownAndDone[notificationID]) {
@@ -126,6 +129,9 @@ define(function (require, exports, module) {
                 if(customFilterCallback && !(await customFilterCallback(notification, notificationID))){
                     continue;
                 }
+                if(!isProEdition && notification.PRO_EDITION_ONLY){
+                    continue;
+                }
                 if(!notification.DANGER_SHOW_ON_EVERY_BOOT){
                     // One time notification. mark as shown and never show again
                     // all notifications are one time, we track metrics for each notification separately

test/spec/Extn-InAppNotifications-integ-test.js

@@ -19,7 +19,7 @@
  *
  */
 
-/*global describe, it, expect, beforeAll, afterAll, awaits, awaitsFor */
+/*global describe, it, expect, beforeAll, beforeEach, afterEach, afterAll, awaits, awaitsFor */
 
 define(function (require, exports, module) {
     // Recommended to avoid reloading the integration test window Phoenix instance for each test.
@@ -28,7 +28,7 @@ define(function (require, exports, module) {
 
     const testPath = SpecRunnerUtils.getTestPath("/spec/JSUtils-test-files");
 
-    let testWindow, banner;
+    let testWindow, banner, originalPhoenixPro;
 
 
     describe("integration:In App notification banner integration tests", function () {
@@ -40,6 +40,16 @@ define(function (require, exports, module) {
             await SpecRunnerUtils.loadProjectInTestWindow(testPath);
         }, 30000);
 
+        beforeEach(function () {
+            // Save original Phoenix.pro before each test
+            originalPhoenixPro = testWindow.Phoenix.pro;
+        });
+
+        afterEach(function () {
+            // Restore Phoenix.pro after each test (even if test fails)
+            testWindow.Phoenix.pro = originalPhoenixPro;
+        });
+
         async function _waitForBannerShown() {
             await awaitsFor(function () {
                 return testWindow.$('#notification-bar').is(":visible");
@@ -52,16 +62,20 @@ define(function (require, exports, module) {
             await SpecRunnerUtils.closeTestWindow();
         }, 30000);
 
-        function getRandomNotification(platform, showOnEveryBoot=false, ack = false) {
+        function getRandomNotification(platform, showOnEveryBoot=false, ack = false, proOnly = false) {
             const notification = {};
             const id = crypto.randomUUID();
             const ackClass = ack? "notification_ack" : '';
-            notification[id] = {
+            const notificationObj = {
                 "DANGER_SHOW_ON_EVERY_BOOT": showOnEveryBoot,
                 "HTML_CONTENT": `<div id='${id}' class="${ackClass}">random notification ${platform} with id ${id}, DANGER_SHOW_ON_EVERY_BOOT: ${showOnEveryBoot}, ack:${ack}</div>`,
                 "FOR_VERSIONS": ">=3.0.0",
                 "PLATFORM": platform || "all"
             };
+            if (proOnly) {
+                notificationObj.PRO_EDITION_ONLY = true;
+            }
+            notification[id] = notificationObj;
             return {notification, id: `#${id}`};
         }
 
@@ -189,6 +203,53 @@ define(function (require, exports, module) {
             expect(testWindow.$(id).length).toEqual(0);
         });
 
+        it("Should show PRO_EDITION_ONLY notification in pro edition", async function () {
+            banner.cleanNotificationBanner();
+
+            // Mock pro edition
+            testWindow.Phoenix.pro = { commitID: "test-pro-commit" };
+
+            const {notification, id} = getRandomNotification("all", true, false, true);
+            banner._renderNotifications(notification);
+
+            expect(testWindow.$(id).length).toEqual(1);
+
+            banner.cleanNotificationBanner();
+        });
+
+        it("Should not show PRO_EDITION_ONLY notification in community edition", async function () {
+            banner.cleanNotificationBanner();
+
+            // Mock community edition
+            testWindow.Phoenix.pro = null;
+
+            const {notification, id} = getRandomNotification("all", true, false, true);
+            banner._renderNotifications(notification);
+            await awaits(50);
+
+            expect(testWindow.$(id).length).toEqual(0);
+
+            banner.cleanNotificationBanner();
+        });
+
+        it("Should show non-PRO_EDITION_ONLY notification in all editions", async function () {
+            const {notification, id} = getRandomNotification("all", true, false, false);
+
+            // Test in pro edition
+            banner.cleanNotificationBanner();
+            testWindow.Phoenix.pro = { commitID: "test-pro-commit" };
+            banner._renderNotifications(notification);
+            expect(testWindow.$(id).length).toEqual(1);
+            banner.cleanNotificationBanner();
+            expect(testWindow.$(id).length).toEqual(0);
+
+            // Test in community edition
+            testWindow.Phoenix.pro = null;
+            banner._renderNotifications(notification);
+            expect(testWindow.$(id).length).toEqual(1);
+            banner.cleanNotificationBanner();
+        });
+
         it("Should apply custom filter to block notification", async function () {
             banner.cleanNotificationBanner();
             banner.registerCustomFilter(async () => false);