Refactoring using a GitHubRequestHandler

HeahDude · HeahDude · commit c6c44ab3f1ef · 2016-05-09T21:21:20.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 /app/bootstrap.php.cache
 /app/cache/*
 !app/cache/.gitkeep
+/app/config/github.yml
 /app/config/parameters.yml
 /app/logs/*
 !app/logs/.gitkeep
diff --git a/app/config/config.yml b/app/config/config.yml
@@ -2,6 +2,7 @@ imports:
     - { resource: parameters.yml }
     - { resource: security.yml }
     - { resource: services.yml }
+    - { resource: github.yml }
 
 # Put parameters here that don't need to change on each machine where the app is deployed
 # http://symfony.com/doc/current/best_practices/configuration.html#application-related-configuration
diff --git a/app/config/github.yml.dist b/app/config/github.yml.dist
@@ -0,0 +1,16 @@
+parameters:
+    # token used to update labels on the repository, etc
+    github_token: XXX
+
+    # defines symfony repository as default
+    default_repository: symfony/symfony
+
+    # point to the main symfony repositories
+    repositories:
+        symfony/symfony:
+            listeners:
+                - AppBundle\Listener\SymfonyIssueListener
+            secret: change_me
+        symfony/symfony-docs:
+            listeners:
+                 - AppBundle\Listener\SymfonyDocsIssueListener
diff --git a/app/config/parameters.yml.dist b/app/config/parameters.yml.dist
@@ -17,13 +17,3 @@ parameters:
 
     # A secret key that's used to generate certain security-related tokens
     secret:            ThisTokenIsNotSoSecretChangeIt
-
-    # token used to update labels on the repository, etc
-    github_token: XXXX
-    # defines symfony repository as default
-    default_repository: symfony/symfony
-    # point to the main symfony repositories
-    github_listeners:
-        symfony/symfony: 'AppBundle\Listener\SymfonyIssueListener'
-        symfony/symfony-docs: 'AppBundle\Listener\SymfonyDocsIssueListener'
-        symfony/symfony-standard: 'AppBundle\Listener\SymfonyStandardIssueListener'
diff --git a/app/config/services.yml b/app/config/services.yml
@@ -30,11 +30,12 @@ services:
         class: AppBundle\Issues\GitHub\GitHubStatusApi
         arguments: ['@app.github.cached_labels_api', '%default_repository%']
 
-    app.github.listener_factory:
-        class: AppBundle\Issues\GitHubListenerFactory
-        arguments: ['@app.github.labels_api', '%github_listeners%']
+    app.github.request_handler:
+        class: AppBundle\Issues\GitHubRequestHandler
+        arguments: ['@app.github.labels_api', '@event_dispatcher', '%repositories%']
 
     app.github.exception_listener:
-        class: Appbundle\Listener\ExceptionListener
+        class: Appbundle\Listener\GitHubExceptionListener
+        arguments: ['%kernel.debug%']
         tags:
             - { name: kernel.event_subscriber }
diff --git a/src/AppBundle/Controller/WebhookController.php b/src/AppBundle/Controller/WebhookController.php
@@ -2,8 +2,6 @@
 
 namespace AppBundle\Controller;
 
-use AppBundle\Event\GitHubEvent;
-use AppBundle\Exception\GitHubException;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
@@ -18,42 +16,8 @@ class WebhookController extends Controller
      */
     public function githubAction(Request $request)
     {
-        $data = json_decode($request->getContent(), true);
-        if (null === $data) {
-            throw new GitHubException('Invalid JSON body!');
-        }
-
-        $repository = isset($data['repository']['full_name']) ? $data['repository']['full_name'] : null;
-        if (empty($repository)) {
-            throw new GitHubException('No repository name!');
-        }
-
-        $listener = $this->get('app.github.listener_factory')->createFromRepository($repository);
-
-        $dispatcher = $this->get('event_dispatcher');
-        $dispatcher->addSubscriber($listener);
-
-        $event = new GitHubEvent($data);
-        $eventName = $request->headers->get('X-Github-Event');
-
-        try {
-            $dispatcher->dispatch('github.'.$eventName, $event);
-        } catch (\Exception $e) {
-            throw new GitHubException(sprintf('Failed dispatching "%s" event for "%s" repository.', $eventName, $repository), 0, $e);
-        }
-
-        $responseData = $event->getResponseData();
-
-        if (empty($responseData)) {
-            $responseData['unsupported_event'] = $eventName;
-        }
+        $responseData = $this->get('app.github.request_handler')->handle($request);
 
         return new JsonResponse($responseData);
-
-        // 1 read in what event they have
-        // 2 perform some action
-        // 3 return JSON
-
-        // log something to the database?
     }
 }
diff --git a/src/AppBundle/Exception/GitHubAccessDeniedException.php b/src/AppBundle/Exception/GitHubAccessDeniedException.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace AppBundle\Exception;
+
+use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
+
+/**
+ * GitHubAccessDeniedException.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class GitHubAccessDeniedException extends AccessDeniedHttpException implements GitHubExceptionInterface
+{
+}
diff --git a/src/AppBundle/Exception/GitHubBadRequestException.php b/src/AppBundle/Exception/GitHubBadRequestException.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace AppBundle\Exception;
+
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+
+/**
+ * GitHubBadRequestException.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class GitHubBadRequestException extends BadRequestHttpException implements GitHubExceptionInterface
+{
+}
diff --git a/src/AppBundle/Exception/GitHubException.php b/src/AppBundle/Exception/GitHubException.php
diff --git a/src/AppBundle/Exception/GitHubExceptionInterface.php b/src/AppBundle/Exception/GitHubExceptionInterface.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace AppBundle\Exception;
+
+/**
+ * GitHubExceptionInterface.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+interface GitHubExceptionInterface
+{
+}
diff --git a/src/AppBundle/Exception/GitHubInvalidConfigurationException.php b/src/AppBundle/Exception/GitHubInvalidConfigurationException.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace AppBundle\Exception;
+
+/**
+ * GitHubInvalidConfigurationException.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class GitHubInvalidConfigurationException extends \LogicException implements GitHubExceptionInterface
+{
+}
diff --git a/src/AppBundle/Exception/GitHubPreconditionFailedException.php b/src/AppBundle/Exception/GitHubPreconditionFailedException.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace AppBundle\Exception;
+
+use Symfony\Component\HttpKernel\Exception\PreconditionFailedHttpException;
+
+/**
+ * GitHubPreconditionFailedException.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class GitHubPreconditionFailedException extends PreconditionFailedHttpException implements GitHubExceptionInterface
+{
+}
diff --git a/src/AppBundle/Exception/GitHubRuntimeException.php b/src/AppBundle/Exception/GitHubRuntimeException.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace AppBundle\Exception;
+
+/**
+ * GitHubRuntimeException.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class GitHubRuntimeException extends \RuntimeException implements GitHubExceptionInterface
+{
+}
diff --git a/src/AppBundle/Issues/GitHubListenerFactory.php b/src/AppBundle/Issues/GitHubListenerFactory.php
diff --git a/src/AppBundle/Issues/GitHubRequestHandler.php b/src/AppBundle/Issues/GitHubRequestHandler.php
@@ -0,0 +1,108 @@
+<?php
+
+namespace AppBundle\Issues;
+
+use AppBundle\Event\GitHubEvent;
+use AppBundle\Exception\GitHubAccessDeniedException;
+use AppBundle\Exception\GitHubBadRequestException;
+use AppBundle\Exception\GitHubExceptionInterface;
+use AppBundle\Exception\GitHubInvalidConfigurationException;
+use AppBundle\Exception\GitHubPreconditionFailedException;
+use AppBundle\Exception\GitHubRuntimeException;
+use AppBundle\Issues\GitHub\CachedLabelsApi;
+use AppBundle\Issues\GitHub\GitHubStatusApi;
+use Github\Api\Issue\Labels;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Class GitHubRequestHandler.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class GitHubRequestHandler
+{
+    private $labelsApi;
+    private $dispatcher;
+    private $repositories;
+
+    public function __construct(Labels $labelsApi, EventDispatcherInterface $dispatcher, array $repositories)
+    {
+        $this->labelsApi = $labelsApi;
+        $this->dispatcher = $dispatcher;
+        $this->repositories = $repositories;
+    }
+
+    /**
+     * @return array The response data
+     *
+     * @throws GitHubExceptionInterface When the request or the configuration are invalid
+     */
+    public function handle(Request $request)
+    {
+        $data = json_decode($request->getContent(), true);
+        if (null === $data) {
+            throw new GitHubBadRequestException('Invalid JSON body!');
+        }
+
+        $repository = isset($data['repository']['full_name']) ? $data['repository']['full_name'] : null;
+        if (empty($repository)) {
+            throw new GitHubBadRequestException('No repository name!');
+        }
+
+        if (!isset($this->repositories[$repository])) {
+            throw new GitHubPreconditionFailedException(sprintf('Unsupported repository "%s".', $repository));
+        }
+
+        $config = $this->repositories[$repository];
+        if (isset($config['secret'])) {
+            if (!$request->headers->has('X-Hub-Signature')) {
+                throw new GitHubAccessDeniedException('The request is not secured.');
+            }
+            if (!$this->authenticate($request->headers->get('X-Hub-Signature'), $config['secret'], $request->getContent())) {
+                throw new GitHubAccessDeniedException('Invalid signature.');
+            }
+        }
+        if (empty($config['listeners'])) {
+            throw new GitHubInvalidConfigurationException('The repository "%s" has no listeners configured.');
+        }
+
+        $api = new GitHubStatusApi(
+            new CachedLabelsApi($this->labelsApi, $repository),
+            $repository
+        );
+        foreach ($config['listeners'] as $listener) {
+            if (!is_subclass_of($listener, __NAMESPACE__.'\IssueListener')) {
+                throw new GitHubInvalidConfigurationException(sprintf('The listener "%s" must be an instance of "\AppBundle\Issues\IssueListener".', $listener));
+            }
+
+            $this->dispatcher->addSubscriber(new $listener($api));
+        }
+
+        $event = new GitHubEvent($data);
+        $eventName = $request->headers->get('X-Github-Event');
+
+        try {
+            $this->dispatcher->dispatch('github.'.$eventName, $event);
+        } catch (\Exception $e) {
+            throw new GitHubRuntimeException(sprintf('Failed dispatching "%s" event for "%s" repository.', $eventName, $repository), 0, $e);
+        }
+
+        $responseData = $event->getResponseData();
+
+        if (empty($responseData)) {
+            throw new GitHubPreconditionFailedException(sprintf('Unsupported event "%s"', $eventName));
+        }
+
+        return $responseData;
+    }
+
+    private function authenticate($hash, $key, $data)
+    {
+        if (!extension_loaded('hash')) {
+            throw new GitHubInvalidConfigurationException('"hash" extension is needed to check request signature.');
+        }
+
+        return $hash !== 'sha1='.hash_hmac('sha1', $data, $key);
+    }
+}
diff --git a/src/AppBundle/Issues/IssueListener.php b/src/AppBundle/Issues/IssueListener.php
@@ -7,7 +7,7 @@
 
 abstract class IssueListener implements EventSubscriberInterface
 {
-    private static $triggerWordToStatus = [
+    protected static $triggerWordToStatus = [
         'needs review' => Status::NEEDS_REVIEW,
         'needs work' => Status::NEEDS_WORK,
         'works for me' => Status::WORKS_FOR_ME,
@@ -17,7 +17,7 @@ abstract class IssueListener implements EventSubscriberInterface
     /**
      * @var StatusApi
      */
-    private $statusApi;
+    protected $statusApi;
 
     public function __construct(StatusApi $statusApi)
     {
diff --git a/src/AppBundle/Listener/GitHubExceptionListener.php b/src/AppBundle/Listener/GitHubExceptionListener.php
diff --git a/src/AppBundle/Test/Issues/GitHubRequestHandlerTest.php b/src/AppBundle/Test/Issues/GitHubRequestHandlerTest.php
