Ping optimization + custom encode / decode support

Author: romanbaitaliuk

ClusterWS-Client-Swift.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'ClusterWS-Client-Swift'
-  s.version          = '2.0.9'
+  s.version          = '3.0.0'
   s.summary          = 'Swift Client for ClusterWS'
   s.description      = 'Swift Client for ClusterWS - lightweight, fast and powerful framework for building horizontally & vertically scalable WebSocket applications in Node.js'
   s.homepage         = 'https://github.com/ClusterWS/ClusterWS-Client-Swift'

Docs/README.md

@@ -1,18 +1,18 @@
 <h1 align="center">ClusterWS Swift Client</h1>
-<h6 align="center">Build Scalable Node.js WebSocket Applications</h6>
+<h6 align="center">Build Scalable Node.js WebSockets Applications</h6>
 
 <p align="center">
- <img src="https://cdn.rawgit.com/goriunov/159120ca6a883d8d4e75543ec395d361/raw/146220360173a2428fceb44e7fc9b2cda8a17832/clusterws.svg" width="450">
+<img src="https://cdn.rawgit.com/goriunov/159120ca6a883d8d4e75543ec395d361/raw/d22028ecc726d7d3cc30a2a85cc7cc454b0afada/clusterws.svg" width="450">
 </p>
 
 <p align="center">
-<a title="Cocoapod Version" href="https://cocoapods.org/pods/ClusterWS-Client-Swift"><img src="https://img.shields.io/cocoapods/v/ClusterWS-Client-Swift.svg?style=for-the-badge"></a>
-<a title="Platforms" href="https://github.com/ClusterWS/ClusterWS-Client-Swift"><img src="https://img.shields.io/cocoapods/p/ClusterWS-Client-Swift.svg?style=for-the-badge"></a>
-<a title="License" href="https://github.com/ClusterWS/ClusterWS-Client-Swift/blob/master/LICENSE"><img src="https://img.shields.io/cocoapods/l/ClusterWS-Client-Swift.svg?style=for-the-badge"></a>
+<a title="Cocoapod Version" href="https://cocoapods.org/pods/ClusterWS-Client-Swift"><img src="https://img.shields.io/cocoapods/v/ClusterWS-Client-Swift.svg?colorB=AE1E80&style=for-the-badge"></a>
+<a title="Platforms" href="https://github.com/ClusterWS/ClusterWS-Client-Swift"><img src="https://img.shields.io/badge/platforms-ios | tvos | osx-AE1E80.svg?style=for-the-badge"></a>
+<a title="License" href="https://github.com/ClusterWS/ClusterWS-Client-Swift/blob/master/LICENSE"><img src="https://img.shields.io/badge/LICENSE-MIT-AE1E80.svg?style=for-the-badge"></a>
 </p>
 
 <p align="center">
-<i>Official Swift Client library for <a href="https://github.com/ClusterWS/ClusterWS">ClusterWS</a> - lightweight, fast and powerful framework for building horizontally & vertically scalable WebSocket applications in Node.js</i>
+<i>Official <strong>Swift Client</strong> library for <a href="https://github.com/ClusterWS/ClusterWS">ClusterWS</a> - <strong>lightweight</strong>, <strong>fast</strong> and <strong>powerful</strong> framework for building <strong>scalable</strong> WebSockets applications in Node.js.</i>
 </p>
 
 <h1></h1>

Sources/CWSChannel.swift

@@ -8,8 +8,10 @@
 
 import Foundation
 
-// MARK: Properties & Initialization
 open class CWSChannel: Equatable {
+    
+    // MARK: - Properties
+    
     public static func ==(lhs: CWSChannel, rhs: CWSChannel) -> Bool {
         if lhs.mChannelName == rhs.mChannelName {
             return true
@@ -22,15 +24,19 @@ open class CWSChannel: Equatable {
     private var mCompletion: CompletionHandler?
     private let mSocket: ClusterWS
 
+    // MARK: - Init
+    
     public init(channelName: String, socket: ClusterWS) {
         self.mChannelName = channelName
         self.mSocket = socket
         self.subscribe()
     }
 }
 
-//MARK: Public methods
+// MARK: - Public
+
 extension CWSChannel {
+    
     public func watch(completion: @escaping CompletionHandler) -> CWSChannel {
         self.mCompletion = completion
         return self
@@ -47,17 +53,21 @@ extension CWSChannel {
     }
 }
 
-//MARK: Open methods
+// MARK: - Open methods
+
 extension CWSChannel {
+    
     open func onMessage(data: Any) {
         if let completion = self.mCompletion {
             completion(data)
         }
     }
 }
 
-//MARK: Private methods
+// MARK: - Private methods
+
 extension CWSChannel {
+    
     private func subscribe() {
         self.mSocket.send(event: SystemEventType.subscribe.rawValue, data: self.mChannelName, type: .system)
     }

Sources/CWSDelegate.swift

@@ -11,7 +11,31 @@ import Foundation
      ClusterWS delegate methods
 */
 public protocol CWSDelegate: class {
+    
+    /// Called when socket is connected
     func onConnect()
+    
+    /// Called when socket disconnected
     func onDisconnect(code: Int?, reason: String?)
+    
+    /// Called on error
+    /// - Parameter error: thrown error
     func onError(error: Error)
+    
+    func decode(message: Any?) -> Any?
+    
+    func encode(message: Any?) -> Any?
+}
+
+extension CWSDelegate {
+    
+    /// Custom decode that user can implement
+    func decode(message: Any?) -> Any? {
+        return nil
+    }
+    
+    /// Custom encode that user can implement
+    func encode(message: Any?) -> Any? {
+        return nil
+    }
 }

Sources/CWSErrors.swift renamed to Sources/CWSError.swift

@@ -8,7 +8,7 @@
 
 import Foundation
 
-public enum CWSErrors: Error, LocalizedError {
+public enum CWSError: Error, LocalizedError {
     case invalidURL(String)
     case JSONStringConversionError(String)
     case JSONStringifyError(Any?)
@@ -17,6 +17,8 @@ public enum CWSErrors: Error, LocalizedError {
     case pingIntervalCastError(Any)
     case binaryCastError(Any)
     case binaryDecodeError(Any)
+    case binaryEncodeError(Any)
+    case failedToCastPingTimer
     public var localizedDescription: String {
         switch self {
         case .invalidURL(let url): return "Invalid URL: \(url)."
@@ -27,6 +29,8 @@ public enum CWSErrors: Error, LocalizedError {
         case .pingIntervalCastError(let json): return "Cannot cast ping interval as 'Double' from ping JSON, JSON: \(json)."
         case .binaryCastError(let json): return "Cannot cast ping binary as 'Bool' from ping JSON, JSON: \(json)."
         case .binaryDecodeError(let message): return "Cannot convert binary message to string using UTF8, message: \(message)"
+        case .binaryEncodeError(let ping): return "Cannot encode ping message to binary, ping message: \(ping)"
+         case .failedToCastPingTimer: return "Failed to get ping timer from settings, might be a server set up error"
         }
     }
 }

Sources/CWSParser.swift

@@ -11,7 +11,6 @@ public enum MessageType: String {
     case publish
     case emit
     case system
-    case ping
 }
 
 public enum SystemEventType: String {
@@ -27,17 +26,20 @@ public enum SystemEventType: String {
     }
 }
 
-// MARK: Properties & Initialization
+// MARK: - Properties & Initialization
 open class CWSParser {
+    
     private let mSocket: ClusterWS
 
     public init(socket: ClusterWS) {
         self.mSocket = socket
     }
 }
 
-//MARK: Open methods
+// MARK: - Open methods
+
 extension CWSParser {
+    
     open func encode(event: String, data: Any? = nil, type: MessageType) -> String? {
         var jsonDict: [String: Any]
         switch type {
@@ -52,19 +54,21 @@ extension CWSParser {
                 case .unsubscribe:
                     jsonDict = ["#": ["s", "u", data]]
             }
-        case .ping:
-            return event
         }
         return self.JSONStringify(value: jsonDict)
     }
 
+    open func encode(message: String) -> Data? {
+        return message.data(using: .utf8, allowLossyConversion: false)
+    }
+    
     open func handleMessage(with string: String) {
         guard let jsonDict = self.convertToJSON(text: string) else {
-            self.mSocket.delegate?.onError(error: CWSErrors.JSONStringConversionError(string))
+            self.mSocket.delegate?.onError(error: CWSError.JSONStringConversionError(string))
             return
         }
         guard let jsonArray = jsonDict["#"] as? [Any] else {
-            self.mSocket.delegate?.onError(error: CWSErrors.hashArrayCastError(jsonDict))
+            self.mSocket.delegate?.onError(error: CWSError.hashArrayCastError(jsonDict))
             return
         }
         switch String(describing: jsonArray[0]) {
@@ -80,8 +84,10 @@ extension CWSParser {
     }
 }
 
-//MARK: Private methods
+// MARK: - Private methods
+
 extension CWSParser {
+    
     private func convertToJSON(text: String) -> [String: Any]? {
         if let data = text.data(using: .utf8) {
             do {
@@ -111,31 +117,33 @@ extension CWSParser {
 
     private func handleP(with data: [Any]) {
         let channelName = String(describing: data[1])
-        self.mSocket.getChannel(by: channelName)?.onMessage(data: data[2])
+        let decodedMessage = self.mSocket.delegate?.decode(message: data[2]) ?? data[2]
+        self.mSocket.getChannel(by: channelName)?.onMessage(data: decodedMessage)
     }
 
     private func handleE(with data: [Any]) {
         let event = String(describing: data[1])
-        let data = data[2]
-        self.mSocket.emit(event: event, data: data)
+        let decodedMessage = self.mSocket.delegate?.decode(message: data[2]) ?? data[2]
+        self.mSocket.emit(event: event, data: decodedMessage)
     }
 
     private func handleS(with data: [Any]) {
         switch String(describing: data[1]) {
         case "c":
-            guard let pingJSON = data[2] as? [String: Any] else {
-                self.mSocket.delegate?.onError(error: CWSErrors.pingJSONCastError(data[2]))
+            let decodedMessage = self.mSocket.delegate?.decode(message: data[2]) ?? data[2]
+            guard let pingJSON = decodedMessage as? [String: Any] else {
+                self.mSocket.delegate?.onError(error: CWSError.pingJSONCastError(decodedMessage))
                 return
             }
             guard let pingInterval = pingJSON["ping"] as? Double else {
-                self.mSocket.delegate?.onError(error: CWSErrors.pingIntervalCastError(pingJSON))
+                self.mSocket.delegate?.onError(error: CWSError.pingIntervalCastError(pingJSON))
                 return
             }
             guard let binary = pingJSON["binary"] as? Bool else {
-                self.mSocket.delegate?.onError(error: CWSErrors.binaryCastError(pingJSON))
+                self.mSocket.delegate?.onError(error: CWSError.binaryCastError(pingJSON))
                 return
             }
-            self.mSocket.startPinging(with: pingInterval)
+            self.mSocket.setPingInterval(pingInterval * 2 + 100)
             self.mSocket.setBinary(to: binary)
             self.mSocket.delegate?.onConnect()
         default:

Sources/CWSPing.swift

@@ -8,33 +8,25 @@
 
 import Foundation
 
-// MARK: Properties & Initialization
 open class CWSPing {
-    private var mMissedPing: Int = 0
+    
+    // MARK: - Properties
+    
     private var mPingTimer: Timer?
 }
 
-//MARK: Open methods
+// MARK: - Open methods
+
 extension CWSPing {
-    open func resetMissedPing() {
-        self.mMissedPing = 0
-    }
 
-    private func resetPingTimer() {
+    open func stop() {
         self.mPingTimer?.invalidate()
         self.mPingTimer = nil
     }
 
     @objc private func executionBlock(_ socket: ClusterWS) {
         func block(_ socket: ClusterWS) {
-            if self.mMissedPing < 3 {
-                self.mMissedPing += 1
-            } else {
-                if socket.getState() != .closed {
-                    socket.disconnect(closeCode: 4001, reason: "No pings")
-                    self.resetPingTimer()
-                }
-            }
+            socket.disconnect(closeCode: 4001, reason: "No pings")
         }
 
         guard let userInfoWS = self.mPingTimer?.userInfo as? ClusterWS else {
@@ -45,24 +37,20 @@ extension CWSPing {
         block(userInfoWS)
     }
 
-    open func stop() {
-        self.mMissedPing = 0
-        self.resetPingTimer()
-    }
-    
-    open func start(interval: TimeInterval, socket: ClusterWS) {
+    open func restart(with interval: TimeInterval, socket: ClusterWS) {
+        self.stop()
         if #available(iOS 10.0, *, OSX 10.12, tvOS 10.0, *) {
             self.mPingTimer = Timer.scheduledTimer(withTimeInterval: interval / 1000,
-                                                   repeats: true,
+                                                   repeats: false,
                                                    block: { (timer) in
                                                     self.executionBlock(socket)
             })
         } else {
-            self.mPingTimer = Timer(timeInterval: interval,
+            self.mPingTimer = Timer(timeInterval: interval / 1000,
                                     target: self,
                                     selector: #selector(executionBlock(_:)),
                                     userInfo: socket,
-                                    repeats: true)
+                                    repeats: false)
             self.mPingTimer?.fire()
         }
     }

Sources/CWSReconnection.swift

@@ -8,8 +8,10 @@
 
 import Foundation
 
-// MARK: Properties & Initialization
 open class CWSReconnection {
+    
+    // MARK: - Properties
+    
     private var mReconnectionTimer: Timer?
     private var mAutoReconnect: Bool
     private var mReconnectionAttempts: Int
@@ -18,6 +20,8 @@ open class CWSReconnection {
     private var mCurrentReconnectionAttempted: Int = 0
     private let mSocket: ClusterWS
 
+    // MARK: - Initialization
+    
     public init(socket: ClusterWS) {
         self.mSocket = socket
         self.mAutoReconnect = false
@@ -27,8 +31,10 @@ open class CWSReconnection {
     }
 }
 
-//MARK: Open methods
+// MARK: - Open methods
+
 extension CWSReconnection {
+    
     open func onConnected() {
         self.resetTimer()
         self.mReconnectionAttempts = 0
@@ -75,8 +81,10 @@ extension CWSReconnection {
     }
 }
 
-//MARK: Private methods
+// MARK: Private methods
+
 extension CWSReconnection {
+    
     private func resubscribe() {
         let channels = self.mSocket.getChannels()
         channels.forEach { _ = self.mSocket.subscribe($0.mChannelName) }