Skip to content

Commit f87ed47

Browse files
nuclearacenuclearace
committed
tweak logging
1 parent d887c96 commit f87ed47

File tree

4 files changed

+42
-38
lines changed

4 files changed

+42
-38
lines changed

‎SocketIOClientSwift/SocketEngine.swift

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,12 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
5353
private var waitingForPost = false
5454
private var _websocket = false
5555
private var websocketConnected = false
56+
57+
let logType = "SocketEngine"
58+
5659
var connected:Bool {
5760
return self._connected
5861
}
59-
6062
weak var client:SocketEngineClient?
6163
var cookies:[NSHTTPCookie]?
6264
var log = false
@@ -180,7 +182,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
180182

181183
private func doFastUpgrade() {
182184
if self.waitingForPoll {
183-
SocketLogger.err("Engine: Outstanding poll when switched to WebSockets," +
185+
SocketLogger.err("Outstanding poll when switched to WebSockets," +
184186
"we'll probably disconnect soon. You should report this.", client: self)
185187
}
186188

@@ -210,7 +212,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
210212

211213
req.cachePolicy = NSURLRequestCachePolicy.ReloadIgnoringLocalAndRemoteCacheData
212214

213-
SocketLogger.log("Engine: Doing polling request", client: self)
215+
SocketLogger.log("Doing polling request", client: self)
214216

215217
self.session.dataTaskWithRequest(req) {[weak self] data, res, err in
216218
if self == nil {
@@ -225,7 +227,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
225227
return
226228
}
227229

228-
SocketLogger.log("Engine: Got polling response", client: self!)
230+
SocketLogger.log("Got polling response", client: self!)
229231

230232
if let str = NSString(data: data, encoding: NSUTF8StringEncoding) as? String {
231233
dispatch_async(self!.parseQueue) {
@@ -245,7 +247,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
245247
}
246248

247249
private func flushProbeWait() {
248-
SocketLogger.log("Engine: Flushing probe wait", client: self)
250+
SocketLogger.log("Flushing probe wait", client: self)
249251

250252
dispatch_async(self.emitQueue) {[weak self] in
251253
if self == nil {
@@ -295,7 +297,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
295297

296298
self.waitingForPost = true
297299

298-
SocketLogger.log("Engine: POSTing: \(postStr)", client: self)
300+
SocketLogger.log("POSTing: \(postStr)", client: self)
299301

300302
self.session.dataTaskWithRequest(req) {[weak self] data, res, err in
301303
if self == nil {
@@ -349,13 +351,13 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
349351

350352
public func open(opts:[String: AnyObject]? = nil) {
351353
if self.connected {
352-
SocketLogger.err("Engine: Tried to open while connected", client: self)
354+
SocketLogger.err("Tried to open while connected", client: self)
353355

354-
self.client?.didError("Engine tried to open while connected")
356+
self.client?.didError("Tried to open while connected")
355357
return
356358
}
357359

358-
SocketLogger.log("Engine: Starting engine", client: self)
360+
SocketLogger.log("Starting engine", client: self)
359361

360362
self.closed = false
361363
let (urlPolling, urlWebSocket) = self.createURLs(opts)
@@ -409,7 +411,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
409411
length += chr
410412
} else {
411413
if length == "" || testLength(length, &n) {
412-
SocketLogger.err("Engine: parsing error: \(str)", client: self)
414+
SocketLogger.err("Parsing error: \(str)", client: self)
413415

414416
self.handlePollingFailed("Error parsing XHR message")
415417
return
@@ -448,7 +450,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
448450
}
449451

450452
private func parseEngineMessage(var message:String, fromPolling:Bool) {
451-
SocketLogger.log("Engine: Got message: \(message)", client: self)
453+
SocketLogger.log("Got message: \(message)", client: self)
452454

453455
if fromPolling {
454456
fixDoubleUTF8(&message)
@@ -561,7 +563,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
561563
/// Only call on emitQueue
562564
private func sendPollMessage(var msg:String, withType type:PacketType,
563565
datas:ContiguousArray<NSData>? = nil) {
564-
SocketLogger.log("Engine: Sending poll: \(msg) as type: \(type.rawValue)", client: self)
566+
SocketLogger.log("Sending poll: \(msg) as type: \(type.rawValue)", client: self)
565567

566568
doubleEncodeUTF8(&msg)
567569
let strMsg = "\(type.rawValue)\(msg)"
@@ -585,7 +587,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
585587
/// Only call on emitQueue
586588
private func sendWebSocketMessage(str:String, withType type:PacketType,
587589
datas:ContiguousArray<NSData>? = nil) {
588-
SocketLogger.log("Engine: Sending ws: \(str) as type: \(type.rawValue)", client: self)
590+
SocketLogger.log("Sending ws: \(str) as type: \(type.rawValue)", client: self)
589591

590592
self.ws?.writeString("\(type.rawValue)\(str)")
591593

@@ -615,7 +617,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
615617

616618
private func upgradeTransport() {
617619
if self.websocketConnected {
618-
SocketLogger.log("Engine: Upgrading transport to WebSockets", client: self)
620+
SocketLogger.log("Upgrading transport to WebSockets", client: self)
619621

620622
// Do a fast upgrade
621623
// At this point, we should not send anymore polling messages-
@@ -631,10 +633,10 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
631633
}
632634

633635
if self!.websocket {
634-
SocketLogger.log("Engine: Writing ws: \(msg):\(data)", client: self!)
636+
SocketLogger.log("Writing ws: \(msg):\(data)", client: self!)
635637
self?.sendWebSocketMessage(msg, withType: type, datas: data)
636638
} else {
637-
SocketLogger.log("Engine: Writing poll: \(msg):\(data)", client: self!)
639+
SocketLogger.log("Writing poll: \(msg):\(data)", client: self!)
638640
self?.sendPollMessage(msg, withType: type, datas: data)
639641
}
640642
}

‎SocketIOClientSwift/SocketIOClient.swift

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
4141
private var reconnectTimer:NSTimer?
4242

4343
let reconnectAttempts:Int!
44+
let logType = "SocketClient"
4445
var ackHandlers = SocketAckMap()
4546
var currentAck = -1
4647
var log = false
@@ -138,7 +139,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
138139
}
139140

140141
private func addEngine() {
141-
SocketLogger.log("Client: Adding engine", client: self)
142+
SocketLogger.log("Adding engine", client: self)
142143

143144
self.engine = SocketEngine(client: self,
144145
forcePolling: self.forcePolling,
@@ -153,7 +154,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
153154
Pass true to fast if you're closing from a background task
154155
*/
155156
public func close(#fast:Bool) {
156-
SocketLogger.log("Client: Closing socket", client: self)
157+
SocketLogger.log("Closing socket", client: self)
157158

158159
self.reconnects = false
159160
self._connecting = false
@@ -222,7 +223,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
222223
}
223224

224225
func didConnect() {
225-
SocketLogger.log("Client: Socket connected", client: self)
226+
SocketLogger.log("Socket connected", client: self)
226227

227228
self._closed = false
228229
self._connected = true
@@ -240,7 +241,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
240241

241242
/// error
242243
public func didError(reason:AnyObject) {
243-
SocketLogger.err("Client: Error", client: self)
244+
SocketLogger.err("Error", client: self)
244245

245246
self.handleEvent("error", data: reason as? [AnyObject] ?? [reason],
246247
isInternalMessage: true)
@@ -313,7 +314,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
313314
SocketParser.parseForEmit(packet)
314315
str = packet.createMessageForEvent(event)
315316

316-
SocketLogger.log("Client: Emitting: \(str)", client: self)
317+
SocketLogger.log("Emitting: \(str)", client: self)
317318

318319
if packet.type == SocketPacket.PacketType.BINARY_EVENT {
319320
self.engine?.send(str, withData: packet.binary)
@@ -335,7 +336,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
335336
SocketParser.parseForEmit(packet)
336337
str = packet.createAck()
337338

338-
SocketLogger.log("Client: Emitting Ack: \(str)", client: self!)
339+
SocketLogger.log("Emitting Ack: \(str)", client: self!)
339340

340341
if packet.type == SocketPacket.PacketType.BINARY_ACK {
341342
self?.engine?.send(str, withData: packet.binary)
@@ -351,7 +352,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
351352
return
352353
}
353354

354-
SocketLogger.log("Client: Engine closed", client: self)
355+
SocketLogger.log("Engine closed", client: self)
355356

356357
self._closed = true
357358
self._connected = false
@@ -363,7 +364,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
363364

364365
// Called when the socket gets an ack for something it sent
365366
func handleAck(ack:Int, data:AnyObject?) {
366-
SocketLogger.log("Client: Handling ack: \(ack) with data: \(data)", client: self)
367+
SocketLogger.log("Handling ack: \(ack) with data: \(data)", client: self)
367368

368369
self.ackHandlers.executeAck(ack,
369370
items: (data as? [AnyObject]?) ?? (data != nil ? [data!] : nil))
@@ -379,7 +380,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
379380
return
380381
}
381382

382-
SocketLogger.log("Client: Handling event: \(event) with data: \(data)", client: self)
383+
SocketLogger.log("Handling event: \(event) with data: \(data)", client: self)
383384

384385
if self.anyHandler != nil {
385386
dispatch_async(dispatch_get_main_queue()) {[weak self] in
@@ -399,7 +400,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
399400
}
400401

401402
func joinNamespace() {
402-
SocketLogger.log("Client: Joining namespace", client: self)
403+
SocketLogger.log("Joining namespace", client: self)
403404

404405
if self.nsp != "/" {
405406
self.engine?.send("0/\(self.nsp)", withData: nil)
@@ -410,7 +411,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
410411
Removes handler(s)
411412
*/
412413
public func off(event:String) {
413-
SocketLogger.log("Client: Removing handler for event: \(event)", client: self)
414+
SocketLogger.log("Removing handler for event: \(event)", client: self)
414415

415416
self.handlers = self.handlers.filter {$0.event == event ? false : true}
416417
}
@@ -419,7 +420,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
419420
Adds a handler for an event.
420421
*/
421422
public func on(name:String, callback:NormalCallback) {
422-
SocketLogger.log("Client: Adding handler for event: \(name)", client: self)
423+
SocketLogger.log("Adding handler for event: \(name)", client: self)
423424

424425
let handler = SocketEventHandler(event: name, callback: callback)
425426
self.handlers.append(handler)
@@ -468,7 +469,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
468469
}
469470

470471
if self.reconnectTimer == nil {
471-
SocketLogger.log("Client: Starting reconnect", client: self)
472+
SocketLogger.log("Starting reconnect", client: self)
472473

473474
self._reconnecting = true
474475

@@ -483,7 +484,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
483484
}
484485
}
485486

486-
SocketLogger.log("Client: Trying to reconnect", client: self)
487+
SocketLogger.log("Trying to reconnect", client: self)
487488
self.handleEvent("reconnectAttempt", data: [self.reconnectAttempts - self.currentReconnectAttempt],
488489
isInternalMessage: true)
489490

‎SocketIOClientSwift/SocketLogger.swift

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,19 @@ import Foundation
2626

2727
protocol SocketLogClient {
2828
var log:Bool {get set}
29+
var logType:String {get}
2930
}
3031

3132
final class SocketLogger {
32-
static func log(message:String, client:SocketLogClient) {
33+
static func log(message:String, client:SocketLogClient, altType:String? = nil) {
3334
if client.log {
34-
NSLog("%@", message)
35+
NSLog("%@: %@", altType ?? client.logType, message)
3536
}
3637
}
3738

38-
static func err(message:String, client:SocketLogClient) {
39+
static func err(message:String, client:SocketLogClient, altType:String? = nil) {
3940
if client.log {
40-
NSLog("ERROR %@", message)
41+
NSLog("ERROR %@: %@", altType ?? client.logType, message)
4142
}
4243
}
4344
}

‎SocketIOClientSwift/SocketParser.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
import Foundation
2424

25-
class SocketParser {
25+
class SocketParser {
2626
private static let shredder = SocketParser.PacketShredder()
2727

2828
// Translation of socket.io-parser#deconstructPacket
@@ -185,7 +185,7 @@ class SocketParser {
185185
return nsp == "" && socket.nsp != "/"
186186
}
187187

188-
SocketLogger.log("Parser: Parsing \(stringMessage)", client: socket)
188+
SocketLogger.log("Parsing \(stringMessage)", client: socket, altType: "SocketParser")
189189

190190
let p:SocketPacket
191191

@@ -198,7 +198,7 @@ class SocketParser {
198198

199199
// Don't call SocketPacket.description unless we need to
200200
if socket.log {
201-
SocketLogger.log("Parser: Decoded packet as: \(p)", client: socket)
201+
SocketLogger.log("Decoded packet as: \(p)", client: socket, altType: "SocketParser")
202202
}
203203

204204
if p.type == SocketPacket.PacketType.EVENT {
@@ -247,7 +247,7 @@ class SocketParser {
247247
// NSLog(data.base64EncodedStringWithOptions(NSDataBase64EncodingOptions.allZeros))
248248

249249
if socket.waitingData.count == 0 {
250-
SocketLogger.err("Parser: Got data when not remaking packet", client: socket)
250+
SocketLogger.err("Got data when not remaking packet", client: socket, altType: "SocketParser")
251251
return
252252
}
253253

0 commit comments

Comments
 (0)