Added better comments on the issue

Author: Nyholm

src/Api/Issue/IssueType.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Api\Issue;
+
+class IssueType
+{
+    public const BUG = 'Bug';
+    public const FEATURE = 'Feature';
+    public const UNKNOWN = 'Unknown';
+    public const RFC = 'RFC';
+}

src/Command/CloseStaleIssuesCommand.php

@@ -3,8 +3,10 @@
 namespace App\Command;
 
 use App\Api\Issue\IssueApi;
+use App\Api\Issue\IssueType;
 use App\Entity\Task;
 use App\Service\RepositoryProvider;
+use App\Service\StaleIssueCommentGenerator;
 use App\Service\TaskScheduler;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -22,13 +24,15 @@ class CloseStaleIssuesCommand extends Command
     private $repositoryProvider;
     private $issueApi;
     private $scheduler;
+    private $commentGenerator;
 
-    public function __construct(RepositoryProvider $repositoryProvider, IssueApi $issueApi, TaskScheduler $scheduler)
+    public function __construct(RepositoryProvider $repositoryProvider, IssueApi $issueApi, TaskScheduler $scheduler, StaleIssueCommentGenerator $commentGenerator)
     {
         parent::__construct();
         $this->repositoryProvider = $repositoryProvider;
         $this->issueApi = $issueApi;
         $this->scheduler = $scheduler;
+        $this->commentGenerator = $commentGenerator;
     }
 
     protected function configure()
@@ -51,21 +55,40 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $issues = $this->issueApi->findStaleIssues($repository, $notUpdatedAfter);
 
         foreach ($issues as $issue) {
-            $this->issueApi->commentOnIssue($repository, $issue['number'], <<<TXT
-Hey,
+            $comment = $this->commentGenerator->getComment($this->extractType($issue));
+            //$this->issueApi->commentOnIssue($repository, $issue['number'], $comment);
 
-Is this issue still relevant? It has not been any activity in a while. I will close this if nobody makes a comment soon.
+            // add a scheduled task to process this issue again after 2 weeks
+            //$this->scheduler->runLater($repository, $issue['number'], Task::ACTION_CLOSE_STALE, new \DateTimeImmutable('+2weeks'));
+        }
 
-Cheers!
+        return 0;
+    }
 
-Carsonbot
-TXT
-);
+    /**
+     * Extract type form issue array. Make sure we priorities labels if there are
+     * more than one type defined.
+     */
+    private function extractType(array $issue)
+    {
+        $types = [
+            IssueType::FEATURE => false,
+            IssueType::BUG => false,
+            IssueType::RFC => false,
+        ];
 
-            // add a scheduled task to process this issue again after 2 weeks
-            $this->scheduler->runLater($repository, $issue['number'], Task::ACTION_CLOSE_STALE, new \DateTimeImmutable('+2weeks'));
+        foreach ($issue['labels'] as $label) {
+            if (isset($types[$label['name']])) {
+                $types[$label['name']] = true;
+            }
         }
 
-        return 0;
+        foreach ($types as $type => $exists) {
+            if ($exists) {
+                return $type;
+            }
+        }
+
+        return IssueType::UNKNOWN;
     }
 }

src/Service/StaleIssueCommentGenerator.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Service;
+
+use App\Api\Issue\IssueType;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class StaleIssueCommentGenerator
+{
+    /**
+     * Get a comment to say: "I'm closing this now".
+     */
+    public function getClosingComment()
+    {
+        return <<<TXT
+Hey,
+
+I didn't hear anything so I'm going to close it. Feel free to comment if this is still relevant, I can always reopen!
+TXT;
+    }
+
+    /**
+     * Get a comment that encurage users to reply or close the issue themselves.
+     *
+     * @param string $type Valid types are IssueType::*
+     */
+    public function getComment(string $type): string
+    {
+        switch ($type) {
+            case IssueType::BUG:
+                return $this->bug();
+            case IssueType::FEATURE:
+            case IssueType::RFC:
+                return $this->feature();
+            case IssueType::UNKNOWN:
+                return $this->unknown();
+        }
+    }
+
+    private function bug(): string
+    {
+        return <<<TXT
+Hey,
+Is this bug still relevant? Have you managed to find a workaround?
+TXT;
+    }
+
+    private function feature(): string
+    {
+        return <<<TXT
+Thank you for this suggestion.
+Is this still something we want to do?
+TXT;
+    }
+
+    private function unknown(): string
+    {
+        return <<<TXT
+Thank you for this issue. Has this been resolved?
+TXT;
+    }
+}

src/Service/TaskHandler/CloseStaleIssuesHandler.php

@@ -8,6 +8,7 @@
 use App\Api\Label\LabelApi;
 use App\Entity\Task;
 use App\Service\RepositoryProvider;
+use App\Service\StaleIssueCommentGenerator;
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
@@ -17,12 +18,14 @@ class CloseStaleIssuesHandler implements TaskHandlerInterface
     private $issueApi;
     private $repositoryProvider;
     private $labelApi;
+    private $commentGenerator;
 
-    public function __construct(LabelApi $labelApi, IssueApi $issueApi, RepositoryProvider $repositoryProvider)
+    public function __construct(LabelApi $labelApi, IssueApi $issueApi, RepositoryProvider $repositoryProvider, StaleIssueCommentGenerator $commentGenerator)
     {
         $this->issueApi = $issueApi;
         $this->repositoryProvider = $repositoryProvider;
         $this->labelApi = $labelApi;
+        $this->commentGenerator = $commentGenerator;
     }
 
     /**
@@ -39,6 +42,7 @@ public function handle(Task $task): void
         }
 
         if ($this->issueApi->lastCommentWasMadeByBot($repository, $task->getNumber())) {
+            $this->issueApi->commentOnIssue($repository, $task->getNumber(), $this->commentGenerator->getClosingComment());
             $this->issueApi->close($repository, $task->getNumber());
         }
     }