Feat: added SDKkey and environment in datafile (#417)

Author: yasirfolio3

Sources/Data Model/Project.swift

@@ -43,6 +43,8 @@ struct Project: Codable, Equatable {
     var featureFlags: [FeatureFlag]
     var botFiltering: Bool?
     var sendFlagDecisions: Bool?
+    var sdkKey: String?
+    var environmentKey: String?
 
     let logger = OPTLoggerFactory.getLogger()
 
@@ -53,7 +55,7 @@ struct Project: Codable, Equatable {
         // V3
         case anonymizeIP
         // V4
-        case rollouts, typedAudiences, featureFlags, botFiltering, sendFlagDecisions
+        case rollouts, typedAudiences, featureFlags, botFiltering, sendFlagDecisions, sdkKey, environmentKey
     }
 
     // Required since logger is not equatable
@@ -62,7 +64,7 @@ struct Project: Codable, Equatable {
             lhs.audiences == rhs.audiences && lhs.groups == rhs.groups && lhs.attributes == rhs.attributes &&
             lhs.accountId == rhs.accountId && lhs.events == rhs.events && lhs.revision == rhs.revision &&
             lhs.anonymizeIP == rhs.anonymizeIP && lhs.rollouts == rhs.rollouts && lhs.typedAudiences == rhs.typedAudiences &&
-            lhs.featureFlags == rhs.featureFlags && lhs.botFiltering == rhs.botFiltering && lhs.sendFlagDecisions == rhs.sendFlagDecisions
+            lhs.featureFlags == rhs.featureFlags && lhs.botFiltering == rhs.botFiltering && lhs.sendFlagDecisions == rhs.sendFlagDecisions && lhs.sdkKey == rhs.sdkKey && lhs.environmentKey == rhs.environmentKey
     }
 }
 

Sources/Optimizely/OptimizelyConfig+ObjC.swift

@@ -20,7 +20,9 @@ import Foundation
 
 @objc(OptimizelyConfig)
 public protocol ObjcOptimizelyConfig {
+    var environmentKey: String { get }
     var revision: String { get }
+    var sdkKey: String { get }
     var experimentsMap: [String: ObjcOptimizelyExperiment] { get }
     var featuresMap: [String: ObjcOptimizelyFeature] { get }
 }
@@ -59,12 +61,16 @@ public protocol ObjcOptimizelyVariable {
 // MARK: - Implementations for Objective-C support
 
 class ObjcOptimizelyConfigImp: NSObject, ObjcOptimizelyConfig {
+    public var environmentKey: String
     public var revision: String
+    public var sdkKey: String
     public var experimentsMap: [String: ObjcOptimizelyExperiment]
     public var featuresMap: [String: ObjcOptimizelyFeature]
 
     public init(_ optimizelyConfig: OptimizelyConfig) {
+        self.environmentKey = optimizelyConfig.environmentKey
         self.revision = optimizelyConfig.revision
+        self.sdkKey = optimizelyConfig.sdkKey
         self.experimentsMap = optimizelyConfig.experimentsMap.mapValues { ObjcExperiment($0) }
         self.featuresMap = optimizelyConfig.featuresMap.mapValues { ObjcFeature($0) }
     }

Sources/Optimizely/OptimizelyConfig.swift

@@ -19,7 +19,9 @@ import Foundation
 /// A data model of public project configuration
 
 public protocol OptimizelyConfig {
+    var environmentKey: String { get }
     var revision: String { get }
+    var sdkKey: String { get }
     var experimentsMap: [String: OptimizelyExperiment] { get }
     var featuresMap: [String: OptimizelyFeature] { get }
 }
@@ -54,14 +56,18 @@ public protocol OptimizelyVariable {
 // MARK: - OptimizelyConfig Implementation
 
 struct OptimizelyConfigImp: OptimizelyConfig {
+    var environmentKey: String = ""
     var revision: String = ""
+    var sdkKey: String = ""
     var experimentsMap: [String: OptimizelyExperiment] = [:]
     var featuresMap: [String: OptimizelyFeature] = [:]
 
     init(projectConfig: ProjectConfig) {
         guard let project = projectConfig.project else { return }
 
+        self.environmentKey = project.environmentKey ?? ""
         self.revision = project.revision
+        self.sdkKey = project.sdkKey ?? ""
 
         // copy feature's variable data to variables in all variations
         let updatedExperiments = projectConfig.allExperiments.map {

Tests/OptimizelyTests-APIs/OptimizelyClientTests_OptimizelyConfig.swift

@@ -89,12 +89,16 @@ class OptimizelyClientTests_OptimizelyConfig: XCTestCase {
 
         optimizelyConfig = try! optimizely.getOptimizelyConfig()
         XCTAssert(optimizelyConfig!.revision == "100")
+        XCTAssert(optimizelyConfig!.sdkKey == "")
+        XCTAssert(optimizelyConfig!.environmentKey == "")
 
         wait(for: [exp!], timeout: 10)
         exp = nil // disregard following update notification
 
         // after datafile remote updated ("optimizely_config_datafile")
         XCTAssert(optimizelyConfig!.revision == "9")
+        XCTAssert(optimizelyConfig!.sdkKey == "ValidProjectConfigV4")
+        XCTAssert(optimizelyConfig!.environmentKey == "production")
     }
 
     func testGetOptimizelyConfig_ExperimentsMap() {
@@ -188,6 +192,8 @@ extension OptimizelyConfig {
     var dict: [String: Any]? {
         let expected: [String: Any] = [
             "revision": self.revision,
+            "sdkKey": self.sdkKey,
+            "environmentKey": self.environmentKey,
             "experimentsMap": self.experimentsMap.mapValues{ $0.dict },
             "featuresMap": self.featuresMap.mapValues{ $0.dict }
         ]

Tests/OptimizelyTests-APIs/OptimizelyClientTests_OptimizelyConfig_Objc.m

@@ -166,6 +166,8 @@ -(NSDictionary*)dictForOptimizelyConfig: (id <OptimizelyConfig>)optConfig {
 
     return @{
         @"revision": optConfig.revision,
+        @"sdkKey": optConfig.sdkKey,
+        @"environmentKey": optConfig.environmentKey,
         @"experimentsMap": expMap,
         @"featuresMap": featMap
     };

Tests/OptimizelyTests-DataModel/ProjectTests.swift

@@ -60,6 +60,18 @@ extension ProjectTests {
         XCTAssert(model.featureFlags == [try OTUtils.model(from: FeatureFlagTests.sampleData)])
         XCTAssert(model.botFiltering == false)
         XCTAssert(model.sendFlagDecisions == true)
+        XCTAssert(model.sdkKey == nil)
+        XCTAssert(model.environmentKey == nil)
+    }
+    
+    func testDecodeWithSDKKeyAndEnvironmentKey() {
+        var data: [String: Any] = ProjectTests.sampleData
+        data["sdkKey"] = "123"
+        data["environmentKey"] = "production"
+        
+        let model: Project? = try? OTUtils.model(from: data)
+        XCTAssertEqual(model?.sdkKey, "123")
+        XCTAssertEqual(model?.environmentKey, "production")
     }
 
     func testDecodeFailWithMissingVersion() {