Better handle errors where conversion occurs. (#11)

bsneed · Brandon Sneed · web-flow · commit 8bdf2b31f064 · 2021-05-18T13:36:53.000-07:00
Co-authored-by: Brandon Sneed &lt;brandon.sneed@segment.com&gt;
diff --git a/Segment.xcodeproj/project.pbxproj b/Segment.xcodeproj/project.pbxproj
@@ -34,7 +34,7 @@
 		46A018D425E6C9C200F9CCD8 /* LinuxUtils.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46A018D325E6C9C200F9CCD8 /* LinuxUtils.swift */; };
 		46A018DA25E97FDF00F9CCD8 /* AppleUtils.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46A018D925E97FDF00F9CCD8 /* AppleUtils.swift */; };
 		46A018EE25E9A74F00F9CCD8 /* VendorSystem.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46A018ED25E9A74F00F9CCD8 /* VendorSystem.swift */; };
-		46E382E5264C738100BA2502 /* LateInit.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46E382E4264C738100BA2502 /* LateInit.swift */; };
+		46E382E72654429A00BA2502 /* Utils.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46E382E62654429A00BA2502 /* Utils.swift */; };
 		46FE4C9225A3EE90003A7362 /* Lifecycle_.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46FE4C9125A3EE90003A7362 /* Lifecycle_.swift */; };
 		46FE4C9725A3F35E003A7362 /* macOSLifecycleMonitor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46FE4C9625A3F35E003A7362 /* macOSLifecycleMonitor.swift */; };
 		46FE4C9C25A3F41C003A7362 /* LinuxLifecycleMonitor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46FE4C9B25A3F41C003A7362 /* LinuxLifecycleMonitor.swift */; };
@@ -139,7 +139,7 @@
 		46A018D325E6C9C200F9CCD8 /* LinuxUtils.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LinuxUtils.swift; sourceTree = "<group>"; };
 		46A018D925E97FDF00F9CCD8 /* AppleUtils.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppleUtils.swift; sourceTree = "<group>"; };
 		46A018ED25E9A74F00F9CCD8 /* VendorSystem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VendorSystem.swift; sourceTree = "<group>"; };
-		46E382E4264C738100BA2502 /* LateInit.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LateInit.swift; sourceTree = "<group>"; };
+		46E382E62654429A00BA2502 /* Utils.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Utils.swift; sourceTree = "<group>"; };
 		46FE4C9125A3EE90003A7362 /* Lifecycle_.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Lifecycle_.swift; sourceTree = "<group>"; };
 		46FE4C9625A3F35E003A7362 /* macOSLifecycleMonitor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = macOSLifecycleMonitor.swift; sourceTree = "<group>"; };
 		46FE4C9B25A3F41C003A7362 /* LinuxLifecycleMonitor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LinuxLifecycleMonitor.swift; sourceTree = "<group>"; };
@@ -324,7 +324,7 @@
 				46FE4CDF25A53FAD003A7362 /* Storage.swift */,
 				4621080B2605332D00EBC4A8 /* KeyPath.swift */,
 				46022770261F7A4800A9E913 /* Atomic.swift */,
-				46E382E4264C738100BA2502 /* LateInit.swift */,
+				46E382E62654429A00BA2502 /* Utils.swift */,
 			);
 			path = Utilities;
 			sourceTree = "<group>";
@@ -559,11 +559,11 @@
 				96C33AB1258961F500F3D538 /* Settings.swift in Sources */,
 				969A534325B10324009227D9 /* iOSAppBackground.swift in Sources */,
 				46FE4C9225A3EE90003A7362 /* Lifecycle_.swift in Sources */,
+				46E382E72654429A00BA2502 /* Utils.swift in Sources */,
 				A31A16B225781CB400C9CDDF /* JSON.swift in Sources */,
 				46022771261F7A4800A9E913 /* Atomic.swift in Sources */,
 				A3471FBE256487F000965480 /* Configuration.swift in Sources */,
 				OBJ_23 /* Analytics.swift in Sources */,
-				46E382E5264C738100BA2502 /* LateInit.swift in Sources */,
 				A31A16342576B7AF00C9CDDF /* Types.swift in Sources */,
 				46A018DA25E97FDF00F9CCD8 /* AppleUtils.swift in Sources */,
 				A31A16E12579779600C9CDDF /* Version.swift in Sources */,
diff --git a/Sources/Segment/Events.swift b/Sources/Segment/Events.swift
@@ -27,14 +27,18 @@ extension Analytics {
             }
             
         } catch {
-            assertionFailure("\(error)")
+            exceptionFailure("\(error)")
         }
     }
     
     public func track(name: String, properties: [String: Any]?) {
         var props: JSON? = nil
         if let properties = properties {
-            props = try? JSON(properties)
+            do {
+                props = try JSON(properties)
+            } catch {
+                exceptionFailure("\(error)")
+            }
         }
         let event = TrackEvent(event: name, properties: props)
         process(incomingEvent: event)
@@ -64,7 +68,7 @@ extension Analytics {
             let event = IdentifyEvent(userId: userId, traits: jsonTraits)
             process(incomingEvent: event)
         } catch {
-            assertionFailure("\(error)")
+            exceptionFailure("\(error)")
         }
     }
     
@@ -78,7 +82,7 @@ extension Analytics {
             let event = IdentifyEvent(traits: jsonTraits)
             process(incomingEvent: event)
         } catch {
-            assertionFailure("\(error)")
+            exceptionFailure("\(error)")
         }
     }
 
@@ -109,7 +113,7 @@ extension Analytics {
                 process(incomingEvent: event)
             }
         } catch {
-            assertionFailure("\(error)")
+            exceptionFailure("\(error)")
         }
     }
     
@@ -133,7 +137,7 @@ extension Analytics {
                 process(incomingEvent: event)
             }
         } catch {
-            assertionFailure("\(error)")
+            exceptionFailure("\(error)")
         }
     }
     
diff --git a/Sources/Segment/Plugins/Context.swift b/Sources/Segment/Plugins/Context.swift
@@ -34,7 +34,11 @@ public class Context: PlatformPlugin {
             context.merge(eventContext) { (_, new) in new }
         }
         
-        workingEvent.context = try? JSON(context)
+        do {
+            workingEvent.context = try JSON(context)
+        } catch {
+            exceptionFailure("Unable to convert context to JSON: \(error)")
+        }
         
         return workingEvent
     }
diff --git a/Sources/Segment/Plugins/DeviceToken.swift b/Sources/Segment/Plugins/DeviceToken.swift
@@ -24,7 +24,11 @@ public class DeviceToken: PlatformPlugin {
         guard var workingEvent = event else { return event }
         if var context = workingEvent.context?.dictionaryValue, let token = token {
             context[keyPath: "device.token"] = token
-            workingEvent.context = try? JSON(context)
+            do {
+                workingEvent.context = try JSON(context)
+            } catch {
+                exceptionFailure("Unable to convert context to JSON: \(error)")
+            }
         }
         return workingEvent
     }
diff --git a/Sources/Segment/Plugins/Metrics.swift b/Sources/Segment/Plugins/Metrics.swift
@@ -31,13 +31,18 @@ public enum MetricType: Int {
 
 public extension RawEvent {
     mutating func addMetric(_ type: MetricType, name: String, value: Double, tags: [String]?, timestamp: Date) {
-        guard let metric = try? JSON(with: Metric(eventName: "\(Self.self)", metricName: name, value: value, tags: tags, type: type, timestamp: Date())) else { return }
+        guard let metric = try? JSON(with: Metric(eventName: "\(Self.self)", metricName: name, value: value, tags: tags, type: type, timestamp: Date())) else {
+            exceptionFailure("Unable to add metric `\(name)`")
+            return
+        }
         if self.metrics == nil {
             metrics = [JSON]()
         }
         
         if let jsonEncoded = try? JSON(with: metric) {
             metrics?.append(jsonEncoded)
+        } else {
+            exceptionFailure("Unable to encode metric `\(name)` to JSON.")
         }
     }
 }
diff --git a/Sources/Segment/Utilities/HTTPClient.swift b/Sources/Segment/Utilities/HTTPClient.swift
@@ -69,6 +69,7 @@ public class HTTPClient {
         urlRequest.httpMethod = "POST"
         
         guard let session = try? configuredSession(for: writeKey) else {
+            exceptionFailure("Unable to create a HTTPClient session!")
             completion(false)
             return nil
         }
diff --git a/Sources/Segment/Utilities/LateInit.swift b/Sources/Segment/Utilities/LateInit.swift
diff --git a/Sources/Segment/Utilities/Utils.swift b/Sources/Segment/Utilities/Utils.swift
@@ -0,0 +1,26 @@
+//
+//  Utils.swift
+//  Segment
+//
+//  Created by Brandon Sneed on 5/18/21.
+//
+
+import Foundation
+
+internal var isUnitTesting: Bool = {
+    let env = ProcessInfo().environment
+    let value = (env["XCTestConfigurationFilePath"] != nil)
+    return value
+}()
+
+internal let _SegmentException = "SegmentException"
+internal func exceptionFailure(_ message: String) {
+    let args: [CVarArg] = []
+    if isUnitTesting {
+        NSException.raise(NSExceptionName(_SegmentException), format: message, arguments: getVaList(args))
+    } else {
+        #if DEBUG
+        NSException.raise(NSExceptionName(_SegmentException), format: message, arguments: getVaList(args))
+        #endif
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -27,14 +27,18 @@ extension Analytics {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`} catch {`
`30`		`- assertionFailure("\(error)")`
	`30`	`+ exceptionFailure("\(error)")`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`public func track(name: String, properties: [String: Any]?) {`
`35`	`35`	`var props: JSON? = nil`
`36`	`36`	`if let properties = properties {`
`37`		`- props = try? JSON(properties)`
	`37`	`+ do {`
	`38`	`+ props = try JSON(properties)`
	`39`	`+ } catch {`
	`40`	`+ exceptionFailure("\(error)")`
	`41`	`+ }`
`38`	`42`	`}`
`39`	`43`	`let event = TrackEvent(event: name, properties: props)`
`40`	`44`	`process(incomingEvent: event)`
`@@ -64,7 +68,7 @@ extension Analytics {`
`64`	`68`	`let event = IdentifyEvent(userId: userId, traits: jsonTraits)`
`65`	`69`	`process(incomingEvent: event)`
`66`	`70`	`} catch {`
`67`		`- assertionFailure("\(error)")`
	`71`	`+ exceptionFailure("\(error)")`
`68`	`72`	`}`
`69`	`73`	`}`
`70`	`74`
`@@ -78,7 +82,7 @@ extension Analytics {`
`78`	`82`	`let event = IdentifyEvent(traits: jsonTraits)`
`79`	`83`	`process(incomingEvent: event)`
`80`	`84`	`} catch {`
`81`		`- assertionFailure("\(error)")`
	`85`	`+ exceptionFailure("\(error)")`
`82`	`86`	`}`
`83`	`87`	`}`
`84`	`88`
`@@ -109,7 +113,7 @@ extension Analytics {`
`109`	`113`	`process(incomingEvent: event)`
`110`	`114`	`}`
`111`	`115`	`} catch {`
`112`		`- assertionFailure("\(error)")`
	`116`	`+ exceptionFailure("\(error)")`
`113`	`117`	`}`
`114`	`118`	`}`
`115`	`119`
`@@ -133,7 +137,7 @@ extension Analytics {`
`133`	`137`	`process(incomingEvent: event)`
`134`	`138`	`}`
`135`	`139`	`} catch {`
`136`		`- assertionFailure("\(error)")`
	`140`	`+ exceptionFailure("\(error)")`
`137`	`141`	`}`
`138`	`142`	`}`
`139`	`143`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,11 @@ public class Context: PlatformPlugin {`
`34`	`34`	`context.merge(eventContext) { (_, new) in new }`
`35`	`35`	`}`
`36`	`36`
`37`		`- workingEvent.context = try? JSON(context)`
	`37`	`+ do {`
	`38`	`+ workingEvent.context = try JSON(context)`
	`39`	`+ } catch {`
	`40`	`+ exceptionFailure("Unable to convert context to JSON: \(error)")`
	`41`	`+ }`
`38`	`42`
`39`	`43`	`return workingEvent`
`40`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,11 @@ public class DeviceToken: PlatformPlugin {`
`24`	`24`	`guard var workingEvent = event else { return event }`
`25`	`25`	`if var context = workingEvent.context?.dictionaryValue, let token = token {`
`26`	`26`	`context[keyPath: "device.token"] = token`
`27`		`- workingEvent.context = try? JSON(context)`
	`27`	`+ do {`
	`28`	`+ workingEvent.context = try JSON(context)`
	`29`	`+ } catch {`
	`30`	`+ exceptionFailure("Unable to convert context to JSON: \(error)")`
	`31`	`+ }`
`28`	`32`	`}`
`29`	`33`	`return workingEvent`
`30`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,13 +31,18 @@ public enum MetricType: Int {`
`31`	`31`
`32`	`32`	`public extension RawEvent {`
`33`	`33`	`mutating func addMetric(_ type: MetricType, name: String, value: Double, tags: [String]?, timestamp: Date) {`
`34`		`- guard let metric = try? JSON(with: Metric(eventName: "\(Self.self)", metricName: name, value: value, tags: tags, type: type, timestamp: Date())) else { return }`
	`34`	`+ guard let metric = try? JSON(with: Metric(eventName: "\(Self.self)", metricName: name, value: value, tags: tags, type: type, timestamp: Date())) else {`
	`35`	+ exceptionFailure("Unable to add metric `\(name)`")
	`36`	`+ return`
	`37`	`+ }`
`35`	`38`	`if self.metrics == nil {`
`36`	`39`	`metrics = [JSON]()`
`37`	`40`	`}`
`38`	`41`
`39`	`42`	`if let jsonEncoded = try? JSON(with: metric) {`
`40`	`43`	`metrics?.append(jsonEncoded)`
	`44`	`+ } else {`
	`45`	+ exceptionFailure("Unable to encode metric `\(name)` to JSON.")
`41`	`46`	`}`
`42`	`47`	`}`
`43`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,7 @@ public class HTTPClient {`
`69`	`69`	`urlRequest.httpMethod = "POST"`
`70`	`70`
`71`	`71`	`guard let session = try? configuredSession(for: writeKey) else {`
	`72`	`+ exceptionFailure("Unable to create a HTTPClient session!")`
`72`	`73`	`completion(false)`
`73`	`74`	`return nil`
`74`	`75`	`}`