Merge pull request #399 from socketio/development

Development

Author: nuclearace

README.md

@@ -165,6 +165,7 @@ case ReconnectAttempts(Int) // How many times to reconnect. Default is `-1` (inf
 case ReconnectWait(Int) // Amount of time to wait between reconnects. Default is `10`
 case SessionDelegate(NSURLSessionDelegate) // Sets an NSURLSessionDelegate for the underlying engine. Useful if you need to handle self-signed certs. Default is nil.
 case Secure(Bool) // If the connection should use TLS. Default is false.
+case Security(SSLSecurity) // Allows you to set which certs are valid. Useful for SSL pinning.
 case SelfSigned(Bool) // Sets WebSocket.selfSignedSSL (Don't do this, iOS will yell at you)
 case VoipEnabled(Bool) // Only use this option if you're using the client with VoIP services. Changes the way the WebSocket is created. Default is false
 ```

Socket.IO-Client-Swift.xcodeproj/project.pbxproj

@@ -44,4 +44,10 @@ - (void)testOffSyntax {
     [self.socket off:@"test"];
 }
 
+- (void)testSocketManager {
+    SocketClientManager* manager = [SocketClientManager sharedManager];
+    [manager addSocket:self.socket labeledAs:@"test"];
+    [manager removeSocketWithLabel:@"test"];    
+}
+
 @end

SocketIO-MacTests/SocketObjectiveCTest.m

@@ -13,7 +13,7 @@ class SocketParserTest: XCTestCase {
     let testSocket = SocketIOClient(socketURL: NSURL())
 
     //Format key: message; namespace-data-binary-id
-    static let packetTypes: Dictionary<String, (String, [AnyObject], [NSData], Int)> = [
+    static let packetTypes: [String: (String, [AnyObject], [NSData], Int)] = [
         "0": ("/", [], [], -1), "1": ("/", [], [], -1),
         "25[\"test\"]": ("/", ["test"], [], 5),
         "2[\"test\",\"~~0\"]": ("/", ["test", "~~0"], [], -1),

SocketIO-MacTests/SocketParserTest.swift

@@ -153,4 +153,16 @@ class SocketSideEffectTest: XCTestCase {
         socket.parseBinaryData(data2)
         waitForExpectationsWithTimeout(3, handler: nil)
     }
+    
+    func testSocketManager() {
+        let manager = SocketClientManager.sharedManager
+        manager["test"] = socket
+        
+        XCTAssert(manager["test"] === socket, "failed to get socket")
+        
+        manager["test"] = nil
+        
+        XCTAssert(manager["test"] == nil, "socket not removed")
+
+    }
 }

SocketIO-MacTests/SocketSideEffectTest.swift

@@ -0,0 +1,82 @@
+//
+//  SocketClientManager.swift
+//  Socket.IO-Client-Swift
+//
+//  Created by Erik Little on 6/11/16.
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+
+import Foundation
+
+/**
+ Experimental socket manager.
+ 
+ API subject to change.
+ 
+ Can be used to persist sockets across ViewControllers.
+ 
+ Sockets are strongly stored, so be sure to remove them once they are no
+ longer needed.
+ 
+ Example usage:
+ ```
+ let manager = SocketClientManager.sharedManager
+ manager["room1"] = socket1
+ manager["room2"] = socket2
+ manager.removeSocket(socket: socket2)
+ manager["room1"]?.emit("hello")
+ ```
+ */
+public final class SocketClientManager : NSObject {
+    public static let sharedManager = SocketClientManager()
+    
+    private var sockets = [String: SocketIOClient]()
+    
+    public subscript(string: String) -> SocketIOClient? {
+        get {
+            return sockets[string]
+        }
+        
+        set(socket) {
+            sockets[string] = socket
+        }
+    }
+    
+    public func addSocket(socket: SocketIOClient, labeledAs label: String) {
+        sockets[label] = socket
+    }
+    
+    public func removeSocket(withLabel label: String) -> SocketIOClient? {
+        return sockets.removeValueForKey(label)
+    }
+
+    public func removeSocket(socket socket: SocketIOClient) -> SocketIOClient? {
+        var returnSocket: SocketIOClient?
+        
+        for (label, dictSocket) in sockets where dictSocket === socket {
+            returnSocket = sockets.removeValueForKey(label)
+        }
+        
+        return returnSocket
+    }
+    
+    public func removeSockets() {
+        sockets.removeAll()
+    }
+}

SocketIO-iOSTests/Info.plist

@@ -76,6 +76,7 @@ public final class SocketEngine : NSObject, SocketEnginePollable, SocketEngineWe
     private var pongsMissedMax = 0
     private var probeWait = ProbeWaitQueue()
     private var secure = false
+    private var security: SSLSecurity?
     private var selfSigned = false
     private var voipEnabled = false
 
@@ -105,6 +106,8 @@ public final class SocketEngine : NSObject, SocketEnginePollable, SocketEngineWe
                 voipEnabled = enable
             case let .Secure(secure):
                 self.secure = secure
+            case let .Security(security):
+                self.security = security
             case let .SelfSigned(selfSigned):
                 self.selfSigned = selfSigned
             default:
@@ -153,9 +156,8 @@ public final class SocketEngine : NSObject, SocketEnginePollable, SocketEngineWe
             // binary in base64 string
             let noPrefix = message[message.startIndex.advancedBy(2)..<message.endIndex]
 
-            if let data = NSData(base64EncodedString: noPrefix,
-                options: .IgnoreUnknownCharacters) {
-                    client?.parseEngineBinaryData(data)
+            if let data = NSData(base64EncodedString: noPrefix, options: .IgnoreUnknownCharacters) {
+                client?.parseEngineBinaryData(data)
             }
 
             return true
@@ -164,14 +166,24 @@ public final class SocketEngine : NSObject, SocketEnginePollable, SocketEngineWe
         }
     }
 
+    private func closeOutEngine() {
+        sid = ""
+        closed = true
+        invalidated = true
+        connected = false
+        
+        ws?.disconnect()
+        stopPolling()
+    }
+    
     /// Starts the connection to the server
     public func connect() {
         if connected {
             DefaultSocketLogger.Logger.error("Engine tried opening while connected. Assuming this was a reconnect", type: logType)
             disconnect("reconnect")
         }
 
-        DefaultSocketLogger.Logger.log("Starting engine", type: logType)
+        DefaultSocketLogger.Logger.log("Starting engine. Server: %@", type: logType, args: url)
         DefaultSocketLogger.Logger.log("Handshaking", type: logType)
 
         resetEngine()
@@ -256,6 +268,7 @@ public final class SocketEngine : NSObject, SocketEnginePollable, SocketEngineWe
         ws?.voipEnabled = voipEnabled
         ws?.delegate = self
         ws?.selfSignedSSL = selfSigned
+        ws?.security = security
 
         ws?.connect()
     }
@@ -267,35 +280,32 @@ public final class SocketEngine : NSObject, SocketEnginePollable, SocketEngineWe
     }
 
     public func disconnect(reason: String) {
-        func postSendClose(data: NSData?, _ res: NSURLResponse?, _ err: NSError?) {
-            sid = ""
-            closed = true
-            invalidated = true
-            connected = false
-            
-            ws?.disconnect()
-            stopPolling()
-            client?.engineDidClose(reason)
-        }
+        guard connected else { return closeOutEngine() }
 
         DefaultSocketLogger.Logger.log("Engine is being closed.", type: logType)
 
         if closed {
+            closeOutEngine()
             client?.engineDidClose(reason)
             return
         }
 
         if websocket {
             sendWebSocketMessage("", withType: .Close, withData: [])
-            postSendClose(nil, nil, nil)
+            closeOutEngine()
         } else {
-            // We need to take special care when we're polling that we send it ASAP
-            // Also make sure we're on the emitQueue since we're touching postWait
-            dispatch_sync(emitQueue) {
-                self.postWait.append(String(SocketEnginePacketType.Close.rawValue))
-                let req = self.createRequestForPostWithPostWait()
-                self.doRequest(req, withCallback: postSendClose)
-            }
+            disconnectPolling()
+        }
+    }
+    
+    // We need to take special care when we're polling that we send it ASAP
+    // Also make sure we're on the emitQueue since we're touching postWait
+    private func disconnectPolling() {
+        dispatch_sync(emitQueue) {
+            self.postWait.append(String(SocketEnginePacketType.Close.rawValue))
+            let req = self.createRequestForPostWithPostWait()
+            self.doRequest(req) {_, _, _ in }
+            self.closeOutEngine()
         }
     }
 
@@ -335,7 +345,7 @@ public final class SocketEngine : NSObject, SocketEnginePollable, SocketEngineWe
         guard let ws = self.ws else { return }
 
         for msg in postWait {
-            ws.writeString(fixDoubleUTF8(msg))
+            ws.writeString(msg)
         }
 
         postWait.removeAll(keepCapacity: true)
@@ -535,13 +545,11 @@ public final class SocketEngine : NSObject, SocketEnginePollable, SocketEngineWe
             connected = false
             websocket = false
 
-            let reason = error?.localizedDescription ?? "Socket Disconnected"
-            
-            if error != nil {
+            if let reason = error?.localizedDescription {
                 didError(reason)
+            } else {
+                client?.engineDidClose("Socket Disconnected")
             }
-            
-            client?.engineDidClose(reason)
         } else {
             flushProbeWait()
         }

Source/SocketClientManager.swift

@@ -123,7 +123,7 @@ extension SocketEnginePollable {
 
                 return
             }
-
+            
             DefaultSocketLogger.Logger.log("Got polling response", type: "SocketEnginePolling")
 
             if let str = String(data: data!, encoding: NSUTF8StringEncoding) {
@@ -213,9 +213,7 @@ extension SocketEnginePollable {
             fixedMessage = message
         }
 
-        let strMsg = "\(type.rawValue)\(fixedMessage)"
-        
-        postWait.append(strMsg)
+        postWait.append(String(type.rawValue) + fixedMessage)
 
         for data in datas {
             if case let .Right(bin) = createBinaryDataForSend(data) {

Source/SocketEngine.swift

@@ -197,8 +197,7 @@ public final class SocketIOClient : NSObject, SocketEngineClient, SocketParsable
         handleEvent("disconnect", data: [reason], isInternalMessage: true)
     }
 
-    /// Disconnects the socket. Only reconnect the same socket if you know what you're doing.
-    /// Will turn off automatic reconnects.
+    /// Disconnects the socket.
     public func disconnect() {
         assert(status != .NotConnected, "Tried closing a NotConnected client")