Shlinkio\Shlink\Rest\Middleware\BackwardsCompatibleProblemDetailsMiddleware

Complexity

Total Complexity

10

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Test Coverage

Coverage

92.59%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	isVersionOne()	0	4	2
A	__construct()	0	4	1
A	mapStandardErrorTypes()	0	8	2
A	process()	0	21	4
A	makePayloadBackwardsCompatible()	0	6	1

<?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)) {

The function Shlinkio\Shlink\Rest\Middleware\BackwardsCompatibleProblemDetailsMiddleware::isVersionOne() has been deprecated: When Shlink 2 is released, do not chekc the version

            $payload = $this->makePayloadBackwardsCompatible($payload);

The function Shlinkio\Shlink\Rest\Middleware\BackwardsCompatibleProblemDetailsMiddleware::makePayloadBackwardsCompatible() has been deprecated: When Shlink v2 is released, do not map old fields

        }

        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
    {
        $path = $request->getUri()->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);
    }
}