Add new #[SubscriptionId] attribute to replace SubscritionUtil trait

Author: DanielBadura

infection.json.dist

@@ -16,7 +16,7 @@
   "mutators": {
     "@default": true
   },
-  "minMsi": 72,
+  "minMsi": 87,
   "minCoveredMsi": 87,
   "testFrameworkOptions": "--testsuite=unit"
 }

phpstan-baseline.neon

@@ -156,18 +156,18 @@ parameters:
 			count: 1
 			path: src/Subscription/Store/DoctrineSubscriptionStore.php
 
+		-
+			message: '#^Trait Patchlevel\\EventSourcing\\Subscription\\Subscriber\\SubscriberUtil is used zero times and is not analysed\.$#'
+			identifier: trait.unused
+			count: 1
+			path: src/Subscription/Subscriber/SubscriberUtil.php
+
 		-
 			message: '#^Cannot cast mixed to string\.$#'
 			identifier: cast.string
 			count: 3
 			path: src/Subscription/ThrowableToErrorContextTransformer.php
 
-		-
-			message: '#^Property Patchlevel\\EventSourcing\\Tests\\Benchmark\\BasicImplementation\\ProfileWithCommands\:\:\$id is never read, only written\.$#'
-			identifier: property.onlyWritten
-			count: 1
-			path: tests/Benchmark/BasicImplementation/ProfileWithCommands.php
-
 		-
 			message: '#^Cannot access offset ''name'' on array\<string, mixed\>\|false\.$#'
 			identifier: offsetAccess.nonOffsetAccessible
@@ -463,7 +463,7 @@ parameters:
 			path: tests/Unit/Message/Translator/ReplaceEventTranslatorTest.php
 
 		-
-			message: '#^Method class@anonymous/tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest\.php\:212\:\:profileVisited\(\) has parameter \$message with no type specified\.$#'
+			message: '#^Method class@anonymous/tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest\.php\:290\:\:profileVisited\(\) has parameter \$message with no type specified\.$#'
 			identifier: missingType.parameter
 			count: 1
 			path: tests/Unit/Metadata/Subscriber/AttributeSubscriberMetadataFactoryTest.php

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,
         public readonly RunMode $runMode,
         public readonly string $group = 'default',
     ) {

src/Attribute/SubscriptionId.php

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

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\SubscriptionId;
 use Patchlevel\EventSourcing\Attribute\Teardown;
 use ReflectionAttribute;
 use ReflectionClass;
@@ -17,6 +18,7 @@
 
 use function array_key_exists;
 use function count;
+use function is_string;
 
 final class AttributeSubscriberMetadataFactory implements SubscriberMetadataFactory
 {
@@ -38,6 +40,7 @@ public function metadata(string $subscriber): SubscriberMetadata
             throw new ClassIsNotASubscriber($subscriber);
         }
 
+        /** @var Subscriber $subscriberInfo */
         $subscriberInfo = $attributes[0]->newInstance();
 
         $methods = $reflector->getMethods();
@@ -109,8 +112,35 @@ public function metadata(string $subscriber): SubscriberMetadata
             throw DuplicateSubscribeMethod::mixedWithAll($subscriber);
         }
 
+        $subscriptionId = $subscriberInfo->id;
+
+        foreach ($reflector->getReflectionConstants() as $constant) {
+            if (!$constant->getAttributes(SubscriptionId::class)) {
+                continue;
+            }
+
+            $subscriptionIdValue = $constant->getValue();
+
+            if (!is_string($subscriptionIdValue)) {
+                throw new SubscriptionIdWrongType($subscriber, $subscriptionIdValue);
+            }
+
+            if ($subscriptionId !== null) {
+                throw new SubscriberHasMultipleSubscriptionIds(
+                    $subscriber,
+                    [$subscriptionId, $subscriptionIdValue],
+                );
+            }
+
+            $subscriptionId = $subscriptionIdValue;
+        }
+
+        if ($subscriptionId === null) {
+            throw new SubscriptionIdMissing($subscriber);
+        }
+
         $metadata = new SubscriberMetadata(
-            $subscriberInfo->id,
+            $subscriptionId,
             $subscriberInfo->group,
             $subscriberInfo->runMode,
             $subscribeMethods,

src/Metadata/Subscriber/SubscriberHasMultipleSubscriptionIds.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Metadata\Subscriber;
+
+use Patchlevel\EventSourcing\Metadata\MetadataException;
+
+use function implode;
+use function sprintf;
+
+final class SubscriberHasMultipleSubscriptionIds extends MetadataException
+{
+    /**
+     * @param class-string $subscriberClass
+     * @param list<string> $ids
+     */
+    public function __construct(string $subscriberClass, array $ids)
+    {
+        parent::__construct(
+            sprintf(
+                'There are multiple subscription ids (%s) defined for the subscriber "%s".',
+                $subscriberClass,
+                implode(', ', $ids),
+            ),
+        );
+    }
+}

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 $subscriberClass */
+    public function __construct(string $subscriberClass)
+    {
+        parent::__construct(
+            sprintf(
+                'There is no subscription id defined for the subscriber "%s". Define it via #[Subscriber] or #[SubscriptionId] attribute.',
+                $subscriberClass,
+            ),
+        );
+    }
+}

src/Metadata/Subscriber/SubscriptionIdWrongType.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Metadata\Subscriber;
+
+use Patchlevel\EventSourcing\Metadata\MetadataException;
+
+use function get_debug_type;
+use function sprintf;
+
+final class SubscriptionIdWrongType extends MetadataException
+{
+    /** @param class-string $subscriberClass */
+    public function __construct(string $subscriberClass, mixed $subscriptionId)
+    {
+        parent::__construct(
+            sprintf(
+                'The subscription id defined for the subscriber "%s" has a wrong type. The Id needs to be a string, "%s" given.',
+                $subscriberClass,
+                get_debug_type($subscriptionId)
+            ),
+        );
+    }
+}