feat: add apiProxyURL to DevCycleOptions (#176)

jonathannorris · web-flow · commit dd17c28f8722 · 2023-08-17T16:13:56.000-04:00
* feat: add apiProxyURL to DevCycleOptions

* fix: add docs to DevCycleOptions methods
diff --git a/DevCycle/DevCycleClient.swift b/DevCycle/DevCycleClient.swift
@@ -67,7 +67,7 @@ public class DevCycleClient {
         
         self.config = DVCConfig(sdkKey: sdkKey, user: user)
         
-        let service = DevCycleService(config: self.config!, cacheService: self.cacheService)
+        let service = DevCycleService(config: self.config!, cacheService: self.cacheService, options: self.options)
 
         self.initialize(service: service, callback: callback)
     }
diff --git a/DevCycle/Models/DevCycleOptions.swift b/DevCycle/Models/DevCycleOptions.swift
@@ -1,8 +1,7 @@
 //
-//  DVCOptions.swift
+//  DevCycleOptions.swift
 //  DevCycle
 //
-//
 
 import Foundation
 
@@ -16,6 +15,7 @@ public class DevCycleOptions {
     var disableRealtimeUpdates: Bool = false
     var disableAutomaticEventLogging: Bool = false
     var disableCustomEventLogging: Bool = false
+    var apiProxyURL: String?
     
     public class OptionsBuilder {
         var options: DevCycleOptions
@@ -24,6 +24,7 @@ public class DevCycleOptions {
             self.options = DevCycleOptions()
         }
         
+        // Controls the interval between flushing events to the DevCycle servers in milliseconds, defaults to 10 seconds.
         public func flushEventsIntervalMs(_ interval: Int? = 10000) -> OptionsBuilder {
             self.options.flushEventsIntervalMs = interval
             return self
@@ -35,41 +36,54 @@ public class DevCycleOptions {
             return self
         }
         
+        // Disables logging of SDK generated events (e.g. variableEvaluated, variableDefaulted) to DevCycle.
         public func disableAutomaticEventLogging(_ disable: Bool) -> OptionsBuilder{
             self.options.disableAutomaticEventLogging = disable
             return self
         }
         
+        // Disables logging of custom events generated by calling .track() method to DevCycle.
         public func disableCustomEventLogging(_ disable: Bool) -> OptionsBuilder{
             self.options.disableCustomEventLogging = disable
             return self
         }
         
+        // Controls the log level of the SDK, defaults to `error`
         public func logLevel(_ level: LogLevel) -> OptionsBuilder {
             self.options.logLevel = level
             return self
         }
         
+        // Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle.
         public func enableEdgeDB(_ enable: Bool) -> OptionsBuilder {
             self.options.enableEdgeDB = enable
             return self
         }
         
+        // Disable the use of cached configs
         public func disableConfigCache(_ disable: Bool) -> OptionsBuilder {
             self.options.disableConfigCache = disable
             return self
         }
         
+        // The maximum allowed age of a cached config in milliseconds, defaults to 7 days
         public func configCacheTTL(_ ttl: Int = 604800000) -> OptionsBuilder {
             self.options.configCacheTTL = ttl
             return self
         }
 
+        // Disable Realtime Update and their SSE connection.
         public func disableRealtimeUpdates(_ disable: Bool) -> OptionsBuilder {
             self.options.disableRealtimeUpdates = disable
             return self
         }
         
+        // Allows the SDK to communicate with a proxy of DevCycle APIs.
+        public func apiProxyURL(_ proxyURL: String) -> OptionsBuilder {
+            self.options.apiProxyURL = proxyURL
+            return self
+        }
+        
         public func build() -> DevCycleOptions {
             let result = self.options
             self.options = DevCycleOptions()
diff --git a/DevCycle/Networking/DevCycleService.swift b/DevCycle/Networking/DevCycleService.swift
@@ -71,16 +71,18 @@ protocol DevCycleServiceProtocol {
 class DevCycleService: DevCycleServiceProtocol {
     var session: URLSession
     var config: DVCConfig
+    var options: DevCycleOptions?
     
     var cacheService: CacheServiceProtocol
     var requestConsolidator: RequestConsolidator!
 
     private var newUser: DevCycleUser?
     
-    init(config: DVCConfig, cacheService: CacheServiceProtocol) {
+    init(config: DVCConfig, cacheService: CacheServiceProtocol, options: DevCycleOptions? = nil) {
         let sessionConfig = URLSessionConfiguration.default
         self.session = URLSession(configuration: sessionConfig)
         self.config = config
+        self.options = options
         self.cacheService = cacheService
         self.requestConsolidator = RequestConsolidator(service: self, cacheService: cacheService)
     }
@@ -243,18 +245,30 @@ class DevCycleService: DevCycleServiceProtocol {
         
         switch(type) {
         case "event":
-            url = NetworkingConstants.eventsUrl + NetworkingConstants.hostUrl
+            if let proxyUrl = self.options?.apiProxyURL {
+                url = proxyUrl
+            } else {
+                url = NetworkingConstants.eventsUrl + NetworkingConstants.hostUrl
+            }
             url.append("\(NetworkingConstants.Version.v1)")
             url.append("\(NetworkingConstants.UrlPaths.events)")
         case "edgeDB":
-            url = NetworkingConstants.sdkUrl + NetworkingConstants.hostUrl
+            if let proxyUrl = self.options?.apiProxyURL {
+                url = proxyUrl
+            } else {
+                url = NetworkingConstants.sdkUrl + NetworkingConstants.hostUrl
+            }
             url.append("\(NetworkingConstants.Version.v1)")
             url.append("\(NetworkingConstants.UrlPaths.edgeDB)")
             if let userId = config.user.userId {
                 url.append("/\(userId)")
             }
         default:
-            url = NetworkingConstants.sdkUrl + NetworkingConstants.hostUrl
+            if let proxyUrl = self.options?.apiProxyURL {
+                url = proxyUrl
+            } else {
+                url = NetworkingConstants.sdkUrl + NetworkingConstants.hostUrl
+            }
             url.append("\(NetworkingConstants.Version.v1)")
             url.append("\(NetworkingConstants.UrlPaths.config)")
             querySpecificItems.append(URLQueryItem(name: "sdkKey", value: config.sdkKey))
diff --git a/DevCycle/ObjC/ObjCDevCycleOptions.swift b/DevCycle/ObjC/ObjCDevCycleOptions.swift
@@ -21,6 +21,9 @@ public class ObjCDevCycleOptions: NSObject {
     @objc public var disableConfigCache: NSNumber?
     @objc public var configCacheTTL: NSNumber?
     @objc public var disableRealtimeUpdates: NSNumber?
+    @objc public var disableAutomaticEventLogging: NSNumber?
+    @objc public var disableCustomEventLogging: NSNumber?
+    @objc public var apiProxyURL: NSString?
     
     func buildDevCycleOptions() -> DevCycleOptions {
         var optionsBuilder = DevCycleOptions.builder()
@@ -54,6 +57,21 @@ public class ObjCDevCycleOptions: NSObject {
             optionsBuilder = optionsBuilder.disableRealtimeUpdates(disable)
         }
         
+        if let disableAutomaticEventLogging = self.disableAutomaticEventLogging,
+           let disable = disableAutomaticEventLogging as? Bool {
+            optionsBuilder = optionsBuilder.disableAutomaticEventLogging(disable)
+        }
+        
+        if let disableCustomEventLogging = self.disableCustomEventLogging,
+           let disable = disableCustomEventLogging as? Bool {
+            optionsBuilder = optionsBuilder.disableCustomEventLogging(disable)
+        }
+        
+        if let apiProxyURL = self.apiProxyURL,
+           let proxyURL = apiProxyURL as? String {
+            optionsBuilder = optionsBuilder.apiProxyURL(proxyURL)
+        }
+        
         if let logLevel = self.logLevel,
            let level = logLevel as? Int {
             var setLogLevel = LogLevel.error
diff --git a/DevCycleTests/Models/DevCycleOptionsTest.swift b/DevCycleTests/Models/DevCycleOptionsTest.swift
@@ -21,6 +21,9 @@ class DevCycleOptionsTest: XCTestCase {
                 .configCacheTTL(172800000)
                 .disableConfigCache(true)
                 .disableRealtimeUpdates(true)
+                .disableCustomEventLogging(true)
+                .disableAutomaticEventLogging(true)
+                .apiProxyURL("localhost:4000")
                 .build()
         XCTAssertNotNil(options)
         XCTAssert(options.flushEventsIntervalMs == 1000)
@@ -29,6 +32,9 @@ class DevCycleOptionsTest: XCTestCase {
         XCTAssert(options.configCacheTTL == 172800000)
         XCTAssert(options.disableConfigCache)
         XCTAssert(options.disableRealtimeUpdates)
+        XCTAssert(options.disableCustomEventLogging)
+        XCTAssert(options.disableAutomaticEventLogging)
+        XCTAssert(options.apiProxyURL == "localhost:4000")
     }
     
     func testBuilderReturnsOptionsAndSomeAreNil() {
diff --git a/DevCycleTests/Networking/DevCycleServiceTests.swift b/DevCycleTests/Networking/DevCycleServiceTests.swift
@@ -15,6 +15,14 @@ class DevCycleServiceTests: XCTestCase {
         XCTAssert(url!.contains("user_id=my_user"))
     }
     
+    func testProxyConfigURL() throws {
+        let options = DevCycleOptions.builder().apiProxyURL("localhost:4000").build()
+        let url = getService(options).createConfigRequest(user: getTestUser(), enableEdgeDB: false).url?.absoluteString
+        XCTAssert(url!.contains("localhost:4000/v1/mobileSDKConfig"))
+        XCTAssert(url!.contains("sdkKey=my_sdk_key"))
+        XCTAssert(url!.contains("user_id=my_user"))
+    }
+    
     func testCreateConfigURLRequestWithEdgeDB() throws {
         let url = getService().createConfigRequest(user: getTestUser(), enableEdgeDB: true).url?.absoluteString
         XCTAssert(url!.contains("https://sdk-api.devcycle.com/v1/mobileSDKConfig"))
@@ -29,12 +37,26 @@ class DevCycleServiceTests: XCTestCase {
         XCTAssertFalse(url!.contains("user_id=my_user"))
     }
     
+    func testProxyEventUrl() throws {
+        let options = DevCycleOptions.builder().apiProxyURL("localhost:4000").build()
+        let url = getService(options).createEventsRequest().url?.absoluteString
+        XCTAssert(url!.contains("localhost:4000/v1/events"))
+        XCTAssertFalse(url!.contains("user_id=my_user"))
+    }
+    
     func testCreateSaveEntityRequest() throws {
         let url = getService().createSaveEntityRequest().url?.absoluteString
         XCTAssert(url!.contains("https://sdk-api.devcycle.com/v1/edgedb"))
         XCTAssert(url!.contains("my_user"))
     }
     
+    func testProxyEntityUrl() throws {
+        let options = DevCycleOptions.builder().apiProxyURL("localhost:4000").build()
+        let url = getService(options).createSaveEntityRequest().url?.absoluteString
+        XCTAssert(url!.contains("localhost:4000/v1/edgedb"))
+        XCTAssert(url!.contains("my_user"))
+    }
+    
     func testProcessConfigReturnsNilIfMissingProperties() throws {
         let data = "{\"config\":\"key\"}".data(using: .utf8)
         let config = processConfig(data)
@@ -81,10 +103,10 @@ extension DevCycleServiceTests {
         }
     }
 
-    func getService() -> DevCycleService {
+    func getService(_ options: DevCycleOptions? = nil) -> DevCycleService {
         let user = getTestUser()
         let config = DVCConfig(sdkKey: "my_sdk_key", user: user)
-        return DevCycleService(config: config, cacheService: MockCacheService())
+        return DevCycleService(config: config, cacheService: MockCacheService(), options: options)
     }
     
     func getTestUser() -> DevCycleUser {

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ public class DevCycleClient {`
`67`	`67`
`68`	`68`	`self.config = DVCConfig(sdkKey: sdkKey, user: user)`
`69`	`69`
`70`		`- let service = DevCycleService(config: self.config!, cacheService: self.cacheService)`
	`70`	`+ let service = DevCycleService(config: self.config!, cacheService: self.cacheService, options: self.options)`
`71`	`71`
`72`	`72`	`self.initialize(service: service, callback: callback)`
`73`	`73`	`}`