Merge branch 'release/1.1.0'

Author: anthonyGuiguen

CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 All notable changes to this project will be documented in this file.
 
+### [1.1.0](https://github.com/Insurlytech/CometDClient-iOS/1.1.0)
+
+* Errors - Create recorder for sharing important errors  
+* Errors - Refact error to be more precise on the failure  
+
 ### [1.0.0](https://github.com/Insurlytech/CometDClient-iOS/1.0.0)
 
  * First release of CometD Client for iOS

CometDClient.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |spec|
   spec.name         = "CometDClient"
-  spec.version      = "1.0.0"
+  spec.version      = "1.1.0"
   spec.summary      = "Swift client for CometD"
   spec.description  = <<-DESC
   CometD is a scalable web event routing bus that allows you to write low-latency, server-side, event-driven web applications. Typical examples of such applications are stock trading applications, web chat applications, online games, and monitoring consoles.

Package.resolved

@@ -15,7 +15,7 @@ let package = Package(
         // Dependencies declare other packages that this package depends on.
         .package(url: "https://github.com/daltoniam/Starscream.git", .upToNextMajor(from: "4.0.3")),
         .package(url: "https://github.com/DaveWoodCom/XCGLogger.git", .upToNextMajor(from: "7.0.0")),
-        .package(url: "https://github.com/SwiftyJSON/SwiftyJSON.git", .upToNextMajor(from: "4.0.0"))
+        .package(url: "https://github.com/SwiftyJSON/SwiftyJSON.git", .upToNextMajor(from: "5.0.0"))
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.

Package.swift

@@ -18,7 +18,7 @@ Check out [Get Started](http://cocoapods.org/) tab on [cocoapods.org](http://coc
 
 To use CometDClient in your 'Podfile':
 
-    pod 'CometDClient', '~> 1.0.0'
+    pod 'CometDClient', '~> 1.1.0'
 
 Then run:
 

README.md

@@ -21,4 +21,7 @@ public enum Bayeux: String {
   case error = "error"
   case advice = "advice"
   case ext = "ext"
+  case code = "code"
+  case message = "message"
+  case context = "context"
 }

Sources/CometDClient/Bayeux/Models/Bayeux.swift

@@ -14,7 +14,13 @@ public class CometdClient: CometdClientContract {
   // MARK: Properties
   private lazy var bayeuxClient: BayeuxClientContract = BayeuxClient(log: log, timeOut: timeOut)
   private lazy var subscriber: SubscriberContract = Subscriber(bayeuxClient: bayeuxClient, log: log)
-  private lazy var transportAdapter = CometdClientTransportAdapter(bayeuxClient: bayeuxClient, subscriber: subscriber, log: log, delegate: self)
+  private lazy var transportAdapter = CometdClientTransportAdapter(
+    bayeuxClient: bayeuxClient,
+    subscriber: subscriber,
+    log: log,
+    delegate: self,
+    recorder: recorder
+  )
 
   private var forceSecure = false
   /// Default in 10 seconds
@@ -24,6 +30,7 @@ public class CometdClient: CometdClientContract {
   public var isConnected: Bool { bayeuxClient.isConnected }
   public var clientId: String? { bayeuxClient.clientId }
 
+  public private(set) weak var recorder: CometDClientRecorder?
   public weak var delegate: CometdClientDelegate?
 
   // MARK: Lifecycle
@@ -36,7 +43,7 @@ public class CometdClient: CometdClientContract {
     self.forceSecure = isSecure
   }
 
-  public func configure(url: String, backoffIncrement: Int = 1000, maxBackoff: Int = 60000, appendMessageTypeToURL: Bool = false) {
+  public func configure(url: String, backoffIncrement: Int = 1000, maxBackoff: Int = 60000, appendMessageTypeToURL: Bool = false, recorder: CometDClientRecorder?) {
     // Check protocol (only websocket for now)
     let rawUrl = URL(string: url)
     guard let path = rawUrl?.path, let host = rawUrl?.host else {
@@ -52,7 +59,8 @@ public class CometdClient: CometdClientContract {
       cometdURLString = scheme + host + path
     }
 
-    let transport = WebsocketTransport(url: cometdURLString, logLevel: log.outputLevel)
+    self.recorder = recorder
+    let transport = WebsocketTransport(url: cometdURLString, logLevel: log.outputLevel, recorder: recorder)
     transport.delegate = transportAdapter
     self.bayeuxClient.transport = transport
   }
@@ -104,13 +112,13 @@ extension CometdClient: CometdClientTransportAdapterDelegate {
     delegate?.didReceivePong(from: self)
   }
   func didWriteError(error: Error, from adapter: CometdClientTransportAdapter) {
-    delegate?.didWriteError(error: error, from: self)
+    delegate?.didWriteError(error: CometDClientError.write, from: self)
   }
-  func didFailConnection(error: Error?, from adapter: CometdClientTransportAdapter) {
-    delegate?.didFailConnection(error: error, from: self)
+  func didLostConnection(error: Error, from adapter: CometdClientTransportAdapter) {
+    delegate?.didLostConnection(error: CometDClientError.lostConnection, from: self)
   }
-  func didDisconnected(error: Error?, from adapter: CometdClientTransportAdapter) {
-    delegate?.didDisconnected(error: error, from: self)
+  func didDisconnected(error: Error, from adapter: CometdClientTransportAdapter) {
+    delegate?.didDisconnected(error: CometDClientError.lostConnection, from: self)
   }
 }
 
@@ -122,8 +130,15 @@ extension CometdClient: CometdClientMessageResolverDelegate {
   func handshakeDidSucceeded(dictionary: NSDictionary, from resolver: CometdClientMessageResolver) {
     delegate?.handshakeDidSucceeded(dictionary: dictionary, from: self)
   }
-  func handshakeDidFailed(from resolver: CometdClientMessageResolver) {
-    delegate?.handshakeDidFailed(from: self)
+  func handshakeDidFailed(error: Error, from resolver: CometdClientMessageResolver) {
+    let handshakeError: CometDClientError
+    switch error {
+    case let error as CometdClientMessageResolverError where error.code == CometdClientMessageResolverError.Constant.SIMPLE_UNMATCHED_LOGIN_PASSWORD:
+      handshakeError = .handshake(reason: HandshakeError.wrongCredential)
+    default:
+      handshakeError = .handshake(reason: nil)
+    }
+    delegate?.handshakeDidFailed(error: handshakeError, from: self)
   }
   func didDisconnected(from adapter: CometdClientMessageResolver) {
     delegate?.didDisconnected(error: nil, from: self)
@@ -140,7 +155,7 @@ extension CometdClient: CometdClientMessageResolverDelegate {
   func didUnsubscribeFromChannel(channel: String, from resolver: CometdClientMessageResolver) {
     delegate?.didUnsubscribeFromChannel(channel: channel, from: self)
   }
-  func subscriptionFailedWithError(error: SubscriptionError, from resolver: CometdClientMessageResolver) {
-    delegate?.subscriptionFailedWithError(error: error, from: self)
+  func subscriptionFailedWithError(error: Error, from resolver: CometdClientMessageResolver) {
+    delegate?.subscriptionFailedWithError(error: CometDClientError.subscription, from: self)
   }
 }

Sources/CometDClient/CometdClient.swift

@@ -13,8 +13,9 @@ public protocol CometdClientContract: class {
   var clientId: String? { get }
   var log: XCGLogger { get }
   var delegate: CometdClientDelegate? { get set }
+  var recorder: CometDClientRecorder? { get }
 
-  func configure(url: String, backoffIncrement: Int, maxBackoff: Int, appendMessageTypeToURL: Bool)
+  func configure(url: String, backoffIncrement: Int, maxBackoff: Int, appendMessageTypeToURL: Bool, recorder: CometDClientRecorder?)
 
   func handshake(fields: [String: Any])
   func disconnectFromServer()
@@ -30,7 +31,7 @@ public protocol CometdClientContract: class {
 }
 
 public extension CometdClientContract {
-  func configure(url: String) {
-    configure(url: url, backoffIncrement: 1000, maxBackoff: 60000, appendMessageTypeToURL: false)
+  func configure(url: String, recorder: CometDClientRecorder?) {
+    configure(url: url, backoffIncrement: 1000, maxBackoff: 60000, appendMessageTypeToURL: false, recorder: recorder)
   }
 }

Sources/CometDClient/CometdClientContract.swift

@@ -14,13 +14,13 @@ public protocol CometdClientDelegate: class {
   func didReceivePong(from client: CometdClientContract)
   func didConnected(from client: CometdClientContract)
   func handshakeDidSucceeded(dictionary: NSDictionary, from client: CometdClientContract)
-  func handshakeDidFailed(from client: CometdClientContract)
+  func handshakeDidFailed(error: Error, from client: CometdClientContract)
   func didDisconnected(error: Error?, from client: CometdClientContract)
   func didAdvisedToReconnect(from client: CometdClientContract)
-  func didFailConnection(error: Error?, from client: CometdClientContract)
+  func didLostConnection(error: Error, from client: CometdClientContract)
   func didSubscribeToChannel(channel: String, from client: CometdClientContract)
   func didUnsubscribeFromChannel(channel: String, from client: CometdClientContract)
-  func subscriptionFailedWithError(error: SubscriptionError, from client: CometdClientContract)
+  func subscriptionFailedWithError(error: Error, from client: CometdClientContract)
   func didWriteError(error: Error, from client: CometdClientContract)
 }
 
@@ -29,12 +29,12 @@ public extension CometdClientDelegate {
   func didReceivePong(from client: CometdClientContract) { }
   func didConnected(from client: CometdClientContract) { }
   func handshakeDidSucceeded(dictionary: NSDictionary, from client: CometdClientContract) { }
-  func handshakeDidFailed(from client: CometdClientContract) { }
+  func handshakeDidFailed(error: Error, from client: CometdClientContract) { }
   func didDisconnected(error: Error?, from client: CometdClientContract) { }
   func didAdvisedToReconnect(from client: CometdClientContract) { }
-  func didFailConnection(error: Error?, from client: CometdClientContract) { }
+  func didLostConnection(error: Error, from client: CometdClientContract) { }
   func didSubscribeToChannel(channel: String, from client: CometdClientContract) { }
   func didUnsubscribeFromChannel(channel: String, from client: CometdClientContract) { }
-  func subscriptionFailedWithError(error: SubscriptionError, from client: CometdClientContract) { }
+  func subscriptionFailedWithError(error: Error, from client: CometdClientContract) { }
   func didWriteError(error: Error, from client: CometdClientContract) { }
 }

Sources/CometDClient/CometdClientDelegate.swift

@@ -12,8 +12,8 @@ import XCGLogger
 protocol CometdClientTransportAdapterDelegate: class {
   func didReceivePong(from adapter: CometdClientTransportAdapter)
   func didWriteError(error: Error, from adapter: CometdClientTransportAdapter)
-  func didFailConnection(error: Error?, from adapter: CometdClientTransportAdapter)
-  func didDisconnected(error: Error?, from adapter: CometdClientTransportAdapter)
+  func didLostConnection(error: Error, from adapter: CometdClientTransportAdapter)
+  func didDisconnected(error: Error, from adapter: CometdClientTransportAdapter)
 }
 
 // MARK: Transport Delegate
@@ -24,22 +24,25 @@ class CometdClientTransportAdapter: TransportDelegate {
   private let bayeuxClient: BayeuxClientContract
   private let subscriber: SubscriberContract
   private let log: XCGLogger
+  private weak var recorder: CometDClientRecorder?
 
   weak var delegate: Delegate?
 
   private lazy var messageResolver = CometdClientMessageResolver(
     bayeuxClient: bayeuxClient,
     subscriber: subscriber,
     log: log,
-    delegate: delegate
+    delegate: delegate,
+    recorder: recorder
   )
 
   // MARK: Lifecycle
-  init(bayeuxClient: BayeuxClientContract, subscriber: SubscriberContract, log: XCGLogger, delegate: Delegate?) {
+  init(bayeuxClient: BayeuxClientContract, subscriber: SubscriberContract, log: XCGLogger, delegate: Delegate?, recorder: CometDClientRecorder?) {
     self.bayeuxClient = bayeuxClient
     self.subscriber = subscriber
     self.log = log
     self.delegate = delegate
+    self.recorder = recorder
   }
 
   // MARK: TransportDelegate
@@ -49,22 +52,23 @@ class CometdClientTransportAdapter: TransportDelegate {
     bayeuxClient.handshake()
   }
 
-  public func didDisconnect(_ error: Error?) {
+  
+  func didDisconnect(_ error: Error) {
     log.debug("CometdClient didDisconnect")
     bayeuxClient.connectionInitiated = false
     bayeuxClient.isConnected = false
     delegate?.didDisconnected(error: error, from: self)
   }
 
-  public func didFailConnection(_ error: Error?) {
+  func didLostConnection(_ error: Error) {
     log.warning("CometdClient didFailConnection")
     bayeuxClient.connectionInitiated = false
     bayeuxClient.isConnected = false
-    delegate?.didFailConnection(error: error, from: self)
+    delegate?.didLostConnection(error: error, from: self)
   }
 
-  public func didWriteError(_ error: Error?) {
-    delegate?.didWriteError(error: error ?? CometdSocketError.transportWrite, from: self)
+  func didWriteError(_ error: Error?) {
+    delegate?.didWriteError(error: error ?? WebsocketTransportError.write(error: nil), from: self)
   }
 
   public func didReceiveMessage(_ text: String) {