Register with the loop

Author: mbabker

docs/periodic-manager.md

@@ -10,13 +10,9 @@ Periodic managers are initialized during the `BabDev\WebSocketBundle\Event\Befor
 
 A manager must provide a unique name, these names are used in conjunction with the `BabDev\WebSocketBundle\PeriodicManager\PeriodicManagerRegistry`
 
-### `setLoop()`
-
-When managers are registered, they will be provided the event loop that is being used for the server process.
-
 ### `register()`
 
-The `register()` method is used to initialize the periodic manager.
+The `register()` method is used to initialize the periodic manager using the provided event loop.
 
 ### `cancelTimers()`
 
@@ -29,7 +25,6 @@ The `cancelTimers()` method is called during the `BabDev\WebSocketBundle\Event\A
 
 namespace App\WebSocket\PeriodicManager;
 
-use BabDev\WebSocketBundle\Exception\MissingLoop;
 use BabDev\WebSocketBundle\PeriodicManager\PeriodicManager;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
@@ -46,33 +41,19 @@ final class EchoPeriodicManager implements PeriodicManager, LoggerAwareInterface
         return 'echo'
     }
 
-    public function setLoop(LoopInterface $loop): void
+    public function register(LoopInterface $loop): void
     {
         $this->loop = $loop;
-    }
 
-    public function register(): void
-    {
         // Wrap the entire loop in try/catch to prevent fatal errors crashing the websocket server
         try {
-            if (null === $this->loop) {
-                throw new MissingLoop(sprintf('The event loop has not been registered in %s', self::class));
-            }
-
             // Register the timer to run every 15 seconds
             $this->loop->addPeriodicTimer(
                 15,
                 static function (): void {
                     echo 'This is a demo';
                 },
             );
-        } catch (MissingLoopException $exception) {
-            $this->logger->error(
-                $exception->getMessage(),
-                [
-                    'exception' => $exception,
-                ],
-            );
         } catch (\Throwable $exception) {
             $this->logger->error(
                 'Uncaught Throwable in the echo manager.',

src/EventListener/PeriodicManagerSubscriber.php

@@ -31,11 +31,8 @@ public function onAfterServerClosed(AfterServerClosed $event): void
 
     public function onBeforeRunServer(BeforeRunServer $event): void
     {
-        $loop = $event->loop;
-
         foreach ($this->registry->getManagers() as $manager) {
-            $manager->setLoop($loop);
-            $manager->register();
+            $manager->register($event->loop);
         }
     }
 }

src/Exception/MissingLoop.php

@@ -2,19 +2,13 @@
 
 namespace BabDev\WebSocketBundle\PeriodicManager;
 
-use BabDev\WebSocketBundle\Exception\MissingLoop;
 use React\EventLoop\LoopInterface;
 
 interface PeriodicManager
 {
     public function getName(): string;
 
-    /**
-     * @throws MissingLoop if called before setting the event loop
-     */
-    public function register(): void;
+    public function register(LoopInterface $loop): void;
 
     public function cancelTimers(): void;
-
-    public function setLoop(LoopInterface $loop): void;
 }

src/PeriodicManager/PeriodicManager.php

@@ -2,7 +2,6 @@
 
 namespace BabDev\WebSocketBundle\PeriodicManager;
 
-use BabDev\WebSocketBundle\Exception\MissingLoop;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception as DBALException;
 use Psr\Log\LoggerAwareInterface;
@@ -30,22 +29,18 @@ public function getName(): string
         return 'ping_doctrine_dbal_connections';
     }
 
-    public function register(): void
+    public function register(LoopInterface $loop): void
     {
+        $this->loop = $loop;
+
         // Wrap the entire loop in try/catch to prevent fatal errors crashing the websocket server
         try {
             $this->logger?->info('Registering ping doctrine/dbal connections manager.');
 
-            if (!$this->loop instanceof LoopInterface) {
-                throw new MissingLoop(sprintf('The event loop has not been registered in %s', self::class));
-            }
-
             $this->timer = $this->loop->addPeriodicTimer(
                 $this->interval,
                 $this->pingConnections(...),
             );
-        } catch (MissingLoop $exception) {
-            $this->logger?->error($exception->getMessage(), ['exception' => $exception]);
         } catch (\Throwable $exception) {
             $this->logger?->error('Uncaught Throwable in the ping doctrine/dbal connections loop.', ['exception' => $exception]);
         }
@@ -56,11 +51,6 @@ public function cancelTimers(): void
         $this->reset();
     }
 
-    public function setLoop(LoopInterface $loop): void
-    {
-        $this->loop = $loop;
-    }
-
     /**
      * @internal
      */

src/PeriodicManager/PingDoctrineDBALConnectionsPeriodicManager.php

@@ -57,12 +57,9 @@ public function testInitializesPeriodicManagers(): void
         /** @var MockObject&PeriodicManager $manager */
         $manager = $this->createMock(PeriodicManager::class);
         $manager->expects(self::once())
-            ->method('setLoop')
+            ->method('register')
             ->with($loop);
 
-        $manager->expects(self::once())
-            ->method('register');
-
         $this->registry->method('getManagers')
             ->willReturn(['test' => $manager]);
 

tests/EventListener/PeriodicManagerSubscriberTest.php

@@ -43,13 +43,6 @@ protected function tearDown(): void
         parent::tearDown();
     }
 
-    public function testTheManagerIsNotRegisteredWhenTheLoopIsMissing(): void
-    {
-        $this->manager->register();
-
-        self::assertTrue($this->logger->hasErrorThatContains(sprintf('The event loop has not been registered in %s', PingDoctrineDBALConnectionsPeriodicManager::class)));
-    }
-
     public function testTheManagerIsRegistered(): void
     {
         /** @var MockObject&LoopInterface $loop */
@@ -59,8 +52,7 @@ public function testTheManagerIsRegistered(): void
             ->method('addPeriodicTimer')
             ->willReturn($this->createMock(TimerInterface::class));
 
-        $this->manager->setLoop($loop);
-        $this->manager->register();
+        $this->manager->register($loop);
     }
 
     public function testTheManagerPingsAllConnections(): void