feat: update settings on vwo client with or without webhook

Author: Abhi591

CHANGELOG.md

@@ -5,6 +5,11 @@ 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.8.0] - 2025-05-20
+
+### Added
+- added new method `updateSettings` to update settings on the vwo client instance.
+
 ## [1.7.0] - 2025-05-12
 
 ### Added
@@ -198,4 +203,4 @@ Send event properties as third param in trackEvent() call`
   vwInitOptions.setSdkKey("sdk-key");
   vwInitOptions.setAccountId(1234);
   vwInitOptions.setPollInterval(60);
-  ```
+  ```

src/main/java/com/vwo/VWOClient.java

@@ -33,6 +33,7 @@
 import com.vwo.utils.SDKMetaUtil;
 import com.vwo.utils.SettingsUtil;
 import com.vwo.services.BatchEventQueue;
+import com.vwo.services.SettingsManager;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -76,19 +77,6 @@ public void setBatchEventQueue(BatchEventQueue batchEventQueue) {
         this.batchEventQueue = batchEventQueue;
     }
 
-    /**
-     * This method is used to update the settings
-     * @param newSettings New settings to be updated
-     */
-    public void updateSettings(String newSettings) {
-        try {
-            this.processedSettings = objectMapper.readValue(newSettings, Settings.class);
-            SettingsUtil.processSettings(this.processedSettings);
-        } catch (Exception exception) {
-            LoggerService.log(LogLevelEnum.ERROR, "Exception occurred while updating settings " + exception.getMessage());
-        }
-    }
-
     /**
      * This method is used to get the flag value for the given feature key
      * @param featureKey Feature key for which the flag value is to be fetched
@@ -287,4 +275,87 @@ public boolean flushEvents() {
             return false;
         }
     }
+
+     /**
+     * This method is used to update the settings on the VWOClient instance
+     * It validates the new settings and updates the processedSettings
+     * @param newSettings New settings to be updated
+     */
+    private void updateSettingsOnVWOClient(String newSettings) {
+        try {
+            if (newSettings == null || newSettings.isEmpty()) {
+                throw new IllegalArgumentException("Settings cannot be empty");
+            }
+            // Read the new settings and update the processedSettings
+            this.processedSettings = objectMapper.readValue(newSettings, Settings.class);
+
+            // Check if the new settings are valid
+            boolean settingsValid = new SettingsSchema().isSettingsValid(this.processedSettings);
+            if (settingsValid) {
+                // Process the new settings and update the client instance
+                SettingsUtil.processSettings(this.processedSettings);
+            } else {
+                throw new IllegalStateException("Settings schema is invalid");
+            }
+        } catch (Exception exception) {
+            throw new IllegalStateException(exception.getMessage());
+        }
+    }
+
+    /**
+     * This method is used to update the settings by fetching from server
+     */
+    public String updateSettings() {
+        return this.updateSettings(true);
+    }
+
+    /**
+     * This method is used to update the settings with provided settings string
+     * @param settings New settings to be updated
+     */
+    public String updateSettings(String settings) {
+        String apiName = "updateSettings";
+        try {
+            LoggerService.log(LogLevelEnum.DEBUG, "API_CALLED", new HashMap<String, String>() {{
+                put("apiName", apiName);
+            }});
+
+            String settingsToUpdate = settings;
+            if (settings == null || settings.isEmpty()) {
+                settingsToUpdate = this.updateSettings(true);
+            }
+            // Update the settings on the VWOClient instance
+            this.updateSettingsOnVWOClient(settingsToUpdate);
+            LoggerService.log(LogLevelEnum.INFO, "SETTINGS_UPDATED", new HashMap<String, String>() {{
+                put("apiName", apiName);
+            }});
+            return settingsToUpdate;
+        } catch (Exception exception) {
+            LoggerService.log(LogLevelEnum.ERROR, "SETTINGS_FETCH_FAILED", new HashMap<String, String>() {{
+                put("apiName", apiName);
+                put("err", exception.toString());
+            }});
+            return null;
+        }
+    }
+
+    /**
+     * This method is used to update the settings
+     * @param isViaWebhook Boolean value to indicate if the settings are being fetched via webhook
+     */
+    public String updateSettings(Boolean isViaWebhook) {
+        String apiName = "updateSettings";
+        try {
+            // Fetch the new settings from the server
+            this.settings = SettingsManager.getInstance().fetchSettings(isViaWebhook);
+            return this.updateSettings(this.settings);
+        } catch (Exception exception) {
+            LoggerService.log(LogLevelEnum.ERROR, "SETTINGS_FETCH_FAILED", new HashMap<String, String>() {{
+                put("apiName", apiName);
+                put("isViaWebhook", isViaWebhook.toString());
+                put("err", exception.toString());
+            }});
+            return null;
+        }
+    }
 }

src/main/java/com/vwo/constants/Constants.java

@@ -33,6 +33,7 @@ public class Constants {
 
   public static final String HOST_NAME = "dev.visualwebsiteoptimizer.com";
   public static final String SETTINGS_ENDPOINT = "/server-side/v2-settings";
+  public static final String WEBHOOK_SETTINGS_ENDPOINT = "/server-side/v2-pull";
 
   public static final String VWO_FS_ENVIRONMENT = "vwo_fs_environment";
   public static final String HTTPS_PROTOCOL = "https";

src/main/java/com/vwo/models/BatchEventData.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024 Wingify Software Pvt. Ltd.
+ * Copyright 2024-2025 Wingify Software Pvt. Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/vwo/models/FlushInterface.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024 Wingify Software Pvt. Ltd.
+ * Copyright 2024-2025 Wingify Software Pvt. Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/vwo/services/BatchEventQueue.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024 Wingify Software Pvt. Ltd.
+ * Copyright 2024-2025 Wingify Software Pvt. Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/vwo/services/SettingsManager.java

@@ -90,7 +90,7 @@ public static SettingsManager getInstance() {
      */
     private String fetchSettingsAndCacheInStorage() {
         try {
-            return fetchSettings();
+            return fetchSettings(false);
         } catch (Exception e) {
             LoggerService.log(LogLevelEnum.ERROR, "SETTINGS_FETCH_ERROR", new HashMap<String, String>() {
                 {
@@ -105,7 +105,7 @@ private String fetchSettingsAndCacheInStorage() {
      * Fetches settings from the server
      * @return settings
      */
-    private String fetchSettings() {
+    public String fetchSettings(Boolean isViaWebhook) {
         if (sdkKey == null || accountId == null) {
             throw new IllegalArgumentException("SDK Key and Account ID are required to fetch settings. Aborting!");
         }
@@ -118,8 +118,13 @@ private String fetchSettings() {
             options.put("s", "prod");
         }
 
+        String endpoint = Constants.SETTINGS_ENDPOINT;
+        if (isViaWebhook) {
+            endpoint = Constants.WEBHOOK_SETTINGS_ENDPOINT;
+        }
+
         try {
-            RequestModel request = new RequestModel(hostname, "GET", Constants.SETTINGS_ENDPOINT, options, null, null, this.protocol, port);
+            RequestModel request = new RequestModel(hostname, "GET", endpoint, options, null, null, this.protocol, port);
             request.setTimeout(networkTimeout);
 
             ResponseModel response = networkInstance.get(request);

src/main/resources/error-messages.json

@@ -23,5 +23,6 @@
 
   "GATEWAY_URL_ERROR": "Please provide a valid URL for VWO Gateway Service",
 
-  "NETWORK_CALL_FAILED": "Error occurred while sending {method} request. Error: {err}"
-}
+  "NETWORK_CALL_FAILED": "Error occurred while sending {method} request. Error: {err}",
+  "SETTINGS_FETCH_FAILED": "Failed to fetch settings and hence VWO client instance couldn't be updated when API: {apiName} got called having isViaWebhook param as {isViaWebhook}. Error: {err}"
+}

src/main/resources/info-messages.json

@@ -27,5 +27,6 @@
   "MEG_SKIP_ROLLOUT_EVALUATE_EXPERIMENTS": "No rollout rule found for feature:{featureKey}. Hence, evaluating experiments",
   "MEG_CAMPAIGN_FOUND_IN_STORAGE": "Campaign {campaignKey} found in storage for user ID:{userId}",
   "MEG_CAMPAIGN_ELIGIBLE": "Campaign {campaignKey} is eligible for user ID:{userId}",
-  "MEG_WINNER_CAMPAIGN": "MEG: Campaign {campaignKey} is the winner for group {groupId} for user ID:{userId} {algo}"
-}
+  "MEG_WINNER_CAMPAIGN": "MEG: Campaign {campaignKey} is the winner for group {groupId} for user ID:{userId} {algo}",
+  "SETTINGS_UPDATED": "Settings fetched and updated successfully on the current VWO client instance when API: {apiName} got called having isViaWebhook param as {isViaWebhook}"
+}