refactor: create custom exception for when a handler receives a wrong event type

carlalexander · carlalexander · commit f9e983c53239 · 2026-02-07T10:52:22.000-05:00
diff --git a/src/Exception/InvalidHandlerEventException.php b/src/Exception/InvalidHandlerEventException.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Ymir PHP Runtime.
+ *
+ * (c) Carl Alexander <support@ymirapp.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ymir\Runtime\Exception;
+
+use Ymir\Runtime\Lambda\Handler\LambdaEventHandlerInterface;
+use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;
+
+/**
+ * Exception thrown when a handler receives an event it cannot handle.
+ */
+class InvalidHandlerEventException extends \InvalidArgumentException implements ExceptionInterface
+{
+    /**
+     * Constructor.
+     */
+    public function __construct(LambdaEventHandlerInterface $handler, InvocationEventInterface $event)
+    {
+        parent::__construct(sprintf('%s cannot handle %s event', (new \ReflectionClass($handler))->getShortName(), (new \ReflectionClass($event))->getShortName()));
+    }
+}
diff --git a/src/Lambda/Handler/ConsoleCommandLambdaEventHandler.php b/src/Lambda/Handler/ConsoleCommandLambdaEventHandler.php
@@ -14,6 +14,7 @@
 namespace Ymir\Runtime\Lambda\Handler;
 
 use Symfony\Component\Process\Process;
+use Ymir\Runtime\Exception\InvalidHandlerEventException;
 use Ymir\Runtime\Lambda\InvocationEvent\ConsoleCommandEvent;
 use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;
 use Ymir\Runtime\Lambda\Response\ProcessResponse;
@@ -54,7 +55,7 @@ public function canHandle(InvocationEventInterface $event): bool
     public function handle(InvocationEventInterface $event): ResponseInterface
     {
         if (!$event instanceof ConsoleCommandEvent) {
-            throw new \InvalidArgumentException('ConsoleCommandLambdaEventHandler can only handle ConsoleCommandEvent objects');
+            throw new InvalidHandlerEventException($this, $event);
         }
 
         $process = Process::fromShellCommandline("{$event->getCommand()} 2>&1");
diff --git a/src/Lambda/Handler/Http/AbstractHttpRequestEventHandler.php b/src/Lambda/Handler/Http/AbstractHttpRequestEventHandler.php
@@ -13,6 +13,7 @@
 
 namespace Ymir\Runtime\Lambda\Handler\Http;
 
+use Ymir\Runtime\Exception\InvalidHandlerEventException;
 use Ymir\Runtime\Lambda\Handler\LambdaEventHandlerInterface;
 use Ymir\Runtime\Lambda\InvocationEvent\HttpRequestEvent;
 use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;
@@ -55,7 +56,7 @@ public function canHandle(InvocationEventInterface $event): bool
     public function handle(InvocationEventInterface $event): ResponseInterface
     {
         if (!$event instanceof HttpRequestEvent || !$this->canHandle($event)) {
-            throw new \InvalidArgumentException(sprintf('%s cannot handle the given invocation event object', (new \ReflectionClass(static::class))->getShortName()));
+            throw new InvalidHandlerEventException($this, $event);
         }
 
         $filePath = $this->getEventFilePath($event);
diff --git a/src/Lambda/Handler/PingLambdaEventHandler.php b/src/Lambda/Handler/PingLambdaEventHandler.php
@@ -13,6 +13,7 @@
 
 namespace Ymir\Runtime\Lambda\Handler;
 
+use Ymir\Runtime\Exception\InvalidHandlerEventException;
 use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;
 use Ymir\Runtime\Lambda\InvocationEvent\PingEvent;
 use Ymir\Runtime\Lambda\Response\Http\HttpResponse;
@@ -37,7 +38,7 @@ public function canHandle(InvocationEventInterface $event): bool
     public function handle(InvocationEventInterface $event): ResponseInterface
     {
         if (!$event instanceof PingEvent) {
-            throw new \InvalidArgumentException('PingLambdaEventHandler can only handle PingEvent objects');
+            throw new InvalidHandlerEventException($this, $event);
         }
 
         usleep(50 * 1000);
diff --git a/src/Lambda/Handler/Sqs/AbstractSqsHandler.php b/src/Lambda/Handler/Sqs/AbstractSqsHandler.php
@@ -13,6 +13,7 @@
 
 namespace Ymir\Runtime\Lambda\Handler\Sqs;
 
+use Ymir\Runtime\Exception\InvalidHandlerEventException;
 use Ymir\Runtime\Lambda\Handler\LambdaEventHandlerInterface;
 use Ymir\Runtime\Lambda\InvocationEvent\InvocationContext;
 use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;
@@ -56,7 +57,7 @@ public function canHandle(InvocationEventInterface $event): bool
     public function handle(InvocationEventInterface $event): ResponseInterface
     {
         if (!$event instanceof SqsEvent || !$this->canHandle($event)) {
-            throw new \InvalidArgumentException(sprintf('%s cannot handle the given invocation event object', (new \ReflectionClass(static::class))->getShortName()));
+            throw new InvalidHandlerEventException($this, $event);
         }
 
         $failedRecords = [];
diff --git a/src/Lambda/Handler/WarmUpEventHandler.php b/src/Lambda/Handler/WarmUpEventHandler.php
@@ -15,6 +15,7 @@
 
 use AsyncAws\Lambda\LambdaClient;
 use Ymir\Runtime\Exception\InvalidConfigurationException;
+use Ymir\Runtime\Exception\InvalidHandlerEventException;
 use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;
 use Ymir\Runtime\Lambda\InvocationEvent\WarmUpEvent;
 use Ymir\Runtime\Lambda\Response\Http\HttpResponse;
@@ -63,7 +64,7 @@ public function canHandle(InvocationEventInterface $event): bool
     public function handle(InvocationEventInterface $event): ResponseInterface
     {
         if (!$event instanceof WarmUpEvent) {
-            throw new \InvalidArgumentException('WarmUpEventHandler can only handle WarmUpEvent objects');
+            throw new InvalidHandlerEventException($this, $event);
         }
 
         $concurrency = $event->getConcurrency();
diff --git a/tests/Unit/Lambda/Handler/ConsoleCommandLambdaEventHandlerTest.php b/tests/Unit/Lambda/Handler/ConsoleCommandLambdaEventHandlerTest.php
@@ -14,6 +14,7 @@
 namespace Ymir\Runtime\Tests\Unit\Lambda\Handler;
 
 use PHPUnit\Framework\TestCase;
+use Ymir\Runtime\Exception\InvalidHandlerEventException;
 use Ymir\Runtime\Lambda\Handler\ConsoleCommandLambdaEventHandler;
 use Ymir\Runtime\Lambda\Response\ProcessResponse;
 use Ymir\Runtime\Tests\Mock\ConsoleCommandEventMockTrait;
@@ -139,8 +140,8 @@ public function testHandleWithUnsuccessfulCommand(): void
 
     public function testHandleWithWrongEventType(): void
     {
-        $this->expectException(\InvalidArgumentException::class);
-        $this->expectExceptionMessage('ConsoleCommandLambdaEventHandler can only handle ConsoleCommandEvent objects');
+        $this->expectException(InvalidHandlerEventException::class);
+        $this->expectExceptionMessageMatches('/ConsoleCommandLambdaEventHandler cannot handle Mock_InvocationEventInterface[^\s]* event/');
 
         (new ConsoleCommandLambdaEventHandler($this->getLoggerMock()))->handle($this->getInvocationEventInterfaceMock());
     }
diff --git a/tests/Unit/Lambda/Handler/Http/AbstractHttpRequestEventHandlerTest.php b/tests/Unit/Lambda/Handler/Http/AbstractHttpRequestEventHandlerTest.php
@@ -14,6 +14,7 @@
 namespace Ymir\Runtime\Tests\Unit\Lambda\Handler\Http;
 
 use PHPUnit\Framework\TestCase;
+use Ymir\Runtime\Exception\InvalidHandlerEventException;
 use Ymir\Runtime\Lambda\Handler\Http\AbstractHttpRequestEventHandler;
 use Ymir\Runtime\Lambda\Response\Http\StaticFileHttpResponse;
 use Ymir\Runtime\Tests\Mock\HttpRequestEventMockTrait;
@@ -78,8 +79,8 @@ public function testHandleReturnsStaticFileHttpResponse(): void
 
     public function testHandleWithWrongEventType(): void
     {
-        $this->expectException(\InvalidArgumentException::class);
-        $this->expectExceptionMessageMatches('/[^\s]* cannot handle the given invocation event object/');
+        $this->expectException(InvalidHandlerEventException::class);
+        $this->expectExceptionMessageMatches('/[^\s]* cannot handle Mock_InvocationEventInterface[^\s]* event/');
 
         $handler = $this->getMockForAbstractClass(AbstractHttpRequestEventHandler::class, ['/']);
 
diff --git a/tests/Unit/Lambda/Handler/PingLambdaEventHandlerTest.php b/tests/Unit/Lambda/Handler/PingLambdaEventHandlerTest.php
@@ -14,6 +14,7 @@
 namespace Ymir\Runtime\Tests\Unit\Lambda\Handler;
 
 use PHPUnit\Framework\TestCase;
+use Ymir\Runtime\Exception\InvalidHandlerEventException;
 use Ymir\Runtime\Lambda\Handler\PingLambdaEventHandler;
 use Ymir\Runtime\Lambda\Response\Http\HttpResponse;
 use Ymir\Runtime\Tests\Mock\InvocationEventInterfaceMockTrait;
@@ -47,8 +48,8 @@ public function testHandleWithPingEvent(): void
 
     public function testHandleWithWrongEventType(): void
     {
-        $this->expectException(\InvalidArgumentException::class);
-        $this->expectExceptionMessage('PingLambdaEventHandler can only handle PingEvent objects');
+        $this->expectException(InvalidHandlerEventException::class);
+        $this->expectExceptionMessageMatches('/PingLambdaEventHandler cannot handle Mock_InvocationEventInterface[^\s]* event/');
 
         $handler = new PingLambdaEventHandler();
 
diff --git a/tests/Unit/Lambda/Handler/WarmUpEventHandlerTest.php b/tests/Unit/Lambda/Handler/WarmUpEventHandlerTest.php
@@ -15,6 +15,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Ymir\Runtime\Exception\InvalidConfigurationException;
+use Ymir\Runtime\Exception\InvalidHandlerEventException;
 use Ymir\Runtime\Lambda\Handler\WarmUpEventHandler;
 use Ymir\Runtime\Lambda\Response\Http\HttpResponse;
 use Ymir\Runtime\Tests\Mock\FunctionMockTrait;
@@ -124,8 +125,8 @@ public function testHandleWithNoEnvironmentVariable(): void
 
     public function testHandleWithWrongEventType(): void
     {
-        $this->expectException(\InvalidArgumentException::class);
-        $this->expectExceptionMessage('WarmUpEventHandler can only handle WarmUpEvent objects');
+        $this->expectException(InvalidHandlerEventException::class);
+        $this->expectExceptionMessageMatches('/WarmUpEventHandler cannot handle Mock_InvocationEventInterface[^\s]* event/');
 
         (new WarmUpEventHandler($this->getLambdaClientMock(), $this->getLoggerMock()))->handle($this->getInvocationEventInterfaceMock());
     }

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`namespace Ymir\Runtime\Lambda\Handler;`
`15`	`15`
`16`	`16`	`use Symfony\Component\Process\Process;`
	`17`	`+use Ymir\Runtime\Exception\InvalidHandlerEventException;`
`17`	`18`	`use Ymir\Runtime\Lambda\InvocationEvent\ConsoleCommandEvent;`
`18`	`19`	`use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;`
`19`	`20`	`use Ymir\Runtime\Lambda\Response\ProcessResponse;`
`@@ -54,7 +55,7 @@ public function canHandle(InvocationEventInterface $event): bool`
`54`	`55`	`public function handle(InvocationEventInterface $event): ResponseInterface`
`55`	`56`	`{`
`56`	`57`	`if (!$event instanceof ConsoleCommandEvent) {`
`57`		`- throw new \InvalidArgumentException('ConsoleCommandLambdaEventHandler can only handle ConsoleCommandEvent objects');`
	`58`	`+ throw new InvalidHandlerEventException($this, $event);`
`58`	`59`	`}`
`59`	`60`
`60`	`61`	`$process = Process::fromShellCommandline("{$event->getCommand()} 2>&1");`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`namespace Ymir\Runtime\Lambda\Handler\Http;`
`15`	`15`
	`16`	`+use Ymir\Runtime\Exception\InvalidHandlerEventException;`
`16`	`17`	`use Ymir\Runtime\Lambda\Handler\LambdaEventHandlerInterface;`
`17`	`18`	`use Ymir\Runtime\Lambda\InvocationEvent\HttpRequestEvent;`
`18`	`19`	`use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;`
`@@ -55,7 +56,7 @@ public function canHandle(InvocationEventInterface $event): bool`
`55`	`56`	`public function handle(InvocationEventInterface $event): ResponseInterface`
`56`	`57`	`{`
`57`	`58`	`if (!$event instanceof HttpRequestEvent \|\| !$this->canHandle($event)) {`
`58`		`- throw new \InvalidArgumentException(sprintf('%s cannot handle the given invocation event object', (new \ReflectionClass(static::class))->getShortName()));`
	`59`	`+ throw new InvalidHandlerEventException($this, $event);`
`59`	`60`	`}`
`60`	`61`
`61`	`62`	`$filePath = $this->getEventFilePath($event);`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`
`16`	`16`	`use AsyncAws\Lambda\LambdaClient;`
`17`	`17`	`use Ymir\Runtime\Exception\InvalidConfigurationException;`
	`18`	`+use Ymir\Runtime\Exception\InvalidHandlerEventException;`
`18`	`19`	`use Ymir\Runtime\Lambda\InvocationEvent\InvocationEventInterface;`
`19`	`20`	`use Ymir\Runtime\Lambda\InvocationEvent\WarmUpEvent;`
`20`	`21`	`use Ymir\Runtime\Lambda\Response\Http\HttpResponse;`
`@@ -63,7 +64,7 @@ public function canHandle(InvocationEventInterface $event): bool`
`63`	`64`	`public function handle(InvocationEventInterface $event): ResponseInterface`
`64`	`65`	`{`
`65`	`66`	`if (!$event instanceof WarmUpEvent) {`
`66`		`- throw new \InvalidArgumentException('WarmUpEventHandler can only handle WarmUpEvent objects');`
	`67`	`+ throw new InvalidHandlerEventException($this, $event);`
`67`	`68`	`}`
`68`	`69`
`69`	`70`	`$concurrency = $event->getConcurrency();`