feat: feature Usage

Author: sakshamg1304

CHANGELOG.md

@@ -5,6 +5,12 @@ 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.1] - 2025-05-21
+
+### Added
+
+- Added a feature to track and collect usage statistics related to various SDK features and configurations which can be useful for analytics, and gathering insights into how different features are being utilized by end users.
+
 ## [1.8.0] - 2025-05-21
 
 ### Added
@@ -123,4 +129,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
   // Send attribute data
   vwoInstance.SetAttribute("attribute-key", "attribute-value" , context);
-  ```
+  ```

VWOFmeSdk.NetStandard2.0/VWOFmeSdk.NetStandard2.0.csproj

@@ -6,7 +6,7 @@
     <AssemblyName>VWOFmeSdk</AssemblyName>
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackageId>VWO.FME.Sdk</PackageId>
-    <Version>1.8.0</Version>
+    <Version>1.8.1</Version>
     <Authors>VWO devs</Authors>
     <Company>Wingify</Company>
     <Product>VWO</Product>

VWOFmeSdk/Models/Request/Props.cs

@@ -49,6 +49,9 @@ public class Props
         [JsonProperty("data")]
         public object Data { get; set; } // Added explicitly for "data"
 
+        [JsonProperty("vwoMeta")]
+        public Dictionary<string, object> VwoMeta { get; set; }
+
         [JsonExtensionData]
         public Dictionary<string, object> AdditionalProperties { get; set; } = new Dictionary<string, object>();
     }

VWOFmeSdk/Models/User/VWOInitOptions.cs

@@ -37,6 +37,8 @@ public class VWOInitOptions
         private VWOBuilder vwoBuilder;
         private Dictionary<string, object> gatewayService = new Dictionary<string, object>();
         private BatchEventData batchEventData;
+        private bool isUsageStatsDisabled;
+        private Dictionary<string, object> vwoMetaData = new Dictionary<string, object>();
 
         private string settings;
 
@@ -111,5 +113,17 @@ public BatchEventData BatchEventData
             get { return batchEventData; }
             set { batchEventData = value; }
         }
+        
+        public bool IsUsageStatsDisabled
+        {
+            get { return isUsageStatsDisabled; }
+            set { isUsageStatsDisabled = value; }
+        }
+
+        public Dictionary<string, object> VwoMetaData
+        {
+            get { return vwoMetaData; }
+            set { vwoMetaData = value; }
+        }
     }
-}
+}

VWOFmeSdk/Packages/Logger/Enums/LogLevelNumberEnum.cs

@@ -20,10 +20,10 @@ namespace VWOFmeSdk.Packages.Logger.Enums
 {
     public enum LogLevelNumberEnum
     {
-        Trace = 0,
-        Debug = 1,
-        Info = 2,
-        Warn = 3,
-        Error = 4
+        TRACE = 0,
+        DEBUG = 1,
+        INFO = 2,
+        WARN = 3,
+        ERROR = 4
     }
 }

VWOFmeSdk/Packages/NetworkLayer/Manager/NetworkManager.cs

@@ -25,6 +25,7 @@
 using VWOFmeSdk.Services;
 using VWOFmeSdk.Packages.Logger.Enums;
 using VWOFmeSdk.Interfaces.Batching;
+using VWOFmeSdk.Utils;
 
 namespace VWOFmeSdk.Packages.NetworkLayer.Manager
 {
@@ -153,7 +154,17 @@ public ResponseModel Post(RequestModel request, IFlushInterface flushCallback =
         /// <param name="request">The RequestModel containing the URL, headers, and body of the POST request.</param>
         public void PostAsync(RequestModel request)
         {
-            executorService.StartNew(() => Post(request));
+            executorService.StartNew(() => 
+            {
+                var response = Post(request);
+                if (response != null && response.GetStatusCode() >= 200 && response.GetStatusCode() <= 299)
+                {
+                    if (UsageStatsUtil.GetInstance().GetUsageStats().Count > 0)
+                    {
+                        UsageStatsUtil.GetInstance().ClearUsageStats();
+                    }
+                }
+            });
         }
     }
 }

VWOFmeSdk/Utils/NetworkUtil.cs

@@ -186,6 +186,11 @@ public static Dictionary<string, object> GetTrackUserPayloadData(Settings settin
             properties.D.Event.Props.Id = campaignId;
             properties.D.Event.Props.Variation = variationId.ToString(CultureInfo.InvariantCulture);
             properties.D.Event.Props.IsFirst = 1;
+            
+            if (UsageStatsUtil.GetInstance().GetUsageStats().Count > 0)
+            {
+                properties.D.Event.Props.VwoMeta = UsageStatsUtil.GetInstance().GetUsageStats();
+            }
 
             LoggerService.Log(LogLevelEnum.DEBUG, "IMPRESSION_FOR_TRACK_USER", new Dictionary<string, string>
             {

VWOFmeSdk/Utils/UsageStatsUtil.cs

@@ -0,0 +1,126 @@
+using System;
+using System.Collections.Generic;
+using VWOFmeSdk.Models.User;
+using VWOFmeSdk.Packages.Logger.Enums;
+
+namespace VWOFmeSdk.Utils
+{
+    /// <summary>
+    /// Manages usage statistics for the SDK.
+    /// Tracks various features and configurations being used by the client.
+    /// Implements Singleton pattern to ensure a single instance.
+    /// </summary>
+    public class UsageStatsUtil
+    {
+        /// <summary>
+        /// Singleton instance
+        /// </summary>
+        private static UsageStatsUtil _instance;
+
+        /// <summary>
+        /// Internal storage for usage statistics data
+        /// </summary>
+        private Dictionary<string, object> _usageStatsData;
+
+        /// <summary>
+        /// Private constructor to prevent direct instantiation
+        /// </summary>
+        private UsageStatsUtil()
+        {
+            _usageStatsData = new Dictionary<string, object>();
+        }
+
+        /// <summary>
+        /// Provides access to the singleton instance of UsageStatsUtil
+        /// </summary>
+        /// <returns>The single instance of UsageStatsUtil</returns>
+        public static UsageStatsUtil GetInstance()
+        {
+            if (_instance == null)
+            {
+                _instance = new UsageStatsUtil();
+            }
+            return _instance;
+        }
+
+        /// <summary>
+        /// Sets usage statistics based on provided options
+        /// </summary>
+        /// <param name="options">Configuration options for the SDK</param>
+        public void SetUsageStats(VWOInitOptions options)
+        {
+            var data = new Dictionary<string, object>();
+
+            // Map configuration options to usage stats flags
+            if (options.Integrations != null) data["ig"] = 1;
+
+            // Check if the logger has transports in it
+            if (options.Logger != null && options.Logger is Dictionary<string, object> loggerDict)
+            {
+                if (loggerDict.ContainsKey("transport") || loggerDict.ContainsKey("transports"))
+                {
+                    data["cl"] = 1;
+                }
+            }
+
+            // Check the logger level
+            if (options.Logger != null && options.Logger is Dictionary<string, object> loggerMap)
+            {
+                if (loggerMap.ContainsKey("level"))
+                {
+                    string level = loggerMap["level"].ToString();
+                    try
+                    {
+                        if (Enum.TryParse<LogLevelNumberEnum>(level.ToUpper(), out var logLevelEnum))
+                        {
+                            data["ll"] = (int)logLevelEnum;
+                        }
+                        else
+                        {
+                            data["ll"] = -1;
+                        }
+                    }
+                    catch
+                    {
+                        data["ll"] = -1;
+                    }
+                }
+            }
+
+            if (options.Storage != null) data["ss"] = 1;
+            if (options.GatewayService != null) data["gs"] = 1;
+            if (options.PollInterval != null) data["pi"] = 1;
+
+            // Handle _vwo_meta
+            if (options.VwoMetaData != null && options.VwoMetaData is Dictionary<string, object> vwoMetaMap)
+            {
+                if (vwoMetaMap.ContainsKey("ea"))
+                {
+                    data["_ea"] = 1;
+                }
+            }
+
+            // Get .NET version
+            data["lv"] = Environment.Version.ToString();
+
+            _usageStatsData = data;
+        }
+
+        /// <summary>
+        /// Retrieves the current usage statistics
+        /// </summary>
+        /// <returns>Dictionary containing flags for various SDK features in use</returns>
+        public Dictionary<string, object> GetUsageStats()
+        {
+            return new Dictionary<string, object>(_usageStatsData);
+        }
+
+        /// <summary>
+        /// Clears the usage statistics data
+        /// </summary>
+        public void ClearUsageStats()
+        {
+            _usageStatsData.Clear();
+        }
+    }
+}

VWOFmeSdk/VWO.cs

@@ -61,7 +61,8 @@ private static VWO SetInstance(VWOInitOptions options)
                 .SetStorage()
                 .SetNetworkManager()
                 .SetSegmentation()
-                .InitPolling();
+                .InitPolling()
+                .InitUsageStats();
 
             string settings;
             if (!string.IsNullOrEmpty(options.Settings))

VWOFmeSdk/VWOBuilder.cs

@@ -31,6 +31,7 @@
 using VWOFmeSdk.Services;
 using VWOFmeSdk.Constants;
 using ConstantsNamespace = VWOFmeSdk.Constants;
+using VWOFmeSdk.Utils;
 
 namespace VWOFmeSdk
 {
@@ -355,6 +356,23 @@ public VWOBuilder InitBatching()
             return this;
         }
 
+        /// <summary>
+        /// Initializes the usage stats for the VWO instance.
+        /// </summary>
+        /// <returns>The instance of this builder.</returns>
+        public VWOBuilder InitUsageStats()
+        {
+            // if usageStatsDisabled is not null and is true, then return
+            if (this.options.IsUsageStatsDisabled)
+            {
+                return this;
+            }
+            
+            UsageStatsUtil.GetInstance().SetUsageStats(this.options);
+            
+            return this;
+        } 
+
         /// <summary>
         /// Checks and polls for settings updates at the provided interval.
         /// </summary>
@@ -413,4 +431,4 @@ private static Dictionary<string, object> ConvertLoggerOptions(Dictionary<string
             return convertedLoggerOptions;
         }
     }
-}
+}