feat: support for proxy url for bypassing ad-blockers

Author: Abhi591

CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.73.0] - 2025-08-18
+
+### Added
+
+- Added support for redirecting all network calls through a custom proxy URL for browser environments. This feature allows users to route all SDK network requests (settings, tracking, etc.) through their own proxy server. This is particularly useful for bypassing ad-blockers that may interfere with VWO's default network requests.
+
+```javascript
+const settingsFile = await vwoSdk.getSettingsFile(accountId, sdkKey, null, { proxyUrl: 'http://localhost:3000' });
+
+// If you are not calling getSettingsFile and are using locally stored settings, 
+// you can pass the proxyUrl directly in the launch method.
+const clientInstance = vwoSdk.launch({
+  settingsFile: localSettings,       // local json parsed settings
+  proxyUrl: 'http://localhost:3000', // your custome proxy url here
+});
+```
+
 ## [1.72.0] - 2025-02-25
 
 ### Feat

dist/vwo-javascript-sdk.js

@@ -51,6 +51,12 @@ class VWO {
     this.logger = config.logger;
     this.returnPromiseFor = config.returnPromiseFor;
     this.asyncStorageConfig = config.asyncStorageConfig;
+    this.proxyUrl = config.proxyUrl;
+
+    // set proxy url in the settings file if it is provided
+    if (config.settingsFile && DataTypeUtil.isObject(config.settingsFile) && this.proxyUrl) {
+      config.settingsFile.proxyUrl = this.proxyUrl;
+    }
     this.optOut = false;
 
     if (this.userStorageService === undefined && config.asyncStorageConfig) {

dist/vwo-javascript-sdk.js.map

@@ -51,5 +51,6 @@ module.exports = {
   HTTPS_PROTOCOL: 'https://',
 
   SDK_QUERY_PARAM: 'sdk',
-  SDK_VERSION_QUERY_PARAM: 'sdk-v'
+  SDK_VERSION_QUERY_PARAM: 'sdk-v',
+  SERVER_SIDE: 'server-side'
 };

dist/vwo-javascript-sdk.min.js

@@ -22,7 +22,14 @@ declare module 'vwo-node-sdk' {
    *
    * @returns           Settings file.
    */
-  export function getSettingsFile(accountId: string, apiKey: string, userStorageService?: VWOUserStorageConfig): Promise<object>;
+  export function getSettingsFile(accountId: string, apiKey: string, userStorageService?: VWOUserStorageConfig, config?: VWOGetSettingsFileExternalConfig): Promise<object>;
+
+  /**
+   * VWO Get Settings File Configuration
+   */
+  export interface VWOGetSettingsFileExternalConfig {
+    proxyUrl?: string;
+  }
 
   /**
    * Creates an instance of the VWO
@@ -391,6 +398,11 @@ declare module 'vwo-node-sdk' {
        */
       callback?: (properties: Record<string, any>) => void;
     };
+
+    /**
+     * Proxy URL for the VWO SDK
+     */
+    proxyUrl?: string;
   }
 
   // For synchronous code

dist/vwo-javascript-sdk.min.js.map

@@ -69,7 +69,7 @@ let ImpressionUtil = {
    */
   buildEventForPushing(configObj, tagKey, tagValue, userId) {
     const properties = Object.assign({}, getBaseProperties(configObj, userId));
-    properties.url = Constants.HTTPS_PROTOCOL + UrlService.getBaseUrl() + UrlEnum.PUSH;
+    properties.url = this._buildUrlWithProxy(configObj, UrlEnum.PUSH);
     properties.tags = JSON.stringify({
       u: {
         [encodeURIComponent(tagKey)]: encodeURIComponent(tagValue)
@@ -143,7 +143,7 @@ let ImpressionUtil = {
       usageStats
     );
     properties.ed = JSON.stringify({ p: 'server' });
-    properties.url = Constants.HTTPS_PROTOCOL + UrlService.getBaseUrl() + UrlEnum.TRACK_USER;
+    properties.url = this._buildUrlWithProxy(configObj, UrlEnum.TRACK_USER);
 
     logger.log(
       LogLevelEnum.DEBUG,
@@ -229,7 +229,7 @@ let ImpressionUtil = {
 
     properties.visitor_ua = visitorUserAgent;
     properties.visitor_ip = userIpAddress;
-    properties.url = Constants.HTTPS_PROTOCOL + UrlService.getBaseUrl() + UrlEnum.TRACK_GOAL;
+    properties.url = this._buildUrlWithProxy(configObj, UrlEnum.TRACK_GOAL);
 
     properties['goal_id'] = goalId;
     if (goal.type === GoalTypeEnum.REVENUE && ValidateUtil.isValidValue(revenue)) {
@@ -337,7 +337,8 @@ let ImpressionUtil = {
       usageStats
     );
 
-    properties.url = Constants.HTTPS_PROTOCOL + UrlService.getBaseUrl() + UrlEnum.EVENTS;
+    properties.url = this._buildUrlWithProxy(config, UrlEnum.EVENTS);
+
     return properties;
   },
 
@@ -513,6 +514,27 @@ let ImpressionUtil = {
     const logProperties = Object.assign({}, properties);
     delete logProperties.env;
     return JSON.stringify(logProperties);
+  },
+
+  /**
+   * Builds the url with proxy url if it is provided
+   * @param {Object} configObj
+   * @param {String} event
+   * @returns {String} url with proxy url if it is provided
+   */
+  _buildUrlWithProxy(configObj, event) {
+    let url = Constants.HTTPS_PROTOCOL + UrlService.getBaseUrl() + event;
+    // if we are in browser environment and not in serverless environment
+    if (typeof process.env === 'undefined' && typeof XMLHttpRequest !== 'undefined') {
+      if (configObj.proxyUrl) {
+        if (configObj.collectionPrefix) {
+          url = configObj.proxyUrl + '/' + configObj.collectionPrefix + event;
+        } else {
+          url = configObj.proxyUrl + event;
+        }
+      }
+    }
+    return url;
   }
 };
 

lib/VWO.js

@@ -48,18 +48,24 @@ let SettingsFileUtil = {
       hostname = config.hostname || hostname;
       path = config.path || path;
     }
+    let url;
+    if (config.proxyUrl) {
+      url = `${config.proxyUrl}${path}`;
+    } else {
+      url = `${protocol}://${hostname}${path}`;
+    }
 
     if (typeof process.env === 'undefined') {
       if (typeof XMLHttpRequest === 'undefined') {
         return require('./FetchUtil').send({
           method: 'GET',
-          url: `${protocol}://${hostname}${path}`,
+          url: url,
           userStorageService
         });
       }
       return require('./XhrUtil').send({
         method: 'GET',
-        url: `${protocol}://${hostname}${path}`,
+        url: url,
         userStorageService
       });
     } else {