Handle dropped connections georgeboot#9

Author: georgeboot

src/ConnectionRepository.php

@@ -3,13 +3,16 @@
 namespace Georgeboot\LaravelEchoApiGateway;
 
 use Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient;
+use Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException;
 
 class ConnectionRepository
 {
     protected ApiGatewayManagementApiClient $apiGatewayManagementApiClient;
 
-    public function __construct(array $config)
-    {
+    public function __construct(
+        protected SubscriptionRepository $subscriptionRepository,
+        array $config
+    ) {
         $this->apiGatewayManagementApiClient = new ApiGatewayManagementApiClient(array_merge($config['connection'], [
             'version' => '2018-11-29',
             'endpoint' => "https://{$config['api']['id']}.execute-api.{$config['connection']['region']}.amazonaws.com/{$config['api']['stage']}/",
@@ -18,9 +21,20 @@ public function __construct(array $config)
 
     public function sendMessage(string $connectionId, string $data): void
     {
-        $this->apiGatewayManagementApiClient->postToConnection([
-            'ConnectionId' => $connectionId,
-            'Data' => $data,
-        ]);
+        try {
+            $this->apiGatewayManagementApiClient->postToConnection([
+                'ConnectionId' => $connectionId,
+                'Data' => $data,
+            ]);
+        } catch (ApiGatewayManagementApiException $e) {
+            // handle gone connections
+            if ($e->getAwsErrorCode() === 'GoneException') {
+                $this->subscriptionRepository->clearConnection($connectionId);
+
+                return;
+            }
+
+            throw $e;
+        }
     }
 }

src/Handler.php

@@ -11,11 +11,10 @@
 
 class Handler extends WebsocketHandler
 {
-    protected SubscriptionRepository $subscriptionRepository;
-    protected ConnectionRepository $connectionRepository;
-
-    public function __construct(SubscriptionRepository $subscriptionRepository, ConnectionRepository $connectionRepository)
-    {
+    public function __construct(
+        protected SubscriptionRepository $subscriptionRepository,
+        protected ConnectionRepository $connectionRepository
+    ) {
         $this->subscriptionRepository = $subscriptionRepository;
         $this->connectionRepository = $connectionRepository;
     }

src/ServiceProvider.php

@@ -12,7 +12,8 @@ class ServiceProvider extends LaravelServiceProvider
     public function register()
     {
         $this->mergeConfigFrom(
-            __DIR__ . '/../config/laravel-echo-api-gateway.php', 'laravel-echo-api-gateway'
+            __DIR__ . '/../config/laravel-echo-api-gateway.php',
+            'laravel-echo-api-gateway'
         );
 
         Config::set('broadcasting.connections.laravel-echo-api-gateway', [
@@ -21,8 +22,10 @@ public function register()
 
         $config = config('laravel-echo-api-gateway');
 
-        $this->app->bind(ConnectionRepository::class, fn () => new ConnectionRepository($config));
-        $this->app->bind(SubscriptionRepository::class, fn () => new SubscriptionRepository($config));
+        $subscriptionRepository = new SubscriptionRepository($config);
+
+        $this->app->bind(SubscriptionRepository::class, fn () => $subscriptionRepository);
+        $this->app->bind(ConnectionRepository::class, fn () => new ConnectionRepository($subscriptionRepository, $config));
     }
 
     public function boot(BroadcastManager $broadcastManager): void

tests/HandlerTest.php

@@ -1,10 +1,16 @@
 <?php
 
+use Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException;
+use Aws\CommandInterface;
+use Aws\Exception\AwsException;
+use Aws\MockHandler;
+use Aws\Result;
 use Bref\Context\Context;
 use Georgeboot\LaravelEchoApiGateway\ConnectionRepository;
 use Georgeboot\LaravelEchoApiGateway\Handler;
 use Georgeboot\LaravelEchoApiGateway\SubscriptionRepository;
 use Mockery\Mock;
+use Psr\Http\Message\RequestInterface;
 
 it('can subscribe to open channels', function () {
     app()->instance(SubscriptionRepository::class, Mockery::mock(SubscriptionRepository::class, function ($mock) {
@@ -71,3 +77,26 @@
         'body' => json_encode(['event' => 'unsubscribe', 'data' => ['channel' => 'test-channel']]),
     ], $context);
 });
+
+it('handles dropped connections', function () {
+    $mock = new MockHandler();
+
+    $mock->append(function (CommandInterface $cmd, RequestInterface $req) {
+        return new  ApiGatewayManagementApiException('', $cmd, ['code' => 'GoneException']);
+    });
+
+    /** @var SubscriptionRepository */
+    $subscriptionRepository = Mockery::mock(SubscriptionRepository::class, function ($mock) {
+        /** @var Mock $mock */
+        $mock->shouldReceive('clearConnection')->withArgs(function (string $connectionId): bool {
+            return $connectionId === 'dropped-connection-id-1234';
+        })->once();
+    });
+
+    $config = config('laravel-echo-api-gateway');
+
+    /** @var ConnectionRepository */
+    $connectionRepository = new ConnectionRepository($subscriptionRepository, array_merge_recursive(['connection' => ['handler' => $mock]], $config));
+
+    $connectionRepository->sendMessage('dropped-connection-id-1234', 'test-message');
+});