Merge pull request #176 from optimizely/jae/errors

cleanup NSError conversion for ObjC

Author: jaeopt

OptimizelySDK/Customization/DefaultEventDispatcher.swift

@@ -142,20 +142,20 @@ open class DefaultEventDispatcher : BackgroundingCallbacks, OPTEventDispatcher {
                 self.sendEvent(event: event) { (result) -> (Void) in
                     switch result {
                     case .failure(let error):
-                        self.logger?.e(error.localizedDescription)
+                        self.logger?.e(error.reason)
                         failureCount += 1
                     case .success(_):
                         // we succeeded. remove the batch size sent.
                         if let removedItem:[EventForDispatch] = self.dataStore.removeFirstItems(count: self.batchSize) {
                             if self.batchSize == 1 && removedItem.first != event {
-                                self.logger?.log(level: .error, message: "Removed event different from sent event")
+                                self.logger?.e("Removed event different from sent event")
                             }
                             else {
-                                self.logger?.log(level: .debug, message: "Successfully sent event " + event.body.debugDescription)
+                                self.logger?.d("Successfully sent event " + event.body.debugDescription)
                             }
                         }
                         else {
-                            self.logger?.log(level: .error, message: "Removed event nil for sent item")
+                            self.logger?.e("Removed event nil for sent item")
                         }
                         // reset failureCount
                         failureCount = 0

OptimizelySDK/Customization/DefaultLogger.swift

@@ -37,7 +37,7 @@ open class DefaultLogger : OPTLogger {
         if level.rawValue > DefaultLogger.logLevel.rawValue {
             return
         }
-        let message = "[OPTIMIZELY][" + level.name + "]:" + message
+        let message = "[OPTIMIZELY][" + level.name + "] " + message
         NSLog(message)
     }
 }

OptimizelySDK/Implementation/DefaultDatafileHandler.swift

@@ -40,7 +40,7 @@ class DefaultDatafileHandler : OPTDatafileHandler {
             case .success(let data):
                 datafile = data
             case .failure(let error):
-                self.logger?.e(error.localizedDescription)
+                self.logger?.e(error.reason)
             }
             group.leave()
         }
@@ -76,7 +76,7 @@ class DefaultDatafileHandler : OPTDatafileHandler {
     open func getResponseData(sdkKey:String, response:HTTPURLResponse, url:URL?) -> Data? {
         if let url = url, let data = try? Data(contentsOf: url) {
             if let str = String(data: data, encoding: .utf8) {
-                self.logger?.log(level: .debug, message: str)
+                self.logger?.d(str)
             }
             self.saveDatafile(sdkKey: sdkKey, dataFile: data)
             if let lastModified = response.allHeaderFields["Last-Modified"] {
@@ -110,7 +110,7 @@ class DefaultDatafileHandler : OPTDatafileHandler {
                         result = .success(data)
                     }
                     else if response.statusCode == 304 {
-                        self.logger?.log(level: .debug, message: "The datafile was not modified and won't be downloaded again")
+                        self.logger?.d("The datafile was not modified and won't be downloaded again")
                         result = .success(nil)
                     }
                 }
@@ -209,7 +209,7 @@ class DefaultDatafileHandler : OPTDatafileHandler {
                     datafileChangeNotification(data)
                 }
             case .failure(let error):
-                self.logger?.e(error.localizedDescription)
+                self.logger?.e(error.reason)
             }
 
             if self.hasPeriodUpdates(sdkKey: sdkKey) {

OptimizelySDK/Optimizely/OptimizelyClient+ObjC.swift

@@ -70,7 +70,7 @@ extension OptimizelyClient {
         start { result in
             switch result {
             case .failure(let error):
-                completion?(nil, self.convertErrorForObjc(error))
+                completion?(nil, error as NSError)
             case .success(let data):
                 completion?(data, nil)
             }
@@ -347,25 +347,6 @@ extension OptimizelyClient {
         }
     }
 
-    /// Conver Swift Error for Objective-C interfaces
-    ///
-    /// - Parameter error: Swift Error
-    /// - Returns: Objective-C NSError converted
-    func convertErrorForObjc(_ error: Error) -> NSError {
-        var errorInObjc: NSError
-        
-        // TODO: [Jae] add more details for error types
-        
-        switch error {
-        default:
-            errorInObjc = NSError(domain: "com.optimizely.OptimizelySwiftSDK",
-                                  code: 1000,
-                                  userInfo: [NSLocalizedDescriptionKey: error.localizedDescription])
-        }
-        
-        return errorInObjc
-    }
-    
     @available(swift, obsoleted: 1.0)
     @objc(notificationCenter)
     /// NotificationCenter for Objective-C interface support

OptimizelySDK/Optimizely/OptimizelyError.swift

@@ -75,6 +75,8 @@ public enum OptimizelyError: Error {
     case eventDispatchFailed(_ reason: String)
 }
 
+// MARK: - CustomStringConvertible
+
 extension OptimizelyError: CustomStringConvertible {
     public var description: String {
         return "[Optimizely][Error] " + self.reason
@@ -135,3 +137,12 @@ extension OptimizelyError: CustomStringConvertible {
         return message
     }
 }
+
+// MARK: - LocalizedError (ObjC NSError)
+
+extension OptimizelyError: LocalizedError {
+    public var errorDescription: String? {
+        return self.reason
+    }
+}
+