countly-sdk-web 22.6.1 → 22.6.3

package/.markdownlint.json

@@ -48,5 +48,5 @@
     "MD051": true,
     "MD052": true,
     "MD053": true
-    }
+}
   

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 22.06.3
+- Fixed an issue that arose when sending crashes through a gateway. User agent information is now sent as part of the request.
+
+## 22.06.2
+- ! Minor breaking change ! If no domain whitelist is provided for the heatmaps the SDK will fallback to your server url
+- Fixed a bug where heatmap files were susceptible to DOM XSS
+- Users can now input their domain whitelist for heatmaps feature during init
+- Implementing new Remote Config/AB testing API:
+  - Added an init time flag to enable/disable new remote config API (default: disabled)
+  - Added a new call to opt in users to the A/B testing for the given keys
+  - Added an init time flag to enable/disable automatically opting in users for A/B testing while fetching remote config (with new RC API)(default: enabled)
+
 ## 22.06.1
 - Added SDK calls to report Feedback widgets manually
 

package/README.md

@@ -1,76 +1,61 @@
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/79582b7ee7ca4021a3950376402fac00)](https://www.codacy.com/gh/Countly/countly-sdk-web/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Countly/countly-sdk-web&utm_campaign=Badge_Grade)
+[![npm version](https://badge.fury.io/js/countly-sdk-web.svg)](https://badge.fury.io/js/countly-sdk-web)
+[![js delivr](https://data.jsdelivr.com/v1/package/npm/countly-sdk-web/badge)](https://www.jsdelivr.com/package/npm/countly-sdk-web)
+
 # Countly Web SDK
- [![Codacy Badge](https://app.codacy.com/project/badge/Grade/79582b7ee7ca4021a3950376402fac00)](https://www.codacy.com/gh/Countly/countly-sdk-web/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Countly/countly-sdk-web&utm_campaign=Badge_Grade) [![npm version](https://badge.fury.io/js/countly-sdk-web.svg)](https://badge.fury.io/js/countly-sdk-web) [![](https://data.jsdelivr.com/v1/package/npm/countly-sdk-web/badge)](https://www.jsdelivr.com/package/npm/countly-sdk-web)
+
+This repository contains the Countly Web SDK, which can be integrated into websites and web applications. The Countly Web SDK is intended to be used with [Countly Community Edition](https://github.com/Countly/countly-server) or [Countly Enterprise Edition](https://count.ly/product).
 
 ## What is Countly?
-[Countly](http://count.ly) is a product analytics solution and innovation enabler that helps teams track product performance and customer journey and behavior across [mobile](https://count.ly/mobile-analytics), [web](http://count.ly/web-analytics), and [desktop](https://count.ly/desktop-analytics) applications. [Ensuring privacy by design](https://count.ly/your-data-your-rules), Countly allows you to innovate and enhance your products to provide personalized and customized customer experiences, and meet key business and revenue goals.
+[Countly](https://count.ly) is a product analytics solution and innovation enabler that helps teams track product performance and customer journey and behavior across [mobile](https://count.ly/mobile-analytics), [web](http://count.ly/web-analytics),
+and [desktop](https://count.ly/desktop-analytics) applications. [Ensuring privacy by design](https://count.ly/privacy-by-design), Countly allows you to innovate and enhance your products to provide personalized and customized customer experiences, and meet key business and revenue goals.
 
 Track, measure, and take action - all without leaving Countly.
 
-* **Slack user?** [Join our community](https://slack.count.ly) to ask questions and get answers!
-* **Questions?** [Ask in our Community forum](https://support.count.ly/hc/en-us/community/topics)
-
-## Implementing Countly SDK in your web pages
-There are 3 ways to get Countly SDK.
-
-### 1. Available with Countly server
-Since Countly server 16.02, Countly Web SDK is available in your Countly server installation in `countly/frontend/express/public/sdk/web/countly.min.js` which should be available through URL as `https://yourserver.com/sdk/web/countly.min.js`
-
-### 2. Installation using package managers
-    bower install countly-sdk-web
-or
-
-    npm install countly-sdk-web
-or
-
-    yarn add countly-sdk-web
+* **Slack user?** [Join our Slack Community](https://slack.count.ly)
+* **Questions or feature requests?** [Post in our Community Forum](https://support.count.ly/hc/en-us/community/topics)
+* **Looking for the Countly Server?** [Countly Community Edition repository](https://github.com/Countly/countly-server)
+* **Looking for other Countly SDKs?** [An overview of all Countly SDKs for mobile, web and desktop](https://support.count.ly/hc/en-us/articles/360037236571-Downloading-and-Installing-SDKs#officially-supported-sdks)
 
-### 3. Use a CDN (content delivery network)
-Countly web SDK is available on CDNJS. Use either
+## Integrating Countly SDK in your projects
 
-[https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/22.06.1/countly.min.js](https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/22.06.1/countly.min.js)
+For a detailed description on how to use this SDK [check out our documentation](https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-).
 
-or
+For information about how to add the SDK to your project, please check [this section of the documentation](https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-#adding-the-sdk-to-the-project).
 
-[https://cdn.jsdelivr.net/npm/countly-sdk-web@latest/lib/countly.min.js](https://cdn.jsdelivr.net/npm/countly-sdk-web@latest/lib/countly.min.js)
+You can reach minimal integration info for your website from [this section of the documentation](https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-#minimal-setup).
 
-## How to use Countly Web SDK?
-Link to the script and call helper methods based on what you want to track: sessions, views, clicks, custom events, user data, etc. and for much more information check out our documentation at [https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-](https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-)
+Countly Web SDK has JSDoc3 compatible comments, and you can generate documentation by running `npm run-script docs` or you can use [the online version](https://countly.github.io/countly-sdk-web/).
 
-You can reach minimal integration info for your website from here [https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-#minimal-setup](https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-#minimal-setup)
+For an example integration of this SDK, you can have a look [here](https://github.com/Countly/countly-sdk-web/tree/master/examples).
 
-Countly Web SDK has JSDoc3 compatible comments and you can generate documentation by running `npm run-script docs` or access online version at [https://countly.github.io/countly-sdk-web/](https://countly.github.io/countly-sdk-web/)
+This SDK supports the following features:
+* [Analytics](https://support.count.ly/hc/en-us/articles/4431589003545-Analytics)
+* [User Profiles](https://support.count.ly/hc/en-us/articles/4403281285913-User-Profiles)
+* [Crash Reports](https://support.count.ly/hc/en-us/articles/4404213566105-Crashes-Errors)
+* [A/B Testing](https://support.count.ly/hc/en-us/articles/4416496362393-A-B-Testing-)
+* [Performance Monitoring](https://support.count.ly/hc/en-us/articles/4734457847705-Performance)
+* [Feedback Widgets](https://support.count.ly/hc/en-us/articles/4652903481753-Feedback-Surveys-NPS-and-Ratings-)
 
 ## Security
 Security is very important to us. If you discover any issue regarding security, please disclose the information responsibly by sending an email to security@count.ly and **not by creating a GitHub issue**.
 
-## Other Github resources
-Check Countly Community Edition source code here:
-
-* [Countly Server](https://github.com/Countly/countly-server)
-
-There are also other Countly SDK repositories below:
-
-* [Countly iOS SDK](https://github.com/Countly/countly-sdk-ios)
-* [Countly Android SDK](https://github.com/Countly/countly-sdk-android)
-* [Countly Windows Phone SDK](https://github.com/Countly/countly-sdk-windows-phone)
-* [Countly Appcelerator Titanium SDK](https://github.com/euforic/Titanium-Count.ly) (Community supported)
-* [Countly Unity3D SDK](https://github.com/Countly/countly-sdk-unity) (Community supported)
-
-## How can I help you with your efforts?
-Glad you asked. We need ideas, feedbacks and constructive comments. All your suggestions will be taken care with upmost importance. We are on [Twitter](http://twitter.com/gocountly) and [Facebook](https://www.facebook.com/Countly) if you would like to keep up with our fast progress!
-
 ## Badges
-If you like Countly, [why not use one of our badges](https://count.ly/brand-assets) and give a link back to us, so others know about this wonderful platform?
+If you like Countly, [why not use one of our badges](https://count.ly/brand-assets) and give a link back to us so others know about this wonderful platform?
 
 <a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg?v2" alt="Countly - Product Analytics" /></a>
 
-    <a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg" alt="Countly - Product Analytics" /></a>
+```JS
+<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg" alt="Countly - Product Analytics" /></a>
+```
 
 <a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg?v2" alt="Countly - Product Analytics" /></a>
 
-    <a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg" alt="Countly - Product Analytics" /></a>
+```JS
+<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg" alt="Countly - Product Analytics" /></a>
+```
 
-## Support
-For a public community support page, visit [https://support.count.ly/hc/en-us/community/topics](https://support.count.ly/hc/en-us/community/topics "Countly Community Forum").
+## How can I help you with your efforts?
+Glad you asked! We need ideas, feedback and constructive comments. All your suggestions will be taken care of with utmost importance. For feature requests and engaging with the community, join [our Slack Community](https://slack.count.ly) or [Community Forum](https://support.count.ly/hc/en-us/community/topics).
 
-[![NPM](https://nodei.co/npm/countly-sdk-web.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/countly-sdk-web/)
+We are on [Twitter](http://twitter.com/gocountly), [Facebook](https://www.facebook.com/Countly) and [LinkedIn](https://www.linkedin.com/company/countly) if you would like to keep up with Countly related updates.

package/cypress/integration/crashes.js

@@ -0,0 +1,36 @@
+/* eslint-disable require-jsdoc */
+var Countly = require("../../lib/countly");
+var hp = require("../support/helper");
+
+function initMain() {
+    Countly.init({
+        app_key: "YOUR_APP_KEY",
+        url: "https://try.count.ly",
+        test_mode: true
+    });
+}
+
+function cause_error() {
+    // eslint-disable-next-line no-undef
+    undefined_function();
+}
+
+describe("Crashes tests ", () => {
+    it("Checks if a caught crash is reported correctly", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            Countly.track_errors();
+            try {
+                cause_error();
+            }
+            catch (err) {
+                Countly.log_error(err);
+            }
+            cy.wait(3000).then(() => {
+                cy.fetch_local_request_queue().then((rq) => {
+                    cy.check_crash(rq[0], hp.appKey);
+                });
+            });
+        });
+    });
+});

package/cypress/support/commands.js

@@ -33,6 +33,32 @@ Cypress.Commands.add("check_request_commons", (testObject, appKey) => {
     expect(testObject.sdk_version).to.be.ok;
 });
 
+/**
+ * Checks a crash request for valid/correct formation
+ * @param {Object} testObject - crash object to be checked
+ */
+Cypress.Commands.add("check_crash", (testObject, appKey) => {
+    appKey = appKey || hp.appKey;
+    const metrics = JSON.parse(testObject.metrics);
+    const crash = JSON.parse(testObject.crash);
+    const metricKeys = Object.keys(metrics);
+    cy.check_request_commons(testObject, appKey);
+    cy.check_commons(testObject);
+    expect(metrics._ua).to.be.exist;
+    expect(metricKeys.length).to.equal(1);
+    expect(crash._app_version).to.be.exist;
+    expect(crash._background).to.be.exist;
+    expect(crash._error).to.be.exist;
+    expect(crash._javascript).to.be.exist;
+    expect(crash._nonfatal).to.be.exist;
+    expect(crash._not_os_specific).to.be.exist;
+    expect(crash._online).to.be.exist;
+    expect(crash._opengl).to.be.exist;
+    expect(crash._resolution).to.be.exist;
+    expect(crash._run).to.be.exist;
+    expect(crash._view).to.be.exist;
+});
+
 /**
  * Checks a queue object for valid/correct begin session, end session and session extension values 
  * @param {Object} queue - queue object to check

package/examples/example_remote_config.html

@@ -13,6 +13,8 @@
             app_key: "YOUR_APP_KEY",
             url: "https://try.count.ly", //your server goes here
             debug: true,
+            rc_automatic_optin_for_ab: true, // set it to false for not opting in users for AB testing while fetching the remote config (only with latest API)
+            use_explicit_rc_api: false, // set it to true to use the latest API
             remote_config: function (err, configs) {
                 //handle initial remote configs here
                 console.log(err, configs);
@@ -31,19 +33,25 @@
     <center>
         <img src="./images/team_countly.jpg" id="wallpaper" />
         <br />
-        <input type="button" onclick="reloadConfig()" value="Reload Config">
+        <input type="button" onclick="fetchConfig()" value="Fetch Config">
         <input type="button" onclick="getConfig()" value="Get Config">
         <input type="button" onclick="getConfig('test')" value="Get config for key Test">
+        <input type="button" onclick="ab(['key1','key2'])" value="Enroll user to AB test">
         <p><a href='http://count.ly/'>Count.ly</a></p>
     </center>
     <script type='text/javascript'>
-        //reload configs
-        function reloadConfig(ob) {
+        // fetches all keys
+        function fetchConfig() {
             Countly.fetch_remote_config(function (err, config) {
                 alert(JSON.stringify(config));
             });
         }
 
+        // enroll user
+        function ab(keyArray) {
+            Countly.enrollUserToAb(keyArray);
+        }
+
         //get config
         function getConfig(key) {
             alert(JSON.stringify(Countly.get_remote_config(key)));

package/examples/react/package.json

@@ -6,7 +6,7 @@
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^13.3.0",
     "@testing-library/user-event": "^14.2.1",
-    "countly-sdk-web": "^22.02.4",
+    "countly-sdk-web": "^22.06.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-router-dom": "^5.3.3",

package/examples/symbolication/package.json

@@ -10,8 +10,8 @@
     "build": "webpack"
   },
   "devDependencies": {
-    "@babel/core": "^7.18.9",
-    "@babel/preset-env": "^7.18.9",
+    "@babel/core": "^7.19.1",
+    "@babel/preset-env": "^7.19.1",
     "@webpack-cli/init": "^1.1.3",
     "babel-loader": "^8.2.5",
     "babel-plugin-syntax-dynamic-import": "^6.18.0",

package/lib/countly.js

@@ -175,7 +175,7 @@
     */
     Countly.onload = Countly.onload || [];
 
-    var SDK_VERSION = "22.06.1";
+    var SDK_VERSION = "22.06.3";
     var SDK_NAME = "javascript_native_web";
 
     var urlParseRE = /^(((([^:\/#\?]+:)?(?:(\/\/)((?:(([^:@\/#\?]+)(?:\:([^:@\/#\?]+))?)@)?(([^:\/#\?\]\[]+|\[[^\/\]@#?]+\])(?:\:([0-9]+))?))?)?)?((\/?(?:[^\/\?#]+\/+)*)([^\?#]*)))?(\?[^#]+)?)(#.*)?/;
@@ -255,6 +255,8 @@
             this.onload = getConfig("onload", ob, []);
             this.utm = getConfig("utm", ob, { source: true, medium: true, campaign: true, term: true, content: true });
             this.ignore_prefetch = getConfig("ignore_prefetch", ob, true);
+            this.rcAutoOptinAb = getConfig("rc_automatic_optin_for_ab", ob, true);
+            this.useExplicitRcApi = getConfig("use_explicit_rc_api", ob, false);
             this.debug = getConfig("debug", ob, false);
             this.test_mode = getConfig("test_mode", ob, false);
             this.metrics = getConfig("metrics", ob, {});
@@ -278,6 +280,7 @@
             this.maxBreadcrumbCount = getConfig("max_breadcrumb_count", ob, null);
             this.maxStackTraceLinesPerThread = getConfig("max_stack_trace_lines_per_thread", ob, configurationDefaultValues.MAX_STACKTRACE_LINES_PER_THREAD);
             this.maxStackTraceLineLength = getConfig("max_stack_trace_line_length", ob, configurationDefaultValues.MAX_STACKTRACE_LINE_LENGTH);
+            this.heatmapWhitelist = getConfig("heatmap_whitelist", ob, []);
 
             if (maxCrashLogs && !this.maxBreadcrumbCount) {
                 this.maxBreadcrumbCount = maxCrashLogs;
@@ -291,6 +294,11 @@
                 lsSupport = false;
             }
 
+            if (!this.rcAutoOptinAb && !this.useExplicitRcApi) {
+                log(logLevelEnums.WARNING, "initialize, Auto opting is disabled, switching to explicit RC API");
+                this.useExplicitRcApi = true;
+            }
+
             if (!Array.isArray(ignoreReferrers)) {
                 ignoreReferrers = [];
             }
@@ -341,11 +349,25 @@
                         setToken(this.passed_data.token);
                         setValueInStorage("cly_old_token", this.passed_data.token);
                     }
-                    this.passed_data.url = this.passed_data.url || this.url;
-                    if (this.passed_data.purpose === "heatmap") {
-                        this.ignore_visitor = true;
-                        showLoader();
-                        loadJS(this.passed_data.url + "/views/heatmap.js", hideLoader);
+                    var strippedList = [];
+                    // if whitelist is provided is an array
+                    if (Array.isArray(this.heatmapWhitelist)) {
+                        this.heatmapWhitelist.push(this.url);
+                        strippedList = this.heatmapWhitelist.map(function(e) {
+                            // remove trailing slashes from the entries
+                            return stripTrailingSlash(e);
+                        });
+                    }
+                    else {
+                        strippedList = [this.url];
+                    }
+                    // if the passed url is in the whitelist proceed
+                    if (strippedList.includes(this.passed_data.url)) {
+                        if (this.passed_data.purpose === "heatmap") {
+                            this.ignore_visitor = true;
+                            showLoader();
+                            loadJS(this.passed_data.url + "/views/heatmap.js", hideLoader);
+                        }
                     }
                 }
             }
@@ -394,6 +416,10 @@
             if (this.test_mode) {
                 log(logLevelEnums.WARNING, "initialize, test_mode:[" + this.test_mode + "], queues won't be processed");
             }
+            // if test mode is enabled warn the user
+            if (this.heatmapWhitelist) {
+                log(logLevelEnums.DEBUG, "initialize, heatmap whitelist:[" + JSON.stringify(this.heatmapWhitelist) + "], these domains will be whitelisted");
+            }
             // if storage is se to something other than local storage
             if (this.storage !== "default") {
                 log(logLevelEnums.DEBUG, "initialize, storage is set to:[" + this.storage + "]");
@@ -407,6 +433,12 @@
             if (this.remote_config) {
                 log(logLevelEnums.DEBUG, "initialize, remote_config callback provided:[" + !!this.remote_config + "]");
             }
+            if (typeof this.rcAutoOptinAb === "boolean") {
+                log(logLevelEnums.DEBUG, "initialize, automatic RC optin is enabled:[" + this.rcAutoOptinAb + "]");
+            }
+            if (!this.useExplicitRcApi) {
+                log(logLevelEnums.WARNING, "initialize, will use legacy RC API. Consider enabling new API during init with use_explicit_rc_api flag");
+            }
             if (this.track_domains) {
                 log(logLevelEnums.DEBUG, "initialize, tracking domain info:[" + this.track_domains + "]");
             }
@@ -419,6 +451,9 @@
             if (offlineMode) {
                 log(logLevelEnums.DEBUG, "initialize, offline_mode:[" + offlineMode + "], user info won't be send to the servers");
             }
+            if (offlineMode) {
+                log(logLevelEnums.DEBUG, "initialize, stored remote configs:[" + JSON.stringify(remoteConfigs) + "]");
+            }
             // functions, if provided, would be printed as true without revealing their content
             log(logLevelEnums.DEBUG, "initialize, 'getViewName' callback override provided:[" + !!this.getViewName + "]");
             log(logLevelEnums.DEBUG, "initialize, 'getSearchQuery' callback override provided:[" + !!this.getSearchQuery + "]");
@@ -671,6 +706,8 @@
             self.ip_address = undefined;
             self.ignore_bots = undefined;
             self.force_post = undefined;
+            self.rcAutoOptinAb = undefined;
+            self.useExplicitRcApi = undefined;
             self.remote_config = undefined;
             self.ignore_visitor = undefined;
             self.require_consent = undefined;
@@ -1063,6 +1100,7 @@
                     // start new session for new ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                     this.begin_session(!autoExtend, true);
                 }
+                // if init time remote config was enabled with a callback function, remove currently stored remote configs and fetch remote config again
                 if (this.remote_config) {
                     remoteConfigs = {};
                     setValueInStorage("cly_remote_configs", remoteConfigs);
@@ -1579,46 +1617,102 @@
                 crashLogs.push(record);
             }
         };
-
         /**
-        * Fetch remote config
+        * Fetch remote config from the server (old one for method=fetch_remote_config API)
         * @param {array=} keys - Array of keys to fetch, if not provided will fetch all keys
         * @param {array=} omit_keys - Array of keys to omit, if provided will fetch all keys except provided ones
         * @param {function=} callback - Callback to notify with first param error and second param remote config object
         * */
         this.fetch_remote_config = function(keys, omit_keys, callback) {
-            log(logLevelEnums.INFO, "fetch_remote_config, Fetching remote config");
-            if (this.check_consent(featureEnums.REMOTE_CONFIG)) {
-                var request = {
-                    method: "fetch_remote_config"
-                };
-                if (this.check_consent(featureEnums.SESSIONS)) {
-                    request.metrics = JSON.stringify(getMetrics());
+            var keysFiltered = null;
+            var omitKeysFiltered = null;
+            var callbackFiltered = null;
+
+            // check first param is truthy
+            if (keys) {
+                // if third parameter is falsy and first param is a function assign it as the callback function
+                if (!callback && typeof keys === "function") {
+                    callbackFiltered = keys;
                 }
-                if (keys) {
-                    if (!callback && typeof keys === "function") {
-                        callback = keys;
-                        keys = null;
-                    }
-                    else if (Array.isArray(keys) && keys.length) {
-                        log(logLevelEnums.INFO, "fetch_remote_config, Keys to fetch: [ " + keys + " ]");
-                        request.keys = JSON.stringify(keys);
-                    }
+                // else if first param is an array assign it as 'keys'
+                else if (Array.isArray(keys)) {
+                    keysFiltered = keys;
                 }
-                if (omit_keys) {
-                    log(logLevelEnums.INFO, "fetch_remote_config, Keys to omit: [ " + omit_keys + " ]");
-                    if (!callback && typeof omit_keys === "function") {
-                        callback = omit_keys;
-                        omit_keys = null;
-                    }
-                    else if (Array.isArray(omit_keys) && omit_keys.length) {
-                        request.omit_keys = JSON.stringify(omit_keys);
-                    }
+            }
+            // check second param is truthy
+            if (omit_keys) {
+                // if third parameter is falsy and second param is a function assign it as the callback function
+                if (!callback && typeof omit_keys === "function") {
+                    callbackFiltered = omit_keys;
+                }
+                // else if second param is an array assign it as 'omit_keys'
+                else if (Array.isArray(omit_keys)) {
+                    omitKeysFiltered = omit_keys;
                 }
+            }
+            // assign third param as a callback function if it was not assigned yet in first two params
+            if (!callbackFiltered && typeof callback === "function") {
+                callbackFiltered = callback;
+            }
+
+            // use new RC API
+            if (this.useExplicitRcApi) {
+                log(logLevelEnums.INFO, "fetch_remote_config, Fetching remote config");
+                // opt in is true(1) or false(0)
+                var opt = this.rcAutoOptinAb ? 1 : 0;
+                fetch_remote_config_explicit(keysFiltered, omitKeysFiltered, opt, null, callbackFiltered);
+                return;
+            }
+
+            log(logLevelEnums.WARNING, "fetch_remote_config, Fetching remote config, with legacy API");
+            fetch_remote_config_explicit(keysFiltered, omitKeysFiltered, null, "legacy", callbackFiltered);
+        };
+
+        /**
+        * Fetch remote config from the server (new one with method=rc API)
+        * @param {array=} keys - Array of keys to fetch, if not provided will fetch all keys
+        * @param {array=} omit_keys - Array of keys to omit, if provided will fetch all keys except provided ones
+        * @param {number=} optIn - an inter to indicate if the user is opted in for the AB testing or not (1 is opted in, 0 is opted out)
+        * @param {string=} api - which API to use, if not provided would use default ("legacy" is for method="fetch_remote_config", default is method="rc")
+        * @param {function=} callback - Callback to notify with first param error and second param remote config object
+        * */
+        function fetch_remote_config_explicit(keys, omit_keys, optIn, api, callback) {
+            log(logLevelEnums.INFO, "fetch_remote_config_explicit, Fetching sequence initiated");
+            var request = {
+                method: "rc"
+            };
+            // check if keys were provided
+            if (keys.length > 0) {
+                request.keys = JSON.stringify(keys);
+            }
+            // check if omit_keys were provided
+            if (omit_keys.length > 0) {
+                request.omit_keys = JSON.stringify(omit_keys);
+            }
+            var providedCall;
+            // legacy api prompt check
+            if (api === "legacy") {
+                request.method = "fetch_remote_config";
+            }
+            // opted out/in check
+            if (optIn === 0) {
+                request.oi = 0;
+            }
+            if (optIn === 1) {
+                request.oi = 1;
+            }
+            // callback check
+            if (typeof callback === "function") {
+                providedCall = callback;
+            }
+            if (self.check_consent(featureEnums.SESSIONS)) {
+                request.metrics = JSON.stringify(getMetrics());
+            }
+            if (self.check_consent(featureEnums.REMOTE_CONFIG)) {
                 prepareRequest(request);
-                sendXmlHttpRequest("fetch_remote_config", this.url + readPath, request, function(err, params, responseText) {
+                sendXmlHttpRequest("fetch_remote_config_explicit", self.url + readPath, request, function(err, params, responseText) {
                     if (err) {
-                        log(logLevelEnums.ERROR, "fetch_remote_config, An error occurred: " + err);
+                        log(logLevelEnums.ERROR, "fetch_remote_config_explicit, An error occurred: " + err);
                         return;
                     }
                     try {
@@ -1636,30 +1730,61 @@
                         setValueInStorage("cly_remote_configs", remoteConfigs);
                     }
                     catch (ex) {
-                        log(logLevelEnums.ERROR, "fetch_remote_config, Had an issue while parsing the response: " + ex);
+                        log(logLevelEnums.ERROR, "fetch_remote_config_explicit, Had an issue while parsing the response: " + ex);
                     }
-                    if (typeof callback === "function") {
-                        log(logLevelEnums.INFO, "fetch_remote_config, Callback function is provided");
-                        callback(err, remoteConfigs);
+                    if (providedCall) {
+                        log(logLevelEnums.INFO, "fetch_remote_config_explicit, Callback function is provided");
+                        providedCall(err, remoteConfigs);
                     }
                 // JSON array can pass    
                 }, true);
             }
             else {
-                log(logLevelEnums.ERROR, "fetch_remote_config, Remote config requires explicit consent");
-                if (typeof callback === "function") {
-                    callback(new Error("Remote config requires explicit consent"), remoteConfigs);
+                log(logLevelEnums.ERROR, "fetch_remote_config_explicit, Remote config requires explicit consent");
+                if (providedCall) {
+                    providedCall(new Error("Remote config requires explicit consent"), remoteConfigs);
                 }
             }
+        }
+
+        /**
+        * AB testing key provider, opts the user in for the selected keys
+        * @param {array=} keys - Array of keys opt in FOR
+        * */
+        this.enrollUserToAb = function(keys) {
+            log(logLevelEnums.INFO, "enrollUserToAb, Providing AB test keys to opt in for");
+            if (!keys || !Array.isArray(keys) || keys.length === 0) {
+                log(logLevelEnums.ERROR, "enrollUserToAb, No keys provided");
+                return;
+            }
+            var request = {
+                method: "ab",
+                keys: JSON.stringify(keys)
+            };
+            prepareRequest(request);
+            sendXmlHttpRequest("enrollUserToAb", this.url + readPath, request, function(err, params, responseText) {
+                if (err) {
+                    log(logLevelEnums.ERROR, "enrollUserToAb, An error occurred: " + err);
+                    return;
+                }
+                try {
+                    var resp = JSON.parse(responseText);
+                    log(logLevelEnums.DEBUG, "enrollUserToAb, Parsed the response's result: [" + resp.result + "]");
+                }
+                catch (ex) {
+                    log(logLevelEnums.ERROR, "enrollUserToAb, Had an issue while parsing the response: " + ex);
+                }
+                // JSON array can pass    
+            }, true);
         };
 
         /**
-        * Get Remote config object or specific value for provided key
+        * Gets remote config object (all key/value pairs) or specific value for provided key from the storage
         * @param {string=} key - if provided, will return value for key, or return whole object
         * @returns {object} remote configs
         * */
         this.get_remote_config = function(key) {
-            log(logLevelEnums.INFO, "get_remote_config, Getting remote config");
+            log(logLevelEnums.INFO, "get_remote_config, Getting remote config from storage");
             if (typeof key !== "undefined") {
                 return remoteConfigs[key];
             }
@@ -3227,7 +3352,12 @@
                     log(logLevelEnums.ERROR, "Could not get the experimental-webgl context: " + ex);
                 }
 
-                toRequestQueue({ crash: JSON.stringify(obj) });
+                // send userAgent string with the crash object incase it gets removed by a gateway
+                var req = {};
+                req.crash = JSON.stringify(obj);
+                req.metrics = JSON.stringify({ _ua: metrics._ua });
+
+                toRequestQueue(req);
             }
         };
 
@@ -4279,12 +4409,15 @@
      * @param {number} [conf.max_stack_trace_line_length=200] - maximum amount of characters are allowed per stack trace line. This limits also the crash message length
      * @param {array=} conf.ignore_referrers - array with referrers to ignore
      * @param {boolean} [conf.ignore_prefetch=true] - ignore prefetching and pre rendering from counting as real website visits
+     * @param {boolean} [conf.rc_automatic_optin_for_ab=true] - opts in the user for A/B testing while fetching the remote config (if true)
+     * @param {boolean} [conf.use_explicit_rc_api=false] - set it to true to use the new remote config API
      * @param {boolean} [conf.force_post=false] - force using post method for all requests
      * @param {boolean} [conf.ignore_visitor=false] - ignore this current visitor
      * @param {boolean} [conf.require_consent=false] - Pass true if you are implementing GDPR compatible consent management. It would prevent running any functionality without proper consent
      * @param {boolean} [conf.utm={"source":true, "medium":true, "campaign":true, "term":true, "content":true}] - Object instructing which UTM parameters to track
      * @param {boolean} [conf.use_session_cookie=true] - Use cookie to track session
      * @param {boolean} [conf.enable_orientation_tracking=true] - Enables orientation tracking at the start of a session
+     * @param {array=} [conf.heatmap_whitelist=[]] - array with trustable domains for heatmap reporting
      * @param {number} [conf.session_cookie_timeout=30] - How long till cookie session should expire in minutes
      * @param {boolean|function} [conf.remote_config=false] - Enable automatic remote config fetching, provide callback function to be notified when fetching done
      * @param {string=} [conf.namespace=""] - Have separate namespace of of persistent data
@@ -4448,8 +4581,10 @@
      *  @returns {String} modified string
      */
     function stripTrailingSlash(str) {
-        if (str.substr(str.length - 1) === "/") {
-            return str.substr(0, str.length - 1);
+        if (typeof str === "string") {
+            if (str.substring(str.length - 1) === "/") {
+                return str.substring(0, str.length - 1);
+            }
         }
         return str;
     }