feat: content filter callback

Author: arifBurakDemiray

CHANGELOG.md

@@ -1,4 +1,9 @@
-## X.X.X
+## XX.XX.XX
+
+* Added a new init time config option for filtering contents:
+  * `content_filter_callback`
+
+## 25.4.2
 
 * Mitigated an issue where manual feedback reporting could have failed
 * Mitigated a possible issue with request timeouts in IE11

modules/CountlyClass.js

@@ -88,6 +88,7 @@ class CountlyClass {
     #contentZoneTimer;
     #contentIframeID;
     #crashFilterCallback;
+    #contentFilterCallback;
     #serverConfigCache;
     #SCNetwork;
     #SCSizeReqQueue;
@@ -169,6 +170,7 @@ class CountlyClass {
         this.#contentZoneTimer = null;
         this.#contentIframeID = "cly-content-iframe";
         this.#crashFilterCallback = null;
+        this.#contentFilterCallback = null;
         this.#SCNetwork = true;
         this.#SCSizeReqQueue = getConfig("queue_size", ob, configurationDefaultValues.QUEUE_SIZE);
         this.#SCSizeEventBatch = getConfig("max_events", ob, configurationDefaultValues.MAX_EVENT_BATCH);
@@ -443,6 +445,7 @@ class CountlyClass {
         this.hcConsecutiveBackoffCount = this.#getValueFromStorage(healthCheckCounterEnum.consecutiveBackoffCount) || 0;
         this.#lastRequestWasBackoff = false; // Track if the previous request resulted in a backoff
         this.#crashFilterCallback = getConfig("crash_filter_callback", ob, null);
+        this.#contentFilterCallback = getConfig("content_filter_callback", ob, null);
 
         if (this.storage === "cookie") {
             this.#lsSupport = false;
@@ -4087,6 +4090,24 @@ class CountlyClass {
                 return;
             }
 
+            // Build query params
+            const queryParams = { type: "content" };
+
+            const qIndex = response.html.indexOf("?");
+            if (qIndex !== -1) {
+                const search = response.html.slice(qIndex + 1);
+                new URLSearchParams(search).forEach((v, k) => {
+                    queryParams[k] = v;
+                });
+            }
+
+            // Filter check
+            if (typeof this.#contentFilterCallback === "function" &&
+                this.#contentFilterCallback(queryParams) === false) {
+                this.#log(logLevelEnums.VERBOSE, "sendContentRequest, Content was filtered out by the content filter");
+                return;
+            }
+
             this.#displayContent(response);
             clearInterval(this.#contentZoneTimer); // prevent multiple content requests while one is on
             window.addEventListener('message', (event) => {