Merge pull request #648 from patchlevel/deprecate-subscriber-accessor…

…-interface deprecate subscriber accessor interface and remove experimantel trace feature
patchlevel · Dec 5, 2024 · 13b647a · 13b647a
2 parents a9660a0 + 3cdc4b4
commit 13b647a
Show file tree

Hide file tree

Showing 15 changed files with 54 additions and 353 deletions.
diff --git a/baseline.xml b/baseline.xml
@@ -113,6 +113,11 @@
       <code><![CDATA[$data['playhead'] === null ? null : (int)$data['playhead']]]></code>
     </ArgumentTypeCoercion>
   </file>
+  <file src="src/Subscription/Engine/DefaultSubscriptionEngine.php">
+    <DeprecatedInterface>
+      <code><![CDATA[SubscriberAccessor|null]]></code>
+    </DeprecatedInterface>
+  </file>
   <file src="src/Subscription/Store/DoctrineSubscriptionStore.php">
     <MixedArgument>
       <code><![CDATA[$context]]></code>
@@ -126,6 +131,10 @@
     </PossiblyNullPropertyFetch>
   </file>
   <file src="src/Subscription/Subscriber/MetadataSubscriberAccessor.php">
+    <DeprecatedInterface>
+      <code><![CDATA[MetadataSubscriberAccessor]]></code>
+      <code><![CDATA[MetadataSubscriberAccessor]]></code>
+    </DeprecatedInterface>
     <MixedAssignment>
       <code><![CDATA[$arguments[]]]></code>
     </MixedAssignment>
@@ -135,6 +144,12 @@
       <code><![CDATA[$methodName]]></code>
     </MixedMethodCall>
   </file>
+  <file src="src/Subscription/Subscriber/SubscriberAccessorRepository.php">
+    <DeprecatedInterface>
+      <code><![CDATA[SubscriberAccessor|null]]></code>
+      <code><![CDATA[iterable<SubscriberAccessor>]]></code>
+    </DeprecatedInterface>
+  </file>
   <file src="tests/Benchmark/PersonalDataBench.php">
     <MissingConstructor>
       <code><![CDATA[$multipleEventsId]]></code>
@@ -354,4 +369,12 @@
       <code><![CDATA[$update1]]></code>
     </PossiblyUndefinedArrayOffset>
   </file>
+  <file src="tests/Unit/Subscription/Subscriber/MetadataSubscriberAccessorTest.php">
+    <DeprecatedMethod>
+      <code><![CDATA[group]]></code>
+      <code><![CDATA[id]]></code>
+      <code><![CDATA[realSubscriber]]></code>
+      <code><![CDATA[runMode]]></code>
+    </DeprecatedMethod>
+  </file>
 </files>
diff --git a/src/Debug/Trace/Trace.php b/src/Debug/Trace/Trace.php
diff --git a/src/Debug/Trace/TraceDecorator.php b/src/Debug/Trace/TraceDecorator.php
diff --git a/src/Debug/Trace/TraceHeader.php b/src/Debug/Trace/TraceHeader.php
diff --git a/src/Debug/Trace/TraceStack.php b/src/Debug/Trace/TraceStack.php
diff --git a/src/Debug/Trace/TraceableSubscriberAccessor.php b/src/Debug/Trace/TraceableSubscriberAccessor.php
diff --git a/src/Debug/Trace/TraceableSubscriberAccessorRepository.php b/src/Debug/Trace/TraceableSubscriberAccessorRepository.php
diff --git a/src/Metadata/Message/MessageHeaderRegistry.php b/src/Metadata/Message/MessageHeaderRegistry.php
@@ -5,7 +5,6 @@
 namespace Patchlevel\EventSourcing\Metadata\Message;
 
 use Patchlevel\EventSourcing\Aggregate\AggregateHeader;
-use Patchlevel\EventSourcing\Debug\Trace\TraceHeader;
 use Patchlevel\EventSourcing\Store\ArchivedHeader;
 use Patchlevel\EventSourcing\Store\StreamHeader;
 use Patchlevel\EventSourcing\Store\StreamStartHeader;
@@ -76,7 +75,6 @@ public static function createWithInternalHeaders(array $headerNameToClassMap = [
         $internalHeaders = [
             'stream' => StreamHeader::class,
             'aggregate' => AggregateHeader::class,
-            'trace' => TraceHeader::class,
             'archived' => ArchivedHeader::class,
             'newStreamStart' => StreamStartHeader::class,
         ];

diff --git a/src/Subscription/Subscriber/MetadataSubscriberAccessor.php b/src/Subscription/Subscriber/MetadataSubscriberAccessor.php
@@ -16,29 +16,47 @@
 use function array_map;
 use function array_merge;
 
+/** @template T of object */
 final class MetadataSubscriberAccessor implements SubscriberAccessor, RealSubscriberAccessor
 {
     /** @var array<class-string, list<Closure(Message):void>> */
     private array $subscribeCache = [];
 
-    /** @param list<ArgumentResolver> $argumentResolvers */
+    /**
+     * @param T                      $subscriber
+     * @param list<ArgumentResolver> $argumentResolvers
+     */
     public function __construct(
         private readonly object $subscriber,
         private readonly SubscriberMetadata $metadata,
         private readonly array $argumentResolvers,
     ) {
     }
 
+    public function metadata(): SubscriberMetadata
+    {
+        return $this->metadata;
+    }
+
+    /** @return T */
+    public function subscriber(): object
+    {
+        return $this->subscriber;
+    }
+
+    /** @deprecated use `->metadata()->id` instead */
     public function id(): string
     {
         return $this->metadata->id;
     }
 
+    /** @deprecated use `->metadata()->group` instead */
     public function group(): string
     {
         return $this->metadata->group;
     }
 
+    /** @deprecated use `->metadata()->runMode` instead */
     public function runMode(): RunMode
     {
         return $this->metadata->runMode;
@@ -139,6 +157,11 @@ private function resolvers(string $eventClass, SubscribeMethodMetadata $method):
         return $resolvers;
     }
 
+    /**
+     * @deprecated use `->metadata()` instead
+     *
+     * @return T
+     */
     public function realSubscriber(): object
     {
         return $this->subscriber;

diff --git a/src/Subscription/Subscriber/MetadataSubscriberAccessorRepository.php b/src/Subscription/Subscriber/MetadataSubscriberAccessorRepository.php
@@ -20,7 +20,7 @@
 
 final class MetadataSubscriberAccessorRepository implements SubscriberAccessorRepository
 {
-    /** @var array<string, SubscriberAccessor> */
+    /** @var array<string, MetadataSubscriberAccessor> */
     private array $subscribersMap = [];
 
     /** @var list<ArgumentResolver> $argumentResolvers */
@@ -47,20 +47,20 @@ public function __construct(
         );
     }
 
-    /** @return iterable<SubscriberAccessor> */
+    /** @return iterable<MetadataSubscriberAccessor> */
     public function all(): iterable
     {
         return array_values($this->subscriberAccessorMap());
     }
 
-    public function get(string $id): SubscriberAccessor|null
+    public function get(string $id): MetadataSubscriberAccessor|null
     {
         $map = $this->subscriberAccessorMap();
 
         return $map[$id] ?? null;
     }
 
-    /** @return array<string, SubscriberAccessor> */
+    /** @return array<string, MetadataSubscriberAccessor> */
     private function subscriberAccessorMap(): array
     {
         if ($this->subscribersMap !== []) {