Merge pull request #438 from 27pchrisl/fix-apply-types

Added an extra rejection to prevent events being passed to invalid handlers
spatie · Sep 5, 2023 · 83a06c8 · 83a06c8
2 parents 6ba1fb0 + 503477b
commit 83a06c8
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 4 deletions.
diff --git a/src/AggregateRoots/AggregateRoot.php b/src/AggregateRoots/AggregateRoot.php
@@ -73,6 +73,7 @@ public function handleCommand(object $command): static
             ->public()
             ->protected()
             ->reject(fn (Method $method) => in_array($method->getName(), ['handleCommand', 'recordThat', 'apply', 'tap']))
+            ->reject(fn (Method $method) => $method->accepts(null))
             ->accepts($command)
             ->first()
         ) {
@@ -86,6 +87,7 @@ public function handleCommand(object $command): static
                 ->public()
                 ->protected()
                 ->reject(fn (Method $method) => in_array($method->getName(), ['recordThat', 'apply', 'tap']))
+                ->reject(fn (Method $method) => $method->accepts(null))
                 ->accepts($command)
                 ->first();
 
@@ -256,6 +258,7 @@ protected function apply(ShouldBeStored $event): void
             ->public()
             ->protected()
             ->reject(fn (Method $method) => in_array($method->getName(), ['handleCommand', 'recordThat', 'apply', 'tap']))
+            ->reject(fn (Method $method) => $method->accepts(null))
             ->accepts($event)
             ->all()
             ->each(function (Method $method) use ($event) {

diff --git a/src/EventHandlers/AppliesEvents.php b/src/EventHandlers/AppliesEvents.php
@@ -26,6 +26,7 @@ private function applyStoredEvent(StoredEvent | ShouldBeStored $event)
             ->public()
             ->protected()
             ->reject(fn (Method $method) => in_array($method->getName(), ['apply', 'recordThat']))
+            ->reject(fn (Method $method) => $method->accepts(null))
             ->accepts($event)
             ->all()
             ->each(

diff --git a/src/EventHandlers/HandlesEvents.php b/src/EventHandlers/HandlesEvents.php
@@ -16,6 +16,7 @@ public function handles(StoredEvent $storedEvent): bool
         return Handlers::new($this)
             ->public()
             ->protected()
+            ->reject(fn (Method $method) => $method->accepts(null))
             ->accepts($storedEvent->event)
             ->all()
             ->isNotEmpty();
@@ -28,6 +29,7 @@ public function handle(StoredEvent $storedEvent): void
         Handlers::new($this)
             ->public()
             ->protected()
+            ->reject(fn (Method $method) => $method->accepts(null))
             ->accepts($event)
             ->all()
             ->each(function (Method $method) use ($event) {
@@ -45,6 +47,7 @@ public function getEventHandlingMethods(): Collection
         return Handlers::new($this)
             ->public()
             ->protected()
+            ->reject(fn (Method $method) => $method->accepts(null))
             ->all()
             ->groupBy(fn (Method $method) => $method->getTypes()->first()?->getName())
             ->filter(function (Collection $group, string $key) {

diff --git a/tests/AggregateRootTest.php b/tests/AggregateRootTest.php
@@ -29,6 +29,7 @@
 use Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\Reactors\DoubleBalanceReactor;
 use Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\Reactors\SendMailReactor;
 use Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\StorableEvents\MoneyAdded;
+use Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\StorableEvents\MoneyIncremented;
 use Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\StorableEvents\MoneyMultiplied;
 use Spatie\EventSourcing\Tests\TestClasses\FakeUuid;
 use Spatie\EventSourcing\Tests\TestClasses\Models\Account;
@@ -246,6 +247,13 @@
     assertEquals(123, $aggregateRoot->balance);
 });
 
+it('should apply to aggregate root event handlers using interfaces', function () {
+    $aggregateRoot = AccountAggregateRoot::retrieve($this->aggregateUuid);
+    $aggregateRoot->recordThat(new MoneyIncremented(123));
+
+    assertEquals(123, $aggregateRoot->balance);
+});
+
 it('can persist aggregate roots in a transaction', function () {
     Mail::fake();
 

diff --git a/tests/AggregateRoots/CommandHandlerTest.php b/tests/AggregateRoots/CommandHandlerTest.php
@@ -16,7 +16,8 @@
     class AddItem
     {
         public function __construct(
-            #[AggregateUuid] public string $cartUuid,
+            #[AggregateUuid]
+            public string $cartUuid,
             public string $name
         ) {
         }
@@ -26,7 +27,8 @@ public function __construct(
     class ClearCart
     {
         public function __construct(
-            #[AggregateUuid] public string $cartUuid
+            #[AggregateUuid]
+            public string $cartUuid
         ) {
         }
     }

diff --git a/tests/Commands/CommandBusTest.php b/tests/Commands/CommandBusTest.php
@@ -22,7 +22,8 @@
     class AddItem
     {
         public function __construct(
-            #[AggregateUuid] public string $cartUuid,
+            #[AggregateUuid]
+            public string $cartUuid,
             public string $name
         ) {
         }

diff --git a/tests/TestClasses/AggregateRoots/AccountAggregateRoot.php b/tests/TestClasses/AggregateRoots/AccountAggregateRoot.php
@@ -2,8 +2,10 @@
 
 namespace Spatie\EventSourcing\Tests\TestClasses\AggregateRoots;
 
+use Exception;
 use Spatie\EventSourcing\AggregateRoots\AggregateRoot;
 use Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\StorableEvents\MoneyAdded;
+use Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\StorableEvents\MoneyAddedInterface;
 use Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\StorableEvents\MoneyMultiplied;
 
 class AccountAggregateRoot extends AggregateRoot
@@ -38,7 +40,7 @@ public function multiplyMoney(int $amount): self
         return $this;
     }
 
-    protected function applyMoneyAdded(MoneyAdded $event)
+    protected function applyMoneyAdded(MoneyAdded|MoneyAddedInterface $event)
     {
         $this->balance += $event->amount;
     }
@@ -47,4 +49,14 @@ public function applyMoneyMultiplied(MoneyMultiplied $event)
     {
         $this->balance = $this->math->multiply($this->balance, $event->amount);
     }
+
+    public function mixedMethod($param): void
+    {
+        throw new Exception("Method should not be called by apply()");
+    }
+
+    public function variadicMethod(...$param): void
+    {
+        throw new Exception("Method should not be called by apply()");
+    }
 }
diff --git a/tests/TestClasses/AggregateRoots/StorableEvents/MoneyAddedInterface.php b/tests/TestClasses/AggregateRoots/StorableEvents/MoneyAddedInterface.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\StorableEvents;
+
+interface MoneyAddedInterface
+{
+}
diff --git a/tests/TestClasses/AggregateRoots/StorableEvents/MoneyIncremented.php b/tests/TestClasses/AggregateRoots/StorableEvents/MoneyIncremented.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Spatie\EventSourcing\Tests\TestClasses\AggregateRoots\StorableEvents;
+
+use Spatie\EventSourcing\StoredEvents\ShouldBeStored;
+
+class MoneyIncremented extends ShouldBeStored implements MoneyAddedInterface
+{
+    public int $amount;
+
+    public function __construct(int $amount)
+    {
+        $this->amount = $amount;
+    }
+}