Add new #[SubscriptionName] attribute to replace SubscritionUtil trait

Author: DanielBadura

src/Attribute/Processor.php

@@ -11,7 +11,7 @@
 final class Processor extends Subscriber
 {
     public function __construct(
-        string $id,
+        string|null $id = null,
         string $group = 'processor',
         RunMode $runMode = RunMode::FromNow,
     ) {

src/Attribute/Projector.php

@@ -11,7 +11,7 @@
 final class Projector extends Subscriber
 {
     public function __construct(
-        string $id,
+        string|null $id = null,
         string $group = 'projector',
         RunMode $runMode = RunMode::FromBeginning,
     ) {

src/Attribute/Subscriber.php

@@ -11,7 +11,7 @@
 class Subscriber
 {
     public function __construct(
-        public readonly string $id,
+        public readonly string|null $id = null,
         public readonly RunMode $runMode,
         public readonly string $group = 'default',
     ) {

src/Attribute/SubscriptionName.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Attribute;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_CLASS_CONSTANT)]
+final class SubscriptionName
+{
+}

src/Metadata/Subscriber/AttributeSubscriberMetadataFactory.php

@@ -9,6 +9,7 @@
 use Patchlevel\EventSourcing\Attribute\Setup;
 use Patchlevel\EventSourcing\Attribute\Subscribe;
 use Patchlevel\EventSourcing\Attribute\Subscriber;
+use Patchlevel\EventSourcing\Attribute\SubscriptionName;
 use Patchlevel\EventSourcing\Attribute\Teardown;
 use ReflectionAttribute;
 use ReflectionClass;
@@ -109,8 +110,23 @@ public function metadata(string $subscriber): SubscriberMetadata
             throw DuplicateSubscribeMethod::mixedWithAll($subscriber);
         }
 
+        $subscriptionId = $subscriberInfo->id;
+
+        if ($subscriptionId === null) {
+            foreach ($reflector->getReflectionConstants() as $constant) {
+                if ($constant->getAttributes(SubscriptionName::class)) {
+                    $subscriptionId = $constant->getValue();
+                    break;
+                }
+            }
+        }
+
+        if ($subscriptionId === null) {
+            throw new SubscriptionIdMissing($subscriber);
+        }
+
         $metadata = new SubscriberMetadata(
-            $subscriberInfo->id,
+            $subscriptionId,
             $subscriberInfo->group,
             $subscriberInfo->runMode,
             $subscribeMethods,

src/Metadata/Subscriber/SubscriptionIdMissing.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Metadata\Subscriber;
+
+use Patchlevel\EventSourcing\Metadata\MetadataException;
+
+use function sprintf;
+
+final class SubscriptionIdMissing extends MetadataException
+{
+    /** @param class-string $subscriber */
+    public function __construct(string $subscriberClass)
+    {
+        parent::__construct(
+            sprintf(
+                'There is no subscription id defined for the subscriber "%s". Define it via #[Subscriber] or #[SubscriptionName] attribute.',
+                $subscriberClass,
+            ),
+        );
+    }
+}

src/Subscription/Subscriber/SubscriberHelper.php

@@ -8,16 +8,17 @@
 use Patchlevel\EventSourcing\Attribute\Projector;
 use Patchlevel\EventSourcing\Attribute\Setup;
 use Patchlevel\EventSourcing\Attribute\Subscribe;
+use Patchlevel\EventSourcing\Attribute\SubscriptionName;
 use Patchlevel\EventSourcing\Attribute\Teardown;
 use Patchlevel\EventSourcing\Subscription\Subscriber\BatchableSubscriber;
-use Patchlevel\EventSourcing\Subscription\Subscriber\SubscriberUtil;
 use Patchlevel\EventSourcing\Tests\Benchmark\BasicImplementation\Events\NameChanged;
 use Patchlevel\EventSourcing\Tests\Benchmark\BasicImplementation\Events\ProfileCreated;
 
-#[Projector('profile')]
+#[Projector]
 final class BatchProfileProjector implements BatchableSubscriber
 {
-    use SubscriberUtil;
+    #[SubscriptionName]
+    private const TABLE_NAME = 'projection_profile';
 
     /** @var array<string, string> */
     private array $nameChanged = [];
@@ -30,20 +31,23 @@ public function __construct(
     #[Setup]
     public function create(): void
     {
-        $this->connection->executeStatement("CREATE TABLE IF NOT EXISTS {$this->table()} (id VARCHAR PRIMARY KEY, name VARCHAR);");
+        $this->connection->executeStatement(sprintf(
+            "CREATE TABLE IF NOT EXISTS %s (id VARCHAR PRIMARY KEY, name VARCHAR);",
+            self::TABLE_NAME,
+        ));
     }
 
     #[Teardown]
     public function drop(): void
     {
-        $this->connection->executeStatement("DROP TABLE IF EXISTS {$this->table()};");
+        $this->connection->executeStatement(sprintf("DROP TABLE IF EXISTS %s;", self::TABLE_NAME));
     }
 
     #[Subscribe(ProfileCreated::class)]
     public function onProfileCreated(ProfileCreated $profileCreated): void
     {
         $this->connection->insert(
-            $this->table(),
+            self::TABLE_NAME,
             [
                 'id' => $profileCreated->profileId->toString(),
                 'name' => $profileCreated->name,
@@ -73,7 +77,7 @@ public function commitBatch(): void
             $this->connection->transactional(function (): void {
                 foreach ($this->nameChanged as $profileId => $name) {
                     $this->connection->update(
-                        $this->table(),
+                        self::TABLE_NAME,
                         ['name' => $name],
                         ['id' => $profileId],
                     );

src/Subscription/Subscriber/SubscriberUtil.php

@@ -8,15 +8,16 @@
 use Patchlevel\EventSourcing\Attribute\Projector;
 use Patchlevel\EventSourcing\Attribute\Setup;
 use Patchlevel\EventSourcing\Attribute\Subscribe;
+use Patchlevel\EventSourcing\Attribute\SubscriptionName;
 use Patchlevel\EventSourcing\Attribute\Teardown;
-use Patchlevel\EventSourcing\Subscription\Subscriber\SubscriberUtil;
 use Patchlevel\EventSourcing\Tests\Benchmark\BasicImplementation\Events\NameChanged;
 use Patchlevel\EventSourcing\Tests\Benchmark\BasicImplementation\Events\ProfileCreated;
 
 #[Projector('profile')]
 final class ProfileProjector
 {
-    use SubscriberUtil;
+    #[SubscriptionName]
+    private const TABLE_NAME = 'projection_profile';
 
     public function __construct(
         private Connection $connection,
@@ -26,20 +27,23 @@ public function __construct(
     #[Setup]
     public function create(): void
     {
-        $this->connection->executeStatement("CREATE TABLE IF NOT EXISTS {$this->table()} (id VARCHAR PRIMARY KEY, name VARCHAR);");
+        $this->connection->executeStatement(sprintf(
+            "CREATE TABLE IF NOT EXISTS %s (id VARCHAR PRIMARY KEY, name VARCHAR);",
+            self::TABLE_NAME,
+        ));
     }
 
     #[Teardown]
     public function drop(): void
     {
-        $this->connection->executeStatement("DROP TABLE IF EXISTS {$this->table()};");
+        $this->connection->executeStatement(sprintf("DROP TABLE IF EXISTS %s;", self::TABLE_NAME));
     }
 
     #[Subscribe(ProfileCreated::class)]
     public function onProfileCreated(ProfileCreated $profileCreated): void
     {
         $this->connection->insert(
-            $this->table(),
+            self::TABLE_NAME,
             [
                 'id' => $profileCreated->profileId->toString(),
                 'name' => $profileCreated->name,
@@ -51,14 +55,9 @@ public function onProfileCreated(ProfileCreated $profileCreated): void
     public function onNameChanged(NameChanged $nameChanged): void
     {
         $this->connection->update(
-            $this->table(),
+            self::TABLE_NAME,
             ['name' => $nameChanged->name],
             ['id' => $nameChanged->profileId->toString()],
         );
     }
-
-    public function table(): string
-    {
-        return 'projection_' . $this->subscriberId();
-    }
 }