Handling reconnect scenarios properly when socket is hung socketio#1375

https://github.com/socketio/socket.io-client-swift/pull/1375/files

Author: Ondrej Vesely

Package.swift

@@ -5,7 +5,7 @@ import PackageDescription
 let package = Package(
     name: "SocketIO",
     products: [
-        .library(name: "SocketIO", targets: ["SocketIO"])
+        .library(name: "SocketIO", targets: ["SocketIO"]),
     ],
     dependencies: [
         .package(url: "https://github.com/daltoniam/Starscream", .upToNextMinor(from: "4.0.0")),

Source/SocketIO/Ack/SocketAckEmitter.swift

@@ -28,7 +28,7 @@ import Foundation
 /// A class that represents a waiting ack call.
 ///
 /// **NOTE**: You should not store this beyond the life of the event handler.
-public final class SocketAckEmitter : NSObject {
+public final class SocketAckEmitter: NSObject {
     private unowned let socket: SocketIOClient
     private let ackNum: Int
 
@@ -74,7 +74,7 @@ public final class SocketAckEmitter : NSObject {
         guard ackNum != -1 else { return }
 
         do {
-            socket.emitAck(ackNum, with: try items.map({ try $0.socketRepresentation() }))
+            socket.emitAck(ackNum, with: try items.map { try $0.socketRepresentation() })
         } catch {
             socket.handleClientEvent(.error, data: [ackNum, items, error])
         }
@@ -89,7 +89,6 @@ public final class SocketAckEmitter : NSObject {
 
         socket.emitAck(ackNum, with: items)
     }
-
 }
 
 /// A class that represents an emit that will request an ack that has not yet been sent.
@@ -101,7 +100,7 @@ public final class SocketAckEmitter : NSObject {
 ///     ...
 /// }
 /// ```
-public final class OnAckCallback : NSObject {
+public final class OnAckCallback: NSObject {
     private let ackNumber: Int
     private let binary: Bool
     private let items: [Any]
@@ -129,18 +128,17 @@ public final class OnAckCallback : NSObject {
     ///                       To check for timeout, use `SocketAckStatus`'s `noAck` case.
     @objc
     public func timingOut(after seconds: Double, callback: @escaping AckCallback) {
-        guard let socket = self.socket, ackNumber != -1 else { return }
+        guard let socket = socket, ackNumber != -1 else { return }
 
         socket.ackHandlers.addAck(ackNumber, callback: callback)
         socket.emit(items, ack: ackNumber, binary: binary)
 
         guard seconds != 0 else { return }
 
-        socket.manager?.handleQueue.asyncAfter(deadline: DispatchTime.now() + seconds) {[weak socket] in
+        socket.manager?.handleQueue.asyncAfter(deadline: DispatchTime.now() + seconds) { [weak socket] in
             guard let socket = socket else { return }
 
             socket.ackHandlers.timeoutAck(self.ackNumber)
         }
     }
-
 }

Source/SocketIO/Ack/SocketAckManager.swift

@@ -26,7 +26,7 @@ import Dispatch
 import Foundation
 
 /// The status of an ack.
-public enum SocketAckStatus : String {
+public enum SocketAckStatus: String {
     // MARK: Cases
 
     /// The ack timed out.
@@ -43,7 +43,7 @@ public enum SocketAckStatus : String {
     }
 }
 
-private struct SocketAck : Hashable {
+private struct SocketAck: Hashable {
     let ack: Int
     var callback: AckCallback!
 
@@ -60,11 +60,11 @@ private struct SocketAck : Hashable {
         ack.hash(into: &hasher)
     }
 
-    fileprivate static func <(lhs: SocketAck, rhs: SocketAck) -> Bool {
+    fileprivate static func < (lhs: SocketAck, rhs: SocketAck) -> Bool {
         return lhs.ack < rhs.ack
     }
 
-    fileprivate static func ==(lhs: SocketAck, rhs: SocketAck) -> Bool {
+    fileprivate static func == (lhs: SocketAck, rhs: SocketAck) -> Bool {
         return lhs.ack == rhs.ack
     }
 }
@@ -83,6 +83,6 @@ class SocketAckManager {
 
     /// Should be called on handle queue
     func timeoutAck(_ ack: Int) {
-       acks.remove(SocketAck(ack: ack))?.callback?([SocketAckStatus.noAck.rawValue])
+        acks.remove(SocketAck(ack: ack))?.callback?([SocketAckStatus.noAck.rawValue])
     }
 }

Source/SocketIO/Client/SocketAnyEvent.swift

@@ -25,7 +25,7 @@
 import Foundation
 
 /// Represents some event that was received.
-public final class SocketAnyEvent : NSObject {
+public final class SocketAnyEvent: NSObject {
     // MARK: Properties
 
     /// The event name.

Source/SocketIO/Client/SocketIOClient.swift

@@ -49,7 +49,7 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
     public let nsp: String
 
     /// A handler that will be called on any event.
-    public private(set) var anyHandler: ((SocketAnyEvent) -> ())?
+    public private(set) var anyHandler: ((SocketAnyEvent) -> Void)?
 
     /// The array of handlers for this socket.
     public private(set) var handlers = [SocketEventHandler]()
@@ -122,10 +122,10 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
     /// - parameter timeoutAfter: The number of seconds after which if we are not connected we assume the connection
     ///                           has failed. Pass 0 to never timeout.
     /// - parameter handler: The handler to call when the client fails to connect.
-    open func connect(withPayload payload: [String: Any]? = nil, timeoutAfter: Double, withHandler handler: (() -> ())?) {
+    open func connect(withPayload payload: [String: Any]? = nil, timeoutAfter: Double, withHandler handler: (() -> Void)?) {
         assert(timeoutAfter >= 0, "Invalid timeout: \(timeoutAfter)")
 
-        guard let manager = self.manager, status != .connected else {
+        guard let manager = manager, status != .connected else {
             DefaultSocketLogger.Logger.log("Tried connecting on an already connected socket", type: logType)
             return
         }
@@ -148,7 +148,7 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
 
         guard timeoutAfter != 0 else { return }
 
-        manager.handleQueue.asyncAfter(deadline: DispatchTime.now() + timeoutAfter) {[weak self] in
+        manager.handleQueue.asyncAfter(deadline: DispatchTime.now() + timeoutAfter) { [weak self] in
             guard let this = self, this.status == .connecting || this.status == .notConnected else { return }
 
             this.status = .disconnected
@@ -158,7 +158,7 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
         }
     }
 
-    func createOnAck(_ items: [Any], binary: Bool = true) -> OnAckCallback {
+    func createOnAck(_ items: [Any], binary _: Bool = true) -> OnAckCallback {
         currentAck += 1
 
         return OnAckCallback(ackNumber: currentAck, items: items, socket: self)
@@ -211,10 +211,10 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
     /// - parameter event: The event to send.
     /// - parameter items: The items to send with this event. May be left out.
     /// - parameter completion: Callback called on transport write completion.
-    open func emit(_ event: String, _ items: SocketData..., completion: (() -> ())? = nil)  {
+    open func emit(_ event: String, _ items: SocketData..., completion: (() -> Void)? = nil) {
         emit(event, with: items, completion: completion)
     }
-    
+
     /// Send an event to the server, with optional data items and optional write completion handler.
     ///
     /// If an error occurs trying to transform `items` into their socket representation, a `SocketClientEvent.error`
@@ -223,10 +223,9 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
     /// - parameter event: The event to send.
     /// - parameter items: The items to send with this event. May be left out.
     /// - parameter completion: Callback called on transport write completion.
-    open func emit(_ event: String, with items: [SocketData], completion: (() -> ())?) {
-        
+    open func emit(_ event: String, with items: [SocketData], completion: (() -> Void)?) {
         do {
-            emit([event] + (try items.map({ try $0.socketRepresentation() })), completion: completion)
+            emit([event] + (try items.map { try $0.socketRepresentation() }), completion: completion)
         } catch {
             DefaultSocketLogger.Logger.error("Error creating socketRepresentation for emit: \(event), \(items)",
                                              type: logType)
@@ -257,7 +256,7 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
     open func emitWithAck(_ event: String, _ items: SocketData...) -> OnAckCallback {
         emitWithAck(event, with: items)
     }
-    
+
     /// Sends a message to the server, requesting an ack.
     ///
     /// **NOTE**: It is up to the server send an ack back, just calling this method does not mean the server will ack.
@@ -278,9 +277,8 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
     /// - parameter items: The items to send with this event. May be left out.
     /// - returns: An `OnAckCallback`. You must call the `timingOut(after:)` method before the event will be sent.
     open func emitWithAck(_ event: String, with items: [SocketData]) -> OnAckCallback {
-        
         do {
-            return createOnAck([event] + (try items.map({ try $0.socketRepresentation() })))
+            return createOnAck([event] + (try items.map { try $0.socketRepresentation() }))
         } catch {
             DefaultSocketLogger.Logger.error("Error creating socketRepresentation for emit: \(event), \(items)",
                                              type: logType)
@@ -295,10 +293,10 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
               ack: Int? = nil,
               binary: Bool = true,
               isAck: Bool = false,
-              completion: (() -> ())? = nil
-    ) {
+              completion: (() -> Void)? = nil)
+    {
         // wrap the completion handler so it always runs async via handlerQueue
-        let wrappedCompletion: (() -> ())? = (completion == nil) ? nil : {[weak self] in
+        let wrappedCompletion: (() -> Void)? = (completion == nil) ? nil : { [weak self] in
             guard let this = self else { return }
             this.manager?.handleQueue.async {
                 completion!()
@@ -421,7 +419,7 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
     open func off(_ event: String) {
         DefaultSocketLogger.Logger.log("Removing handler for event: \(event)", type: logType)
 
-        handlers = handlers.filter({ $0.event != event })
+        handlers = handlers.filter { $0.event != event }
     }
 
     /// Removes a handler with the specified UUID gotten from an `on` or `once`
@@ -432,7 +430,7 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
     open func off(id: UUID) {
         DefaultSocketLogger.Logger.log("Removing handler with id: \(id)", type: logType)
 
-        handlers = handlers.filter({ $0.id != id })
+        handlers = handlers.filter { $0.id != id }
     }
 
     /// Adds a handler for an event.
@@ -489,7 +487,7 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
 
         let id = UUID()
 
-        let handler = SocketEventHandler(event: event, id: id) {[weak self] data, ack in
+        let handler = SocketEventHandler(event: event, id: id) { [weak self] data, ack in
             guard let this = self else { return }
             this.off(id: id)
             callback(data, ack)
@@ -503,13 +501,13 @@ open class SocketIOClient: NSObject, SocketIOClientSpec {
     /// Adds a handler that will be called on every event.
     ///
     /// - parameter handler: The callback that will execute whenever an event is received.
-    open func onAny(_ handler: @escaping (SocketAnyEvent) -> ()) {
+    open func onAny(_ handler: @escaping (SocketAnyEvent) -> Void) {
         anyHandler = handler
     }
 
     /// Tries to reconnect to the server.
     @available(*, unavailable, message: "Call the manager's reconnect method")
-    open func reconnect() { }
+    open func reconnect() {}
 
     /// Removes all handlers.
     ///

Source/SocketIO/Client/SocketIOClientConfiguration.swift

@@ -23,7 +23,7 @@
 //  THE SOFTWARE.
 
 /// An array-like type that holds `SocketIOClientOption`s
-public struct SocketIOClientConfiguration : ExpressibleByArrayLiteral, Collection, MutableCollection {
+public struct SocketIOClientConfiguration: ExpressibleByArrayLiteral, Collection, MutableCollection {
     // MARK: Typealiases
 
     /// Type of element stored.
@@ -36,7 +36,7 @@ public struct SocketIOClientConfiguration : ExpressibleByArrayLiteral, Collectio
     public typealias Iterator = Array<SocketIOClientOption>.Iterator
 
     /// SubSequence type.
-    public typealias SubSequence =  Array<SocketIOClientOption>.SubSequence
+    public typealias SubSequence = Array<SocketIOClientOption>.SubSequence
 
     // MARK: Properties
 
@@ -115,7 +115,7 @@ public struct SocketIOClientConfiguration : ExpressibleByArrayLiteral, Collectio
     /// - parameter element: The element to insert.
     /// - parameter replacing: Whether to replace any occurrences of element to the new item. Default is `true`.
     public mutating func insert(_ element: Element, replacing replace: Bool = true) {
-        for i in 0..<backingArray.count where backingArray[i] == element {
+        for i in 0 ..< backingArray.count where backingArray[i] == element {
             guard replace else { return }
 
             backingArray[i] = element

Source/SocketIO/Client/SocketIOClientOption.swift

@@ -34,12 +34,12 @@ public enum SocketIOVersion: Int {
     case three = 3
 }
 
-protocol ClientOption : CustomStringConvertible, Equatable {
+protocol ClientOption: CustomStringConvertible, Equatable {
     func getSocketIOOptionValue() -> Any
 }
 
 /// The options for a client.
-public enum SocketIOClientOption : ClientOption {
+public enum SocketIOClientOption: ClientOption {
     /// If given, the WebSocket transport will attempt to use compression.
     case compress
 
@@ -213,7 +213,7 @@ public enum SocketIOClientOption : ClientOption {
             value = delegate
         case let .enableSOCKSProxy(enable):
             value = enable
-        case let.version(versionNum):
+        case let .version(versionNum):
             value = versionNum
         }
 
@@ -227,8 +227,7 @@ public enum SocketIOClientOption : ClientOption {
     /// - parameter lhs: Left operand to compare.
     /// - parameter rhs: Right operand to compare.
     /// - returns: `true` if the two are the same option.
-    public static func ==(lhs: SocketIOClientOption, rhs: SocketIOClientOption) -> Bool {
+    public static func == (lhs: SocketIOClientOption, rhs: SocketIOClientOption) -> Bool {
         return lhs.description == rhs.description
     }
-
 }

Source/SocketIO/Client/SocketIOClientSpec.swift

@@ -26,11 +26,11 @@ import Dispatch
 import Foundation
 
 /// Defines the interface for a SocketIOClient.
-public protocol SocketIOClientSpec : AnyObject {
+public protocol SocketIOClientSpec: AnyObject {
     // MARK: Properties
 
     /// A handler that will be called on any event.
-    var anyHandler: ((SocketAnyEvent) -> ())? { get }
+    var anyHandler: ((SocketAnyEvent) -> Void)? { get }
 
     /// The array of handlers for this socket.
     var handlers: [SocketEventHandler] { get }
@@ -77,7 +77,7 @@ public protocol SocketIOClientSpec : AnyObject {
     /// - parameter timeoutAfter: The number of seconds after which if we are not connected we assume the connection
     ///                           has failed. Pass 0 to never timeout.
     /// - parameter handler: The handler to call when the client fails to connect.
-    func connect(withPayload payload: [String: Any]?, timeoutAfter: Double, withHandler handler: (() -> ())?)
+    func connect(withPayload payload: [String: Any]?, timeoutAfter: Double, withHandler handler: (() -> Void)?)
 
     /// Called when the client connects to a namespace. If the client was created with a namespace upfront,
     /// then this is only called when the client connects to that namespace.
@@ -106,8 +106,8 @@ public protocol SocketIOClientSpec : AnyObject {
     /// - parameter event: The event to send.
     /// - parameter items: The items to send with this event. May be left out.
     /// - parameter completion: Callback called on transport write completion.
-    func emit(_ event: String, _ items: SocketData..., completion: (() -> ())?)
-    
+    func emit(_ event: String, _ items: SocketData..., completion: (() -> Void)?)
+
     /// Send an event to the server, with optional data items and optional write completion handler.
     ///
     /// If an error occurs trying to transform `items` into their socket representation, a `SocketClientEvent.error`
@@ -116,7 +116,7 @@ public protocol SocketIOClientSpec : AnyObject {
     /// - parameter event: The event to send.
     /// - parameter items: The items to send with this event. May be left out.
     /// - parameter completion: Callback called on transport write completion.
-    func emit(_ event: String, with items: [SocketData], completion: (() -> ())?)
+    func emit(_ event: String, with items: [SocketData], completion: (() -> Void)?)
 
     /// Call when you wish to tell the server that you've received the event for `ack`.
     ///
@@ -144,7 +144,7 @@ public protocol SocketIOClientSpec : AnyObject {
     /// - parameter items: The items to send with this event. May be left out.
     /// - returns: An `OnAckCallback`. You must call the `timingOut(after:)` method before the event will be sent.
     func emitWithAck(_ event: String, _ items: SocketData...) -> OnAckCallback
-    
+
     /// Sends a message to the server, requesting an ack.
     ///
     /// **NOTE**: It is up to the server send an ack back, just calling this method does not mean the server will ack.
@@ -260,7 +260,7 @@ public protocol SocketIOClientSpec : AnyObject {
     /// Adds a handler that will be called on every event.
     ///
     /// - parameter handler: The callback that will execute whenever an event is received.
-    func onAny(_ handler: @escaping (SocketAnyEvent) -> ())
+    func onAny(_ handler: @escaping (SocketAnyEvent) -> Void)
 
     /// Removes all handlers.
     ///
@@ -284,7 +284,7 @@ public extension SocketIOClientSpec {
 }
 
 /// The set of events that are generated by the client.
-public enum SocketClientEvent : String {
+public enum SocketClientEvent: String {
     // MARK: Cases
 
     /// Emitted when the client connects. This is also called on a successful reconnection. A connect event gets one