Merge branch 'development'

* development:
  Add note about manager not being thread safe
  Make it clear that `handleQueue` should be serial
  remove some redundant connected checking
  get rid of internal emitAck method
  open engine
  Add raw view to ack emitter
  change access level to public for raw view
  rename SocketBinaryView
  Add rawEmitView. Implements #992
  Add way to skip binary inspection.
  bump version
  Set reconnectAttempts in manager. Fixes #989

Author: nuclearace

.travis.yml

@@ -1,7 +1,7 @@
 language: objective-c
 xcode_project: Socket.IO-Client-Swift.xcodeproj # path to your xcodeproj folder
 xcode_scheme: SocketIO-Mac
-osx_image: xcode9
+osx_image: xcode9.2
 branches:
   only:
     - master

CHANGELOG.md

@@ -1,3 +1,13 @@
+# v13.2.0
+
+- Add ability to bypass Data inspection in emits. [#992]((https://github.com/socketio/socket.io-client-swift/issues/992))
+- Allow `SocketEngine` to be subclassed
+
+# v13.1.3
+
+- Fix setting reconnectAttempts [#989]((https://github.com/socketio/socket.io-client-swift/issues/989))
+
+
 # v13.1.2
 
 - Fix [#950](https://github.com/socketio/socket.io-client-swift/issues/950)
@@ -29,7 +39,7 @@ Checkout out the migration guide in Usage Docs for a more detailed guide on how
 What's new:
 ---
 
-- Adds a new `SocketManager` class that multiplexes multiple namespaces through a single engine. 
+- Adds a new `SocketManager` class that multiplexes multiple namespaces through a single engine.
 - Adds `.sentPing` and `.gotPong` client events for tracking ping/pongs.
 - watchOS support.
 

Package.resolved

@@ -1,15 +1,6 @@
 {
   "object": {
     "pins": [
-      {
-        "package": "SSCZLib",
-        "repositoryURL": "https://github.com/daltoniam/zlib-spm.git",
-        "state": {
-          "branch": null,
-          "revision": "83ac8d719a2f3aa775dbdf116a57f56fb2c49abb",
-          "version": "1.1.0"
-        }
-      },
       {
         "package": "SSCommonCrypto",
         "repositoryURL": "https://github.com/daltoniam/common-crypto-spm",
@@ -27,6 +18,15 @@
           "revision": "6cb1c474e09b0a3aa60bcdc7553b570336d6a61a",
           "version": "3.0.3"
         }
+      },
+      {
+        "package": "SSCZLib",
+        "repositoryURL": "https://github.com/daltoniam/zlib-spm.git",
+        "state": {
+          "branch": null,
+          "revision": "83ac8d719a2f3aa775dbdf116a57f56fb2c49abb",
+          "version": "1.1.0"
+        }
       }
     ]
   },

Socket.IO-Client-Swift.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name         = "Socket.IO-Client-Swift"
   s.module_name  = "SocketIO"
-  s.version      = "13.1.2"
+  s.version      = "13.1.3"
   s.summary      = "Socket.IO-client for iOS and OS X"
   s.description  = <<-DESC
                    Socket.IO-client for iOS and OS X.
@@ -18,7 +18,7 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.source = {
     :git => "https://github.com/socketio/socket.io-client-swift.git",
-    :tag => 'v13.1.2',
+    :tag => 'v13.1.3',
     :submodules => true
   }
   s.pod_target_xcconfig = {

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

@@ -8,6 +8,7 @@
 
 /* Begin PBXBuildFile section */
 		1C6572803D7E252A77A86E5F /* SocketManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1C65763817782DFAC67BE05C /* SocketManager.swift */; };
+		1C6573B22DC9423CDFC32F05 /* SocketRawView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1C657533E849FC3E4342C602 /* SocketRawView.swift */; };
 		1C657FBB3F670261780FD72E /* SocketManagerSpec.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1C6574AF9687A213814753E4 /* SocketManagerSpec.swift */; };
 		1C686BE21F869AFD007D8627 /* SocketIOClientConfigurationTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1C686BD21F869AF1007D8627 /* SocketIOClientConfigurationTest.swift */; };
 		1C686BE31F869AFD007D8627 /* SocketEngineTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1C686BD31F869AF1007D8627 /* SocketEngineTest.swift */; };
@@ -61,6 +62,7 @@
 
 /* Begin PBXFileReference section */
 		1C6574AF9687A213814753E4 /* SocketManagerSpec.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SocketManagerSpec.swift; sourceTree = "<group>"; };
+		1C657533E849FC3E4342C602 /* SocketRawView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SocketRawView.swift; sourceTree = "<group>"; };
 		1C65763817782DFAC67BE05C /* SocketManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SocketManager.swift; sourceTree = "<group>"; };
 		1C686BD21F869AF1007D8627 /* SocketIOClientConfigurationTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SocketIOClientConfigurationTest.swift; sourceTree = "<group>"; };
 		1C686BD31F869AF1007D8627 /* SocketEngineTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SocketEngineTest.swift; sourceTree = "<group>"; };
@@ -300,6 +302,7 @@
 				DD52B078DB0A3C3D1BB507CD /* SocketIOClientOption.swift */,
 				DD52B1D9BC4AE46D38D827DE /* SocketIOStatus.swift */,
 				DD52B57FFEE8560CFFD793B3 /* SocketIOClientConfiguration.swift */,
+				1C657533E849FC3E4342C602 /* SocketRawView.swift */,
 			);
 			name = Client;
 			path = Source/SocketIO/Client;
@@ -480,6 +483,7 @@
 				DD52B9412F660F828B683422 /* SocketParsable.swift in Sources */,
 				1C6572803D7E252A77A86E5F /* SocketManager.swift in Sources */,
 				1C657FBB3F670261780FD72E /* SocketManagerSpec.swift in Sources */,
+				1C6573B22DC9423CDFC32F05 /* SocketRawView.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

Source/SocketIO/Ack/SocketAckEmitter.swift

@@ -29,8 +29,20 @@ import Foundation
 ///
 /// **NOTE**: You should not store this beyond the life of the event handler.
 public final class SocketAckEmitter : NSObject {
-    let socket: SocketIOClient
-    let ackNum: Int
+    private unowned let socket: SocketIOClient
+    private let ackNum: Int
+
+    /// A view into this emitter where emits do not check for binary data.
+    ///
+    /// Usage:
+    ///
+    /// ```swift
+    /// ack.rawEmitView.with(myObject)
+    /// ```
+    ///
+    /// **NOTE**: It is not safe to hold on to this view beyond the life of the socket.
+    @objc
+    public private(set) lazy var rawEmitView = SocketRawAckView(socket: socket, ackNum: ackNum)
 
     // MARK: Properties
 
@@ -91,13 +103,16 @@ public final class SocketAckEmitter : NSObject {
 /// ```
 public final class OnAckCallback : NSObject {
     private let ackNumber: Int
+    private let binary: Bool
     private let items: [Any]
+
     private weak var socket: SocketIOClient?
 
-    init(ackNumber: Int, items: [Any], socket: SocketIOClient) {
+    init(ackNumber: Int, items: [Any], socket: SocketIOClient, binary: Bool = true) {
         self.ackNumber = ackNumber
         self.items = items
         self.socket = socket
+        self.binary = binary
     }
 
     deinit {
@@ -116,7 +131,7 @@ public final class OnAckCallback : NSObject {
         guard let socket = self.socket, ackNumber != -1 else { return }
 
         socket.ackHandlers.addAck(ackNumber, callback: callback)
-        socket.emit(items, ack: ackNumber)
+        socket.emit(items, ack: ackNumber, binary: binary)
 
         guard seconds != 0 else { return }
 

Source/SocketIO/Client/SocketIOClient.swift

@@ -67,6 +67,18 @@ open class SocketIOClient : NSObject, SocketIOClientSpec {
     @objc
     public private(set) weak var manager: SocketManagerSpec?
 
+    /// A view into this socket where emits do not check for binary data.
+    ///
+    /// Usage:
+    ///
+    /// ```swift
+    /// socket.rawEmitView.emit("myEvent", myObject)
+    /// ```
+    ///
+    /// **NOTE**: It is not safe to hold on to this view beyond the life of the socket.
+    @objc
+    public private(set) lazy var rawEmitView = SocketRawView(socket: self)
+
     /// The status of this client.
     @objc
     public private(set) var status = SocketIOStatus.notConnected {
@@ -148,7 +160,7 @@ open class SocketIOClient : NSObject, SocketIOClientSpec {
         }
     }
 
-    private func createOnAck(_ items: [Any]) -> OnAckCallback {
+    func createOnAck(_ items: [Any], binary: Bool = true) -> OnAckCallback {
         currentAck += 1
 
         return OnAckCallback(ackNumber: currentAck, items: items, socket: self)
@@ -216,11 +228,6 @@ open class SocketIOClient : NSObject, SocketIOClientSpec {
     /// - parameter items: The items to send with this event. Send an empty array to send no data.
     @objc
     open func emit(_ event: String, with items: [Any]) {
-        guard status == .connected else {
-            handleClientEvent(.error, data: ["Tried emitting \(event) when not connected"])
-            return
-        }
-
         emit([event] + items)
     }
 
@@ -277,16 +284,16 @@ open class SocketIOClient : NSObject, SocketIOClientSpec {
         return createOnAck([event] + items)
     }
 
-    func emit(_ data: [Any], ack: Int? = nil) {
+    func emit(_ data: [Any], ack: Int? = nil, binary: Bool = true, isAck: Bool = false) {
         guard status == .connected else {
             handleClientEvent(.error, data: ["Tried emitting when not connected"])
             return
         }
 
-        let packet = SocketPacket.packetFromEmit(data, id: ack ?? -1, nsp: nsp, ack: false)
+        let packet = SocketPacket.packetFromEmit(data, id: ack ?? -1, nsp: nsp, ack: isAck, checkForBinary: binary)
         let str = packet.packetString
 
-        DefaultSocketLogger.Logger.log("Emitting: \(str)", type: logType)
+        DefaultSocketLogger.Logger.log("Emitting: \(str), Ack: \(isAck)", type: logType)
 
         manager?.engine?.send(str, withData: packet.binary)
     }
@@ -298,14 +305,7 @@ open class SocketIOClient : NSObject, SocketIOClientSpec {
     /// - parameter ack: The ack number.
     /// - parameter with: The data for this ack.
     open func emitAck(_ ack: Int, with items: [Any]) {
-        guard status == .connected else { return }
-
-        let packet = SocketPacket.packetFromEmit(items, id: ack, nsp: nsp, ack: true)
-        let str = packet.packetString
-
-        DefaultSocketLogger.Logger.log("Emitting Ack: \(str)", type: logType)
-
-        manager?.engine?.send(str, withData: packet.binary)
+        emit(items, ack: ack, binary: true, isAck: true)
     }
 
     /// Called when socket.io has acked one of our emits. Causes the corresponding ack callback to be called.

Source/SocketIO/Client/SocketIOClientOption.swift

@@ -55,6 +55,8 @@ public enum SocketIOClientOption : ClientOption {
 
     /// The queue that all interaction with the client should occur on. This is the queue that event handlers are
     /// called on.
+    ///
+    /// **This should be a serial queue! Concurrent queues are not supported and might cause crashes and races**.
     case handleQueue(DispatchQueue)
 
     /// If passed `true`, the client will log debug information. This should be turned off in production code.

Source/SocketIO/Client/SocketIOClientSpec.swift

@@ -43,6 +43,17 @@ public protocol SocketIOClientSpec : class {
     /// **Must** start with a `/`.
     var nsp: String { get }
 
+    /// A view into this socket where emits do not check for binary data.
+    ///
+    /// Usage:
+    ///
+    /// ```swift
+    /// socket.rawEmitView.emit("myEvent", myObject)
+    /// ```
+    ///
+    /// **NOTE**: It is not safe to hold on to this view beyond the life of the socket.
+    var rawEmitView: SocketRawView { get }
+
     /// The status of this client.
     var status: SocketIOStatus { get }