refactor: create custom exception for sqs errors

Author: carlalexander

src/Exception/SqsRecordProcessingException.php

@@ -0,0 +1,34 @@
+<?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;
+
+/**
+ * Exception thrown when an SQS record fails to be processed.
+ */
+class SqsRecordProcessingException extends \RuntimeException implements ExceptionInterface
+{
+    /**
+     * Constructor.
+     */
+    public function __construct(string $message, string $error = '')
+    {
+        $fullMessage = $message;
+
+        if (!empty($error)) {
+            $fullMessage .= sprintf(': %s', $error);
+        }
+
+        parent::__construct($fullMessage);
+    }
+}

src/Lambda/Handler/Sqs/LaravelSqsHandler.php

@@ -14,6 +14,7 @@
 namespace Ymir\Runtime\Lambda\Handler\Sqs;
 
 use Symfony\Component\Process\Process;
+use Ymir\Runtime\Exception\SqsRecordProcessingException;
 use Ymir\Runtime\Lambda\InvocationEvent\InvocationContext;
 use Ymir\Runtime\Lambda\InvocationEvent\SqsRecord;
 use Ymir\Runtime\Logger;
@@ -45,7 +46,7 @@ protected function processRecord(InvocationContext $context, SqsRecord $record):
         $message = json_encode($record);
 
         if (empty($message) || JSON_ERROR_NONE !== json_last_error()) {
-            throw new \RuntimeException(sprintf('Failed to encode SQS message [%s]: %s', $record->getMessageId(), json_last_error_msg()));
+            throw new SqsRecordProcessingException(sprintf('Failed to encode SQS message [%s]', $record->getMessageId()), json_last_error_msg());
         }
 
         $arguments = [
@@ -68,7 +69,7 @@ protected function processRecord(InvocationContext $context, SqsRecord $record):
         $process->run();
 
         if (!$process->isSuccessful()) {
-            throw new \RuntimeException(sprintf('Laravel queue job failed: %s', $process->getErrorOutput()));
+            throw new SqsRecordProcessingException('Laravel queue job failed', $process->getErrorOutput());
         }
     }
 

tests/Unit/Lambda/Handler/Sqs/LaravelSqsHandlerTest.php

@@ -43,16 +43,6 @@ protected function tearDown(): void
         $this->filesystem->remove($this->tempDir);
     }
 
-    public function testHandleThrowsExceptionForWrongEvent(): void
-    {
-        $this->expectException(InvalidHandlerEventException::class);
-        $this->expectExceptionMessageMatches('/LaravelSqsHandler cannot handle Mock_InvocationEventInterface[^\s]* event/');
-
-        $handler = new LaravelSqsHandler($this->getLoggerMock(), $this->tempDir);
-
-        $handler->handle($this->getInvocationEventInterfaceMock());
-    }
-
     public function testCanHandleReturnsFalseForWrongEvent(): void
     {
         $handler = new LaravelSqsHandler($this->getLoggerMock(), '/tmp');
@@ -80,7 +70,8 @@ public function testHandleCollectsFailuresIfProcessFails(): void
 
         $logger = $this->getLoggerMock();
         $logger->expects($this->once())
-               ->method('error');
+               ->method('error')
+               ->with($this->stringContains('Processing SQS message [id1] failed: Laravel queue job failed'));
 
         $handler = new LaravelSqsHandler($logger, '/tmp');
         $response = $handler->handle($event);
@@ -102,7 +93,8 @@ public function testHandleCollectsFailuresOnJsonError(): void
 
         $logger = $this->getLoggerMock();
         $logger->expects($this->once())
-               ->method('error');
+               ->method('error')
+               ->with($this->stringContains('Processing SQS message [id1] failed: Failed to encode SQS message [id1]'));
 
         $handler = new LaravelSqsHandler($logger, '/tmp');
         $response = $handler->handle($event);
@@ -114,6 +106,16 @@ public function testHandleCollectsFailuresOnJsonError(): void
         ], $response->getResponseData());
     }
 
+    public function testHandleThrowsExceptionForWrongEvent(): void
+    {
+        $this->expectException(InvalidHandlerEventException::class);
+        $this->expectExceptionMessageMatches('/LaravelSqsHandler cannot handle Mock_InvocationEventInterface[^\s]* event/');
+
+        $handler = new LaravelSqsHandler($this->getLoggerMock(), $this->tempDir);
+
+        $handler->handle($this->getInvocationEventInterfaceMock());
+    }
+
     public function testHandleUsesEnvironmentVariables(): void
     {
         $_ENV['YMIR_QUEUE_CONNECTION'] = 'custom_connection';