Do not overshadow errors thrown by DescribeLogGroups. (#68)

If DescribeLogGroups throws an error (e.g. AccessDeniedException), the retry logic will still call DescribeLogStreams, which will also fail, either with AccessDeniedException, or, more confusingly, with "The specified log group does not exist." if the log group has never been created. This change makes sure that the original error is thrown.
maxbanton · Sep 11, 2019 · f53e83e · f53e83e
1 parent b7fee45
commit f53e83e
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 6 deletions.
diff --git a/src/Handler/CloudWatch.php b/src/Handler/CloudWatch.php
@@ -168,6 +168,10 @@ private function addToBuffer(array $record)
     private function flushBuffer()
     {
         if (!empty($this->buffer)) {
+            if (false === $this->initialized) {
+                $this->initialize();
+            }
+
             // send items, retry once with a fresh sequence token
             try {
                 $this->send($this->buffer);
@@ -254,10 +258,6 @@ private function formatRecords(array $entry)
      */
     private function send(array $entries)
     {
-        if (false === $this->initialized) {
-            $this->initialize();
-        }
-
         $data = [
             'logGroupName' => $this->group,
             'logStreamName' => $this->stream,
@@ -317,8 +317,6 @@ function ($group) {
         }
 
         $this->refreshSequenceToken();
-
-        $this->initialized = true;
     }
 
     private function refreshSequenceToken()

diff --git a/tests/Handler/CloudWatchTest.php b/tests/Handler/CloudWatchTest.php
@@ -4,6 +4,7 @@
 
 
 use Aws\CloudWatchLogs\CloudWatchLogsClient;
+use Aws\CloudWatchLogs\Exception\CloudWatchLogsException;
 use Aws\Result;
 use Maxbanton\Cwh\Handler\CloudWatch;
 use Monolog\Formatter\LineFormatter;
@@ -301,6 +302,32 @@ public function testFormatter()
         $this->assertEquals($expected, $formatter);
     }
 
+    public function testExceptionFromDescribeLogGroups()
+    {
+        // e.g. 'User is not authorized to perform logs:DescribeLogGroups'
+        $awsException = $this->getMockBuilder(CloudWatchLogsException::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        // if this fails ...
+        $this
+            ->clientMock
+            ->expects($this->atLeastOnce())
+            ->method('describeLogGroups')
+            ->will($this->throwException($awsException));
+
+        // ... this should not be called:
+        $this
+            ->clientMock
+            ->expects($this->never())
+            ->method('describeLogStreams');
+
+        $this->expectException(CloudWatchLogsException::class);
+
+        $handler = $this->getCUT(0);
+        $handler->handle($this->getRecord(Logger::INFO));
+    }
+
     private function prepareMocks()
     {
         $logGroupsResult = new Result(['logGroups' => [['logGroupName' => $this->groupName]]]);