adding more logging - tracking down a production bug!

Author: weaverryan

app/config/github.yml

@@ -4,6 +4,7 @@ services:
         class: AppBundle\Subscriber\StatusChangeByCommentSubscriber
         arguments:
             - '@app.status_api'
+            - '@logger'
 
     app.subscriber.needs_review_new_pr_subscriber:
         class: AppBundle\Subscriber\NeedsReviewNewPRSubscriber

app/config/services.yml

@@ -28,7 +28,7 @@ services:
 
     app.status_api:
         class: AppBundle\Issues\GitHub\GitHubStatusApi
-        arguments: ['@app.github.cached_labels_api']
+        arguments: ['@app.github.cached_labels_api', '@logger']
 
     app.github.request_handler:
         class: AppBundle\Issues\GitHubRequestHandler

src/AppBundle/Issues/GitHub/GitHubStatusApi.php

@@ -5,6 +5,7 @@
 use AppBundle\Issues\Status;
 use AppBundle\Issues\StatusApi;
 use AppBundle\Repository\Repository;
+use Psr\Log\LoggerInterface;
 
 class GitHubStatusApi implements StatusApi
 {
@@ -21,11 +22,16 @@ class GitHubStatusApi implements StatusApi
      * @var CachedLabelsApi
      */
     private $labelsApi;
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
 
-    public function __construct(CachedLabelsApi $labelsApi)
+    public function __construct(CachedLabelsApi $labelsApi, LoggerInterface $logger)
     {
         $this->labelsApi = $labelsApi;
         $this->labelToStatus = array_flip(self::$statusToLabel);
+        $this->logger = $logger;
     }
 
     /**
@@ -59,6 +65,12 @@ public function setIssueStatus($issueNumber, $newStatus, Repository $repository)
             }
 
             // Remove other statuses
+            $this->logger->debug(sprintf(
+                'Removing label %s from issue %s on repository %s',
+                $label,
+                $issueNumber,
+                $repository->getFullName()
+            ));
             $this->labelsApi->removeIssueLabel($issueNumber, $label, $repository);
         }
 

src/AppBundle/Issues/GitHubRequestHandler.php

@@ -76,7 +76,7 @@ public function handle(Request $request)
         try {
             $this->dispatcher->dispatch('github.'.$eventName, $event);
         } catch (\Exception $e) {
-            throw new \RuntimeException(sprintf('Failed dispatching "%s" event for "%s" repository.', $eventName, $repository->getName()), 0, $e);
+            throw new \RuntimeException(sprintf('Failed dispatching "%s" event for "%s" repository.', $eventName, $repository->getFullName()), 0, $e);
         }
 
         $responseData = $event->getResponseData();

src/AppBundle/Repository/Repository.php

@@ -79,4 +79,9 @@ public function getNeedsReviewUrl()
             rawurlencode(GitHubStatusApi::getNeedsReviewLabel())
         );
     }
+
+    public function getFullName()
+    {
+        return sprintf('%s/%s', $this->getVendor(), $this->getName());
+    }
 }

src/AppBundle/Subscriber/StatusChangeByCommentSubscriber.php

@@ -6,6 +6,7 @@
 use AppBundle\GitHubEvents;
 use AppBundle\Issues\Status;
 use AppBundle\Issues\StatusApi;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class StatusChangeByCommentSubscriber implements EventSubscriberInterface
@@ -18,10 +19,12 @@ class StatusChangeByCommentSubscriber implements EventSubscriberInterface
     ];
 
     private $statusApi;
+    private $logger;
 
-    public function __construct(StatusApi $statusApi)
+    public function __construct(StatusApi $statusApi, LoggerInterface $logger)
     {
         $this->statusApi = $statusApi;
+        $this->logger = $logger;
     }
 
     /**
@@ -47,6 +50,7 @@ public function onIssueComment(GitHubEvent $event)
             // Second subpattern = first status character
             $newStatus = static::$triggerWordToStatus[strtolower(end($matches[1]))];
 
+            $this->logger->debug(sprintf('Setting issue number %s to status %s', $issueNumber, $newStatus));
             $this->statusApi->setIssueStatus($issueNumber, $newStatus, $repository);
         }
 

src/AppBundle/Tests/Issues/GitHub/GitHubStatusApiTest.php

@@ -36,7 +36,10 @@ protected function setUp()
         $this->labelsApi = $this->getMockBuilder('AppBundle\Issues\GitHub\CachedLabelsApi')
             ->disableOriginalConstructor()
             ->getMock();
-        $this->api = new GitHubStatusApi($this->labelsApi);
+        $logger = $this->getMockBuilder('Psr\Log\LoggerInterface')
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->api = new GitHubStatusApi($this->labelsApi, $logger);
         $this->repository = new Repository(
             self::USER_NAME,
             self::REPO_NAME,

src/AppBundle/Tests/Subscriber/StatusChangeByCommentSubscriberTest.php

@@ -30,7 +30,8 @@ public static function setUpBeforeClass()
     protected function setUp()
     {
         $this->statusApi = $this->getMock('AppBundle\Issues\StatusApi');
-        $this->statusChangeSubscriber = new StatusChangeByCommentSubscriber($this->statusApi);
+        $logger = $this->getMock('Psr\Log\LoggerInterface');
+        $this->statusChangeSubscriber = new StatusChangeByCommentSubscriber($this->statusApi, $logger);
         $this->repository = new Repository('weaverryan', 'symfony', [], null);
 
         self::$dispatcher->addSubscriber($this->statusChangeSubscriber);