rename classes, add more tests & improve dbal cleanup task handler

Author: DavidBadura

docs/pages/subscription.md

@@ -1026,9 +1026,9 @@ The handler must implement the `CleanupHandler` interface.
 
 ```php
 use MongoDb\Database;
-use Patchlevel\EventSourcing\Subscription\Cleanup\CleanupHandler;
+use Patchlevel\EventSourcing\Subscription\Cleanup\CleanupTaskHandler;
 
-final class MongodbCleanupHandler implements CleanupHandler
+final class MongodbCleanupTaskHandler implements CleanupTaskHandler
 {
     public function __construct(
         private readonly Database $database,
@@ -1054,11 +1054,12 @@ Lastly, we have to add the new handler to `DefaultCleaner`,
 which is responsible for cleaning up subscriptions.
 
 ```php
+use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DbalCleanupTaskHandler;
 use Patchlevel\EventSourcing\Subscription\Cleanup\DefaultCleaner;
 
 $cleaner = new DefaultCleaner([
-    new DbalCleanupHandler($projectionConnection),
-    new MongodbCleanupHandler($mongodbDatabase),
+    new DbalCleanupTaskHandler($projectionConnection),
+    new MongodbCleanupTaskHandler($mongodbDatabase),
 ]);
 ```
 !!! warning
@@ -1093,7 +1094,7 @@ Finally, if we want to use the cleanup feature, we need to pass the cleanup hand
 
 ```php
 use Doctrine\DBAL\Connection;
-use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DbalCleanupHandler;
+use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DbalCleanupTaskHandler;
 use Patchlevel\EventSourcing\Subscription\Cleanup\DefaultCleaner;
 use Patchlevel\EventSourcing\Subscription\Engine\DefaultSubscriptionEngine;
 use Patchlevel\EventSourcing\Subscription\Engine\MessageLoader;
@@ -1115,7 +1116,7 @@ $subscriptionEngine = new DefaultSubscriptionEngine(
     $subscriberAccessorRepository,
     $retryStrategyRepository, // optional, if not set the default retry strategy is used
     $logger, // optional
-    new DefaultCleaner([new DbalCleanupHandler($projectionConnection)]), // optional but required if you want to use the cleanup feature
+    new DefaultCleaner([new DbalCleanupTaskHandler($projectionConnection)]), // optional but required if you want to use the cleanup feature
 );
 ```
 ### Catch up Subscription Engine

…/Subscription/Cleanup/CleanupHandler.php …scription/Cleanup/CleanupTaskHandler.phpsrc/Subscription/Cleanup/CleanupHandler.php renamed to src/Subscription/Cleanup/CleanupTaskHandler.php src/Subscription/Cleanup/CleanupHandler.php renamed to src/Subscription/Cleanup/CleanupTaskHandler.php

@@ -4,7 +4,7 @@
 
 namespace Patchlevel\EventSourcing\Subscription\Cleanup;
 
-interface CleanupHandler
+interface CleanupTaskHandler
 {
     public function __invoke(object $task): void;
 

src/Subscription/Cleanup/CleanupTaskNotSupported.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Subscription\Cleanup;
+
+use RuntimeException;
+
+use function sprintf;
+
+final class CleanupTaskNotSupported extends RuntimeException
+{
+    /** @param class-string<CleanupTaskHandler> $handler */
+    public function __construct(
+        object $task,
+        string $handler,
+    ) {
+        parent::__construct(
+            sprintf('Task "%s" is not supported by handler "%s"', $task::class, $handler),
+        );
+    }
+}

src/Subscription/Cleanup/Dbal/DbalCleanupHandler.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Subscription\Cleanup\Dbal;
+
+use Doctrine\DBAL\Connection;
+use Patchlevel\EventSourcing\Subscription\Cleanup\CleanupTaskHandler;
+use Patchlevel\EventSourcing\Subscription\Cleanup\CleanupTaskNotSupported;
+
+final class DbalCleanupTaskHandler implements CleanupTaskHandler
+{
+    public function __construct(
+        private readonly Connection $connection,
+    ) {
+    }
+
+    public function __invoke(object $task): void
+    {
+        if ($task instanceof DropTableTask) {
+            $this->connection->createSchemaManager()->dropTable($task->table);
+
+            return;
+        }
+
+        if ($task instanceof DropIndexTask) {
+            $this->connection->createSchemaManager()->dropIndex($task->index, $task->table);
+
+            return;
+        }
+
+        throw new CleanupTaskNotSupported($task, self::class);
+    }
+
+    public function supports(object $task): bool
+    {
+        return $task instanceof DropTableTask || $task instanceof DropIndexTask;
+    }
+}

src/Subscription/Cleanup/Dbal/DbalCleanupTaskHandler.php

@@ -9,7 +9,7 @@
 
 final class DefaultCleaner implements Cleaner
 {
-    /** @param iterable<CleanupHandler> $handlers */
+    /** @param iterable<CleanupTaskHandler> $handlers */
     public function __construct(
         private readonly iterable $handlers = [],
     ) {

src/Subscription/Cleanup/DefaultCleaner.php

@@ -21,7 +21,7 @@
 use Patchlevel\EventSourcing\Serializer\DefaultEventSerializer;
 use Patchlevel\EventSourcing\Store\DoctrineDbalStore;
 use Patchlevel\EventSourcing\Store\StreamDoctrineDbalStore;
-use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DbalCleanupHandler;
+use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DbalCleanupTaskHandler;
 use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DropTableTask;
 use Patchlevel\EventSourcing\Subscription\Cleanup\DefaultCleaner;
 use Patchlevel\EventSourcing\Subscription\Engine\CatchUpSubscriptionEngine;
@@ -1186,7 +1186,7 @@ public function testCleanup(): void
         // Test Setup
 
         $cleaner = new DefaultCleaner([
-            new DbalCleanupHandler(
+            new DbalCleanupTaskHandler(
                 $this->projectionConnection,
             ),
         ]);

tests/Integration/Subscription/SubscriptionTest.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Tests\Unit\Subscription\Cleanup\Dbal;
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Schema\AbstractSchemaManager;
+use Patchlevel\EventSourcing\Subscription\Cleanup\CleanupTaskNotSupported;
+use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DbalCleanupTaskHandler;
+use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DropIndexTask;
+use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DropTableTask;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use stdClass;
+
+#[CoversClass(DbalCleanupTaskHandler::class)]
+final class DbalCleanupTaskHandlerTest extends TestCase
+{
+    public function testNoSupport(): void
+    {
+        $handler = new DbalCleanupTaskHandler(
+            $this->createMock(Connection::class),
+        );
+
+        self::assertFalse($handler->supports(new stdClass()));
+    }
+
+    public function testSupports(): void
+    {
+        $handler = new DbalCleanupTaskHandler(
+            $this->createMock(Connection::class),
+        );
+
+        self::assertTrue($handler->supports(new DropTableTask('test')));
+        self::assertTrue($handler->supports(new DropIndexTask('test', 'test')));
+    }
+
+    public function testHandleNoSupportedTask(): void
+    {
+        $handler = new DbalCleanupTaskHandler(
+            $this->createMock(Connection::class),
+        );
+
+        $this->expectException(CleanupTaskNotSupported::class);
+
+        $handler(new stdClass());
+    }
+
+    public function testHandleDropTable(): void
+    {
+        $schemaManager = $this->createMock(AbstractSchemaManager::class);
+        $schemaManager->expects($this->once())->method('dropTable')->with('test');
+
+        $connection = $this->createMock(Connection::class);
+        $connection
+            ->expects($this->once())
+            ->method('createSchemaManager')
+            ->willReturn($schemaManager);
+
+        $handler = new DbalCleanupTaskHandler($connection);
+
+        $handler(new DropTableTask('test'));
+    }
+
+    public function testHandleDropIndex(): void
+    {
+        $schemaManager = $this->createMock(AbstractSchemaManager::class);
+        $schemaManager->expects($this->once())->method('dropIndex')->with('foo', 'bar');
+
+        $connection = $this->createMock(Connection::class);
+        $connection
+            ->expects($this->once())
+            ->method('createSchemaManager')
+            ->willReturn($schemaManager);
+
+        $handler = new DbalCleanupTaskHandler($connection);
+
+        $handler(new DropIndexTask('foo', 'bar'));
+    }
+}

tests/Unit/Subscription/Cleanup/Dbal/DbalCleanupTaskHandlerTest.php

@@ -4,7 +4,7 @@
 
 namespace Patchlevel\EventSourcing\Tests\Unit\Subscription\Cleanup;
 
-use Patchlevel\EventSourcing\Subscription\Cleanup\CleanupHandler;
+use Patchlevel\EventSourcing\Subscription\Cleanup\CleanupTaskHandler;
 use Patchlevel\EventSourcing\Subscription\Cleanup\Dbal\DropTableTask;
 use Patchlevel\EventSourcing\Subscription\Cleanup\DefaultCleaner;
 use Patchlevel\EventSourcing\Subscription\Cleanup\NoHandlerForCleanupTask;
@@ -18,7 +18,7 @@ final class DefaultCleanerTest extends TestCase
 {
     public function testClean(): void
     {
-        $handler = new class implements CleanupHandler {
+        $handler = new class implements CleanupTaskHandler {
             public bool $called = false;
 
             public function __invoke(object $task): void
@@ -42,7 +42,7 @@ public function supports(object $task): bool
 
     public function testCleanupFailed(): void
     {
-        $handler = new class implements CleanupHandler {
+        $handler = new class implements CleanupTaskHandler {
             public function __invoke(object $task): void
             {
                 throw new RuntimeException('Failed to cleanup');
@@ -64,7 +64,7 @@ public function supports(object $task): bool
 
     public function testNoTasks(): void
     {
-        $handler = new class implements CleanupHandler {
+        $handler = new class implements CleanupTaskHandler {
             public bool $called = false;
 
             public function __invoke(object $task): void