Add label "Staled" on issues

Author: Nyholm

config/services.yaml

@@ -11,6 +11,7 @@ parameters:
                 - 'App\Subscriber\MilestoneNewPRSubscriber'
                 - 'App\Subscriber\WelcomeFirstTimeContributorSubscriber'
                 - 'App\Subscriber\CloseDraftPRSubscriber'
+                - 'App\Subscriber\RemoveStaledLabelOnCommentSubscriber'
             secret: '%env(SYMFONY_SECRET)%'
 
         symfony/symfony-docs:
@@ -23,6 +24,7 @@ parameters:
                 - 'App\Subscriber\BugLabelNewIssueSubscriber'
                 - 'App\Subscriber\AutoLabelFromContentSubscriber'
                 - 'subscriber.symfony_docs.milestone'
+                - 'App\Subscriber\RemoveStaledLabelOnCommentSubscriber'
             secret: '%env(SYMFONY_DOCS_SECRET)%'
 
         # used in a functional test
@@ -38,6 +40,7 @@ parameters:
                 - 'App\Subscriber\MilestoneNewPRSubscriber'
                 - 'App\Subscriber\WelcomeFirstTimeContributorSubscriber'
                 - 'App\Subscriber\CloseDraftPRSubscriber'
+                - 'App\Subscriber\RemoveStaledLabelOnCommentSubscriber'
 
 services:
     _defaults:

src/Command/PingStaleIssuesCommand.php

@@ -4,6 +4,7 @@
 
 use App\Api\Issue\IssueApi;
 use App\Api\Issue\IssueType;
+use App\Api\Label\LabelApi;
 use App\Entity\Task;
 use App\Service\RepositoryProvider;
 use App\Service\StaleIssueCommentGenerator;
@@ -30,14 +31,16 @@ class PingStaleIssuesCommand extends Command
     private $issueApi;
     private $scheduler;
     private $commentGenerator;
+    private $labelApi;
 
-    public function __construct(RepositoryProvider $repositoryProvider, IssueApi $issueApi, TaskScheduler $scheduler, StaleIssueCommentGenerator $commentGenerator)
+    public function __construct(RepositoryProvider $repositoryProvider, IssueApi $issueApi, TaskScheduler $scheduler, StaleIssueCommentGenerator $commentGenerator, LabelApi $labelApi)
     {
         parent::__construct();
         $this->repositoryProvider = $repositoryProvider;
         $this->issueApi = $issueApi;
         $this->scheduler = $scheduler;
         $this->commentGenerator = $commentGenerator;
+        $this->labelApi = $labelApi;
     }
 
     protected function configure()
@@ -62,6 +65,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         foreach ($issues as $issue) {
             $comment = $this->commentGenerator->getComment($this->extractType($issue));
             $this->issueApi->commentOnIssue($repository, $issue['number'], $comment);
+            $this->labelApi->addIssueLabel($issue['number'], 'Staled', $repository);
 
             // add a scheduled task to process this issue again after 2 weeks
             $this->scheduler->runLater($repository, $issue['number'], Task::ACTION_INFORM_CLOSE_STALE, new \DateTimeImmutable(self::MESSAGE_TWO_AFTER));

src/Service/TaskHandler/CloseStaleIssuesHandler.php

@@ -38,12 +38,15 @@ public function handle(Task $task): void
         }
         $labels = $this->labelApi->getIssueLabels($task->getNumber(), $repository);
         if (in_array('Keep open', $labels)) {
+            $this->labelApi->removeIssueLabel($task->getNumber(), 'Staled', $repository);
             return;
         }
 
         if ($this->issueApi->lastCommentWasMadeByBot($repository, $task->getNumber())) {
             $this->issueApi->commentOnIssue($repository, $task->getNumber(), $this->commentGenerator->getClosingComment());
             $this->issueApi->close($repository, $task->getNumber());
+        } else {
+            $this->labelApi->removeIssueLabel($task->getNumber(), 'Staled', $repository);
         }
     }
 

src/Service/TaskHandler/InformAboutClosingStaleIssuesHandler.php

@@ -42,12 +42,16 @@ public function handle(Task $task): void
         }
         $labels = $this->labelApi->getIssueLabels($task->getNumber(), $repository);
         if (in_array('Keep open', $labels)) {
+            $this->labelApi->removeIssueLabel($task->getNumber(), 'Staled', $repository);
+
             return;
         }
 
         if ($this->issueApi->lastCommentWasMadeByBot($repository, $task->getNumber())) {
             $this->issueApi->commentOnIssue($repository, $task->getNumber(), $this->commentGenerator->getInformAboutClosingComment());
             $this->scheduler->runLater($repository, $task->getNumber(), Task::ACTION_CLOSE_STALE, new \DateTimeImmutable(PingStaleIssuesCommand::MESSAGE_THREE_AND_CLOSE_AFTER));
+        } else {
+            $this->labelApi->removeIssueLabel($task->getNumber(), 'Staled', $repository);
         }
     }
 

src/Subscriber/RemoveStaledLabelOnCommentSubscriber.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace App\Subscriber;
+
+use App\Api\Label\LabelApi;
+use App\Event\GitHubEvent;
+use App\GitHubEvents;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * If somebody (not the bot) makes a comment on an issue that is stale, then remove
+ * the stale label.
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class RemoveStaledLabelOnCommentSubscriber implements EventSubscriberInterface
+{
+    private $labelApi;
+    private $botUsername;
+
+    public function __construct(LabelApi $labelApi, string $botUsername)
+    {
+        $this->labelApi = $labelApi;
+        $this->botUsername = $botUsername;
+    }
+
+    public function onIssueComment(GitHubEvent $event)
+    {
+        $data = $event->getData();
+        $repository = $event->getRepository();
+
+        // If bot, then nothing.
+        if ($data['comment']['user']['login'] === $this->botUsername) {
+            return;
+        }
+
+        $removed = false;
+        $issueNumber = $data['issue']['number'];
+        foreach ($data['issue']['labels'] as $label) {
+            if ('Staled' === $label['name']) {
+                $removed = true;
+                $this->labelApi->removeIssueLabel($issueNumber, 'Staled', $repository);
+            }
+        }
+
+        if ($removed) {
+            $event->setResponseData([
+                'issue' => $issueNumber,
+                'removed_staled_label' => true,
+            ]);
+        }
+    }
+
+    public static function getSubscribedEvents()
+    {
+        return [
+            GitHubEvents::ISSUE_COMMENT => 'onIssueComment',
+        ];
+    }
+}

tests/Subscriber/RemoveStaledLabelOnCommentSubscriberTest.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Subscriber;
+
+use App\Api\Label\NullLabelApi;
+use App\Event\GitHubEvent;
+use App\GitHubEvents;
+use App\Model\Repository;
+use App\Subscriber\RemoveStaledLabelOnCommentSubscriber;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+
+class RemoveStaledLabelOnCommentSubscriberTest extends TestCase
+{
+    private $subscriber;
+
+    private $repository;
+
+    /**
+     * @var EventDispatcher
+     */
+    private $dispatcher;
+
+    protected function setUp()
+    {
+        $this->subscriber = new RemoveStaledLabelOnCommentSubscriber(new NullLabelApi(), 'carsonbot');
+        $this->repository = new Repository('carsonbot-playground', 'symfony', null);
+
+        $this->dispatcher = new EventDispatcher();
+        $this->dispatcher->addSubscriber($this->subscriber);
+    }
+
+    public function testOnComment()
+    {
+        $event = new GitHubEvent([
+            'issue' => ['number' => 1234, 'labels' => []], 'comment' => ['user' => ['login' => 'nyholm']],
+        ], $this->repository);
+
+        $this->dispatcher->dispatch($event, GitHubEvents::ISSUE_COMMENT);
+
+        $responseData = $event->getResponseData();
+        $this->assertEmpty($responseData);
+    }
+
+    public function testOnCommentOnStale()
+    {
+        $event = new GitHubEvent([
+            'issue' => ['number' => 1234, 'labels' => [['name' => 'Foo'], ['name' => 'Staled']]], 'comment' => ['user' => ['login' => 'nyholm']],
+        ], $this->repository);
+
+        $this->dispatcher->dispatch($event, GitHubEvents::ISSUE_COMMENT);
+
+        $responseData = $event->getResponseData();
+        $this->assertCount(2, $responseData);
+        $this->assertSame(1234, $responseData['issue']);
+        $this->assertSame(true, $responseData['removed_staled_label']);
+    }
+
+    public function testOnBotCommentOnStale()
+    {
+        $event = new GitHubEvent([
+            'issue' => ['number' => 1234, 'labels' => [['name' => 'Foo'], ['name' => 'Staled']]], 'comment' => ['user' => ['login' => 'carsonbot']],
+        ], $this->repository);
+
+        $this->dispatcher->dispatch($event, GitHubEvents::ISSUE_COMMENT);
+
+        $responseData = $event->getResponseData();
+        $this->assertEmpty($responseData);
+    }
+}