From 75e744838c936b9e1e799b270916a22837cf3925 Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Wed, 27 Jul 2016 20:17:23 +0200
Subject: [PATCH] Created content based error handler which allows managing
 errors in a different way depending on the Accepted content type from the
 client

---
 .travis.yml                                   |   4 ++
 config/autoload/database.global.php           |   2 +-
 config/autoload/errorhandler.local.php.dist   |  14 +++-
 config/autoload/services.global.php           |   4 +-
 module/Common/config/error-handler.config.php |  22 ++++++
 .../Expressive/ContentBasedErrorHandler.php   |  64 ++++++++++++++++++
 .../ContentBasedErrorHandlerFactory.php       |  30 ++++++++
 .../src/Expressive/ErrorHandlerInterface.php  |  18 +++++
 module/Rest/config/error-handler.config.php   |  18 +++++
 module/Rest/lang/es.mo                        | Bin 1754 -> 1897 bytes
 module/Rest/lang/es.po                        |  15 ++--
 .../Rest/src/Expressive/JsonErrorHandler.php  |  39 +++++++++++
 12 files changed, 219 insertions(+), 11 deletions(-)
 create mode 100644 module/Common/config/error-handler.config.php
 create mode 100644 module/Common/src/Expressive/ContentBasedErrorHandler.php
 create mode 100644 module/Common/src/Expressive/ContentBasedErrorHandlerFactory.php
 create mode 100644 module/Common/src/Expressive/ErrorHandlerInterface.php
 create mode 100644 module/Rest/config/error-handler.config.php
 create mode 100644 module/Rest/src/Expressive/JsonErrorHandler.php

diff --git a/.travis.yml b/.travis.yml
index 905480ea..abc18f1c 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -11,6 +11,10 @@ php:
   - 7.1
   - hhvm
 
+matrix:
+  allow_failures:
+    - hhvm
+
 before_script:
   - composer self-update
   - composer install --no-interaction
diff --git a/config/autoload/database.global.php b/config/autoload/database.global.php
index 4e3b00e3..62733f22 100644
--- a/config/autoload/database.global.php
+++ b/config/autoload/database.global.php
@@ -5,7 +5,7 @@ return [
         'driver' => 'pdo_mysql',
         'user' => getenv('DB_USER'),
         'password' => getenv('DB_PASSWORD'),
-        'dbname' => getenv('DB_NAME') ?: 'acelaya_url_shortener',
+        'dbname' => getenv('DB_NAME') ?: 'shlink',
         'charset' => 'utf8',
         'driverOptions' => [
             PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8'
diff --git a/config/autoload/errorhandler.local.php.dist b/config/autoload/errorhandler.local.php.dist
index 92a92497..d6de56d7 100644
--- a/config/autoload/errorhandler.local.php.dist
+++ b/config/autoload/errorhandler.local.php.dist
@@ -1,14 +1,14 @@
 <?php
 
+use Shlinkio\Shlink\Common\Expressive\ContentBasedErrorHandler;
+use Zend\Expressive\Container\WhoopsErrorHandlerFactory;
+
 return [
     'services' => [
         'invokables' => [
             'Zend\Expressive\Whoops' => Whoops\Run::class,
             'Zend\Expressive\WhoopsPageHandler' => Whoops\Handler\PrettyPageHandler::class,
         ],
-        'factories' => [
-            'Zend\Expressive\FinalHandler' => Zend\Expressive\Container\WhoopsErrorHandlerFactory::class,
-        ],
     ],
 
     'whoops' => [
@@ -18,4 +18,12 @@ return [
             'ajax_only'  => true,
         ],
     ],
+
+    'error_handler' => [
+        'plugins' => [
+            'factories' => [
+                ContentBasedErrorHandler::DEFAULT_CONTENT => WhoopsErrorHandlerFactory::class,
+            ],
+        ],
+    ],
 ];
diff --git a/config/autoload/services.global.php b/config/autoload/services.global.php
index dc99033c..d7f56ed6 100644
--- a/config/autoload/services.global.php
+++ b/config/autoload/services.global.php
@@ -1,4 +1,6 @@
 <?php
+use Shlinkio\Shlink\Common\Expressive\ContentBasedErrorHandlerFactory;
+use Shlinkio\Shlink\Rest\Expressive\JsonErrorHandler;
 use Zend\Expressive;
 use Zend\Expressive\Container;
 use Zend\Expressive\Helper;
@@ -21,7 +23,7 @@ return [
             Router\FastRouteRouter::class => InvokableFactory::class,
 
             // View
-            'Zend\Expressive\FinalHandler' => Container\TemplatedErrorHandlerFactory::class,
+            'Zend\Expressive\FinalHandler' => ContentBasedErrorHandlerFactory::class,
             Template\TemplateRendererInterface::class => Twig\TwigRendererFactory::class,
         ],
         'aliases' => [
diff --git a/module/Common/config/error-handler.config.php b/module/Common/config/error-handler.config.php
new file mode 100644
index 00000000..a6165fa2
--- /dev/null
+++ b/module/Common/config/error-handler.config.php
@@ -0,0 +1,22 @@
+<?php
+use Shlinkio\Shlink\Common\Expressive\ContentBasedErrorHandler;
+use Zend\Expressive\Container\TemplatedErrorHandlerFactory;
+use Zend\Stratigility\FinalHandler;
+
+return [
+
+    'error_handler' => [
+        'plugins' => [
+            'invokables' => [
+                'text/plain' => FinalHandler::class,
+            ],
+            'factories' => [
+                ContentBasedErrorHandler::DEFAULT_CONTENT => TemplatedErrorHandlerFactory::class,
+            ],
+            'aliases' => [
+                'application/xhtml+xml' => ContentBasedErrorHandler::DEFAULT_CONTENT,
+            ],
+        ],
+    ],
+
+];
diff --git a/module/Common/src/Expressive/ContentBasedErrorHandler.php b/module/Common/src/Expressive/ContentBasedErrorHandler.php
new file mode 100644
index 00000000..f0d4bc04
--- /dev/null
+++ b/module/Common/src/Expressive/ContentBasedErrorHandler.php
@@ -0,0 +1,64 @@
+<?php
+namespace Shlinkio\Shlink\Common\Expressive;
+
+use Psr\Http\Message\RequestInterface as Request;
+use Psr\Http\Message\ResponseInterface as Response;
+use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
+use Zend\ServiceManager\AbstractPluginManager;
+use Zend\ServiceManager\Exception\InvalidServiceException;
+
+class ContentBasedErrorHandler extends AbstractPluginManager implements ErrorHandlerInterface
+{
+    const DEFAULT_CONTENT = 'text/html';
+
+    public function validate($instance)
+    {
+        if (is_callable($instance)) {
+            return;
+        }
+
+        throw new InvalidServiceException(sprintf(
+            'Only callables are valid plugins for "%s". "%s" provided',
+            __CLASS__,
+            is_object($instance) ? get_class($instance) : gettype($instance)
+        ));
+    }
+
+    /**
+     * Final handler for an application.
+     *
+     * @param Request $request
+     * @param Response $response
+     * @param null|mixed $err
+     * @return Response
+     */
+    public function __invoke(Request $request, Response $response, $err = null)
+    {
+        // Try to get an error handler for provided request accepted type
+        $errorHandler = $this->resolveErrorHandlerFromAcceptHeader($request);
+        return $errorHandler($request, $response, $err);
+    }
+
+    /**
+     * Tries to resolve
+     *
+     * @param Request $request
+     * @return callable
+     */
+    protected function resolveErrorHandlerFromAcceptHeader(Request $request)
+    {
+        $accepts = $request->hasHeader('Accept') ? $request->getHeaderLine('Accept') : self::DEFAULT_CONTENT;
+        $accepts = explode(',', $accepts);
+        foreach ($accepts as $accept) {
+            if (! $this->has($accept)) {
+                continue;
+            }
+
+            return $this->get($accept);
+        }
+
+        throw new InvalidArgumentException(sprintf(
+            'It wasn\'t possible to find an error handler for '
+        ));
+    }
+}
diff --git a/module/Common/src/Expressive/ContentBasedErrorHandlerFactory.php b/module/Common/src/Expressive/ContentBasedErrorHandlerFactory.php
new file mode 100644
index 00000000..f262d320
--- /dev/null
+++ b/module/Common/src/Expressive/ContentBasedErrorHandlerFactory.php
@@ -0,0 +1,30 @@
+<?php
+namespace Shlinkio\Shlink\Common\Expressive;
+
+use Interop\Container\ContainerInterface;
+use Interop\Container\Exception\ContainerException;
+use Zend\ServiceManager\Exception\ServiceNotCreatedException;
+use Zend\ServiceManager\Exception\ServiceNotFoundException;
+use Zend\ServiceManager\Factory\FactoryInterface;
+
+class ContentBasedErrorHandlerFactory implements FactoryInterface
+{
+    /**
+     * Create an object
+     *
+     * @param  ContainerInterface $container
+     * @param  string $requestedName
+     * @param  null|array $options
+     * @return object
+     * @throws ServiceNotFoundException if unable to resolve the service.
+     * @throws ServiceNotCreatedException if an exception is raised when
+     *     creating a service.
+     * @throws ContainerException if any other error occurs
+     */
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
+    {
+        $config = $container->get('config')['error_handler'];
+        $plugins = isset($config['plugins']) ? $config['plugins'] : [];
+        return new ContentBasedErrorHandler($container, $plugins);
+    }
+}
diff --git a/module/Common/src/Expressive/ErrorHandlerInterface.php b/module/Common/src/Expressive/ErrorHandlerInterface.php
new file mode 100644
index 00000000..0c787a09
--- /dev/null
+++ b/module/Common/src/Expressive/ErrorHandlerInterface.php
@@ -0,0 +1,18 @@
+<?php
+namespace Shlinkio\Shlink\Common\Expressive;
+
+use Psr\Http\Message\RequestInterface as Request;
+use Psr\Http\Message\ResponseInterface as Response;
+
+interface ErrorHandlerInterface
+{
+    /**
+     * Final handler for an application.
+     *
+     * @param Request $request
+     * @param Response $response
+     * @param null|mixed $err
+     * @return Response
+     */
+    public function __invoke(Request $request, Response $response, $err = null);
+}
diff --git a/module/Rest/config/error-handler.config.php b/module/Rest/config/error-handler.config.php
new file mode 100644
index 00000000..4b5b7e75
--- /dev/null
+++ b/module/Rest/config/error-handler.config.php
@@ -0,0 +1,18 @@
+<?php
+use Shlinkio\Shlink\Rest\Expressive\JsonErrorHandler;
+
+return [
+
+    'error_handler' => [
+        'plugins' => [
+            'invokables' => [
+                'application/json' => JsonErrorHandler::class,
+            ],
+            'aliases' => [
+                'application/x-json' => 'application/json',
+                'text/json' => 'application/json',
+            ],
+        ],
+    ],
+
+];
diff --git a/module/Rest/lang/es.mo b/module/Rest/lang/es.mo
index 2a8d4431a081c2eee3abe6973ebe7cb2bac0ce20..1bfa9aefbc137b30b9e4597348190e0ec80aacf7 100644
GIT binary patch
delta 445
zcmX}nJxjwt7zgkt>6=y*;~)yHIdKuhG_=%~B4X(zln%vJ@MvzRq&ZA3pdu6}72Jv+
zz>gpu#Sb7jJ2<#GI4DjIPX3eDKHQ(*CHKN}ud^R>{kMhWEum(R9HI~dc}Aj|*N7IO
z0U2C}H*gP{@C8=j5451A6Rp7m7_DExWq1dR@Btdg7qUXsCrXVDnD7xB8gL70X`&Xa
z!aBT!HhhA4_zR<kmoh{pScd2!F5DeIC^7zy$Rbk+uAkI2;SdHT@88cgvn`H85h&p>
zUxrFBM~Z-XQZaGT4U{!F)UPuYW>;(F(%@TPZH?y}cG0%8O&+MteV==Q%a!zNtnP{<
z?m50>4dL=r&bImgpWVr<6E9gE+1nWw5}%rOHq51ZTE5AdA1clQ>2^C^#T|}DMtult
IaFuTV0Rh5L(f|Me

delta 326
zcmaFKcZ;|Fo)F7a1|Z-9Vi_RL0b*Vt-UGxS@BxU$fcPU2D*!PEBLhPZkk$m!@<4hU
zkTwU>*MPJhkmh4zU{D6qwm@1ENGAemBOqN3q#pv+tOL?=K>h?4u)2DN^*{#5vdci)
z3?#wIz~Bd@j{|8(AT7qmz+eERBY-r>ft^6w7)UPz(m?YVn1PrBh=JO{0BAk~P%GF&
z><}RaPACo30yI=1G{{GxJh50IFTZ579Ah%$<b_Nf?1l=4W>&_QlMR>^<-lwc18oB%
n0|PFf#Nra&kfOxA;+({i{30ub&GVVxGH&i=&1IY{!5#<zPJJw$

diff --git a/module/Rest/lang/es.po b/module/Rest/lang/es.po
index fdfb2ed5..62f76e1d 100644
--- a/module/Rest/lang/es.po
+++ b/module/Rest/lang/es.po
@@ -1,9 +1,9 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: Shlink 1.0\n"
-"POT-Creation-Date: 2016-07-21 16:39+0200\n"
-"PO-Revision-Date: 2016-07-21 16:40+0200\n"
-"Last-Translator: \n"
+"POT-Creation-Date: 2016-07-27 08:53+0200\n"
+"PO-Revision-Date: 2016-07-27 08:53+0200\n"
+"Last-Translator: Alejandro Celaya <alejandro@alejandrocelaya.com>\n"
 "Language-Team: \n"
 "Language: es_ES\n"
 "MIME-Version: 1.0\n"
@@ -52,9 +52,12 @@ msgid ""
 "Missing or invalid auth token provided. Perform a new authentication request "
 "and send provided token on every new request on the \"%s\" header"
 msgstr ""
-"No se ha proporcionado token de autenticación o este es inválido. Realia una "
-"nueva petición de autenticación y envía el token proporcionado en cada nueva "
-"petición en la cabecera \"%s\""
+"No se ha proporcionado token de autenticación o este es inválido. Realiza "
+"una nueva petición de autenticación y envía el token proporcionado en cada "
+"nueva petición en la cabecera \"%s\""
+
+msgid "Requested route does not exist."
+msgstr "La ruta solicitada no existe."
 
 #~ msgid "RestToken not found for token \"%s\""
 #~ msgstr "No se ha encontrado un RestToken para el token \"%s\""
diff --git a/module/Rest/src/Expressive/JsonErrorHandler.php b/module/Rest/src/Expressive/JsonErrorHandler.php
new file mode 100644
index 00000000..0d02c45b
--- /dev/null
+++ b/module/Rest/src/Expressive/JsonErrorHandler.php
@@ -0,0 +1,39 @@
+<?php
+namespace Shlinkio\Shlink\Rest\Expressive;
+
+use Psr\Http\Message\RequestInterface as Request;
+use Psr\Http\Message\ResponseInterface as Response;
+use Shlinkio\Shlink\Common\Expressive\ErrorHandlerInterface;
+use Zend\Diactoros\Response\JsonResponse;
+
+class JsonErrorHandler implements ErrorHandlerInterface
+{
+    /**
+     * Final handler for an application.
+     *
+     * @param Request $request
+     * @param Response $response
+     * @param null|mixed $err
+     * @return Response
+     */
+    public function __invoke(Request $request, Response $response, $err = null)
+    {
+        $status = $response->getStatusCode();
+        $responsePhrase = $status < 400 ? 'Internal Server Error' : $response->getReasonPhrase();
+        $status = $status < 400 ? 500 : $status;
+
+        return new JsonResponse([
+            'error' => $this->responsePhraseToCode($responsePhrase),
+            'message' => $responsePhrase,
+        ], $status);
+    }
+
+    /**
+     * @param string $responsePhrase
+     * @return string
+     */
+    protected function responsePhraseToCode($responsePhrase)
+    {
+        return strtoupper(str_replace(' ', '_', $responsePhrase));
+    }
+}