Moved InvalidShortCode exception handling to problem details

module/Rest/src/Action/ShortUrl/EditShortUrlAction.php

@@ -15,8 +15,6 @@ use Shlinkio\Shlink\Rest\Util\RestUtils;
 use Zend\Diactoros\Response\EmptyResponse;
 use Zend\Diactoros\Response\JsonResponse;
 
-use function sprintf;
-
 class EditShortUrlAction extends AbstractRestAction
 {
     protected const ROUTE_PATH = '/short-urls/{shortCode}';
@@ -51,12 +49,6 @@ class EditShortUrlAction extends AbstractRestAction
                 ShortUrlMeta::createFromRawData($postData)
             );
             return new EmptyResponse();
-        } catch (Exception\InvalidShortCodeException $e) {
-            $this->logger->warning('Provided data is invalid. {e}', ['e' => $e]);
-            return new JsonResponse([
-                'error' => RestUtils::getRestErrorCodeFromException($e),
-                'message' => sprintf('No URL found for short code "%s"', $shortCode),
-            ], self::STATUS_NOT_FOUND);
         } catch (Exception\ValidationException $e) {
             $this->logger->warning('Provided data is invalid. {e}', ['e' => $e]);
             return new JsonResponse([

module/Rest/src/Action/ShortUrl/EditShortUrlTagsAction.php

@@ -7,14 +7,11 @@ namespace Shlinkio\Shlink\Rest\Action\ShortUrl;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
 use Psr\Log\LoggerInterface;
-use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;
 use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
 use Shlinkio\Shlink\Rest\Action\AbstractRestAction;
 use Shlinkio\Shlink\Rest\Util\RestUtils;
 use Zend\Diactoros\Response\JsonResponse;
 
-use function sprintf;
-
 class EditShortUrlTagsAction extends AbstractRestAction
 {
     protected const ROUTE_PATH = '/short-urls/{shortCode}/tags';
@@ -47,14 +44,7 @@ class EditShortUrlTagsAction extends AbstractRestAction
         }
         $tags = $bodyParams['tags'];
 
-        try {
-            $shortUrl = $this->shortUrlService->setTagsByShortCode($shortCode, $tags);
-            return new JsonResponse(['tags' => $shortUrl->getTags()->toArray()]);
-        } catch (InvalidShortCodeException $e) {
-            return new JsonResponse([
-                'error' => RestUtils::getRestErrorCodeFromException($e),
-                'message' => sprintf('No URL found for short code "%s"', $shortCode),
-            ], self::STATUS_NOT_FOUND);
-        }
+        $shortUrl = $this->shortUrlService->setTagsByShortCode($shortCode, $tags);
+        return new JsonResponse(['tags' => $shortUrl->getTags()->toArray()]);
     }
 }

module/Rest/src/Action/Visit/GetVisitsAction.php

@@ -33,11 +33,6 @@ class GetVisitsAction extends AbstractRestAction
         $this->visitsTracker = $visitsTracker;
     }
 
-    /**
-     * @param Request $request
-     * @return Response
-     * @throws \InvalidArgumentException
-     */
     public function handle(Request $request): Response
     {
         $shortCode = $request->getAttribute('shortCode');

module/Rest/src/ConfigProvider.php

@@ -11,7 +11,7 @@ use function sprintf;
 
 class ConfigProvider
 {
-    private const ROUTES_PREFIX = '/rest/v{version:1}';
+    private const ROUTES_PREFIX = '/rest/v{version:1|2}';
 
     public function __invoke()
     {

module/Rest/src/Middleware/BackwardsCompatibleProblemDetailsMiddleware.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Rest\Middleware;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\MiddlewareInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+use Throwable;
+use Zend\Diactoros\Response\JsonResponse;
+
+use function Functional\reduce_left;
+use function Shlinkio\Shlink\Common\json_decode;
+use function strpos;
+
+class BackwardsCompatibleProblemDetailsMiddleware implements MiddlewareInterface
+{
+    private const BACKWARDS_COMPATIBLE_FIELDS = [
+        'error' => 'type',
+        'message' => 'detail',
+    ];
+
+    /** @var array */
+    private $defaultTypeFallbacks;
+    /** @var int */
+    private $jsonFlags;
+
+    public function __construct(array $defaultTypeFallbacks, int $jsonFlags)
+    {
+        $this->defaultTypeFallbacks = $defaultTypeFallbacks;
+        $this->jsonFlags = $jsonFlags;
+    }
+
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        $resp = $handler->handle($request);
+
+        if ($resp->getHeaderLine('Content-type') !== 'application/problem+json') {
+            return $resp;
+        }
+
+        try {
+            $body = (string) $resp->getBody();
+            $payload = json_decode($body);
+        } catch (Throwable $e) {
+            return $resp;
+        }
+
+        $payload = $this->mapStandardErrorTypes($payload, $resp->getStatusCode());
+
+        if ($this->isVersionOne($request)) {
+            $payload = $this->makePayloadBackwardsCompatible($payload);
+        }
+
+        return new JsonResponse($payload, $resp->getStatusCode(), $resp->getHeaders(), $this->jsonFlags);
+    }
+
+    private function mapStandardErrorTypes(array $payload, int $respStatusCode): array
+    {
+        $type = $payload['type'] ?? '';
+        if (strpos($type, 'https://httpstatus.es') === 0) {
+            $payload['type'] = $this->defaultTypeFallbacks[$respStatusCode] ?? $type;
+        }
+
+        return $payload;
+    }
+
+    /** @deprecated When Shlink 2 is released, do not chekc the version */
+    private function isVersionOne(ServerRequestInterface $request): bool
+    {
+        $uri = $request->getUri();
+        $path = $uri->getPath();
+
+        return strpos($path, '/v') === false || strpos($path, '/v1') === 0;
+    }
+
+    /** @deprecated When Shlink v2 is released, do not map old fields */
+    private function makePayloadBackwardsCompatible(array $payload): array
+    {
+        return reduce_left(self::BACKWARDS_COMPATIBLE_FIELDS, function (string $newKey, string $oldKey, $c, $acc) {
+            $acc[$oldKey] = $acc[$newKey];
+            return $acc;
+        }, $payload);
+    }
+}

module/Rest/src/Middleware/PathVersionMiddleware.php

@@ -15,23 +15,12 @@ class PathVersionMiddleware implements MiddlewareInterface
 {
     // TODO The /health endpoint needs this middleware in order to work without the version.
     //      Take it into account if this middleware is ever removed.
-
-    /**
-     * Process an incoming server request and return a response, optionally delegating
-     * to the next middleware component to create the response.
-     *
-     * @param Request $request
-     * @param RequestHandlerInterface $handler
-     *
-     * @return Response
-     * @throws \InvalidArgumentException
-     */
     public function process(Request $request, RequestHandlerInterface $handler): Response
     {
         $uri = $request->getUri();
         $path = $uri->getPath();
 
-        // If the path does not begin with the version number, prepend v1 by default for BC compatibility purposes
+        // If the path does not begin with the version number, prepend v1 by default for BC purposes
         if (strpos($path, '/v') !== 0) {
             $request = $request->withUri($uri->withPath('/v1' . $uri->getPath()));
         }