Merge pull request #346 from pusher/feature/334-remove-legacy-methods

Removes deprecated legacy 'bind(…)' methods

Author: danielrbrowne

Sources/Models/PusherChannel.swift

@@ -35,10 +35,6 @@ open class PusherChannel: NSObject {
         }
     }
 
-    internal var shouldParseJSONForLegacyCallbacks: Bool {
-        return connection?.options.attemptToReturnJSONObject ?? true
-    }
-
     /**
         Initializes a new PusherChannel with a given name and connection
 
@@ -56,37 +52,6 @@ open class PusherChannel: NSObject {
         self.type = PusherChannelType(name: name)
     }
 
-    /**
-        Binds a callback to a given event name, scoped to the PusherChannel the function is
-        called on
-
-        - parameter eventName: The name of the event to bind to
-        - parameter callback:  The function to call when a new event is received. The
-                               callback receives the event's data payload
-
-        - returns: A unique callbackId that can be used to unbind the callback at a later time
-    */
-    @available(*, deprecated, message: "This will be removed in v10.0.0. Use 'bind(eventName:eventCallback:)' instead.")
-    @discardableResult open func bind(eventName: String, callback: @escaping (Any?) -> Void) -> String {
-        return bind(eventName: eventName, eventCallback: { [weak self] (event: PusherEvent) -> Void in
-            guard let self = self else { return }
-            // Mimic the old parsing behavior for backwards compatibility
-            let callbackData: Any?
-            if self.shouldParseJSONForLegacyCallbacks {
-                if let data = event.dataToJSONObject() {
-                    // Parsed data
-                    callbackData = data
-                } else {
-                    // Unparsed string if we couldn't parse
-                    callbackData = event.data
-                }
-            } else {
-                callbackData = event.raw[Constants.JSONKeys.data]
-            }
-            callback(callbackData)
-        })
-    }
-
     /**
      Binds a callback to a given event name, scoped to the PusherChannel the function is
      called on

Sources/Models/PusherError.swift

@@ -10,9 +10,6 @@ open class PusherError: NSObject {
     /// The error message.
     public let message: String
 
-    // The websocket payload which needs to passed to legacy callbacks for backwards compatibility
-    @nonobjc internal let raw: [String: Any]
-
     @nonobjc internal init?(jsonObject: [String: Any]) {
         guard let data = jsonObject[Constants.JSONKeys.data] as? [String: Any] else {
             return nil
@@ -24,6 +21,5 @@ open class PusherError: NSObject {
 
         self.code = data[Constants.JSONKeys.code] as? Int
         self.message = message
-        self.raw = jsonObject
     }
 }

Sources/Models/PusherGlobalChannel.swift

@@ -3,7 +3,6 @@ import Foundation
 @objcMembers
 @objc open class GlobalChannel: PusherChannel {
     open var globalCallbacks: [String: (PusherEvent) -> Void] = [:]
-    open var globalLegacyCallbacks: [String: (Any?) -> Void] = [:]
 
     /**
         Initializes a new GlobalChannel instance
@@ -28,17 +27,6 @@ import Foundation
         }
     }
 
-    /**
-     Calls the appropriate legacy callbacks for the given event name in the scope of the global channel
-
-     - parameter event: The JSON object received from the websocket
-     */
-    internal func handleGlobalEventLegacy(event: [String: Any]) {
-        for (_, callback) in self.globalLegacyCallbacks {
-            callback(event)
-        }
-    }
-
     /**
         Binds a callback to the global channel
 
@@ -52,34 +40,19 @@ import Foundation
         return randomId
     }
 
-    /**
-     Binds a callback to the global channel
-
-     - parameter callback:  The function to call when a message is received
-
-     - returns: A unique callbackId that can be used to unbind the callback at a later time
-     */
-    internal func bindLegacy(_ callback: @escaping (Any?) -> Void) -> String {
-        let randomId = UUID().uuidString
-        self.globalLegacyCallbacks[randomId] = callback
-        return randomId
-    }
-
     /**
         Unbinds the callback with the given callbackId from the global channel
 
         - parameter callbackId: The unique callbackId string used to identify which callback to unbind
     */
     internal func unbind(callbackId: String) {
         globalCallbacks.removeValue(forKey: callbackId)
-        globalLegacyCallbacks.removeValue(forKey: callbackId)
     }
 
     /**
         Unbinds all callbacks from the channel
     */
     override open func unbindAll() {
         globalCallbacks = [:]
-        globalLegacyCallbacks = [:]
     }
 }

Sources/PusherSwift.swift

@@ -113,19 +113,6 @@ let CLIENT_NAME = "pusher-websocket-swift"
         self.connection.unsubscribeAll()
     }
 
-    /**
-        Binds the client's global channel to all events
-
-        - parameter callback: The function to call when a new event is received. The callback
-                              receives the event's data payload
-
-        - returns: A unique string that can be used to unbind the callback from the client
-    */
-    @available(*, deprecated, message: "This will be removed in v10.0.0. Use 'bind(eventCallback:)' instead.")
-    @discardableResult open func bind(_ callback: @escaping (Any?) -> Void) -> String {
-        return self.connection.addLegacyCallbackToGlobalChannel(callback)
-    }
-
     /**
      Binds the client's global channel to all events
 

Sources/Services/PusherConnection.swift

@@ -300,17 +300,6 @@ import NWWebSocket
         return globalChannel.bind(callback)
     }
 
-    /**
-     Add legacy callback to the connection's global channel
-
-     - parameter callback: The callback to be stored
-
-     - returns: A callbackId that can be used to remove the callback from the connection
-     */
-    internal func addLegacyCallbackToGlobalChannel(_ callback: @escaping (Any?) -> Void) -> String {
-        return globalChannel.bindLegacy(callback)
-    }
-
     /**
         Remove the callback with id of callbackId from the connection's global channel
 
@@ -565,7 +554,6 @@ import NWWebSocket
     open func handleError(error: PusherError) {
         resetActivityTimeoutTimer()
         self.delegate?.receivedError?(error: error)
-        self.globalChannel?.handleGlobalEventLegacy(event: error.raw)
     }
 
     /**
@@ -633,7 +621,6 @@ import NWWebSocket
     */
     private func callGlobalCallbacks(event: PusherEvent) {
         globalChannel?.handleGlobalEvent(event: event)
-        globalChannel?.handleGlobalEventLegacy(event: event.raw)
     }
 
     /**

Tests/Integration/AuthenticationTests.swift

@@ -125,17 +125,12 @@ class AuthenticationTests: XCTestCase {
         let chan = pusher.subscribe("private-test-channel")
         XCTAssertFalse(chan.subscribed, "the channel should not be subscribed")
 
-        _ = pusher.bind({ (data: Any?) -> Void in
-            guard let data = data as? [String: AnyObject],
-                  let eventName = data["event"] as? String,
-                  eventName == "pusher:subscription_error" else {
-                return
-            }
-
-            XCTAssertEqual("private-test-channel", data["channel"] as? String)
+        pusher.bind { event in
+            XCTAssertEqual(event.eventName, "pusher:subscription_error")
+            XCTAssertEqual(event.channelName, "private-test-channel")
             XCTAssertTrue(Thread.isMainThread)
             ex.fulfill()
-        })
+        }
 
         pusher.connect()