Promise v3 (#1157)

* Promise v3 changes - changed ExtendedPromiseInterface to PromiseInterface - replaced Discord\Helpers\Deferred with React\Promise\Deferred - changed ->done(true function, false function) with ->then(true function)->catch(false function) - changed ->always() to ->finally() - added use React\Promise\Deferred where I think it was missing - updated $deferred->resolve() to $deferred->resolve(null) - updated $deferred->reject() to $deferred->reject(throwable) - bumped wyrihaximus/react-cache-redis to ^4.5 - fixed some imports, doc blocks, and return types --------- Co-authored-by: Valithor Obsidion <[email protected]> See https://github.com/reactphp/promise/releases/tag/v3.0.0 for BC recommendations.
discord-php · Nov 20, 2024 · a9bb7fc · a9bb7fc
1 parent 6fbb669
commit a9bb7fc
Show file tree

Hide file tree

Showing 39 changed files with 367 additions and 433 deletions.
diff --git a/composer.json b/composer.json
@@ -23,7 +23,6 @@
         "trafficcophp/bytebuffer": "^0.3",
         "monolog/monolog": "^2.1.1 || ^3.0",
         "react/event-loop": "^1.2",
-        "react/promise": "^2.2",
         "ext-json": "*",
         "ext-zlib": "*",
         "discord-php/http": "^10.1.7",
@@ -38,7 +37,7 @@
         "friendsofphp/php-cs-fixer": "^3",
         "phpunit/phpunit": "^9.4.4",
         "davidcole1340/reactsh": "dev-master",
-        "wyrihaximus/react-cache-redis": "^3.0 || >=4.0 <4.4",
+        "wyrihaximus/react-cache-redis": "^4.5",
         "symfony/cache": "^5.4"
     },
     "autoload": {

diff --git a/src/Discord/Discord.php b/src/Discord/Discord.php
@@ -15,7 +15,6 @@
 use Discord\Factory\Factory;
 use Discord\Helpers\BigInt;
 use Discord\Helpers\CacheConfig;
-use Discord\Helpers\Deferred;
 use Discord\Helpers\RegisteredCommand;
 use Discord\Http\Drivers\React;
 use Discord\Http\Endpoint;
@@ -51,7 +50,8 @@
 use React\EventLoop\Loop;
 use React\EventLoop\LoopInterface;
 use React\EventLoop\TimerInterface;
-use React\Promise\ExtendedPromiseInterface;
+use React\Promise\Deferred;
+use React\Promise\PromiseInterface;
 use React\Socket\Connector as SocketConnector;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -468,10 +468,10 @@ protected function handleReady(object $data)
         $unavailable = [];
 
         foreach ($content->guilds as $guild) {
-            /** @var ExtendedPromiseInterface */
+            /** @var PromiseInterface */
             $promise = coroutine([$event, 'handle'], $guild);
 
-            $promise->done(function ($d) use (&$unavailable) {
+            $promise->then(function ($d) use (&$unavailable) {
                 if (! empty($d->unavailable)) {
                     $unavailable[$d->id] = $d->unavailable;
                 }
@@ -497,7 +497,7 @@ protected function handleReady(object $data)
                 unset($unavailable[$guild->id]);
             }
             if (count($unavailable) < 1) {
-                $guildLoad->resolve();
+                $guildLoad->resolve(null);
             }
         };
         $this->on(Event::GUILD_CREATE, $onGuildCreate);
@@ -512,18 +512,18 @@ protected function handleReady(object $data)
                 unset($unavailable[$guild->id]);
             }
             if (count($unavailable) < 1) {
-                $guildLoad->resolve();
+                $guildLoad->resolve(null);
             }
         };
         $this->on(Event::GUILD_DELETE, $onGuildDelete);
 
-        $guildLoad->promise()->always(function () use ($onGuildCreate, $onGuildDelete) {
+        $guildLoad->promise()->finally(function () use ($onGuildCreate, $onGuildDelete) {
             $this->removeListener(Event::GUILD_CREATE, $onGuildCreate);
             $this->removeListener(Event::GUILD_DELETE, $onGuildDelete);
             $this->logger->info('all guilds are now available', ['count' => $this->guilds->count()]);
 
             $this->setupChunking();
-        })->done();
+        });
     }
 
     /**
@@ -775,7 +775,7 @@ protected function handleDispatch(object $data): void
         $handler = new $hData['class']($this);
 
         $deferred = new Deferred();
-        $deferred->promise()->done(function ($d) use ($data, $hData) {
+        $deferred->promise()->then(function ($d) use ($data, $hData) {
             if (is_array($d) && count($d) == 2) {
                 list($new, $old) = $d;
             } else {
@@ -809,14 +809,14 @@ protected function handleDispatch(object $data): void
 
         if (! $this->emittedInit && (! in_array($data->t, $parse))) {
             $this->unparsedPackets[] = function () use (&$handler, &$deferred, &$data) {
-                /** @var ExtendedPromiseInterface */
+                /** @var PromiseInterface */
                 $promise = coroutine([$handler, 'handle'], $data->d);
-                $promise->done([$deferred, 'resolve'], [$deferred, 'reject']);
+                $promise->then([$deferred, 'resolve'], [$deferred, 'reject']);
             };
         } else {
-            /** @var ExtendedPromiseInterface */
+            /** @var PromiseInterface */
             $promise = coroutine([$handler, 'handle'], $data->d);
-            $promise->done([$deferred, 'resolve'], [$deferred, 'reject']);
+            $promise->then([$deferred, 'resolve'], [$deferred, 'reject']);
         }
     }
 
@@ -1079,7 +1079,7 @@ protected function setupHeartbeat(int $interval): void
      */
     protected function connectWs(): void
     {
-        $this->setGateway()->done(function ($gateway) {
+        $this->setGateway()->then(function ($gateway) {
             if (isset($gateway['session']) && $session = $gateway['session']) {
                 if ($session['remaining'] < 2) {
                     $this->logger->error('exceeded number of reconnects allowed, waiting before attempting reconnect', $session);
@@ -1093,12 +1093,9 @@ protected function connectWs(): void
 
             $this->logger->info('starting connection to websocket', ['gateway' => $this->gateway]);
 
-            /** @var ExtendedPromiseInterface */
+            /** @var PromiseInterface */
             $promise = ($this->wsFactory)($this->gateway);
-            $promise->done(
-                [$this, 'handleWsConnection'],
-                [$this, 'handleWsConnectionFailed']
-            );
+            $promise->then([$this, 'handleWsConnection'], [$this, 'handleWsConnectionFailed']);
         });
     }
 
@@ -1233,9 +1230,9 @@ public function getVoiceClient(string $guild_id): ?VoiceClient
      * @since 10.0.0 Removed argument $check that has no effect (it is always checked)
      * @since 4.0.0
      *
-     * @return ExtendedPromiseInterface<VoiceClient>
+     * @return PromiseInterface<VoiceClient>
      */
-    public function joinVoiceChannel(Channel $channel, $mute = false, $deaf = true, ?LoggerInterface $logger = null): ExtendedPromiseInterface
+    public function joinVoiceChannel(Channel $channel, $mute = false, $deaf = true, ?LoggerInterface $logger = null, bool $check = true): PromiseInterface
     {
         $deferred = new Deferred();
 
@@ -1329,9 +1326,9 @@ public function joinVoiceChannel(Channel $channel, $mute = false, $deaf = true,
      *
      * @param string|null $gateway Gateway URL to set.
      *
-     * @return ExtendedPromiseInterface<array>
+     * @return PromiseInterface
      */
-    protected function setGateway(?string $gateway = null): ExtendedPromiseInterface
+    protected function setGateway(?string $gateway = null): PromiseInterface
     {
         $deferred = new Deferred();
         $defaultSession = [
@@ -1359,7 +1356,7 @@ protected function setGateway(?string $gateway = null): ExtendedPromiseInterface
         };
 
         if (null === $gateway) {
-            $this->http->get(Endpoint::GATEWAY_BOT)->done(function ($response) use ($buildParams) {
+            $this->http->get(Endpoint::GATEWAY_BOT)->then(function ($response) use ($buildParams) {
                 if ($response->shards > 1) {
                     $this->logger->info('Please contact the DiscordPHP devs at https://discord.gg/dphp or https://github.com/discord-php/DiscordPHP/issues if you are interested in assisting us with sharding support development.');
                 }

diff --git a/src/Discord/Helpers/Buffer.php b/src/Discord/Helpers/Buffer.php
@@ -14,7 +14,8 @@
 use Discord\Exceptions\BufferTimedOutException;
 use Evenement\EventEmitter;
 use React\EventLoop\LoopInterface;
-use React\Promise\ExtendedPromiseInterface;
+use React\Promise\Deferred;
+use React\Promise\PromiseInterface;
 use React\Stream\WritableStreamInterface;
 
 /**
@@ -106,11 +107,11 @@ private function readRaw(int $length)
      * @param null|string $format  Format to read the bytes in. See `pack()`.
      * @param int         $timeout Time in milliseconds before the read times out.
      *
-     * @return ExtendedPromiseInterface<mixed, \RuntimeException>
+     * @return PromiseInterface<mixed, \RuntimeException>
      *
      * @throws \RuntimeException When there is an error unpacking the read bytes.
      */
-    public function read(int $length, ?string $format = null, ?int $timeout = -1): ExtendedPromiseInterface
+    public function read(int $length, ?string $format = null, ?int $timeout = -1): PromiseInterface
     {
         $deferred = new Deferred();
 
@@ -152,11 +153,11 @@ public function read(int $length, ?string $format = null, ?int $timeout = -1): E
      *
      * @param int $timeout Time in milliseconds before the read times out.
      *
-     * @return ExtendedPromiseInterface<int, \RuntimeException>
+     * @return PromiseInterface<int, \RuntimeException>
      *
      * @throws \RuntimeException When there is an error unpacking the read bytes.
      */
-    public function readInt32(int $timeout = -1): ExtendedPromiseInterface
+    public function readInt32(int $timeout = -1): PromiseInterface
     {
         return $this->read(4, 'l', $timeout);
     }
@@ -166,11 +167,11 @@ public function readInt32(int $timeout = -1): ExtendedPromiseInterface
      *
      * @param int $timeout Time in milliseconds before the read times out.
      *
-     * @return ExtendedPromiseInterface<int, \RuntimeException>
+     * @return PromiseInterface<int, \RuntimeException>
      *
      * @throws \RuntimeException When there is an error unpacking the read bytes.
      */
-    public function readInt16(int $timeout = -1): ExtendedPromiseInterface
+    public function readInt16(int $timeout = -1): PromiseInterface
     {
         return $this->read(2, 'v', $timeout);
     }

diff --git a/src/Discord/Helpers/Deferred.php b/src/Discord/Helpers/Deferred.php
diff --git a/src/Discord/Helpers/ExtendedPromisorInterface.php b/src/Discord/Helpers/ExtendedPromisorInterface.php