add more logging to the failed acknowledge/enqueue exceptions (#47)

* add more logging to the failed acknowledge/reject/whatever exceptions

* camelCase

Author: Harry Bragg

src/Adapter/SqsAdapter.php

@@ -86,7 +86,7 @@ public function __construct(SqsClient $client, $name, array $options = [])
     public function acknowledge(array $messages)
     {
         $url = $this->getQueueUrl();
-        $failed = [];
+        $errors = [];
         $batches = array_chunk($this->createDeleteEntries($messages), self::BATCHSIZE_DELETE);
 
         foreach ($batches as $batch) {
@@ -95,15 +95,15 @@ public function acknowledge(array $messages)
                 'Entries'  => $batch,
             ]);
 
-            $map = function ($result) use ($messages) {
-                return $messages[$result['Id']];
-            };
-
-            $failed = array_merge($failed, array_map($map, $results->get('Failed') ?: []));
+            $errors = array_merge($errors, $results->get('Failed') ?: []);
         }
+        $map = function ($result) use ($messages) {
+            return $messages[$result['Id']];
+        };
+        $failed = array_map($map, $errors);
 
         if (!empty($failed)) {
-            throw new FailedAcknowledgementException($this, $failed);
+            throw new FailedAcknowledgementException($this, $failed, $errors);
         }
     }
 
@@ -115,7 +115,7 @@ public function acknowledge(array $messages)
     public function reject(array $messages)
     {
         $url = $this->getQueueUrl();
-        $failed = [];
+        $errors = [];
         $batches = array_chunk($this->createRejectEntries($messages), self::BATCHSIZE_DELETE);
 
         foreach ($batches as $batch) {
@@ -124,15 +124,15 @@ public function reject(array $messages)
                 'Entries'  => $batch,
             ]);
 
-            $map = function ($result) use ($messages) {
-                return $messages[$result['Id']];
-            };
-
-            $failed = array_merge($failed, array_map($map, $results->get('Failed') ?: []));
+            $errors = array_merge($errors, $results->get('Failed') ?: []);
         }
+        $map = function ($result) use ($messages) {
+            return $messages[$result['Id']];
+        };
+        $failed = array_map($map, $errors);
 
         if (!empty($failed)) {
-            throw new FailedAcknowledgementException($this, $failed);
+            throw new FailedAcknowledgementException($this, $failed, $errors);
         }
     }
 
@@ -193,7 +193,7 @@ public function dequeue(MessageFactoryInterface $factory, $limit)
     public function enqueue(array $messages)
     {
         $url = $this->getQueueUrl();
-        $failed = [];
+        $errors = [];
         $batches = array_chunk($this->createEnqueueEntries($messages), self::BATCHSIZE_SEND);
 
         foreach ($batches as $batch) {
@@ -202,15 +202,15 @@ public function enqueue(array $messages)
                 'Entries'  => $batch,
             ]);
 
-            $map = function ($result) use ($messages) {
-                return $messages[$result['Id']];
-            };
-
-            $failed = array_merge($failed, array_map($map, $results->get('Failed') ?: []));
+            $errors = array_merge($errors, $results->get('Failed') ?: []);
         }
+        $map = function ($result) use ($messages) {
+            return $messages[$result['Id']];
+        };
+        $failed = array_map($map, $errors);
 
         if (!empty($failed)) {
-            throw new FailedEnqueueException($this, $failed);
+            throw new FailedEnqueueException($this, $failed, $errors);
         }
     }
 

tests/unit/Adapter/SqsAdapterTest.php

@@ -18,6 +18,7 @@
 use Aws\ResultInterface;
 use Aws\Sqs\SqsClient;
 use Graze\DataStructure\Container\ContainerInterface;
+use Graze\Queue\Adapter\Exception\FailedAcknowledgementException;
 use Graze\Queue\Message\MessageFactoryInterface;
 use Graze\Queue\Message\MessageInterface;
 use Mockery as m;
@@ -138,6 +139,43 @@ public function testAcknowledge()
         $adapter->acknowledge($this->messages);
     }
 
+    public function testFailureToAcknowledgeForSomeMessages()
+    {
+        $adapter = new SqsAdapter($this->client, 'foo');
+        $url = $this->stubCreateQueue('foo');
+
+        $this->messageA->shouldReceive('getMetadata->get')->once()->with('ReceiptHandle')->andReturn('foo');
+        $this->messageB->shouldReceive('getMetadata->get')->once()->with('ReceiptHandle')->andReturn('bar');
+        $this->messageC->shouldReceive('getMetadata->get')->once()->with('ReceiptHandle')->andReturn('baz');
+
+        $this->model->shouldReceive('get')->once()->with('Failed')->andReturn([
+            ['Id' => 2, 'Code' => 123, 'SenderFault' => true, 'Message' => 'baz is gone'],
+        ]);
+
+        $this->client->shouldReceive('deleteMessageBatch')->once()->with([
+            'QueueUrl' => $url,
+            'Entries'  => [
+                ['Id' => 0, 'ReceiptHandle' => 'foo'],
+                ['Id' => 1, 'ReceiptHandle' => 'bar'],
+                ['Id' => 2, 'ReceiptHandle' => 'baz'],
+            ],
+        ])->andReturn($this->model);
+
+        $errorThrown = false;
+        try {
+            $adapter->acknowledge($this->messages);
+        } catch (FailedAcknowledgementException $e) {
+            assertThat($e->getMessages(), is(anArray([$this->messageC])));
+            assertThat(
+                $e->getDebug(),
+                is(anArray([['Id' => 2, 'Code' => 123, 'SenderFault' => true, 'Message' => 'baz is gone']]))
+            );
+            $errorThrown = true;
+        }
+
+        assertThat('an exception is thrown', $errorThrown);
+    }
+
     public function testReject()
     {
         $adapter = new SqsAdapter($this->client, 'foo');