HTTP does not pause WebSocket operations during pending reconnect #1228
Comments
|
is there a workaround for this issue? check the connection or something else before requesting. |
I have been unable to come up with a feasible workaround due to the primary $discord object not making its WebSocket instance of $ws publicly accessible. |
|
I've come up with one possible solution to this so far, however with Promises v2 the only way to effectively implement it is from userland. A workaround would involve implementing a middleware that handles the callback results for all A promises v2 solution/workaround could look something like this: $this->onFulfilledDefault = function ($result)
{
$output = 'Promise resolved with type of: `' . gettype($result) . '`';
if (is_object($result)) {
$output .= ' and class of: `' . get_class($result) . '`';
$output .= ' with properties: `' . implode('`, `', array_keys(get_object_vars($result))) . '`';
}
$this->logger->debug($output);
return $result;
};
$this->onRejectedDefault = function ($reason): void
{
$this->logger->error("Promise rejected with reason: `$reason'`");
if ($reason === 'RuntimeException: Connection to tls://discord.com:443 timed out after 60 seconds (ETIMEDOUT)') {
// Check for $reason here and recreate the promise to be reattempted after the connection has been restored
}
};
/**
* Chains a callback to be executed when the promise is fulfilled or rejected.
*
* @param PromiseInterface $promise The promise to chain with.
* @param callable|null $onFulfilled The callback to execute when the promise is fulfilled. If null, the default callback will be used.
* @param callable|null $onRejected The callback to execute when the promise is rejected. If null, the default callback will be used.
* @return PromiseInterface The new promise that will be fulfilled or rejected based on the result of the callback.
*/
public function then(PromiseInterface $promise, ?callable $onFulfilled = null, ?callable $onRejected = null): PromiseInterface
{
return $promise->then($onFulfilled ?? $this->onFulfilledDefault, $onRejected ?? $this->onRejectedDefault);
}This will likely be possible to implement into the library in a non-hacky way whenever we can upgrade to Promises v3, after which we will be able to utilize set_rejection_handler. In my case, I am simply listening for and logging the rejections, so I've included a section within my resolveOption() function to specifically validate what these default handlers should look like if passed into $options. Your preferred callbacks for promises may vary, but this may serve as a template if someone wants to do something similar. $this->logger = $options['logger'];
$onFulfilledDefaultValid = false;
if (isset($options['onFulfilledDefault']) && is_callable($options['onFulfilledDefault'])) {
if ($reflection = new ReflectionFunction($options['onFulfilledDefault']))
if ($returnType = $reflection->getReturnType())
if ($returnType->getName() !== 'void')
{ $this->onFulfilledDefault = $options['onFulfilledDefault']; $onFulfilledDefaultValid = true; }
}
if (! $onFulfilledDefaultValid) $this->onFulfilledDefault = function ($result) {
$output = 'Promise resolved with type of: `' . gettype($result) . '`';
if (is_object($result)) {
$output .= ' and class of: `' . get_class($result) . '`';
$output .= ' with properties: `' . implode('`, `', array_keys(get_object_vars($result))) . '`';
}
$this->logger->debug($output);
return $result;
};
$onRejectedDefaultValid = false;
if (isset($options['onRejectedDefault']) && is_callable($options['onRejectedDefault'])) {
if ($reflection = new ReflectionFunction($options['onRejectedDefault']))
if ($returnType = $reflection->getReturnType())
if ($returnType->getName() === 'void')
{ $this->onRejectedDefault = $options['onRejectedDefault']; $onRejectedDefaultValid = true; }
}
if (! $onRejectedDefaultValid) $this->onRejectedDefault = function ($reason): void
{
$this->logger->error("Promise rejected with reason: `$reason'`");
if ($reason === 'RuntimeException: Connection to tls://discord.com:443 timed out after 60 seconds (ETIMEDOUT)') {
// Check for $reason here and recreate the promise to be reattempted after the connection has been restored
}
}; |
|
Ideally we should Pause the loop of the Discord-PHP-Http client, but since it's not practically possible with React Event loop, the solution to this is to rewrite the Discord-PHP Http queuing mechanism to allow requests to be paused and hold back in the bucket (like the Rate limit implementation) instead of forwarding the network issue as rejection and attempt to recreate the promise which could be indefinite |
|
I believe this issue should now 'softly' be considered as resolved. The exact details of how the client should respond to a timeout will likely vary from person to person, and as such anyone needing special handling should |
Environment
Describe the bug
The library continues to attempt operations on the WebSocket while a reconnect is pending, instead of waiting for the reconnection to complete. This can lead to failed requests and unexpected errors.
To Reproduce
Attempt to perform any API calls after op code 1000 is received but before the socket is reconnected, which should happen automatically after 2 seconds.
Expected behavior
The library should not attempt to perform any functions other than reconnect while the websocket is knowingly disconnected. Any other API-related promises that are created during this time should be deferred.
Additional context
The text was updated successfully, but these errors were encountered: