Merge pull request #323 from pusher/feature/198-remove-print-logging

Refactor 'print()' logging to use 'PusherLogger'

Author: danielrbrowne

Sources/Extensions/PusherWebsocketDelegate.swift

@@ -11,19 +11,20 @@ extension PusherConnection: WebSocketConnectionDelegate {
         - parameter string: The message received over the websocket
     */
     public func webSocketDidReceiveMessage(connection: WebSocketConnection, string: String) {
-        self.delegate?.debugLog?(message: PusherLogger.debug(for: .receivedMessage, context: string))
+        PusherLogger.shared.debug(for: .receivedMessage, context: string)
 
         guard let payload = PusherParser.getPusherEventJSON(from: string),
             let event = payload[Constants.JSONKeys.event] as? String
         else {
-            self.delegate?.debugLog?(message: PusherLogger.debug(for: .unableToHandleIncomingMessage, context: string))
+            PusherLogger.shared.debug(for: .unableToHandleIncomingMessage,
+                                      context: string)
             return
         }
 
         if event == Constants.Events.Pusher.error {
             guard let error = PusherError(jsonObject: payload) else {
-                self.delegate?.debugLog?(message: PusherLogger.debug(for: .unableToHandleIncomingError,
-                                                                     context: string))
+                PusherLogger.shared.debug(for: .unableToHandleIncomingError,
+                                          context: string)
                 return
             }
             self.handleError(error: error)
@@ -35,7 +36,7 @@ extension PusherConnection: WebSocketConnectionDelegate {
     /// Delegate method called when a pong is received over a websocket
     /// - Parameter connection: The websocket that has received the pong
     public func webSocketDidReceivePong(connection: WebSocketConnection) {
-        self.delegate?.debugLog?(message: PusherLogger.debug(for: .pongReceived))
+        PusherLogger.shared.debug(for: .pongReceived)
         resetActivityTimeoutTimer()
     }
 
@@ -63,7 +64,7 @@ extension PusherConnection: WebSocketConnectionDelegate {
         updateConnectionState(to: .disconnected)
 
         guard !intentionalDisconnect else {
-            self.delegate?.debugLog?(message: PusherLogger.debug(for: .intentionalDisconnection))
+            PusherLogger.shared.debug(for: .intentionalDisconnection)
             return
         }
 
@@ -81,7 +82,7 @@ extension PusherConnection: WebSocketConnectionDelegate {
         }
 
         guard reconnectAttemptsMax == nil || reconnectAttempts < reconnectAttemptsMax! else {
-            self.delegate?.debugLog?(message: PusherLogger.debug(for: .maxReconnectAttemptsLimitReached))
+            PusherLogger.shared.debug(for: .maxReconnectAttemptsLimitReached)
             return
         }
 
@@ -90,9 +91,9 @@ extension PusherConnection: WebSocketConnectionDelegate {
 
     public func webSocketViabilityDidChange(connection: WebSocketConnection, isViable: Bool) {
         if isViable {
-            self.delegate?.debugLog?(message: PusherLogger.debug(for: .networkConnectionViable))
+            PusherLogger.shared.debug(for: .networkConnectionViable)
         } else {
-            self.delegate?.debugLog?(message: PusherLogger.debug(for: .networkConnectionUnviable))
+            PusherLogger.shared.debug(for: .networkConnectionUnviable)
         }
     }
 
@@ -101,10 +102,10 @@ extension PusherConnection: WebSocketConnectionDelegate {
         case .success:
             updateConnectionState(to: .reconnecting)
         case .failure(let error):
-            self.delegate?.debugLog?(message: PusherLogger.debug(for: .errorReceived,
-                                                                 context: """
+            PusherLogger.shared.debug(for: .errorReceived,
+                                      context: """
                 Path migration error: \(error.debugDescription)
-                """))
+                """)
         }
     }
 
@@ -187,8 +188,8 @@ extension PusherConnection: WebSocketConnectionDelegate {
             context = "\(timeInterval) seconds " + context
         }
 
-        self.delegate?.debugLog?(message: PusherLogger.debug(for: loggingEvent,
-                                                             context: context))
+        PusherLogger.shared.debug(for: loggingEvent,
+                                  context: context)
     }
 
     /// Logs the websocket disconnection event.
@@ -214,8 +215,8 @@ extension PusherConnection: WebSocketConnectionDelegate {
             closeMessage += " Reason: \(reasonString)."
         }
 
-        self.delegate?.debugLog?(message: PusherLogger.debug(for: .disconnectionWithoutError,
-                                                             context: closeMessage))
+        PusherLogger.shared.debug(for: .disconnectionWithoutError,
+                                  context: closeMessage)
     }
 
     /**
@@ -232,9 +233,9 @@ extension PusherConnection: WebSocketConnectionDelegate {
     }
 
     public func webSocketDidReceiveError(connection: WebSocketConnection, error: NWError) {
-        self.delegate?.debugLog?(message: PusherLogger.debug(for: .errorReceived,
-                                                             context: """
+        PusherLogger.shared.debug(for: .errorReceived,
+                                  context: """
             Error: \(error.debugDescription)
-            """))
+            """)
     }
 }

Sources/Helpers/PusherLogger.swift

@@ -13,12 +13,32 @@ internal class PusherLogger {
         case presenceChannelSubscriptionAttemptWithoutChannelData =
         "Attempting to subscribe to presence channel but no channelData value provided"
         case subscriptionSucceededNoDataInPayload = "Subscription succeeded event received without data key in payload"
+        case unableToSubscribeToChannel = "Unable to subscribe to channel:"
+        case unableToAddMemberToChannel = "Unable to add member to channel"
+        case unableToRemoveMemberFromChannel = "Unable to remove member from channel"
+        case authInfoForCompletionHandlerIsNil = "Auth info passed to authorizer completionHandler was nil"
+        case authenticationFailed = "Authentication failed. You may not be connected"
+        case authValueOnSubscriptionNotSupported = """
+            Passing an auth value to 'subscribe' is not supported for encrypted channels. \
+            Event decryption will fail. You must use one of the following auth methods: \
+            'endpoint', 'authRequestBuilder', 'authorizer'
+            """
 
         // Events
 
         case clientEventSent = "sendClientEvent"
         case eventSent = "sendEvent"
         case skippedEventAfterDecryptionFailure = "Skipping event that failed to decrypt on channel"
+        case cannotSendClientEventForChannel = "You must be subscribed to a private or presence channel to send client events"
+        case clientEventsNotSupported = "Client events are not supported on encrypted channels:"
+
+        // JSON parsing
+
+        case unableToParseStringAsJSON = "Unable to parse string as JSON:"
+
+        // Misc
+
+        case genericError = ""
 
         // Network
 
@@ -48,63 +68,62 @@ internal class PusherLogger {
         case error      = "[PUSHER ERROR]"
     }
 
+    internal static let shared = PusherLogger()
+
+    internal weak var delegate: PusherDelegate?
+
     // MARK: - Event logging
 
-    /// A debug message relating to a particular event of interest.
+    /// Logs a debug message relating to a particular event of interest.
     /// - Parameters:
     ///   - event: A particular `LoggingEvent` of interest.
     ///   - context: Additional context for the message.
-    /// - Returns: A `String` with information to log concerning the event.
-    internal static func debug(for event: LoggingEvent,
-                               context: CustomStringConvertible? = nil) -> String {
-        return message(for: event, level: .debug, context: context)
+    internal func debug(for event: LoggingEvent,
+                        context: CustomStringConvertible? = nil) {
+        message(for: event, level: .debug, context: context)
     }
 
-    /// An informational message relating to a particular event of interest.
+    /// Logs an informational message relating to a particular event of interest.
     /// - Parameters:
     ///   - event: A particular `LoggingEvent` of interest.
     ///   - context: Additional context for the message.
-    /// - Returns: A `String` with information to log concerning the event.
-    internal static func info(for event: LoggingEvent,
-                              context: CustomStringConvertible? = nil) -> String {
-        return message(for: event, level: .info, context: context)
+    internal func info(for event: LoggingEvent,
+                       context: CustomStringConvertible? = nil) {
+        message(for: event, level: .info, context: context)
     }
 
-    /// A warning message relating to a particular event of interest.
+    /// Logs a warning message relating to a particular event of interest.
     /// - Parameters:
     ///   - event: A particular `LoggingEvent` of interest.
     ///   - context: Additional context for the message.
-    /// - Returns: A `String` with information to log concerning the event.
-    internal static func warning(for event: LoggingEvent,
-                                 context: CustomStringConvertible? = nil) -> String {
-        return message(for: event, level: .warning, context: context)
+    internal func warning(for event: LoggingEvent,
+                          context: CustomStringConvertible? = nil) {
+        message(for: event, level: .warning, context: context)
     }
 
-    /// An error message relating to a particular event of interest.
+    /// Logs an error message relating to a particular event of interest.
     /// - Parameters:
     ///   - event: A particular `LoggingEvent` of interest.
     ///   - context: Additional context for the message.
-    /// - Returns: A `String` with information to log concerning the event.
-    internal static func error(for event: LoggingEvent,
-                               context: CustomStringConvertible? = nil) -> String {
-        return message(for: event, level: .error, context: context)
+    internal func error(for event: LoggingEvent,
+                        context: CustomStringConvertible? = nil) {
+        message(for: event, level: .error, context: context)
     }
 
     // MARK: - Private methods
 
-    /// An informational message relating to a particular event of interest.
+    /// Logs an informational message relating to a particular event of interest.
     /// - Parameter event: A particular `LoggingEvent` of interest.
     /// - Parameter level: The `LoggingLevel` to set for the message.
     /// - Parameter context: Additional context for the message.
-    /// - Returns: A `String` with information to log concerning the event.
-    private static func message(for event: LoggingEvent,
-                                level: LoggingLevel,
-                                context: CustomStringConvertible? = nil) -> String {
+    private func message(for event: LoggingEvent,
+                         level: LoggingLevel,
+                         context: CustomStringConvertible? = nil) {
         var message = "\(level.rawValue) \(event.rawValue)"
         if let context = context {
             message += " \(context)"
         }
 
-        return message
+        self.delegate?.debugLog?(message: message)
     }
 }

Sources/Helpers/PusherParser.swift

@@ -20,10 +20,12 @@ internal struct PusherParser {
                                                                   options: []) as? [String: AnyObject] {
                 return jsonObject
             } else {
-                print("Unable to parse string from WebSocket: \(string)")
+                PusherLogger.shared.debug(for: .unableToParseStringAsJSON,
+                                          context: string)
             }
         } catch let error as NSError {
-            print("Error: \(error.localizedDescription)")
+            PusherLogger.shared.error(for: .genericError,
+                                      context: error.localizedDescription)
         }
         return nil
     }
@@ -42,7 +44,8 @@ internal struct PusherParser {
             if let jsonData = data, let jsonObject = try? JSONSerialization.jsonObject(with: jsonData, options: []) {
                 return jsonObject
             } else {
-                print("Unable to parse string as JSON - check that your JSON is valid.")
+                PusherLogger.shared.debug(for: .unableToParseStringAsJSON,
+                                          context: string)
             }
         }
         return nil

Sources/Models/PusherChannel.swift

@@ -172,11 +172,9 @@ open class PusherChannel: NSObject {
     */
     open func trigger(eventName: String, data: Any) {
         if PusherEncryptionHelpers.isEncryptedChannel(channelName: self.name) {
-            let error = """
-            ERROR: Client events are not supported on encrypted channels: '\(self.name)'. \
-            Client event '\(eventName)' will not be sent.
-            """
-            print(error)
+            let context = "'\(self.name)'. Client event '\(eventName)' will not be sent"
+            PusherLogger.shared.error(for: .clientEventsNotSupported,
+                                      context: context)
             return
         }
 

Sources/Models/PusherPresenceChannel.swift

@@ -138,10 +138,12 @@ public typealias PusherUserInfoObject = [String: AnyObject]
                                                                   options: []) as? [String: AnyObject] {
                 return jsonObject
             } else {
-                print("Unable to parse string: \(channelData)")
+                PusherLogger.shared.debug(for: .unableToParseStringAsJSON,
+                                          context: channelData)
             }
         } catch let error as NSError {
-            print(error.localizedDescription)
+            PusherLogger.shared.error(for: .genericError,
+                                      context: error.localizedDescription)
         }
         return nil
     }

Sources/PusherSwift.swift

@@ -57,14 +57,7 @@ let CLIENT_NAME = "pusher-websocket-swift"
         let isEncryptedChannel = PusherEncryptionHelpers.isEncryptedChannel(channelName: channelName)
 
         if isEncryptedChannel && auth != nil {
-            let error = """
-
-            WARNING: Passing an auth value to 'subscribe' is not supported for encrypted channels. \
-            Event decryption will fail. You must use one of the following auth methods: \
-            'endpoint', 'authRequestBuilder', 'authorizer'
-
-            """
-            print(error)
+            PusherLogger.shared.warning(for: .authValueOnSubscriptionNotSupported)
         }
 
         return self.connection.subscribe(