feature #108 Comment on draft PRs, close them after 60 minutes. (Nyholm)

This PR was merged into the master branch.

Discussion
----------

Comment on draft PRs, close them after 60 minutes.

If someone open a draft PR, we should ask them to "mark it ready for review". If they dont, we will close the PR.

This PR will also fix #70. Ie, dont add labels on PRs in "draft".

Commits
-------

610b80c Close draft PRs

Author: weaverryan

config/services.yaml

@@ -10,6 +10,7 @@ parameters:
                 - 'App\Subscriber\AutoLabelFromContentSubscriber'
                 - 'App\Subscriber\MilestoneNewPRSubscriber'
                 - 'App\Subscriber\WelcomeFirstTimeContributorSubscriber'
+                - 'App\Subscriber\CloseDraftPRSubscriber'
             secret: '%env(SYMFONY_SECRET)%'
 
         symfony/symfony-docs:
@@ -36,6 +37,7 @@ parameters:
                 - 'App\Subscriber\AutoLabelFromContentSubscriber'
                 - 'App\Subscriber\MilestoneNewPRSubscriber'
                 - 'App\Subscriber\WelcomeFirstTimeContributorSubscriber'
+                - 'App\Subscriber\CloseDraftPRSubscriber'
 
 services:
     _defaults:

src/Api/Issue/GithubIssueApi.php

@@ -44,6 +44,11 @@ public function open(Repository $repository, string $title, string $body, array
         }
     }
 
+    public function show(Repository $repository, $issueNumber): array
+    {
+        return $this->issueApi->show($repository->getVendor(), $repository->getName(), $issueNumber);
+    }
+
     public function close(Repository $repository, $issueNumber)
     {
         $this->issueApi->update($repository->getVendor(), $repository->getName(), $issueNumber, ['state' => 'closed']);

src/Api/Issue/IssueApi.php

@@ -17,6 +17,8 @@ interface IssueApi
      */
     public function open(Repository $repository, string $title, string $body, array $labels);
 
+    public function show(Repository $repository, $issueNumber): array;
+
     public function commentOnIssue(Repository $repository, $issueNumber, string $commentBody);
 
     /**

src/Api/Issue/NullIssueApi.php

@@ -10,6 +10,11 @@ public function open(Repository $repository, string $title, string $body, array
     {
     }
 
+    public function show(Repository $repository, $issueNumber): array
+    {
+        return [];
+    }
+
     public function commentOnIssue(Repository $repository, $issueNumber, string $commentBody)
     {
     }

src/Service/TaskHandler/CloseDraftHandler.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Service\TaskHandler;
+
+use App\Api\Issue\IssueApi;
+use App\Api\PullRequest\PullRequestApi;
+use App\Entity\Task;
+use App\Service\RepositoryProvider;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class CloseDraftHandler implements TaskHandlerInterface
+{
+    private $issueApi;
+    private $repositoryProvider;
+    private $pullRequestApi;
+
+    public function __construct(PullRequestApi $pullRequestApi, IssueApi $issueApi, RepositoryProvider $repositoryProvider)
+    {
+        $this->issueApi = $issueApi;
+        $this->repositoryProvider = $repositoryProvider;
+        $this->pullRequestApi = $pullRequestApi;
+    }
+
+    public function handle(Task $task): void
+    {
+        $repository = $this->repositoryProvider->getRepository($task->getRepositoryFullName());
+        $pr = $this->pullRequestApi->show($repository, $task->getNumber());
+
+        if ($pr['draft'] ?? false) {
+            $this->issueApi->close($repository, $task->getNumber());
+        }
+    }
+
+    public function supports(Task $task): bool
+    {
+        return Task::ACTION_CLOSE_DRAFT === $task->getAction();
+    }
+}

src/Subscriber/AutoLabelFromContentSubscriber.php

@@ -26,9 +26,10 @@ public function __construct(LabelApi $labelsApi, LabelNameExtractor $labelExtrac
     public function onPullRequest(GitHubEvent $event)
     {
         $data = $event->getData();
-        if ('opened' !== $action = $data['action']) {
+        if (!in_array($data['action'], ['opened', 'ready_for_review']) || ($data['pull_request']['draft'] ?? false)) {
             return;
         }
+
         $repository = $event->getRepository();
 
         $prNumber = $data['pull_request']['number'];

src/Subscriber/CloseDraftPRSubscriber.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace App\Subscriber;
+
+use App\Api\Issue\IssueApi;
+use App\Entity\Task;
+use App\Event\GitHubEvent;
+use App\GitHubEvents;
+use App\Service\ComplementGenerator;
+use App\Service\TaskScheduler;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class CloseDraftPRSubscriber implements EventSubscriberInterface
+{
+    private $issueApi;
+    private $complementGenerator;
+    private $scheduler;
+
+    public function __construct(IssueApi $issueApi, ComplementGenerator $complementGenerator, TaskScheduler $scheduler)
+    {
+        $this->issueApi = $issueApi;
+        $this->complementGenerator = $complementGenerator;
+        $this->scheduler = $scheduler;
+    }
+
+    public function onPullRequest(GitHubEvent $event)
+    {
+        $data = $event->getData();
+        $repository = $event->getRepository();
+        if ('opened' !== $data['action'] || !($data['pull_request']['draft'] ?? false)) {
+            return;
+        }
+
+        $number = $data['pull_request']['number'];
+        $complement = $this->complementGenerator->getPullRequestComplement();
+        $this->issueApi->commentOnIssue($repository, $number, <<<TXT
+Hey!
+
+$complement
+
+Could you please click the "ready for review" button? Or maybe close this PR and open a new one when you are done.
+Note that a pull request does not have to be "perfect" or "ready for merge" when you first open it, but it should be ready for a first review.
+
+Cheers!
+
+Carsonbot
+TXT
+);
+
+        // Add a scheduled task to close the PR within 1 hour.
+        $this->scheduler->runLater($repository, $number, Task::ACTION_CLOSE_DRAFT, new \DateTimeImmutable('+1hour'));
+
+        $event->setResponseData([
+            'pull_request' => $number,
+            'draft_comment' => true,
+        ]);
+    }
+
+    public static function getSubscribedEvents()
+    {
+        return [
+            GitHubEvents::PULL_REQUEST => 'onPullRequest',
+        ];
+    }
+}

src/Subscriber/MilestoneNewPRSubscriber.php

@@ -31,7 +31,7 @@ public function onPullRequest(GitHubEvent $event)
     {
         $data = $event->getData();
         $repository = $event->getRepository();
-        if ('opened' !== $data['action']) {
+        if (!in_array($data['action'], ['opened', 'ready_for_review']) || ($data['pull_request']['draft'] ?? false)) {
             return;
         }
 

src/Subscriber/NeedsReviewNewPRSubscriber.php

@@ -24,7 +24,7 @@ public function onPullRequest(GitHubEvent $event)
     {
         $data = $event->getData();
         $repository = $event->getRepository();
-        if ('opened' !== $action = $data['action']) {
+        if (!in_array($data['action'], ['opened', 'ready_for_review']) || ($data['pull_request']['draft'] ?? false)) {
             return;
         }
 

src/Subscriber/WelcomeFirstTimeContributorSubscriber.php

@@ -25,7 +25,7 @@ public function __construct(IssueApi $commentsApi, PullRequestApi $pullRequestAp
     public function onPullRequest(GitHubEvent $event)
     {
         $data = $event->getData();
-        if ('opened' !== $data['action']) {
+        if (!in_array($data['action'], ['opened', 'ready_for_review']) || ($data['pull_request']['draft'] ?? false)) {
             return;
         }