Added welcome message to first time user (#95)

* Added welcome message to first time user

* CS fixes

* Regsiter github api

* Added a suggestion

* Added link

* CS

* Updated message

* Use the same message on symfony-docs

* remove listener for symfony-docs

* Apply suggestions from code review

Co-authored-by: Ryan Weaver <weaverryan+github@gmail.com>

* minor

* Added hint about bugfixes will be merged up

Co-authored-by: Ryan Weaver <weaverryan+github@gmail.com>

Author: Nyholm

config/services.yaml

@@ -8,6 +8,7 @@ parameters:
                 - 'App\Subscriber\BugLabelNewIssueSubscriber'
                 - 'App\Subscriber\AutoLabelFromContentSubscriber'
                 - 'App\Subscriber\MilestoneNewPRSubscriber'
+                - 'App\Subscriber\WelcomeFirstTimeContributorSubscriber'
             secret: '%env(SYMFONY_SECRET)%'
 
         symfony/symfony-docs:
@@ -31,6 +32,7 @@ parameters:
                 - 'App\Subscriber\BugLabelNewIssueSubscriber'
                 - 'App\Subscriber\AutoLabelFromContentSubscriber'
                 - 'App\Subscriber\MilestoneNewPRSubscriber'
+                - 'App\Subscriber\WelcomeFirstTimeContributorSubscriber'
 
 services:
     _defaults:
@@ -59,7 +61,11 @@ services:
     Github\Api\Issue\Milestones:
         factory: ['@Github\Api\Issue', milestones]
 
+    Github\Api\Issue\Comments:
+        factory: ['@Github\Api\Issue', comments]
+
     App\Issues\StatusApi: '@App\Issues\GitHub\GitHubStatusApi'
+    App\Issues\CommentsApiInterface: '@App\Issues\GitHub\GithubCommentsApi'
 
     App\Repository\Provider\InMemoryRepositoryProvider:
         arguments: [ '%repositories%' ]

config/services_test.yaml

@@ -5,3 +5,6 @@ services:
 
     App\Issues\GitHub\CachedLabelsApi:
         class: App\Tests\Service\Issues\Github\FakedCachedLabelApi
+
+    App\Issues\StatusApi: '@App\Issues\NullStatusApi'
+    App\Issues\CommentsApiInterface: '@App\Issues\NullCommentsApi'

src/Issues/CommentsApiInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Issues;
+
+use App\Repository\Repository;
+
+interface CommentsApiInterface
+{
+    public function commentOnIssue(Repository $repository, $issueNumber, $commentBody);
+}

src/Issues/GitHub/GithubCommentsApi.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Issues\GitHub;
+
+use App\Issues\CommentsApiInterface;
+use App\Repository\Repository;
+use Github\Api\Issue\Comments;
+
+class GithubCommentsApi implements CommentsApiInterface
+{
+    private $issueCommentApi;
+
+    public function __construct(Comments $issueCommentApi)
+    {
+        $this->issueCommentApi = $issueCommentApi;
+    }
+
+    /**
+     * This will comment on both Issues and Pull Requests.
+     */
+    public function commentOnIssue(Repository $repository, $issueNumber, $commentBody)
+    {
+        $this->issueCommentApi->create(
+            $repository->getVendor(),
+            $repository->getName(),
+            $issueNumber,
+            ['body' => $commentBody]
+        );
+    }
+}

src/Issues/NullCommentsApi.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Issues;
+
+use App\Repository\Repository;
+
+class NullCommentsApi implements CommentsApiInterface
+{
+    public function commentOnIssue(Repository $repository, $issueNumber, $commentBody)
+    {
+    }
+}

src/Subscriber/WelcomeFirstTimeContributorSubscriber.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace App\Subscriber;
+
+use App\Event\GitHubEvent;
+use App\GitHubEvents;
+use App\Issues\CommentsApiInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class WelcomeFirstTimeContributorSubscriber implements EventSubscriberInterface
+{
+    private $commentsApi;
+
+    public function __construct(CommentsApiInterface $commentsApi)
+    {
+        $this->commentsApi = $commentsApi;
+    }
+
+    public function onPullRequest(GitHubEvent $event)
+    {
+        $data = $event->getData();
+        if ('opened' !== $data['action']) {
+            return;
+        }
+
+        if ('NONE' !== ($data['pull_request']['author_association'] ?? '')) {
+            return;
+        }
+
+        $repository = $event->getRepository();
+        $pullRequestNumber = $data['pull_request']['number'];
+        $defaultBranch = $data['repository']['default_branch'];
+        $this->commentsApi->commentOnIssue($repository, $pullRequestNumber, <<<TXT
+Hey!
+
+I see that this is your first PR. That is great! Welcome!
+
+Symfony has a [contribution guide](https://symfony.com/doc/current/contributing/index.html) which I suggest you to read.
+
+In short:
+- Always add tests
+- Keep backward compatibility (see https://symfony.com/bc).
+- Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
+- Features and deprecations must be submitted against the $defaultBranch branch.
+
+Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.
+
+When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
+If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.
+
+I am going to sit back now and wait for the reviews.
+
+Cheers!
+
+Carsonbot
+TXT
+);
+
+        $event->setResponseData([
+            'pull_request' => $pullRequestNumber,
+            'new_contributor' => true,
+        ]);
+    }
+
+    public static function getSubscribedEvents()
+    {
+        return [
+            GitHubEvents::PULL_REQUEST => 'onPullRequest',
+        ];
+    }
+}

tests/Controller/WebhookControllerTest.php

@@ -73,6 +73,11 @@ public function getTests()
                 'issues.labeled.feature.json',
                 ['issue' => 2, 'status_change' => null],
             ],
+            'Welcome first users' => [
+                'pull_request',
+                'pull_request.new_contributor.json',
+                ['pull_request' => 4, 'status_change' => 'needs_review',  'pr_labels' => [], 'new_contributor' => true],
+            ],
         ];
     }
 }

tests/webhook_examples/pull_request.new_contibutor.header.txt

@@ -0,0 +1,10 @@
+Request URL: https://nyholm.tech:
+Request method: POST
+Accept: */*
+content-type: application/x-www-form-urlencoded
+User-Agent: GitHub-Hookshot/888f7f5
+X-GitHub-Delivery: 47beb300-1d19-11eb-818f-ace469801400
+X-GitHub-Event: pull_request
+X-GitHub-Hook-ID: 259877073
+X-GitHub-Hook-Installation-Target-ID: 309178226
+X-GitHub-Hook-Installation-Target-Type: repository