Merge pull request #598 from Countly/staging

turtledreams · web-flow · commit 144858fe30bc · 2025-12-02T23:03:58.000+09:00
Staging 25.4.3
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 25.4.3
+
+- Added filtering capability to `content` interface through `enterContentZone(contentFilterCallback)`.
+
 ## 25.4.2
 
 - Mitigated an issue where manual feedback reporting could have failed
diff --git a/cypress.config.js b/cypress.config.js
@@ -27,9 +27,32 @@ module.exports =  defineConfig({
               req.on('data', chunk => { body += chunk; });
               req.on('end', () => {
                 requests.push({ method: req.method, url: req.url, headers: req.headers, body });
+
+                let payload = { result: 'Success' };
+
+                if (req.url && req.url.indexOf('/o/sdk/content') !== -1) {
+                  payload = {
+                    html: 'http://test/_external/content?id=111&uid=tester&app_id=222',
+                    geo: {
+                      l: {
+                        x: 282,
+                        y: 56,
+                        w: 303,
+                        h: 300
+                      },
+                      p: {
+                        x: 62,
+                        y: 325.5,
+                        w: 288,
+                        h: 216
+                      }
+                    }
+                  };
+                }
+
                 setTimeout(() => {
                   res.writeHead(200, { 'Content-Type': 'application/json' });
-                  res.end(JSON.stringify({ result: 'Success' }));
+                  res.end(JSON.stringify(payload));
                 }, responseDelay);
               });
             });
diff --git a/cypress/e2e/bridged_utils.cy.js b/cypress/e2e/bridged_utils.cy.js
@@ -15,7 +15,7 @@ function initMain(name, version) {
 }
 
 const SDK_NAME = "javascript_native_web";
-const SDK_VERSION = "25.4.2";
+const SDK_VERSION = "25.4.3";
 
 // tests
 describe("Bridged SDK Utilities Tests", () => {
diff --git a/cypress/e2e/content_filter.cy.js b/cypress/e2e/content_filter.cy.js
@@ -0,0 +1,77 @@
+/* eslint-disable cypress/no-unnecessary-waiting */
+/* eslint-disable require-jsdoc */
+var Countly = require("../../lib/countly");
+// import * as Countly from "../../dist/countly_umd.js";
+var hp = require("../support/helper.js");
+
+function initMain() {
+    Countly.init({
+        app_key: "YOUR_APP_KEY",
+        url: "http://localhost:9000",
+        debug: true
+    });
+}
+
+describe("Content Filter Tests", () => {
+    beforeEach(() => {
+        cy.wait(1000);
+    });
+
+    afterEach(() => {
+        cy.task("stopServer");
+    });
+
+    it("Correctly provides params", () => {
+        hp.haltAndClearStorage(() => {
+            cy.task("setResponseDelay", 0);
+            cy.task("startServer");
+            const filterParams = [];
+            initMain();
+
+            function filter(params) {
+                filterParams.push(params);
+                return false;
+            }
+
+            Countly.content.enterContentZone(filter);
+
+            cy.wait(5000).then(() => {
+                expect(filterParams.length).to.be.greaterThan(0);
+                expect(filterParams[0]).to.have.property("id");
+                expect(filterParams[0]["id"]).to.equal("111");
+                expect(filterParams[0]).to.have.property("uid");
+                expect(filterParams[0]["uid"]).to.equal("tester");
+                expect(filterParams[0]).to.have.property("app_id");
+                expect(filterParams[0]["app_id"]).to.equal("222");
+                cy.task("stopServer");
+            });
+        });
+    });
+    it("Correctly provides params_async", () => {
+        hp.haltAndClearStorage(() => {
+            cy.task("setResponseDelay", 0);
+            cy.task("startServer");
+            const filterParams = [];
+            Countly.q = Countly.q || [];
+            initMain();
+
+            function filter(params) {
+                filterParams.push(params);
+                return false;
+            }
+
+            Countly.q.push(["content.enterContentZone", filter]);
+
+            cy.wait(5000).then(() => {
+                expect(filterParams.length).to.be.greaterThan(0);
+                expect(filterParams[0]).to.have.property("id");
+                expect(filterParams[0]["id"]).to.equal("111");
+                expect(filterParams[0]).to.have.property("uid");
+                expect(filterParams[0]["uid"]).to.equal("tester");
+                expect(filterParams[0]).to.have.property("app_id");
+                expect(filterParams[0]["app_id"]).to.equal("222");
+                cy.task("stopServer");
+            });
+        });
+    });
+});
diff --git a/cypress/e2e/request_backoff.cy.js b/cypress/e2e/request_backoff.cy.js
@@ -169,9 +169,9 @@ describe("Request Back-off Mechanism Tests", () => {
                     Countly.attempt_to_send_stored_requests();
                     cy.task("setResponseDelay", 0);
                     cy.wait(8000).then(() => {
-                        cy.fetch_local_request_queue().then((rq) => {
-                            cy.log("Request Queue: " + JSON.stringify(rq));
-                            expect(rq.length).to.equal(0);
+                        cy.fetch_local_request_queue().then((rq2) => {
+                            cy.log("Request Queue: " + JSON.stringify(rq2));
+                            expect(rq2.length).to.equal(0);
                             cy.task("stopServer");
                         });
                     });
diff --git a/examples/example_async.html b/examples/example_async.html
@@ -23,6 +23,17 @@
 		//track sessions automatically
 		Countly.q.push(['track_sessions']);
 
+		//content filter example
+		function filter(params) {
+			var shouldContentBeShown = true;
+			console.log("Content filter called with params:", params);
+			// Add your content filtering logic here and determine whether to show content
+			return shouldContentBeShown;
+		}
+
+		//enter content zone with filter
+		Countly.q.push(['content.enterContentZone', filter]);
+
 		//track sessions automatically
 		Countly.q.push(['track_pageview']);
 
diff --git a/examples/example_sync.html b/examples/example_sync.html
@@ -27,6 +27,17 @@
         Countly.track_pageview();
         Countly.track_errors();
 
+        //content filter example
+        function filter(params) {
+            var shouldContentBeShown = true;
+            console.log("Content filter called with params:", params);
+            // Add your content filtering logic here and determine whether to show content
+            return shouldContentBeShown;
+        }
+
+        //enter content zone with filter
+        Countly.content.enterContentZone(filter);
+
         document.getElementById("testButton").addEventListener("click", function () {
             Countly.add_event({
                 key: "buttonClick",
diff --git a/lib/countly.d.ts b/lib/countly.d.ts
@@ -491,16 +491,17 @@ declare module "countly-sdk-web" {
 
     /**
      * Content interface with convenience methods for content zones:
-     * - enterContentZone() - enters a content zone
+     * - enterContentZone(contentFilterCallback) - enters a content zone
      * - refreshContentZone() - refreshes the content zone
      * - exitContentZone() - exits a content zone
      */
     const content: Content;
     interface Content {
       /**
        * Enters content zone and checks and displays available content regularly
+       * @param {Function} [contentFilterCallback] - Optional callback function to filter content based on URL parameters. Should return true to display content, false to ignore.
        */
-      enterContentZone(): void;
+      enterContentZone(contentFilterCallback?: (contentURLParams: object) => boolean): void;
       /**
        * Refreshes content zone
        */
diff --git a/lib/countly.js b/lib/countly.js
@@ -66,8 +66,14 @@
     function _classPrivateFieldSet2(s, a, r) {
         return s.set(_assertClassBrand(s, a), r), r;
     }
+    function _defineProperties(e, r) {
+        for (var t = 0; t < r.length; t++) {
+            var o = r[t];
+            o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o);
+        }
+    }
     function _createClass(e, r, t) {
-        return Object.defineProperty(e, "prototype", {
+        return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", {
             writable: !1
         }), e;
     }
@@ -211,7 +217,7 @@
         backoffCount: "cly_hc_backoff_count",
         consecutiveBackoffCount: "cly_hc_consecutive_backoff_count"
     });
-    var SDK_VERSION = "25.4.2";
+    var SDK_VERSION = "25.4.3";
     var SDK_NAME = "javascript_native_web";
 
     // Using this on document.referrer would return an array with 17 elements in it. The 12th element (array[11]) would be the path we are looking for. Others would be things like password and such (use https://regex101.com/ to check more)
@@ -938,6 +944,7 @@
     var _lastRequestWasBackoff = /*#__PURE__*/new WeakMap();
     var _testModeTime = /*#__PURE__*/new WeakMap();
     var _requestTimeoutDuration = /*#__PURE__*/new WeakMap();
+    var _contentFilterCallback = /*#__PURE__*/new WeakMap();
     var _getAndSetServerConfig = /*#__PURE__*/new WeakMap();
     var _populateServerConfig = /*#__PURE__*/new WeakMap();
     var _initialize = /*#__PURE__*/new WeakMap();
@@ -1093,6 +1100,7 @@
         _classPrivateFieldInitSpec(this, _lastRequestWasBackoff, void 0);
         _classPrivateFieldInitSpec(this, _testModeTime, void 0);
         _classPrivateFieldInitSpec(this, _requestTimeoutDuration, void 0);
+        _classPrivateFieldInitSpec(this, _contentFilterCallback, void 0);
         _classPrivateFieldInitSpec(this, _getAndSetServerConfig, function () {
             if (_this.device_id === "[CLY]_temp_id") {
                 _classPrivateFieldGet2(_log, _this).call(_this, logLevelEnums.INFO, "server_config, Device ID is temporary, not fetching server config");
@@ -4602,8 +4610,8 @@
             }
         });
         _defineProperty(this, "content", {
-            enterContentZone: function enterContentZone() {
-                _classPrivateFieldGet2(_enterContentZoneInternal, _this).call(_this);
+            enterContentZone: function enterContentZone(filter_callback) {
+                _classPrivateFieldGet2(_enterContentZoneInternal, _this).call(_this, undefined, filter_callback);
             },
             refreshContentZone: function refreshContentZone() {
                 _classPrivateFieldGet2(_refreshContentZoneInternal, _this).call(_this);
@@ -4612,7 +4620,7 @@
                 _classPrivateFieldGet2(_exitContentZoneInternal, _this).call(_this);
             }
         });
-        _classPrivateFieldInitSpec(this, _enterContentZoneInternal, function (forced) {
+        _classPrivateFieldInitSpec(this, _enterContentZoneInternal, function (forced, filter_callback) {
             if (!isBrowser) {
                 _classPrivateFieldGet2(_log, _this).call(_this, logLevelEnums.WARNING, "content.enterContentZone, window object is not available. Not entering content zone.");
                 return;
@@ -4621,6 +4629,10 @@
                 _classPrivateFieldGet2(_log, _this).call(_this, logLevelEnums.DEBUG, "content.enterContentZone, Already in content zone");
                 return;
             }
+            if (filter_callback && typeof filter_callback == "function") {
+                _classPrivateFieldGet2(_log, _this).call(_this, logLevelEnums.DEBUG, "content.enterContentZone, Content filter callback is provided");
+                _classPrivateFieldSet2(_contentFilterCallback, _this, filter_callback);
+            }
             if (!_classPrivateFieldGet2(_initTimestamp, _this) || getMsTimestamp() - _classPrivateFieldGet2(_initTimestamp, _this) < 4000) {
                 // settimeout
                 _classPrivateFieldGet2(_log, _this).call(_this, logLevelEnums.DEBUG, "content.enterContentZone, Not enough time passed since initialization");
@@ -4711,6 +4723,22 @@
                     _classPrivateFieldGet2(_log, _this).call(_this, logLevelEnums.VERBOSE, "sendContentRequest, no html content or orientation to display");
                     return;
                 }
+
+                // Build query params
+                var queryParams = {};
+                var qIndex = response.html.indexOf("?");
+                if (qIndex !== -1) {
+                    var search = response.html.slice(qIndex + 1);
+                    new URLSearchParams(search).forEach(function (v, k) {
+                        queryParams[k] = v;
+                    });
+                }
+
+                // Filter check
+                if (_classPrivateFieldGet2(_contentFilterCallback, _this) && _classPrivateFieldGet2(_contentFilterCallback, _this).call(_this, queryParams) === false) {
+                    _classPrivateFieldGet2(_log, _this).call(_this, logLevelEnums.VERBOSE, "sendContentRequest, Content was filtered out by the content filter");
+                    return;
+                }
                 _classPrivateFieldGet2(_displayContent, _this).call(_this, response);
                 clearInterval(_classPrivateFieldGet2(_contentZoneTimer, _this)); // prevent multiple content requests while one is on
                 window.addEventListener('message', function (event) {
@@ -6487,6 +6515,7 @@
         _classPrivateFieldSet2(_SCBackoffRequestAge, this, 24); // 24 hours
         _classPrivateFieldSet2(_SCBackoffDuration, this, 60); // 60 seconds
         _classPrivateFieldSet2(_requestTimeoutDuration, this, 30000); // 30 seconds
+        _classPrivateFieldSet2(_contentFilterCallback, this, null);
         this.app_key = getConfig("app_key", _ob, null);
         this.url = stripTrailingSlash(getConfig("url", _ob, ""));
         this.serialize = getConfig("serialize", _ob, Countly.serialize);
diff --git a/lib/countly.min.js b/lib/countly.min.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ function initMain(name, version) {`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`const SDK_NAME = "javascript_native_web";`
`18`		`-const SDK_VERSION = "25.4.2";`
	`18`	`+const SDK_VERSION = "25.4.3";`
`19`	`19`
`20`	`20`	`// tests`
`21`	`21`	`describe("Bridged SDK Utilities Tests", () => {`