Merge branch 'master' into feature/321-guard-let

Author: Daniel Browne

CHANGELOG.md

@@ -4,7 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/pusher/pusher-websocket-swift/compare/9.1.0...HEAD)
+## [Unreleased](https://github.com/pusher/pusher-websocket-swift/compare/9.1.1...HEAD)
+
+## [9.1.1](https://github.com/pusher/pusher-websocket-swift/compare/9.1.0...9.1.1) - 2020-12-15
+
+### Fixed
+
+- Resolved a race condition that could prevent automatic reconnection attempts in certain circumstances.
 
 ## [9.1.0](https://github.com/pusher/pusher-websocket-swift/compare/9.0.0...9.1.0) - 2020-12-07
 
@@ -73,7 +79,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- Added new `bind` functions which accept a callback that receives a `PusherEvent`. A `PusherEvent` represents an event received from the websocket and has properties containing the event name, channel name and data. In addition, `PusherEvent` has a new property, `userId`, which allows you to verify the ID of the user who triggered a client event on a presence channel. You can read more about this feature in [the docs](https://pusher.com/docs/channels/using_channels/events#user-id-in-client-events). All the old `bind` functions are still available for backwards compatibility. The `data` property of `PusherEvent` is not automatically parsed from JSON and you can decide to parse that as required. The parsing behaviour is unchanged for data passed to callbacks bound by the old `bind` functions.
+- Added new `bind` functions which accept a callback that receives a `PusherEvent`. A `PusherEvent` represents an event received from the websocket and has properties containing the event name, channel name and data. In addition, `PusherEvent` has a new property, `userId`, which allows you to verify the ID of the user who triggered a client event on a presence channel. You can read more about this feature in [the docs](https://pusher.com/docs/channels/using_channels/events#user-id-in-client-events). All the old `bind` functions are still available for backwards compatibility. The `data` property of `PusherEvent` is not automatically parsed from JSON and you can decide to parse that as required. The parsing behavior is unchanged for data passed to callbacks bound by the old `bind` functions.
 
 ### Changed
 

Cartfile

@@ -1,2 +1,2 @@
 github "bitmark-inc/tweetnacl-swiftwrap" ~> 1.0
-github "pusher/NWWebSocket" ~> 0.5.0
+github "pusher/NWWebSocket" ~> 0.5.1

Cartfile.resolved

@@ -1,2 +1,2 @@
 github "bitmark-inc/tweetnacl-swiftwrap" "1.0.2"
-github "pusher/NWWebSocket" "0.5.0"
+github "pusher/NWWebSocket" "0.5.1"

Package.resolved

@@ -9,7 +9,7 @@ let package = Package(
         .library(name: "PusherSwift", targets: ["PusherSwift"])
     ],
     dependencies: [
-        .package(url: "https://github.com/pusher/NWWebSocket.git", .upToNextMajor(from: "0.5.0")),
+        .package(url: "https://github.com/pusher/NWWebSocket.git", .upToNextMajor(from: "0.5.1")),
         .package(url: "https://github.com/bitmark-inc/tweetnacl-swiftwrap", .upToNextMajor(from: "1.0.0")),
     ],
     targets: [

Package.swift

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'PusherSwift'
-  s.version          = '9.1.0'
+  s.version          = '9.1.1'
   s.summary          = 'A Pusher client library in Swift'
   s.homepage         = 'https://github.com/pusher/pusher-websocket-swift'
   s.license          = 'MIT'
@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
   s.source_files  = ['Sources/**/*.swift']
 
   s.dependency 'TweetNacl', '~> 1.0.0'
-  s.dependency 'NWWebSocket', '~> 0.5.0'
+  s.dependency 'NWWebSocket', '~> 0.5.1'
 
   s.ios.deployment_target = '13.0'
   s.osx.deployment_target = '10.15'

PusherSwift.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'PusherSwiftWithEncryption'
-  s.version          = '9.1.0'
+  s.version          = '9.1.1'
   s.summary          = 'A Pusher client library in Swift that supports encrypted channels'
   s.homepage         = 'https://github.com/pusher/pusher-websocket-swift'
   s.license          = 'MIT'
@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
   s.source_files  = ['Sources/**/*.swift']
 
   s.dependency 'TweetNacl', '~> 1.0.0'
-  s.dependency 'NWWebSocket', '~> 0.5.0'
+  s.dependency 'NWWebSocket', '~> 0.5.1'
 
   s.ios.deployment_target = '13.0'
   s.osx.deployment_target = '10.15'

PusherSwiftWithEncryption.podspec

@@ -146,7 +146,7 @@ let package = Package(
             targets: ["YourPackage"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/pusher/pusher-websocket-swift.git", from: "9.1.0"),
+        .package(url: "https://github.com/pusher/pusher-websocket-swift.git", from: "9.1.1"),
     ],
     targets: [
         .target(
@@ -578,7 +578,7 @@ All of this is the case if you have the client option of `autoReconnect` set as
 
 N.B: If the Pusher servers close the websocket with a [Channels Protocol closure code](https://pusher.com/docs/channels/library_auth_reference/pusher-websockets-protocol#connection-closure), then the `autoReconnect` option is ignored, and the reconnection strategy is determined by the specific closure code that was received.
 
-There are a couple of properties on the connection (`PusherConnection`) that you can set that affect how the reconnection behaviour works. These are:
+There are a couple of properties on the connection (`PusherConnection`) that you can set that affect how the reconnection behavior works. These are:
 
 - `public var reconnectAttemptsMax: Int? = 6` - if you set this to `nil` then there is no maximum number of reconnect attempts and so attempts will continue to be made with an exponential backoff (based on number of attempts), otherwise only as many attempts as this property's value will be made before the connection's state moves to `.disconnected`
 - `public var maxReconnectGapInSeconds: Double? = nil` - if you want to set a maximum length of time (in seconds) between reconnect attempts then set this property appropriately
@@ -804,7 +804,7 @@ let pusherAuth = PusherAuth(auth: yourAuthString, channelData: yourOptionalChann
 let chan = self.pusher.subscribe(channelName, auth: pusherAuth)
 ```
 
-This PusherAuth object can be initialised with just an auth (String) value if the subscription is to a private channel, or both an `auth (String)` and `channelData (String)` pair of values if the subscription is to a presence channel.
+This PusherAuth object can be initialized with just an auth (String) value if the subscription is to a private channel, or both an `auth (String)` and `channelData (String)` pair of values if the subscription is to a presence channel.
 
 These `auth` and `channelData` values are the values that you received if the json object created by a call to pusher.authenticate(...) in one of our various server libraries.
 
@@ -877,7 +877,7 @@ PusherChannel *chan = [pusher subscribeWithChannelName:@"my-channel"];
 
 ### Global events
 
-You can attach behaviour to these events regardless of the channel the event is broadcast to. 
+You can attach behavior to these events regardless of the channel the event is broadcast to. 
 
 #### Swift
 

README.md

@@ -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()
     }
 
@@ -49,7 +50,7 @@ extension PusherConnection: WebSocketConnectionDelegate {
     public func webSocketDidDisconnect(connection: WebSocketConnection,
                                        closeCode: NWProtocolWebSocket.CloseCode,
                                        reason: Data?) {
-        // Handles setting channel subscriptions to unsubscribed wheter disconnection
+        // Handles setting channel subscriptions to unsubscribed whether disconnection
         // is intentional or not
         if connectionState == .disconnecting || connectionState == .connected {
             for (_, channel) in self.channels.channels {
@@ -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/Extensions/PusherWebsocketDelegate.swift

@@ -13,19 +13,39 @@ 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
 
         case networkConnectionViable = "Network connection became viable"
         case networkConnectionUnviable = "Network connection became unviable"
 
-        // Websockets
+        // WebSocket
 
         case attemptReconnectionAfterWaiting = "Attempting to reconnect after waiting"
         case attemptReconnectionImmediately = "Attempting to reconnect immediately"
@@ -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)
     }
 }