feat: support for salting

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.5.0] - 2024-03-12
+
+### Added
+
+- Added the support for using salt for bucketing if provided in the rule configuration.
+
 ## [1.4.0] - 2024-03-04
 
 ### Added

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.4.0</Version>
+    <Version>1.5.0</Version>
     <Authors>VWO devs</Authors>
     <Company>Wingify</Company>
     <Product>VWO</Product>

VWOFmeSdk/Models/Campaign.cs

@@ -39,6 +39,7 @@ public class Campaign
         private int endRangeVariation = 0;
         private List<Variable> variables;
         private double weight;
+        private string salt;
 
         public int Id
         {
@@ -136,6 +137,12 @@ public int EndRangeVariation
             set { endRangeVariation = value; }
         }
 
+        public string Salt
+        {
+            get { return salt; }
+            set { salt = value; }
+        }
+
         public void SetModelFromDictionary(Campaign model)
         {
             if (model.Id != 0)
@@ -185,6 +192,10 @@ public void SetModelFromDictionary(Campaign model)
 
             if (model.EndRangeVariation != 0)
                 endRangeVariation = model.EndRangeVariation;
+            
+            if(model.Salt != null) {
+                salt = model.Salt;
+            }
         }
     }
 }

VWOFmeSdk/Models/Variation.cs

@@ -34,6 +34,7 @@ public class Variation
         private Dictionary<string, object> segments = new Dictionary<string, object>();
         private string ruleKey;
         private string type;
+        private string salt;
 
         public int Id
         {
@@ -95,10 +96,16 @@ public string RuleKey
             set { ruleKey = value; }
         }
 
-         public string Type
+        public string Type
         {
             get { return type; }
             set { type = value; }
         }
+
+        public string Salt
+        {
+            get { return salt; }
+            set { salt = value; }
+        }
     }
 }

VWOFmeSdk/Services/CampaignDecisionService.cs

@@ -26,6 +26,7 @@
 using VWOFmeSdk.Packages.DecisionMaker;
 using VWOFmeSdk.Packages.Logger.Enums;
 using VWOFmeSdk.Packages.SegmentationEvaluator.Core;
+using Newtonsoft.Json;
 
 namespace VWOFmeSdk.Services
 {
@@ -38,22 +39,24 @@ public class CampaignDecisionService
         /// <param name="campaign"></param>
         public bool IsUserPartOfCampaign(string userId, Campaign campaign)
         {
-            if (campaign == null || userId == null)
+            if (campaign == null || string.IsNullOrEmpty(userId))
             {
                 return false;
             }
 
-            double trafficAllocation;
-            if (campaign.Type == CampaignTypeEnum.ROLLOUT.GetValue() || campaign.Type == CampaignTypeEnum.PERSONALIZE.GetValue())
-            {
-                trafficAllocation = campaign.Variations[0].Weight;
-            }
-            else
-            {
-                trafficAllocation = campaign.PercentTraffic;
-            }
+            // Determine if the campaign is of type ROLLOUT or PERSONALIZE
+            bool isRolloutOrPersonalize = campaign.Type == CampaignTypeEnum.ROLLOUT.GetValue() || campaign.Type == CampaignTypeEnum.PERSONALIZE.GetValue();
 
-            int valueAssignedToUser = new DecisionMaker().GetBucketValueForUser(campaign.Id + "_" + userId);
+            // Get the salt based on the campaign type
+            string salt = isRolloutOrPersonalize ? campaign.Variations[0].Salt : campaign.Salt;
+
+            // Get the traffic allocation based on the campaign type
+            double trafficAllocation = isRolloutOrPersonalize ? campaign.Variations[0].Weight : campaign.PercentTraffic;
+
+            // Build the bucket key
+            string bucketKey = !string.IsNullOrEmpty(salt) ? $"{salt}_{userId}" : $"{campaign.Id}_{userId}";
+
+            int valueAssignedToUser = new DecisionMaker().GetBucketValueForUser(bucketKey);
             bool isUserPart = valueAssignedToUser != 0 && valueAssignedToUser <= trafficAllocation;
 
             LoggerService.Log(LogLevelEnum.INFO, "USER_PART_OF_CAMPAIGN", new Dictionary<string, string>
@@ -109,14 +112,22 @@ public Variation CheckInRange(Variation variation, int bucketValue)
         /// <param name="campaign"></param>
         public Variation BucketUserToVariation(string userId, string accountId, Campaign campaign)
         {
-            if (campaign == null || userId == null)
+            if (campaign == null || string.IsNullOrEmpty(userId))
             {
                 return null;
             }
 
             int multiplier = campaign.PercentTraffic != 0 ? 1 : 0;
             int percentTraffic = campaign.PercentTraffic;
-            long hashValue = new DecisionMaker().GenerateHashValue(campaign.Id + "_" + accountId + "_" + userId);
+
+            // Get salt
+            string salt = campaign.Salt;
+
+            // Get bucket key
+            string bucketKey = !string.IsNullOrEmpty(salt) ? $"{salt}_{accountId}_{userId}" : $"{campaign.Id}_{accountId}_{userId}";
+
+            // Generate hash value
+            long hashValue = new DecisionMaker().GenerateHashValue(bucketKey);
             int bucketValue = new DecisionMaker().GenerateBucketValue(hashValue, ConstantsNamespace.Constants.MAX_TRAFFIC_VALUE, multiplier);
 
             LoggerService.Log(LogLevelEnum.DEBUG, "USER_BUCKET_TO_VARIATION", new Dictionary<string, string>

VWOFmeSdk/Utils/CampaignUtil.cs

@@ -116,7 +116,24 @@ public static void ScaleVariationWeights(List<Variation> variations)
         /// <returns>The bucketing seed.</returns>
         public static string GetBucketingSeed(string userId, Campaign campaign, int? groupId)
         {
-            return groupId.HasValue ? $"{groupId}_{userId}" : $"{campaign.Id}_{userId}";
+            //return groupId.HasValue ? $"{groupId}_{userId}" : $"{campaign.Id}_{userId}";
+            if(groupId.HasValue) {
+                return $"{groupId}_{userId}";
+            }
+
+              // Determine if the campaign is of type ROLLOUT or PERSONALIZE
+            bool isRolloutOrPersonalize = campaign.Type == CampaignTypeEnum.ROLLOUT.GetValue() || campaign.Type == CampaignTypeEnum.PERSONALIZE.GetValue();
+
+            // Get the salt based on the campaign type
+            string salt = isRolloutOrPersonalize ? campaign.Variations[0].Salt : campaign.Salt;
+
+            if (!string.IsNullOrEmpty(salt))
+            {
+                return $"{salt}_{userId}";
+            } else {
+                return $"{campaign.Id}_{userId}";
+            }
+
         }
 
         /// <summary>