Make engine single queued

Fix polling

allow building of refactor branch

remove self reference

Some refactoring

.travis.yml

@@ -6,6 +6,7 @@ branches:
   only:
     - master
     - development
+    - refactor-engine
 before_install:
   - brew update
   - brew outdated xctool || brew upgrade xctool

Source/SocketEngine.swift

@@ -22,12 +22,11 @@
 //  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 //  THE SOFTWARE.
 
+import Dispatch
 import Foundation
 
 public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePollable, SocketEngineWebsocket {
-    public let emitQueue = DispatchQueue(label: "com.socketio.engineEmitQueue", attributes: [])
+    public let engineQueue = DispatchQueue(label: "com.socketio.engineHandleQueue", attributes: [])
-    public let handleQueue = DispatchQueue(label: "com.socketio.engineHandleQueue", attributes: [])
-    public let parseQueue = DispatchQueue(label: "com.socketio.engineParseQueue", attributes: [])
 
     public var connectParams: [String: Any]? {
         didSet {
@@ -174,6 +173,12 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
 
     /// Starts the connection to the server
     public func connect() {
+        engineQueue.async {
+            self._connect()
+        }
+    }
+
+    private func _connect() {
         if connected {
             DefaultSocketLogger.Logger.error("Engine tried opening while connected. Assuming this was a reconnect", type: logType)
             disconnect(reason: "reconnect")
@@ -191,8 +196,7 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
             return
         }
 
-        var reqPolling = URLRequest(url: urlPolling, cachePolicy: .reloadIgnoringLocalCacheData,
+        var reqPolling = URLRequest(url: urlPolling, cachePolicy: .reloadIgnoringLocalCacheData, timeoutInterval: 60.0)
-                                    timeoutInterval: 60.0)
 
         if cookies != nil {
             let headers = HTTPCookie.requestHeaderFields(with: cookies!)
@@ -244,7 +248,6 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
     }
 
     private func createWebsocketAndConnect() {
-        
         ws?.delegate = nil
         ws = WebSocket(url: urlWebSocketWithSid as URL)
 
@@ -261,7 +264,7 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
             }
         }
 
-        ws?.callbackQueue = handleQueue
+        ws?.callbackQueue = engineQueue
         ws?.voipEnabled = voipEnabled
         ws?.delegate = self
         ws?.disableSSLCertValidation = selfSigned
@@ -277,6 +280,12 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
     }
 
     public func disconnect(reason: String) {
+        engineQueue.async {
+            self._disconnect(reason: reason)
+        }
+    }
+
+    private func _disconnect(reason: String) {
         guard connected else { return closeOutEngine(reason: reason) }
 
         DefaultSocketLogger.Logger.log("Engine is being closed.", type: logType)
@@ -296,12 +305,10 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
     // 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(reason: String) {
-        emitQueue.sync {
+        postWait.append(String(SocketEnginePacketType.close.rawValue))
-            self.postWait.append(String(SocketEnginePacketType.close.rawValue))
+
-            let req = self.createRequestForPostWithPostWait()
+        doRequest(for: createRequestForPostWithPostWait()) {_, _, _ in }
-            self.doRequest(for: req) {_, _, _ in }
+        closeOutEngine(reason: reason)
-            self.closeOutEngine(reason: reason)
-        }
     }
 
     public func doFastUpgrade() {
@@ -321,16 +328,14 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
     private func flushProbeWait() {
         DefaultSocketLogger.Logger.log("Flushing probe wait", type: logType)
 
-        emitQueue.async {
+        for waiter in probeWait {
-            for waiter in self.probeWait {
+            write(waiter.msg, withType: waiter.type, withData: waiter.data)
-                self.write(waiter.msg, withType: waiter.type, withData: waiter.data)
+        }
-            }
 
-            self.probeWait.removeAll(keepingCapacity: false)
+        probeWait.removeAll(keepingCapacity: false)
 
-            if self.postWait.count != 0 {
+        if postWait.count != 0 {
-                self.flushWaitingForPostToWebSocket()
+            flushWaitingForPostToWebSocket()
-            }
         }
     }
 
@@ -456,13 +461,16 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
 
     // Puts the engine back in its default state
     private func resetEngine() {
+        let queue = OperationQueue()
+        queue.underlyingQueue = engineQueue
+
         closed = false
         connected = false
         fastUpgrade = false
         polling = true
         probing = false
         invalidated = false
-        session = Foundation.URLSession(configuration: .default, delegate: sessionDelegate, delegateQueue: OperationQueue.main)
+        session = Foundation.URLSession(configuration: .default, delegate: sessionDelegate, delegateQueue: queue)
         sid = ""
         waitingForPoll = false
         waitingForPost = false
@@ -484,8 +492,7 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
         pongsMissed += 1
         write("", withType: .ping, withData: [])
 
-        let time = DispatchTime.now() + Double(Int64(pingInterval * Double(NSEC_PER_SEC))) / Double(NSEC_PER_SEC)
+        engineQueue.asyncAfter(deadline: DispatchTime.now() + Double(pingInterval)) {[weak self] in self?.sendPing() }
-        DispatchQueue.main.asyncAfter(deadline: time) {[weak self] in self?.sendPing() }
     }
 
     // Moves from long-polling to websockets
@@ -501,16 +508,16 @@ public final class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePoll
 
     /// Write a message, independent of transport.
     public func write(_ msg: String, withType type: SocketEnginePacketType, withData data: [Data]) {
-        emitQueue.async {
+        engineQueue.async {
             guard self.connected else { return }
 
             if self.websocket {
                 DefaultSocketLogger.Logger.log("Writing ws: %@ has data: %@",
-                    type: self.logType, args: msg, data.count != 0)
+                                               type: self.logType, args: msg, data.count != 0)
                 self.sendWebSocketMessage(msg, withType: type, withData: data)
             } else if !self.probing {
                 DefaultSocketLogger.Logger.log("Writing poll: %@ has data: %@",
-                    type: self.logType, args: msg, data.count != 0)
+                                               type: self.logType, args: msg, data.count != 0)
                 self.sendPollMessage(msg, withType: type, withData: data)
             } else {
                 self.probeWait.append((msg, type, data))

Source/SocketEnginePollable.swift

@@ -86,7 +86,7 @@ extension SocketEnginePollable {
         req.httpBody = postData
         req.setValue(String(postData.count), forHTTPHeaderField: "Content-Length")
 
-        return req as URLRequest
+        return req
     }
 
     public func doPoll() {
@@ -94,11 +94,9 @@ extension SocketEnginePollable {
             return
         }
 
-        waitingForPoll = true
-        
         var req = URLRequest(url: urlPollingWithSid)
-        
         req = addHeaders(for: req)
+
         doLongPoll(for: req )
     }
 
@@ -107,12 +105,15 @@ extension SocketEnginePollable {
             return
         }
 
-        DefaultSocketLogger.Logger.log("Doing polling request", type: "SocketEnginePolling")
+        DefaultSocketLogger.Logger.log("Doing polling %@ %@", type: "SocketEnginePolling",
+                                       args: req.httpMethod ?? "", req)
 
         session?.dataTask(with: req, completionHandler: callback).resume()
     }
 
     func doLongPoll(for req: URLRequest) {
+        waitingForPoll = true
+
         doRequest(for: req) {[weak self] data, res, err in
             guard let this = self, this.polling else { return }
 
@@ -129,9 +130,7 @@ extension SocketEnginePollable {
             DefaultSocketLogger.Logger.log("Got polling response", type: "SocketEnginePolling")
 
             if let str = String(data: data!, encoding: String.Encoding.utf8) {
-                this.parseQueue.async {
+                this.parsePollingMessage(str)
-                    this.parsePollingMessage(str)
-                }
             }
 
             this.waitingForPoll = false
@@ -173,11 +172,9 @@ extension SocketEnginePollable {
 
             this.waitingForPost = false
 
-            this.emitQueue.async {
+            if !this.fastUpgrade {
-                if !this.fastUpgrade {
+                this.flushWaitingForPost()
-                    this.flushWaitingForPost()
+                this.doPoll()
-                    this.doPoll()
-                }
             }
         }
     }
@@ -189,11 +186,9 @@ extension SocketEnginePollable {
 
         while reader.hasNext {
             if let n = Int(reader.readUntilOccurence(of: ":")) {
-                let str = reader.read(count: n)
+                parseEngineMessage(reader.read(count: n), fromPolling: true)
-                
-                handleQueue.async { self.parseEngineMessage(str, fromPolling: true) }
             } else {
-                handleQueue.async { self.parseEngineMessage(str, fromPolling: true) }
+                parseEngineMessage(str, fromPolling: true)
                 break
             }
         }

Source/SocketEngineSpec.swift

@@ -32,15 +32,13 @@ import Foundation
     var connectParams: [String: Any]? { get set }
     var doubleEncodeUTF8: Bool { get }
     var cookies: [HTTPCookie]? { get }
+    var engineQueue: DispatchQueue { get }
     var extraHeaders: [String: String]? { get }
     var fastUpgrade: Bool { get }
     var forcePolling: Bool { get }
     var forceWebsockets: Bool { get }
-    var parseQueue: DispatchQueue { get }
     var polling: Bool { get }
     var probing: Bool { get }
-    var emitQueue: DispatchQueue { get }
-    var handleQueue: DispatchQueue { get }
     var sid: String { get }
     var socketPath: String { get }
     var urlPolling: URL { get }