Open mahyarq opened 8 months ago
I've been going crazy trying to figure out why the timingOut
would never fire. And indeed, the issue is that without retaining it it's being deallocated. You can easily see the issue on OnAckCallback.swift:140
. self
is nil
when the dispatch fires and therefore the callback is never called!
// @nuclearace
Environment:
Library Version: 16.1.0 Xcode: tested on Xcode 14 and Xcode 15 Platform: iOS 16 and iOS 17
Description:
I've encountered an issue with the
emitWithAck
function in the Socket.IO-Client-Swift library, specifically when using thetimingOut(after:)
closure. TheOnAckCallback
object returned byemitWithAck
seems to get deallocated prematurely if not explicitly retained in the client code.In addition to the premature deallocation of the
OnAckCallback
instance, a critical part of the issue is that the callback codesocket.ackHandlers.timeoutAck(self.ackNumber)
within thetimingOut(after:)
function is never executed as expected. This is becauseself
(referring to theOnAckCallback
instance) becomesnil
after the timeout period elapses. This behavior results in the failure of the timeout handling logic, as the necessary callback for a timeout situation is not called.Steps to Reproduce:
emitWithAck().timingOut(after:)
on aSocketIOClient
instance. Make sure server doesnt send any callbacks.OnAckCallback
instance is deallocated before the timeout closure is executed, resulting inself
beingnil
within the closure.Expected Behavior:
The
OnAckCallback
instance should be retained internally by the library until thetimingOut(after:)
closure is executed or the timeout occurs.Actual Behavior:
The
OnAckCallback
instance is deallocated prematurely unless explicitly retained in the client code.My hacky fix
In my current SocketHandler class, i've added a
var emitAckCallBack: OnAckCallback?
which i assign the value ofsocket.emitWithAck()
and afterwards i callemitAckCallBack?.timingOut(after:)
and thereafter set theemitAckCallBack
to nil inside the completion block. This seems to hold a reference toOnAckCallback
which prevents it from getting deallocated prematurely.Code example: