fix: remove unsafe casts to prevent runtime exceptions (#234)

jsalaber · web-flow · commit f0ce60cba0b1 · 2025-06-10T14:06:21.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -91,3 +91,5 @@ fastlane/fastlane-buildlog
 iOSInjectionProject/
 .DS_Store
 *.DS_Store
+
+**/contents.xcworkspacedata
diff --git a/DevCycle.xcodeproj/project.pbxproj b/DevCycle.xcodeproj/project.pbxproj
@@ -50,6 +50,7 @@
 		52E693EA27567E2600B52375 /* DevCycleService.swift in Sources */ = {isa = PBXBuildFile; fileRef = 52E693E927567E2600B52375 /* DevCycleService.swift */; };
 		52E693ED2756816A00B52375 /* DVCConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = 52E693EC2756816A00B52375 /* DVCConfig.swift */; };
 		52E693F62758032500B52375 /* DevCycleServiceTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 52E693F52758032500B52375 /* DevCycleServiceTests.swift */; };
+		52E8C1F12DF87C5A0044783D /* DevCycleEventTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 52E8C1F02DF87C560044783D /* DevCycleEventTests.swift */; };
 		D9341C12276967DE00BC753F /* DevCycleEvent.swift in Sources */ = {isa = PBXBuildFile; fileRef = D9341C11276967DE00BC753F /* DevCycleEvent.swift */; };
 		D9341C14276A3C8A00BC753F /* ObjCDevCycleEvent.swift in Sources */ = {isa = PBXBuildFile; fileRef = D9341C13276A3C8A00BC753F /* ObjCDevCycleEvent.swift */; };
 		E66CF1C82901E9C7008734FD /* LDSwiftEventSource.xcframework in Frameworks */ = {isa = PBXBuildFile; fileRef = E66CF1C72901E9C7008734FD /* LDSwiftEventSource.xcframework */; };
@@ -127,6 +128,7 @@
 		52E693E927567E2600B52375 /* DevCycleService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DevCycleService.swift; sourceTree = "<group>"; };
 		52E693EC2756816A00B52375 /* DVCConfig.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DVCConfig.swift; sourceTree = "<group>"; };
 		52E693F52758032500B52375 /* DevCycleServiceTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DevCycleServiceTests.swift; sourceTree = "<group>"; };
+		52E8C1F02DF87C560044783D /* DevCycleEventTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DevCycleEventTests.swift; sourceTree = "<group>"; };
 		D9341C11276967DE00BC753F /* DevCycleEvent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DevCycleEvent.swift; sourceTree = "<group>"; };
 		D9341C13276A3C8A00BC753F /* ObjCDevCycleEvent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ObjCDevCycleEvent.swift; sourceTree = "<group>"; };
 		E66CF1C72901E9C7008734FD /* LDSwiftEventSource.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; name = LDSwiftEventSource.xcframework; path = Carthage/Build/LDSwiftEventSource.xcframework; sourceTree = "<group>"; };
@@ -201,6 +203,7 @@
 		5264A78C2768E87C00FEDB43 /* Models */ = {
 			isa = PBXGroup;
 			children = (
+				52E8C1F02DF87C560044783D /* DevCycleEventTests.swift */,
 				5268DB68275020D900D17A40 /* DevCycleUserTest.swift */,
 				524F4E61276D20A500CB9069 /* DVCVariableTests.swift */,
 				5276C9F1275E6E0D00B9A324 /* DevCycleOptionsTest.swift */,
@@ -463,6 +466,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				529F0CA52774D6BE0075AAB4 /* URLSessionMock.swift in Sources */,
+				52E8C1F12DF87C5A0044783D /* DevCycleEventTests.swift in Sources */,
 				52133B2028DDFB260007691D /* RequestConsolidatorTests.swift in Sources */,
 				5276C9F2275E6E0D00B9A324 /* DevCycleOptionsTest.swift in Sources */,
 				5264A7902768E9F400FEDB43 /* UserConfigTests.swift in Sources */,
diff --git a/DevCycle/DevCycleClient.swift b/DevCycle/DevCycleClient.swift
@@ -273,9 +273,11 @@ public class DevCycleClient {
                     return
                 }
                 do {
-                    let messageDictionary =
+                    guard let messageDictionary =
                         try JSONSerialization.jsonObject(
-                            with: messageData, options: .fragmentsAllowed) as! [String: Any]
+                            with: messageData, options: .fragmentsAllowed) as? [String: Any] else {
+                        throw SSEMessage.SSEMessageError.messageError("Error serializing sse message to JSON")
+                    }
                     let sseMessage = try SSEMessage(from: messageDictionary)
                     if sseMessage.data.type == nil || sseMessage.data.type == "refetchConfig" {
                         if self?.config?.userConfig?.etag == nil
diff --git a/DevCycle/Models/DevCycleEvent.swift b/DevCycle/Models/DevCycleEvent.swift
@@ -37,22 +37,22 @@ public class DevCycleEvent {
             return self
         }
         
-        public func target(_ target: String) -> EventBuilder {
+        public func target(_ target: String?) -> EventBuilder {
             self.event.target = target
             return self
         }
         
-        public func clientDate(_ clientDate: Date) -> EventBuilder {
+        public func clientDate(_ clientDate: Date?) -> EventBuilder {
             self.event.clientDate = clientDate
             return self
         }
         
-        public func value(_ value: Double) -> EventBuilder {
+        public func value(_ value: Double?) -> EventBuilder {
             self.event.value = value
             return self
         }
         
-        public func metaData(_ metaData: [String:Any]) -> EventBuilder {
+        public func metaData(_ metaData: [String:Any]?) -> EventBuilder {
             self.event.metaData = metaData
             return self
         }
diff --git a/DevCycle/Models/UserConfig.swift b/DevCycle/Models/UserConfig.swift
@@ -11,6 +11,7 @@ enum UserConfigError: Error {
     case MissingProperty(String)
     case InvalidVariableType(String)
     case InvalidProperty(String)
+    case InvalidJson(String)
 }
 
 public struct UserConfig {
diff --git a/DevCycle/Networking/DevCycleService.swift b/DevCycle/Networking/DevCycleService.swift
@@ -164,10 +164,14 @@ class DevCycleService: DevCycleServiceProtocol {
                 // Guard below checks if statusCode exists or not in the response body.
                 // Only API Errors (http status codes of 4xx/5xx) have the statusCode in the response body, successful API Requests (http status codes of 2xx/3xx) calls will not.
                 guard responseDataJson["statusCode"] == nil else {
-                    let status = responseDataJson["statusCode"] as! Int
-                    var errorResponse: String
+                    guard let status = responseDataJson["statusCode"] as? Int else {
+                        return
+                    }
+                    var errorResponse: String = ""
                     if (responseDataJson["message"] is [String]) {
-                        errorResponse = (responseDataJson["message"] as! [String]).joined(separator: ", ")
+                        if let errorArray = (responseDataJson["message"] as? [String]) {
+                            errorResponse = errorArray.joined(separator: ", ")
+                        }
                     } else {
                         errorResponse = String(describing: responseDataJson["message"])
                     }
diff --git a/DevCycle/ObjC/ObjCDevCycleEvent.swift b/DevCycle/ObjC/ObjCDevCycleEvent.swift
@@ -49,10 +49,10 @@ public class ObjCDevCycleEvent: NSObject {
             eventBuilder = eventBuilder.clientDate(eventDate as Date)
         }
         if let eventValue = self.value {
-            eventBuilder = eventBuilder.value(eventValue as! Double)
+            eventBuilder = eventBuilder.value(eventValue as? Double)
         }
         if let eventMetaData = self.metaData {
-            eventBuilder = eventBuilder.metaData(eventMetaData as! [String : Any])
+            eventBuilder = eventBuilder.metaData(eventMetaData as? [String : Any])
         }
         
         do {
diff --git a/DevCycle/SSEConnection.swift b/DevCycle/SSEConnection.swift
@@ -94,6 +94,7 @@ class Handler: EventHandler {
 public struct SSEMessage {
     enum SSEMessageError: Error, Equatable {
         case initError(String)
+        case messageError(String)
     }
     struct Data {
         var etag: String?
diff --git a/DevCycle/Utils/ProcessConfig.swift b/DevCycle/Utils/ProcessConfig.swift
@@ -13,7 +13,9 @@ internal func processConfig(_ responseData: Data?) -> UserConfig? {
         return nil
     }
     do {
-        let dictionary = try JSONSerialization.jsonObject(with: data, options: .fragmentsAllowed) as! [String:Any]
+        guard let dictionary = try JSONSerialization.jsonObject(with: data, options: .fragmentsAllowed) as? [String:Any] else {
+            throw UserConfigError.InvalidJson("Error with serializing config data to JSON")
+        }
         return try UserConfig(from: dictionary)
     } catch {
         Log.error("Failed to decode config: \(error)", tags: ["service", "request"])
diff --git a/DevCycle/Utils/RequestConsolidator.swift b/DevCycle/Utils/RequestConsolidator.swift
@@ -60,7 +60,7 @@ class RequestConsolidator {
 
     func makeLastRequestInQueue(user: DevCycleUser, complete: (() -> Void)?) {
         guard let lastRequest = self.requestCallbacks.last?.request else {
-            print("No last request to make in queue")
+            Log.debug("No last request to make in queue")
             return
         }
         service.makeRequest(request: lastRequest) { response in
diff --git a/DevCycleTests/Models/DevCycleEventTests.swift b/DevCycleTests/Models/DevCycleEventTests.swift
@@ -0,0 +1,87 @@
+//
+//  DevCycleEventTests.swift
+//  DevCycleTests
+//
+//
+
+import XCTest
+
+@testable import DevCycle
+
+class DevCycleEventTests: XCTestCase {
+    
+    func testCreateEventWithMinimumRequiredFields() throws {
+        // Test creating an event with just the required type field
+        let event = try DevCycleEvent.builder()
+            .type("test_event")
+            .build()
+        
+        XCTAssertEqual(event.type, "test_event")
+        XCTAssertNil(event.target)
+        XCTAssertNil(event.clientDate)
+        XCTAssertNil(event.value)
+        XCTAssertNil(event.metaData)
+    }
+    
+    func testCreateEventWithAllFields() throws {
+        // Test creating an event with all fields populated
+        let date = Date()
+        let metaData: [String: Any] = ["key1": "value1", "key2": 123, "key3": true]
+        
+        let event = try DevCycleEvent.builder()
+            .type("test_event")
+            .target("test_target")
+            .clientDate(date)
+            .value(42.5)
+            .metaData(metaData)
+            .build()
+        
+        XCTAssertEqual(event.type, "test_event")
+        XCTAssertEqual(event.target, "test_target")
+        XCTAssertEqual(event.clientDate, date)
+        XCTAssertEqual(event.value, 42.5)
+        XCTAssertEqual(event.metaData?["key1"] as? String, "value1")
+        XCTAssertEqual(event.metaData?["key2"] as? Int, 123)
+        XCTAssertEqual(event.metaData?["key3"] as? Bool, true)
+    }
+    
+    func testCreateEventWithMissingType() {
+        // Test that creating an event without a type throws an error
+        XCTAssertThrowsError(try DevCycleEvent.builder().build()) { error in
+            XCTAssertEqual(error as? EventError, EventError.MissingEventType)
+        }
+    }
+    
+    func testCreateEventWithBuilderReuse() throws {
+        // Test that the builder can be reused after building an event
+        let builder = DevCycleEvent.builder()
+        
+        let event1 = try builder
+            .type("event1")
+            .build()
+        
+        let event2 = try builder
+            .type("event2")
+            .build()
+        
+        XCTAssertEqual(event1.type, "event1")
+        XCTAssertEqual(event2.type, "event2")
+    }
+    
+    func testCreateEventWithNilValues() throws {
+        // Test creating an event with explicit nil values
+        let event = try DevCycleEvent.builder()
+            .type("test_event")
+            .target(nil)
+            .clientDate(nil)
+            .value(nil)
+            .metaData(nil)
+            .build()
+        
+        XCTAssertEqual(event.type, "test_event")
+        XCTAssertNil(event.target)
+        XCTAssertNil(event.clientDate)
+        XCTAssertNil(event.value)
+        XCTAssertNil(event.metaData)
+    }
+}
diff --git a/DevCycleTests/Networking/DevCycleServiceTests.swift b/DevCycleTests/Networking/DevCycleServiceTests.swift
@@ -81,6 +81,12 @@ class DevCycleServiceTests: XCTestCase {
         let config = processConfig(data)
         XCTAssertNil(config)
     }
+    
+    func testProcessConfigReturnsErrorIfInvalidJson() throws {
+        let data = "{".data(using: .utf8)
+        let config = processConfig(data)
+        XCTAssertNil(config)
+    }
 
     func testFlushingEvents() {
         let service = MockDevCycleService()

Original file line number	Diff line number	Diff line change
`@@ -37,22 +37,22 @@ public class DevCycleEvent {`
`37`	`37`	`return self`
`38`	`38`	`}`
`39`	`39`
`40`		`- public func target(_ target: String) -> EventBuilder {`
	`40`	`+ public func target(_ target: String?) -> EventBuilder {`
`41`	`41`	`self.event.target = target`
`42`	`42`	`return self`
`43`	`43`	`}`
`44`	`44`
`45`		`- public func clientDate(_ clientDate: Date) -> EventBuilder {`
	`45`	`+ public func clientDate(_ clientDate: Date?) -> EventBuilder {`
`46`	`46`	`self.event.clientDate = clientDate`
`47`	`47`	`return self`
`48`	`48`	`}`
`49`	`49`
`50`		`- public func value(_ value: Double) -> EventBuilder {`
	`50`	`+ public func value(_ value: Double?) -> EventBuilder {`
`51`	`51`	`self.event.value = value`
`52`	`52`	`return self`
`53`	`53`	`}`
`54`	`54`
`55`		`- public func metaData(_ metaData: [String:Any]) -> EventBuilder {`
	`55`	`+ public func metaData(_ metaData: [String:Any]?) -> EventBuilder {`
`56`	`56`	`self.event.metaData = metaData`
`57`	`57`	`return self`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ enum UserConfigError: Error {`
`11`	`11`	`case MissingProperty(String)`
`12`	`12`	`case InvalidVariableType(String)`
`13`	`13`	`case InvalidProperty(String)`
	`14`	`+ case InvalidJson(String)`
`14`	`15`	`}`
`15`	`16`
`16`	`17`	`public struct UserConfig {`
Original file line number	Diff line number	Diff line change
`@@ -49,10 +49,10 @@ public class ObjCDevCycleEvent: NSObject {`
`49`	`49`	`eventBuilder = eventBuilder.clientDate(eventDate as Date)`
`50`	`50`	`}`
`51`	`51`	`if let eventValue = self.value {`
`52`		`- eventBuilder = eventBuilder.value(eventValue as! Double)`
	`52`	`+ eventBuilder = eventBuilder.value(eventValue as? Double)`
`53`	`53`	`}`
`54`	`54`	`if let eventMetaData = self.metaData {`
`55`		`- eventBuilder = eventBuilder.metaData(eventMetaData as! [String : Any])`
	`55`	`+ eventBuilder = eventBuilder.metaData(eventMetaData as? [String : Any])`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`do {`
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,7 @@ class Handler: EventHandler {`
`94`	`94`	`public struct SSEMessage {`
`95`	`95`	`enum SSEMessageError: Error, Equatable {`
`96`	`96`	`case initError(String)`
	`97`	`+ case messageError(String)`
`97`	`98`	`}`
`98`	`99`	`struct Data {`
`99`	`100`	`var etag: String?`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ class RequestConsolidator {`
`60`	`60`
`61`	`61`	`func makeLastRequestInQueue(user: DevCycleUser, complete: (() -> Void)?) {`
`62`	`62`	`guard let lastRequest = self.requestCallbacks.last?.request else {`
`63`		`- print("No last request to make in queue")`
	`63`	`+ Log.debug("No last request to make in queue")`
`64`	`64`	`return`
`65`	`65`	`}`
`66`	`66`	`service.makeRequest(request: lastRequest) { response in`