General fixes and upgrades.

- General fixes so that it compiles under XCode 12.0.1
- Applied fix for unique channel identifiers from here:
  danielrhodes/Swift-ActionCableClient#56
- Use sorted keys in JSON serialization for consistent serialization of
  identifier field.
- Use Websocket delegate callbacks instead of blocks.
- Adapted to new version of Starscream 4.0.4.

Author: kaomte

Package.swift

@@ -4,22 +4,26 @@
 import PackageDescription
 
 let package = Package(
-    name: "ActionCableClient2",
-    products: [
-        // Products define the executables and libraries a package produces, and make them visible to other packages.
-        .library(
-            name: "ActionCableClient2",
-            targets: ["ActionCableClient2"]),
-    ],
-    dependencies: [
-        // Dependencies declare other packages that this package depends on.
-        .package(url: "https://github.com/daltoniam/Starscream", from: "4.0.4"),
-    ],
-    targets: [
-        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
-        // Targets can depend on other targets in this package, and on products in packages this package depends on.
-        .target(
-            name: "ActionCableClient2",
-            dependencies: ["Starscream"]),
-    ]
+  name: "ActionCableClient2",
+  platforms: [
+    // Require iOS 11 for JSON writing options.
+    .iOS("11.0"),
+  ],
+  products: [
+    // Products define the executables and libraries a package produces, and make them visible to other packages.
+    .library(
+      name: "ActionCableClient2",
+      targets: ["ActionCableClient2"]),
+  ],
+  dependencies: [
+    // Dependencies declare other packages that this package depends on.
+    .package(url: "https://github.com/daltoniam/Starscream", from: "4.0.4"),
+  ],
+  targets: [
+    // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+    // Targets can depend on other targets in this package, and on products in packages this package depends on.
+    .target(
+      name: "ActionCableClient2",
+      dependencies: ["Starscream"]),
+  ]
 )

Sources/ActionCableClient2/ActionCableClient.swift

@@ -56,6 +56,9 @@ open class ActionCableClient {
     /// On Rejected
     ///
     /// Called when the client has been rejected from connecting.
+    //
+    // I don't think this actually works yet. Can't find where this actually
+    // gets called.
     open var onRejected: (() -> Void)?
     /// On Ping
     ///
@@ -68,13 +71,13 @@ open class ActionCableClient {
     open var onChannelRejected: ((Channel) -> (Void))?
     open var onChannelReceive: ((Channel, Any?, Swift.Error?) -> Void)?
 
-    //MARK: Properties
+    // MARK: Properties
     open var isConnected: Bool = false
     open var url: Foundation.URL? { return socket.request.url }
     open var headers : [String: String]? {
         get { return socket.request.allHTTPHeaderFields }
         set {
-            for (field, value) in headers ?? [:] {
+            for (field, value) in newValue ?? [:] {
                 socket.request.setValue(value, forHTTPHeaderField: field)
             }
         }
@@ -95,6 +98,7 @@ open class ActionCableClient {
         let request = URLRequest(url: url)
         /// Setup Initialize Socket
         socket = WebSocket(request: request)
+        socket.delegate = self
     }
 
     public required init(url: URL, headers: [String: String]? = nil, origin : String? = nil) {
@@ -115,18 +119,17 @@ open class ActionCableClient {
     /// Connect with the server
     @discardableResult
     open func connect() -> ActionCableClient {
-        DispatchQueue.main.async {
-          if let callback = self.willConnect {
-            callback()
-          }
-          
-          ActionCableConcurrentQueue.async {
-            self.socket.connect()
-            self.reconnectionState = nil
-          }
+      DispatchQueue.main.async {
+        if let callback = self.willConnect {
+          callback()
+        }
+        ActionCableConcurrentQueue.async {
+          self.socket.connect()
+          self.reconnectionState = nil
         }
+      }
 
-        return self
+      return self
     }
 
     /// Disconnect from the server.
@@ -177,7 +180,7 @@ open class ActionCableClient {
         }
 
         // Let's check if we are connected.
-        //guard isConnected else { throw TransmitError.notConnected }
+        guard isConnected else { throw TransmitError.notConnected }
 
         socket.write(string: JSONString) {
           //FINISHED!
@@ -486,16 +489,10 @@ extension ActionCableClient {
 
 extension ActionCableClient : CustomDebugStringConvertible {
     public var debugDescription : String {
-            return "ActionCableClient(url: \"\(url)\" connected: \(isConnected) id: \(Unmanaged.passUnretained(self).toOpaque()))"
+      return "ActionCableClient(url: \"\(String(describing: url))\" connected: \(isConnected) id: \(Unmanaged.passUnretained(self).toOpaque()))"
     }
 }
 
-//extension ActionCableClient : CustomPlaygroundQuickLookable {
-//  public var customPlaygroundQuickLook: PlaygroundQuickLook {
-//        return PlaygroundQuickLook.url(url?.absoluteString)
-//    }
-//}
-
 extension ActionCableClient {
     func copyWithZone(_ zone: NSZone?) -> AnyObject! {
         assert(false, "This class doesn't implement NSCopying. ")
@@ -514,28 +511,32 @@ extension ActionCableClient: WebSocketDelegate {
     switch event {
     case .connected(let headers):
       isConnected = true
+      didConnect()
       print("websocket is connected: \(headers)")
     case .disconnected(let reason, let code):
       isConnected = false
+      didDisconnect(nil)
       print("websocket is disconnected: \(reason) with code: \(code)")
     case .text(let string):
       print("Received text: \(string)")
+      onText(string)
     case .binary(let data):
       print("Received data: \(data.count)")
+      onData(data)
     case .ping(_):
       break
     case .pong(_):
-      break
+      didPong()
     case .viabilityChanged(_):
       break
     case .reconnectSuggested(_):
       break
     case .cancelled:
       isConnected = false
-    case .error(let error):
-      isConnected = false
- //     handleError(error)
-
+      break
+    case .error(let _):
+      //     handleError(error)
+      break
     }
   }
 }

Sources/ActionCableClient2/ActionCableClient2.swift

@@ -22,7 +22,7 @@
 
 import Foundation
 
-public typealias ChannelIdentifier = ActionPayload
+public typealias ChannelIdentifier = [String: String]
 public typealias OnReceiveClosure = ((Any?, Swift.Error?) -> (Void))
 
 /// A particular channel on the server.
@@ -32,7 +32,7 @@ open class Channel: Hashable, Equatable {
     open var name : String
 
     /// Identifier
-    open var identifier: Dictionary<String, Any>?
+    open var identifier: ChannelIdentifier?
 
     /// Auto-Subscribe to channel on initialization and re-connect?
     open var autoSubscribe : Bool
@@ -51,12 +51,16 @@ open class Channel: Hashable, Equatable {
         get {
             //defaults to channel name
             var channelUID = name
-            
+
             //if identifier isn't empty, fetch the first value as the channel unique identifier
-            if let dictionary = identifier?.first {
-                channelUID = dictionary.value as! String
+            if let dictionary = identifier, dictionary.count > 1 {
+                var identifier = name
+                for key in dictionary.keys.sorted() {
+                    identifier += "-\(key):\(dictionary[key] as? String ?? "")"
+                }
+                channelUID = identifier
             }
-            
+
             return channelUID
         }
     }
@@ -193,7 +197,7 @@ open class Channel: Hashable, Equatable {
     internal var onReceiveActionHooks: Dictionary<String, OnReceiveClosure> = Dictionary()
     internal unowned var client: ActionCableClient
     internal var actionBuffer: Array<Action> = Array()
-    open let hashValue: Int = Int(arc4random_uniform(UInt32(Int32.max)))
+    public let hashValue: Int = Int(arc4random_uniform(UInt32(Int32.max)))
 }
 
 public func ==(lhs: Channel, rhs: Channel) -> Bool {
@@ -259,12 +263,3 @@ extension Channel: CustomDebugStringConvertible {
     }
 }
 
-extension Channel: CustomPlaygroundQuickLookable {
-    /// A custom playground quick look for this instance.
-    ///
-    /// If this type has value semantics, the `PlaygroundQuickLook` instance
-    /// should be unaffected by subsequent mutations.
-    public var customPlaygroundQuickLook: PlaygroundQuickLook {
-              return PlaygroundQuickLook.text(self.name)
-    }
-}

Sources/ActionCableClient2/Channel.swift

@@ -37,14 +37,16 @@ internal class JSONSerializer {
             }
 
             identifierDict["channel"] = "\(channel.name)"
-            
-            let JSONData = try JSONSerialization.data(withJSONObject: identifierDict, options: JSONSerialization.WritingOptions(rawValue: 0))
+
+            // Must use .sortedKeys to keep the identifier string constant
+            // across requests.
+            let JSONData = try JSONSerialization.data(withJSONObject: identifierDict, options: [.sortedKeys])
             guard let identifierString = NSString(data: JSONData, encoding: String.Encoding.utf8.rawValue)
                   else { throw SerializationError.json }
-            
+
             var commandDict = [
-                "command" : command.string,
-                "identifier" : identifierString
+              "command" : command.string,
+              "identifier" : identifierString
             ] as [String : Any]
 
             if let _ = data {
@@ -80,6 +82,7 @@ internal class JSONSerializer {
 
             var channelName: String?
             var channelIdentifier: String?
+            // idObj is a hash with channel and room_id keys
             if let idObj = JSONObj["identifier"] {
                 var idJSON: Dictionary<String, AnyObject>
                 if let idString = idObj as? String {
@@ -96,18 +99,24 @@ internal class JSONSerializer {
                 } else {
                     throw SerializationError.protocolViolation
                 }
-                
-                if let item = idJSON.first {
-                    channelIdentifier = item.value as? String
-                }
-                
+
                 if let nameStr = idJSON["channel"], let name = nameStr as? String {
-                  channelName = name
-                }
-                
-                if channelIdentifier != nil {
-                    channelName = channelIdentifier
+                    channelName = name
+
+                    if idJSON.count > 1 {
+                        var identifier = name
+                        for key in idJSON.keys.filter({ $0 != "channel" }).sorted() {
+                            identifier += "-\(key):\(idJSON[key] as? String ?? "")"
+                        }
+                        channelIdentifier = identifier
+                    }
                 }
+                // Why do we set the channel name to the identifier here?
+                // As far as I know the chanell name is distinct from the identifier.
+                // This breaks the client when uncommented.
+//                if let channelIdentifier = channelIdentifier {
+//                    channelName = channelIdentifier
+//               }
             }
 
             switch messageType {