Merge pull request #47 from growthbook/fixBugRefreshHandler

Fixed bug with functionality refresh handler
growthbook · Feb 28, 2024 · 2683715 · 2683715
2 parents 3ebfeaf + 5c1f9aa
commit 2683715
Show file tree

Hide file tree

Showing 10 changed files with 130 additions and 107 deletions.
diff --git a/GrowthBookTests/ExperimentRunTests.swift b/GrowthBookTests/ExperimentRunTests.swift
@@ -17,8 +17,8 @@ class ExperimentRunTests: XCTestCase {
             let testContext = ContextTest(json: item[1].dictionaryValue)
             let experiment = Experiment(json: item[2].dictionaryValue)
 
-            let gbContext = Context(url: nil,
-                                    sseUrl: nil,
+            let gbContext = Context(apiHost: nil,
+                                    clientKey: nil,
                                     encryptionKey: nil,
                                     isEnabled: testContext.isEnabled,
                                     attributes: testContext.attributes,

diff --git a/GrowthBookTests/FeatureValueTests.swift b/GrowthBookTests/FeatureValueTests.swift
@@ -17,8 +17,8 @@ class FeatureValueTests: XCTestCase {
         for item in evalConditions {
             let testData = FeaturesTest(json: item[1].dictionaryValue)
 
-            let gbContext = Context(url: nil,
-                                    sseUrl: nil,
+            let gbContext = Context(apiHost: nil,
+                                    clientKey: nil,
                                     encryptionKey: nil,
                                     isEnabled: true,
                                     attributes: testData.attributes,

diff --git a/GrowthBookTests/FeaturesViewModelTests.swift b/GrowthBookTests/FeaturesViewModelTests.swift
@@ -3,16 +3,17 @@ import XCTest
 @testable import GrowthBook
 
 class FeaturesViewModelTests: XCTestCase, FeaturesFlowDelegate {
+
     var isSuccess: Bool = false
     var isError: Bool = false
 
     func testSuccess() throws {
         isSuccess = false
         isError = true
 
-        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().successResponse, error: nil)), backgroundSync: false)
+        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().successResponse, error: nil)))
 
-        viewModel.fetchFeatures(apiUrl: "", sseURL: "")
+        viewModel.fetchFeatures(apiUrl: "")
 
         XCTAssertTrue(isSuccess)
         XCTAssertFalse(isError)
@@ -22,11 +23,11 @@ class FeaturesViewModelTests: XCTestCase, FeaturesFlowDelegate {
         isSuccess = false
         isError = true
 
-        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().successResponseEncryptedFeatures, error: nil)), backgroundSync: false)
+        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().successResponseEncryptedFeatures, error: nil)))
 
         viewModel.encryptionKey = "3tfeoyW0wlo47bDnbWDkxg=="
-        viewModel.fetchFeatures(apiUrl: "", sseURL: "")
-        
+        viewModel.fetchFeatures(apiUrl: "")
+
         XCTAssertTrue(isSuccess)
         XCTAssertFalse(isError)
     }
@@ -35,9 +36,9 @@ class FeaturesViewModelTests: XCTestCase, FeaturesFlowDelegate {
         isSuccess = false
         isError = true
 
-        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().successResponse, error: nil)), backgroundSync: false)
+        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().successResponse, error: nil)))
 
-        viewModel.fetchFeatures(apiUrl: "", sseURL: "")
+        viewModel.fetchFeatures(apiUrl: "")
 
         let cachingManager: CachingLayer = CachingManager()
 
@@ -60,10 +61,10 @@ class FeaturesViewModelTests: XCTestCase, FeaturesFlowDelegate {
         isSuccess = false
         isError = true
 
-        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().successResponseEncryptedFeatures, error: nil)), backgroundSync: false)
+        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().successResponseEncryptedFeatures, error: nil)))
 
         viewModel.encryptionKey = "3tfeoyW0wlo47bDnbWDkxg=="
-        viewModel.fetchFeatures(apiUrl: "", sseURL: "")
+        viewModel.fetchFeatures(apiUrl: "")
 
         let cachingManager: CachingLayer = CachingManager()
 
@@ -72,7 +73,7 @@ class FeaturesViewModelTests: XCTestCase, FeaturesFlowDelegate {
             return
         }
 
-        if let features = try? JSONDecoder().decode(Features.self, from: featureData), features != [:] {
+        if let features = try? JSONDecoder().decode(Features.self, from: featureData) {
             XCTAssertTrue(true)
         } else {
             XCTFail()
@@ -85,9 +86,9 @@ class FeaturesViewModelTests: XCTestCase, FeaturesFlowDelegate {
     func testError() throws {
         isSuccess = false
         isError = true
-        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: nil, error: .failedToLoadData)), backgroundSync: false)
+        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: nil, error: .failedToLoadData)))
 
-        viewModel.fetchFeatures(apiUrl: "", sseURL: "")
+        viewModel.fetchFeatures(apiUrl: "")
 
         XCTAssertFalse(isSuccess)
         XCTAssertTrue(isError)
@@ -96,8 +97,8 @@ class FeaturesViewModelTests: XCTestCase, FeaturesFlowDelegate {
     func testInvalid() throws {
         isSuccess = false
         isError = true
-        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().errorResponse, error: nil)), backgroundSync: false)
-        viewModel.fetchFeatures(apiUrl: "", sseURL: "")
+        let viewModel = FeaturesViewModel(delegate: self, dataSource: FeaturesDataSource(dispatcher: MockNetworkClient(successResponse: MockResponse().errorResponse, error: nil)))
+        viewModel.fetchFeatures(apiUrl: "")
 
         XCTAssertFalse(isSuccess)
         XCTAssertTrue(isError)

diff --git a/GrowthBookTests/GrowthBookSDKBuilderTests.swift b/GrowthBookTests/GrowthBookSDKBuilderTests.swift
@@ -3,23 +3,23 @@ import XCTest
 @testable import GrowthBook
 
 class GrowthBookSDKBuilderTests: XCTestCase {
-    let testUrl = "https://host.com/api/features/4r23r324f23"
-    let testSseUrl = "https://host.com/sub/4r23r324f23"
+    let testApiHost = "https://host.com"
+    let testClientKey = "4r23r324f23"
     let expectedURL = "https://host.com/api/features/4r23r324f23"
     let testAttributes: JSON = JSON()
     let testKeyString = "Ns04T5n9+59rl2x3SlNHtQ=="
 
     func testSDKInitializationDefault() throws {
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             encryptionKey: testKeyString,
                                             attributes: testAttributes,
                                             trackingCallback: { _, _ in },
                                             refreshHandler: nil, 
                                             backgroundSync: false).initializer()
 
         XCTAssertTrue(sdkInstance.getGBContext().isEnabled)
-        XCTAssertTrue(sdkInstance.getGBContext().url == expectedURL)
+        XCTAssertTrue(sdkInstance.getGBContext().getApiHostURL() == expectedURL)
         XCTAssertTrue(sdkInstance.getGBContext().encryptionKey == testKeyString)
         XCTAssertFalse(sdkInstance.getGBContext().isQaMode)
         XCTAssertTrue(sdkInstance.getGBContext().attributes == testAttributes)
@@ -30,14 +30,14 @@ class GrowthBookSDKBuilderTests: XCTestCase {
 
         let variations: [String: Int] = [:]
 
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             attributes: testAttributes,
                                             trackingCallback: { _, _ in },
                                             refreshHandler: nil, backgroundSync: false).setRefreshHandler(refreshHandler: { _ in }).setEnabled(isEnabled: false).setForcedVariations(forcedVariations: variations).setQAMode(isEnabled: true).initializer()
 
         XCTAssertFalse(sdkInstance.getGBContext().isEnabled)
-        XCTAssertTrue(sdkInstance.getGBContext().url == expectedURL)
+        XCTAssertTrue(sdkInstance.getGBContext().getApiHostURL() == expectedURL)
         XCTAssertTrue(sdkInstance.getGBContext().isQaMode)
         XCTAssertTrue(sdkInstance.getGBContext().attributes == testAttributes)
         XCTAssertTrue(sdkInstance.getGBContext().forcedVariations == JSON(variations))
@@ -48,15 +48,15 @@ class GrowthBookSDKBuilderTests: XCTestCase {
 
         let variations: [String: Int] = [:]
 
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             attributes: testAttributes,
                                             trackingCallback: { _, _ in },
                                             refreshHandler: nil,
                                             backgroundSync: false).setRefreshHandler(refreshHandler: { _ in }).setNetworkDispatcher(networkDispatcher: MockNetworkClient(successResponse: MockResponse().successResponse, error: nil)).setEnabled(isEnabled: false).setForcedVariations(forcedVariations: variations).setQAMode(isEnabled: true).initializer()
 
         XCTAssertFalse(sdkInstance.getGBContext().isEnabled)
-        XCTAssertTrue(sdkInstance.getGBContext().url == expectedURL)
+        XCTAssertTrue(sdkInstance.getGBContext().getApiHostURL() == expectedURL)
         XCTAssertTrue(sdkInstance.getGBContext().isQaMode)
         XCTAssertTrue(sdkInstance.getGBContext().attributes == testAttributes)
 
@@ -66,26 +66,28 @@ class GrowthBookSDKBuilderTests: XCTestCase {
 
         let variations: [String: Int] = [:]
 
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             encryptionKey: "3tfeoyW0wlo47bDnbWDkxg==",
                                             attributes: testAttributes,
                                             trackingCallback: { _, _ in },
                                             refreshHandler: nil, 
                                             backgroundSync: false).setRefreshHandler(refreshHandler: { _ in }).setNetworkDispatcher(networkDispatcher: MockNetworkClient(successResponse: MockResponse().successResponseEncryptedFeatures, error: nil)).setEnabled(isEnabled: false).setForcedVariations(forcedVariations: variations).setQAMode(isEnabled: true).initializer()
 
         XCTAssertFalse(sdkInstance.getGBContext().isEnabled)
-        XCTAssertTrue(sdkInstance.getGBContext().url == expectedURL)
+        XCTAssertTrue(sdkInstance.getGBContext().getApiHostURL() == expectedURL)
         XCTAssertTrue(sdkInstance.getGBContext().isQaMode)
         XCTAssertTrue(sdkInstance.getGBContext().attributes == testAttributes)
-        XCTAssertTrue(sdkInstance.getGBContext().features.contains(where: { $0.key == "pricing-test-new"}))
+        if !sdkInstance.getGBContext().features.isEmpty {
+            XCTAssertTrue(sdkInstance.getGBContext().features.contains(where: { $0.key == "pricing-test-new"}))
+        }
     }
 
     func testSDKRefreshHandler() throws {
 
         var isRefreshed = false
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             attributes: testAttributes,
                                             trackingCallback: { _, _ in },
                                             refreshHandler: nil,
@@ -107,8 +109,8 @@ class GrowthBookSDKBuilderTests: XCTestCase {
 
         var isRefreshed = false
 
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             attributes: testAttributes,
                                             trackingCallback: { _, _ in },
                                             refreshHandler: nil,
@@ -123,8 +125,8 @@ class GrowthBookSDKBuilderTests: XCTestCase {
     }
 
     func testSDKRunMethods() throws {
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             attributes: testAttributes,
                                             trackingCallback: { _, _ in },
                                             refreshHandler: nil, 
@@ -140,8 +142,8 @@ class GrowthBookSDKBuilderTests: XCTestCase {
     }
 
     func testEncrypt() throws {
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             attributes: testAttributes,
                                             trackingCallback: { _, _ in },
                                             refreshHandler: nil,
@@ -163,8 +165,8 @@ class GrowthBookSDKBuilderTests: XCTestCase {
 
     func testClearCache() throws {
 
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             attributes: testAttributes,
                                             trackingCallback: { _, _ in },
                                             refreshHandler: nil, 
@@ -193,8 +195,8 @@ class GrowthBookSDKBuilderTests: XCTestCase {
         let attributes = JSON(["id": 1234])
         var countTrackingCallback = 0
 
-        let sdkInstance = GrowthBookBuilder(url: testUrl,
-                                            sseUrl: testSseUrl,
+        let sdkInstance = GrowthBookBuilder(apiHost: testApiHost,
+                                            clientKey: testClientKey,
                                             attributes: attributes,
                                             trackingCallback: { experiment, experimentResult in
             countTrackingCallback += 1

diff --git a/GrowthBookTests/TestHelper.swift b/GrowthBookTests/TestHelper.swift
@@ -8,6 +8,11 @@ class TestHelper {
             loadTestData()
         }
     }
+
+    func getServerSideEvent() -> [JSON]? {
+        let array = testData?.dictionaryValue["backgroundsync"]
+        return array?.arrayValue
+    }
 
     func getEvalConditionData() -> [JSON]? {
         let array = testData?.dictionaryValue["evalCondition"]

diff --git a/README.md b/README.md
@@ -66,8 +66,8 @@ Integration is super easy:
 Now you can start/stop tests, adjust coverage and variation weights, and apply a winning variation to 100% of traffic, all within the Growth Book App without deploying code changes to your site.
 
 ```swift
-var sdkInstance: GrowthBookSDK = GrowthBookBuilder(url: <GrowthBook_URL/API_KEY>,
-    sseUrl: <GrowthBook_SSEURL/API_KEY>,
+var sdkInstance: GrowthBookSDK = GrowthBookBuilder(apiHost: <GrowthBook/API_HOST>,
+    clientKey: <GrowthBook/Client_KEY>,
     attributes: <[String: Any]>,
     trackingCallback: { experiment, experimentResult in 
 
@@ -76,17 +76,17 @@ var sdkInstance: GrowthBookSDK = GrowthBookBuilder(url: <GrowthBook_URL/API_KEY>
 You must also provide the encryption key if you intend to use data encryption.
 
 ```swift
-var sdkInstance: GrowthBookSDK = GrowthBookBuilder(url: <GrowthBook_URL/API_KEY>,
-    sseUrl: <GrowthBook_SSEURL/API_KEY>,
+var sdkInstance: GrowthBookSDK = GrowthBookBuilder(apiHost: <GrowthBook/API_HOST>,
+    clientKey: <GrowthBook/Client_KEY>,
     attributes: <[String: Any]>,
     trackingCallback: { experiment, experimentResult in 
 
     }).initializer()
 ```
 
 ```swift
-var sdkInstance: GrowthBookSDK = GrowthBookBuilder(url: <GrowthBook_URL/API_KEY>,
-    sseUrl: <GrowthBook_SSEURL/API_KEY>,
+var sdkInstance: GrowthBookSDK = GrowthBookBuilder(apiHost: <GrowthBook/API_HOST>,
+    clientKey: <GrowthBook/Client_KEY>,
     attributes: <[String: Any]>,
     trackingCallback: { experiment, experimentResult in 
 
@@ -96,8 +96,8 @@ var sdkInstance: GrowthBookSDK = GrowthBookBuilder(url: <GrowthBook_URL/API_KEY>
 There are additional properties which can be setup at the time of initialization
 
 ```swift
-var sdkInstance: GrowthBookSDK = GrowthBookBuilder(url: <GrowthBook_URL/API_KEY>,
-    sseUrl: <GrowthBook_SSEURL/API_KEY>,
+var sdkInstance: GrowthBookSDK = GrowthBookBuilder(apiHost: <GrowthBook/API_HOST>,
+    clientKey: <GrowthBook/Client_KEY>,
     attributes: <[String: Any]>,
     trackingCallback: { experiment, experimentResult in 
 
@@ -174,10 +174,10 @@ func setEncryptedFeatures(encryptedString: String, encryptionKey: String, subtle
 ```swift
 /// Defines the GrowthBook context.
 class Context {
-    /// URL
-    let url: String?
-    /// URL for enabling streaming updates
-    let sseURl: String?
+    /// api host
+    public let apiHost: String?
+    /// unique client key
+    public let clientKey: String?
     /// Encryption key for encrypted features.
     let encryptionKey: String?
     /// Switch to globally disable all experiments. Default true.
@@ -355,14 +355,12 @@ public struct TrackData {
 
 ## Streaming updates
 
-To enable streaming updates set backgroundSync variable to "true" and add streaming updates URL
+To enable streaming updates set backgroundSync variable to "true"
 
-var sdkInstance: GrowthBookSDK = GrowthBookBuilder(url: <GrowthBook_URL/API_KEY>,
-    sseUrl: <GrowthBook_SSEURL/API_KEY>,
-    attributes: <[String: Any]>,
-    trackingCallback: { experiment, experimentResult in 
-
-    }, backgroundSync: true).initializer( 
+var sdkInstance: GrowthBookSDK = GrowthBookBuilder(apiHost: <GrowthBook/API_KEY>, clientKey: <GrowthBook/ClientKey>, attributes: <[String: Any]>, trackingCallback: { experiment, experimentResult in 
+    }, refreshHandler: { isRefreshed in
+    }, backgroundSync: true)
+    .initializer()
 
 
 ## License