feat: support for webhook

Author: sakshamg1304

CHANGELOG.md

@@ -5,6 +5,10 @@ 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.4.0] - 2024-03-04
+
+### Added
+- added new method `updateSettings` to update settings on the vwo client instance.
 
 ## [1.3.0] - 2024-11-11
 

VWOFmeSdk/Constants/Constants.cs

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

VWOFmeSdk/Packages/Logger/Messages/info-messages.json

@@ -1,6 +1,7 @@
 {
   "ON_INIT_ALREADY_RESOLVED": "[INFO]: VWO-SDK {date} {apiName} already resolved",
   "ON_INIT_SETTINGS_FAILED": "[INFO]: VWO-SDK {date} VWO settings could not be fetched",
+  "SETTINGS_UPDATED_SUCCESSFULLY" : "Settings File Updated Successfully",
 
   "POLLING_SET_SETTINGS": "There's a change in settings from the last settings fetched. Hence, instantiating a new VWO client internally",
   "POLLING_NO_CHANGE_IN_SETTINGS": "No change in settings with the last settings fetched. Hence, not instantiating new VWO client",

VWOFmeSdk/Services/SettingsManager.cs

@@ -132,7 +132,7 @@ private string FetchSettingsAndCacheInStorage()
          * Fetches settings from the server
          * @return settings
          */
-        private string FetchSettings()
+        public string FetchSettings(bool isViaWebhook = false)
         {
             if (sdkKey == null || accountId == null)
             {
@@ -148,9 +148,13 @@ private string FetchSettings()
                 options.Add("s", "prod");
             }
 
+            string path = isViaWebhook 
+                ? ConstantsNamespace.Constants.WEBHOOK_SETTINGS_ENDPOINT 
+                : ConstantsNamespace.Constants.SETTINGS_ENDPOINT;
+
             try
             {
-                RequestModel request = new RequestModel(hostname, "GET", ConstantsNamespace.Constants.SETTINGS_ENDPOINT, options, null, null, this.protocol, port);
+                RequestModel request = new RequestModel(hostname, "GET", path, options, null, null, this.protocol, port);
                 request.SetTimeout(networkTimeout);
 
                 ResponseModel response = networkInstance.Get(request);

VWOFmeSdk/VWOClient.cs

@@ -32,6 +32,7 @@ namespace VWOFmeSdk
 {
     public class VWOClient
     {
+        private static VWOClient vwoClientInstance;
         private Settings processedSettings;
         public string Settings { get; private set; }
         private VWOInitOptions options;
@@ -40,8 +41,6 @@ public class VWOClient
             MissingMemberHandling = MissingMemberHandling.Ignore
         };
 
-        public static ObjectMapper ObjectMapper { get; } = new ObjectMapper();
-
         /// <summary>
         /// Constructor to initialize the VWOClient
         /// </summary>
@@ -64,6 +63,8 @@ public VWOClient(string settings, VWOInitOptions options)
                 UrlService.Init(this.processedSettings.CollectionPrefix);
                 // Init SDKMetaUtil and set SDK version
                 LoggerService.Log(LogLevelEnum.INFO, "CLIENT_INITIALIZED", null);
+
+                vwoClientInstance = this;
             }
             catch (Exception exception)
             {
@@ -82,13 +83,59 @@ public void UpdateSettings(string newSettings)
             {
                 this.processedSettings = JsonConvert.DeserializeObject<Settings>(newSettings, JsonSerializerSettings);
                 SettingsUtil.ProcessSettings(this.processedSettings);
+                LoggerService.Log(LogLevelEnum.INFO, "SETTINGS_UPDATED_SUCCESSFULLY", null);
             }
             catch (Exception exception)
             {
                 LoggerService.Log(LogLevelEnum.ERROR, "Exception occurred while updating settings: " + exception.Message);
             }
         }
 
+        /// <summary>
+        /// This method is used to update the settings by fetching from server (overloaded method with no parameters).
+        /// </summary>
+        /// <returns>Updated settings in JSON string format</returns>
+        public string UpdateSettings()
+        {
+            return UpdateSettings(true); 
+        }
+
+        /// <summary>
+        /// This method is used to update the settings.
+        /// </summary>
+        /// <param name="isViaWebhook">Boolean value to indicate if the settings are being fetched via webhook</param>
+        /// <returns>Updated settings in JSON string format</returns>
+        public string UpdateSettings(bool isViaWebhook)
+        {
+            string apiName = "updateSettings";
+            try
+            {
+                // Fetch the new settings from the server based on the webhook flag
+                this.Settings = SettingsManager.GetInstance().FetchSettings(isViaWebhook);
+                UpdateSettings(this.Settings);  // Call the method that takes a settings string
+                return this.Settings;
+            }
+            catch (Exception exception)
+            {
+                LoggerService.Log(LogLevelEnum.ERROR, "SETTINGS_FETCH_FAILED", new Dictionary<string, string>
+                {
+                    { "apiName", apiName },
+                    { "isViaWebhook", isViaWebhook.ToString() },
+                    { "err", exception.ToString() }
+                });
+                return null;
+            }
+        }
+
+        /// <summary>
+        /// Static method to get the VWOClient instance
+        /// </summary>
+        /// <returns>VWOClient instance</returns>
+        public static VWOClient GetInstance()
+        {
+            return vwoClientInstance;
+        }
+
         /// <summary>
         /// This method is used to get the flag value for the given feature key
         /// </summary>
@@ -205,8 +252,7 @@ public Dictionary<string, bool> TrackEvent(string eventName, VWOContext context,
         }
 
         /// <summary>
-        /// Overloaded function for no event properties
-        /// calls track method to track the event
+        /// Overloaded function when no event properties are required
         /// </summary>
         /// <param name="eventName">Event name to be tracked</param>
         /// <param name="context">User context</param>
@@ -215,73 +261,5 @@ public Dictionary<string, bool> TrackEvent(string eventName, VWOContext context)
         {
             return Track(eventName, context, new Dictionary<string, object>());
         }
-
-        /// <summary>
-        /// Sets an attribute for a user in the context provided.
-        /// This method validates the types of the inputs before proceeding with the API call.
-        /// </summary>
-        /// <param name="attributeKey">The key of the attribute to set</param>
-        /// <param name="attributeValue">The value of the attribute to set</param>
-        /// <param name="context">User context</param>
-        public void SetAttribute(string attributeKey, string attributeValue, VWOContext context)
-        {
-            string apiName = "setAttribute";
-            try
-            {
-                LoggerService.Log(LogLevelEnum.DEBUG, "API_CALLED", new Dictionary<string, string> { { "apiName", apiName } });
-                if (!DataTypeUtil.IsString(attributeKey))
-                {
-                    LoggerService.Log(LogLevelEnum.ERROR, "API_INVALID_PARAM", new Dictionary<string, string>
-                    {
-                        { "apiName", apiName },
-                        { "key", "attributeKey" },
-                        { "type", DataTypeUtil.GetType(attributeKey) },
-                        { "correctType", "String" }
-                    });
-                    throw new ArgumentException("TypeError: attributeKey should be a string");
-                }
-
-                if (!DataTypeUtil.IsString(attributeValue))
-                {
-                    LoggerService.Log(LogLevelEnum.ERROR, "API_INVALID_PARAM", new Dictionary<string, string>
-                    {
-                        { "apiName", apiName },
-                        { "key", "attributeValue" },
-                        { "type", DataTypeUtil.GetType(attributeValue) },
-                        { "correctType", "String" }
-                    });
-                    throw new ArgumentException("TypeError: attributeValue should be a string");
-                }
-
-                if (context == null || string.IsNullOrEmpty(context.Id))
-                {
-                    throw new ArgumentException("User ID is required");
-                }
-
-                if (this.processedSettings == null || !new SettingsSchema().IsSettingsValid(this.processedSettings))
-                {
-                    LoggerService.Log(LogLevelEnum.ERROR, "SETTINGS_SCHEMA_INVALID", null);
-                    return;
-                }
-
-                SetAttributeAPI.SetAttribute(this.processedSettings, attributeKey, attributeValue, context);
-            }
-            catch (Exception exception)
-            {
-                LoggerService.Log(LogLevelEnum.ERROR, "API_THROW_ERROR", new Dictionary<string, string>
-                {
-                    { "apiName", apiName },
-                    { "err", exception.ToString() }
-                });
-            }
-        }
-    }
-
-    public class ObjectMapper
-    {
-        public Dictionary<string, object> ConvertValue<T>(T value)
-        {
-            return JsonConvert.DeserializeObject<Dictionary<string, object>>(JsonConvert.SerializeObject(value));
-        }
     }
-}
+}