minor #121 Added more logs (Nyholm)

This PR was merged into the master branch.

Discussion
----------

Added more logs

There are some issues when adding labels to the PRs. I need even more logs to figure out what is wrong.

See symfony/symfony#39072

Commits
-------

7f9bd97 Added more logs

Author: weaverryan

src/Api/Label/GithubLabelApi.php

@@ -5,6 +5,7 @@
 use App\Model\Repository;
 use Github\Api\Issue\Labels;
 use Github\Exception\RuntimeException;
+use Psr\Log\LoggerInterface;
 use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\Cache\ItemInterface;
 
@@ -30,10 +31,16 @@ class GithubLabelApi implements LabelApi
      */
     private $cache;
 
-    public function __construct(Labels $labelsApi, CacheInterface $cache)
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    public function __construct(Labels $labelsApi, CacheInterface $cache, LoggerInterface $logger)
     {
         $this->labelsApi = $labelsApi;
         $this->cache = $cache;
+        $this->logger = $logger;
     }
 
     public function getIssueLabels($issueNumber, Repository $repository): array
@@ -54,7 +61,10 @@ public function getIssueLabels($issueNumber, Repository $repository): array
             }
         }
 
-        return array_keys($this->labelCache[$key]);
+        $labels = array_keys($this->labelCache[$key]);
+        $this->logger->debug('Returning labels for {repo}#{issue}', ['repo' => $repository->getFullName(), 'issue' => $issueNumber]);
+
+        return $labels;
     }
 
     public function addIssueLabel($issueNumber, string $label, Repository $repository)
@@ -65,12 +75,8 @@ public function addIssueLabel($issueNumber, string $label, Repository $repositor
             return;
         }
 
-        $this->labelsApi->add(
-            $repository->getVendor(),
-            $repository->getName(),
-            $issueNumber,
-            $label
-        );
+        $this->logger->debug('Adding label "{label}" for {repo}#{issue}', ['label' => $label, 'repo' => $repository->getFullName(), 'issue' => $issueNumber]);
+        $this->labelsApi->add($repository->getVendor(), $repository->getName(), $issueNumber, $label);
 
         // Update cache if already loaded
         if (isset($this->labelCache[$key])) {

src/Service/LabelNameExtractor.php

@@ -4,6 +4,7 @@
 
 use App\Api\Label\LabelApi;
 use App\Model\Repository;
+use Psr\Log\LoggerInterface;
 
 /**
  * Extract label name from a PR/Issue.
@@ -13,6 +14,7 @@
 class LabelNameExtractor
 {
     private $labelsApi;
+    private $logger;
 
     private static $labelAliases = [
         'bridge\doctrine' => 'DoctrineBridge',
@@ -33,9 +35,10 @@ class LabelNameExtractor
         'wdt' => 'WebProfilerBundle',
     ];
 
-    public function __construct(LabelApi $labelsApi)
+    public function __construct(LabelApi $labelsApi, LoggerInterface $logger)
     {
         $this->labelsApi = $labelsApi;
+        $this->logger = $logger;
     }
 
     /**
@@ -57,6 +60,8 @@ public function extractLabels($title, Repository $repository)
             }
         }
 
+        $this->logger->debug('Searched for labels in title', ['title' => $title, 'labels' => json_encode($labels)]);
+
         return $labels;
     }
 

tests/Api/Label/GithubLabelApiTest.php

@@ -7,6 +7,7 @@
 use Github\Api\Issue\Labels;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\NullLogger;
 use Symfony\Component\Cache\Adapter\NullAdapter;
 
 /**
@@ -35,7 +36,7 @@ protected function setUp()
         $this->backendApi = $this->getMockBuilder(Labels::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $this->api = new GithubLabelApi($this->backendApi, new NullAdapter());
+        $this->api = new GithubLabelApi($this->backendApi, new NullAdapter(), new NullLogger());
         $this->repository = new Repository(
             self::USER_NAME,
             self::REPO_NAME,

tests/Service/LabelNameExtractorTest.php

@@ -5,19 +5,15 @@
 use App\Api\Label\StaticLabelApi;
 use App\Model\Repository;
 use App\Service\LabelNameExtractor;
-use Github\Api\Issue\Labels;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Cache\Adapter\NullAdapter;
+use Psr\Log\NullLogger;
 
 class LabelNameExtractorTest extends TestCase
 {
     public function testExtractLabels()
     {
-        $backendApi = $this->getMockBuilder(Labels::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $api = new StaticLabelApi($backendApi, new NullAdapter());
-        $extractor = new LabelNameExtractor($api);
+        $api = new StaticLabelApi();
+        $extractor = new LabelNameExtractor($api, new NullLogger());
         $repo = new Repository('carson-playground', 'symfony');
 
         $this->assertSame(['Messenger'], $extractor->extractLabels('[Messenger] Foobar', $repo));

tests/Subscriber/AutoLabelFromContentSubscriberTest.php

@@ -9,6 +9,7 @@
 use App\Service\LabelNameExtractor;
 use App\Subscriber\AutoLabelFromContentSubscriber;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\NullLogger;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 
 class AutoLabelFromContentSubscriberTest extends TestCase
@@ -30,7 +31,7 @@ protected function setUp()
             ->disableOriginalConstructor()
             ->setMethods(['addIssueLabels'])
             ->getMock();
-        $this->autoLabelSubscriber = new AutoLabelFromContentSubscriber($this->labelsApi, new LabelNameExtractor($this->labelsApi));
+        $this->autoLabelSubscriber = new AutoLabelFromContentSubscriber($this->labelsApi, new LabelNameExtractor($this->labelsApi, new NullLogger()));
         $this->repository = new Repository('weaverryan', 'symfony', null);
 
         $this->dispatcher = new EventDispatcher();

tests/Subscriber/AutoUpdateTitleWithLabelSubscriberTest.php

@@ -8,10 +8,9 @@
 use App\Model\Repository;
 use App\Service\LabelNameExtractor;
 use App\Subscriber\AutoUpdateTitleWithLabelSubscriber;
-use Github\Api\Issue\Labels;
 use Github\Api\PullRequest;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Cache\Adapter\NullAdapter;
+use Psr\Log\NullLogger;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 
 class AutoUpdateTitleWithLabelSubscriberTest extends TestCase
@@ -26,16 +25,13 @@ class AutoUpdateTitleWithLabelSubscriberTest extends TestCase
 
     protected function setUp()
     {
-        $backendApi = $this->getMockBuilder(Labels::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $labelsApi = new StaticLabelApi($backendApi, new NullAdapter());
+        $labelsApi = new StaticLabelApi();
         $this->pullRequestApi = $this->getMockBuilder(PullRequest::class)
             ->disableOriginalConstructor()
             ->setMethods(['update'])
             ->getMock();
 
-        $this->subscriber = new AutoUpdateTitleWithLabelSubscriber($labelsApi, new LabelNameExtractor($labelsApi), $this->pullRequestApi);
+        $this->subscriber = new AutoUpdateTitleWithLabelSubscriber($labelsApi, new LabelNameExtractor($labelsApi, new NullLogger()), $this->pullRequestApi);
         $this->repository = new Repository('carsonbot-playground', 'symfony', null);
 
         $this->dispatcher = new EventDispatcher();