Feat: added SDKkey and environment key in project config (#265)

Author: mnoman09

OptimizelySDK.Tests/OptimizelyConfigTests/OptimizelyConfigTest.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2020, Optimizely
+ * Copyright 2020-2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -326,7 +326,7 @@ public void TestGetOptimizelyConfigService()
  };
 
  OptimizelyConfig optimizelyConfig = new OptimizelyConfigService(datafileProjectConfig).GetOptimizelyConfig();
- OptimizelyConfig expectedOptimizelyConfig = new OptimizelyConfig(datafileProjectConfig.Revision, experimentsMap, featuresMap);
+ OptimizelyConfig expectedOptimizelyConfig = new OptimizelyConfig(datafileProjectConfig.Revision, datafileProjectConfig.SDKKey, datafileProjectConfig.EnvironmentKey, experimentsMap, featuresMap);
  Assert.IsTrue(TestData.CompareObjects(optimizelyConfig, expectedOptimizelyConfig));
  }
 
@@ -338,10 +338,14 @@ public void TestGetOptimizelyConfigService()
  public void TestOptimizelyConfigEntity()
  {
  OptimizelyConfig expectedOptlyFeature = new OptimizelyConfig("123",
+ "testSdkKey",
+ "Development",
  new Dictionary<string, OptimizelyExperiment>(),
  new Dictionary<string, OptimizelyFeature>()
  );
  Assert.AreEqual(expectedOptlyFeature.Revision, "123");
+ Assert.AreEqual(expectedOptlyFeature.SDKKey, "testSdkKey");
+ Assert.AreEqual(expectedOptlyFeature.EnvironmentKey, "Development");
  Assert.AreEqual(expectedOptlyFeature.ExperimentsMap, new Dictionary<string, OptimizelyExperiment>());
  Assert.AreEqual(expectedOptlyFeature.FeaturesMap, new Dictionary<string, OptimizelyFeature>());
  }

OptimizelySDK.Tests/ProjectConfigTest.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2017-2020, Optimizely
+ * Copyright 2017-2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -63,6 +63,10 @@ public void TestInit()
  Assert.AreEqual("7720880029", Config.ProjectId);
  // Check Revision 
  Assert.AreEqual("15", Config.Revision);
+ // Check SDK key 
+ Assert.AreEqual("TestData", Config.SDKKey);
+ // Check Environment key 
+ Assert.AreEqual("Production", Config.EnvironmentKey);
  // Check SendFlagDecision
  Assert.IsTrue(Config.SendFlagDecisions);
 

OptimizelySDK.Tests/TestData.json

@@ -939,6 +939,8 @@
 }
 ],
 "revision": "15",
+"sdkKey": "TestData",
+"environmentKey": "Production",
 "anonymizeIP": false,
 "sendFlagDecisions": true,
 "botFiltering": true

OptimizelySDK.Tests/emptydatafile.json

@@ -11,5 +11,7 @@
  "attributes": [],
  "accountId": "10367498574",
  "events": [],
- "revision": "241"
+ "revision": "241",
+ "sdkKey": "emptydatafile",
+ "environmentKey": "Production"
 }

OptimizelySDK.Tests/typed_audience_datafile.json

@@ -367,5 +367,7 @@
 ]
 }
 ],
-"revision": "3"
-}
+"revision": "3",
+"sdkKey": "typedAudienceDatafile",
+"environmentKey": "Production"
+}

OptimizelySDK/Config/DatafileProjectConfig.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2019-2020, Optimizely
+ * Copyright 2019-2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -65,10 +65,20 @@ public enum OPTLYSDKVersion
 
 
  /// <summary>
- /// Revision of the dataflie.
+ /// Revision of the datafile.
  /// </summary>
  public string Revision { get; set; }
 
+ /// <summary>
+ /// SDK key of the datafile.
+ /// </summary>
+ public string SDKKey { get; set; }
+
+ /// <summary>
+ /// Environment key of the datafile.
+ /// </summary>
+ public string EnvironmentKey { get; set; }
+
  /// <summary>
  /// SendFlagDecisions determines whether impressions events are sent for ALL decision types.
  /// </summary>

OptimizelySDK/OptlyConfig/OptimizelyConfig.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2019-2020, Optimizely
+ * Copyright 2019-2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,18 +14,23 @@
  * limitations under the License.
  */
 
+using Newtonsoft.Json;
 using System.Collections.Generic;
 
 namespace OptimizelySDK.OptlyConfig
 {
  public class OptimizelyConfig
  {
  public string Revision { get; private set; }
+ [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+ public string SDKKey { get; private set; }
+ [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+ public string EnvironmentKey { get; private set; }
  public IDictionary<string, OptimizelyExperiment> ExperimentsMap { get; private set; }
  public IDictionary<string, OptimizelyFeature> FeaturesMap { get; private set; }
 
  private string _datafile;
-
+ 
  public OptimizelyConfig(string revision, IDictionary<string, OptimizelyExperiment> experimentsMap, IDictionary<string, OptimizelyFeature> featuresMap, string datafile = null)
  {
  Revision = revision;
@@ -34,6 +39,16 @@ public OptimizelyConfig(string revision, IDictionary<string, OptimizelyExperimen
  _datafile = datafile;
  }
 
+ public OptimizelyConfig(string revision, string sdkKey, string environmentKey, IDictionary<string, OptimizelyExperiment> experimentsMap, IDictionary<string, OptimizelyFeature> featuresMap, string datafile = null)
+ {
+ Revision = revision;
+ SDKKey = sdkKey;
+ EnvironmentKey = environmentKey;
+ ExperimentsMap = experimentsMap;
+ FeaturesMap = featuresMap;
+ _datafile = datafile;
+ }
+
  /// <summary>
  /// Get the datafile associated with OptimizelyConfig.
  /// </summary>

OptimizelySDK/OptlyConfig/OptimizelyConfigService.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2019-2020, Optimizely
+ * Copyright 2019-2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,6 +34,8 @@ public OptimizelyConfigService(ProjectConfig projectConfig)
  var experimentMap = GetExperimentsMap(projectConfig);
  var featureMap = GetFeaturesMap(projectConfig, experimentMap);
  OptimizelyConfig = new OptimizelyConfig(projectConfig.Revision,
+ projectConfig.SDKKey,
+ projectConfig.EnvironmentKey,
  experimentMap,
  featureMap,
  projectConfig.ToDatafile());

OptimizelySDK/ProjectConfig.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2019-2020, Optimizely
+ * Copyright 2019-2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,10 +40,19 @@ public interface ProjectConfig
 
 
  /// <summary>
- /// Revision of the dataflie.
+ /// Revision of the datafile.
  /// </summary>
  string Revision { get; set; }
 
+ /// <summary>
+ /// SDK key of the datafile.
+ /// </summary>
+ string SDKKey { get; set; }
+
+ /// <summary>
+ /// Environment key of the datafile.
+ /// </summary>
+ string EnvironmentKey { get; set; }
 
  /// <summary>
  /// SendFlagDecisions determines whether impressions events are sent for ALL decision types.