add loglevel and logDelegate to IterableConfig.

Author: tapashmajumder

swift-sdk.xcodeproj/project.pbxproj

@@ -1088,7 +1088,6 @@
 				);
 				MACH_O_TYPE = mh_dylib;
 				OTHER_SWIFT_FLAGS = "";
-				"OTHER_SWIFT_FLAGS[arch=*]" = "-D LOG";
 				PRODUCT_BUNDLE_IDENTIFIER = "iterable.swift-sdk";
 				PRODUCT_NAME = IterableSDK;
 				PROVISIONING_PROFILE_SPECIFIER = "";

swift-sdk/IterableConfig.swift

@@ -34,6 +34,26 @@ import Foundation
     @objc(handleIterableCustomAction:context:) func handle(iterableCustomAction action:IterableAction, inContext context: IterableActionContext) -> Bool
 }
 
+/**
+ * Lowest level that will be logged. By default the LogLevel is set to LogLevel.info.
+ */
+@objc public enum LogLevel : Int {
+    case debug = 1
+    case info
+    case error
+}
+
+/**
+ * Logging Delegate.
+ */
+@objc public protocol IterableLogDelegate: class {
+    /**
+     * Log a message.
+     * - parameter level: The log level.
+     * - parameter message: The message to log. The message will include file, method and line of the call.
+     */
+    @objc(log:Message:) func log(level: LogLevel, message: String)
+}
 
 /**
  Iterable Configuration Object. Use this when initializing the API.
@@ -72,4 +92,17 @@ public class IterableConfig : NSObject {
     /// When set to true, it will check for deferred deeplinks on first time app launch
     /// after installation from the App Store.
     public var checkForDeferredDeeplink = false
+    
+    /// The lowest level that will be logged. The levels go from
+    /// debug < (less than) info < (less than) error.
+    /// The default level is `.info`.
+    public var logLevel = LogLevel.info
+    
+    /// Implement the protocol IterableLogDelegate and set it here to change logging.
+    /// Out of the box you have the following
+    /// 1. DefaultLogDelegate. It will use OsLog for .error, cosole for .info and no logging for debug.
+    /// 2. NoneLogDelegate. No logging messages will be output.
+    /// 3. AllLogDelegate. It will log everything to console.
+    /// The default value is `DefaultLogDelegate`.
+    public var logDelegate: IterableLogDelegate = DefaultLogDelegate()
 }

swift-sdk/IterableUtil.swift

@@ -51,40 +51,58 @@ import os
     }
 }
 
-public func ITBError(_ message: String? = nil, file: String = #file, method: String = #function, line: Int = #line) {
-    let logMessage = formatLogMessage(message: message, file: file, method: method, line: line)
-    if #available(iOS 10.0, *) {
-        os_log("%@", log: OSLog.default, type: .error, logMessage)
-    } else {
-        print(logMessage)
+public class DefaultLogDelegate: IterableLogDelegate {
+    public func log(level: LogLevel = .info, message: String) {
+        guard let configLogLevel = IterableAPIInternal.sharedInstance?.config.logLevel, level.rawValue >= configLogLevel.rawValue else {
+            return
+        }
+        
+        switch level {
+        case .error:
+            // Error goes to os_log, if available
+            if #available(iOS 10.0, *) {
+                os_log("%@", log: OSLog.default, type: .error, message)
+            } else {
+                print(message)
+            }
+        case .info:
+            let markerStr = "💛"
+            print("\(markerStr) \(message)")
+        case .debug:
+            // no logging
+            break
+        }
     }
 }
 
-private func formatLogMessage(message: String?, file: String, method: String, line: Int) -> String {
+public func ITBError(_ message: String? = nil, file: String = #file, method: String = #function, line: Int = #line) {
+    let date = IterableAPIInternal.sharedInstance?.dateProvider.currentDate ?? Date()
+    let logMessage = formatLogMessage(message: message, file: file, method: method, line: line, date: date)
+    IterableAPIInternal.sharedInstance?.config.logDelegate.log(level: .error, message: logMessage)
+}
+
+private func formatLogMessage(message: String?, file: String, method: String, line: Int, date: Date) -> String {
     let fileUrl = NSURL(fileURLWithPath: file)
     let fileToDisplay = fileUrl.deletingPathExtension!.lastPathComponent
+
+    let formattedDate = formatDate(date: date)
 
     if let zeeMessage = message {
-        return "\(fileToDisplay):\(method):\(line): \(zeeMessage)"
+        return "\(formattedDate):\(fileToDisplay):\(method):\(line): \(zeeMessage)"
     } else {
-        return "\(fileToDisplay):\(method):\(line)"
+        return "\(formattedDate):\(fileToDisplay):\(method):\(line)"
     }
 }
 
-/// It will print the output only if 'LOG' is defined in the project via -D LOG as 'Other Swift Flags'
-public func ITBInfo(_ message: String? = nil, file: String = #file, method: String = #function, line: Int = #line) {
-    #if LOG
-    let fileUrl = NSURL(fileURLWithPath: file)
-    let fileToDisplay = fileUrl.deletingPathExtension!.lastPathComponent
-    
+private func formatDate(date: Date) -> String {
     let formatter = DateFormatter()
     formatter.dateFormat = "HH:mm:ss.SSSS"
-    let time = formatter.string(from: Date())
-    
-    if let zeeMessage = message {
-        print("===> \(time):\(fileToDisplay):\(method):\(line): \(zeeMessage)")
-    } else {
-        print("===> \(time):\(fileToDisplay):\(method):\(line)")
-    }
-    #endif
+    return formatter.string(from: date)
+}
+
+/// It will print the output only if 'LOG' is defined in the project via -D LOG as 'Other Swift Flags'
+public func ITBInfo(_ message: String? = nil, file: String = #file, method: String = #function, line: Int = #line) {
+    let date = IterableAPIInternal.sharedInstance?.dateProvider.currentDate ?? Date()
+    let logMessage = formatLogMessage(message: message, file: file, method: method, line: line, date: date)
+    IterableAPIInternal.sharedInstance?.config.logDelegate.log(level: .info, message: logMessage)
 }