Spiral\Http\Middlewares\ExceptionWrapper

Complexity

Total Complexity

7

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	8

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	__invoke()	0	13	2
A	logError()	0	11	2
A	errorWriter()	0	4	1
A	findIp()	0	4	1

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

namespace Spiral\Http\Middlewares;

use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerAwareInterface;
use Spiral\Core\Component;
use Spiral\Core\ContainerInterface;
use Spiral\Debug\Traits\LoggerTrait;
use Spiral\Http\Configs\HttpConfig;
use Spiral\Http\ErrorWriter;
use Spiral\Http\Exceptions\ClientException;
use Spiral\Http\MiddlewareInterface;

/**
 * Isolates ClientException(s) into response.
 *
 * Attention, middleware requests ViewsInterface on demand!
 */
class ExceptionWrapper extends Component implements MiddlewareInterface, LoggerAwareInterface
{
    use LoggerTrait;

    /**
     * Format to be used for log messages in cases where http error caused by client request.
     */
    const LOG_FORMAT = "{scheme}://{host}{path} caused the error {code} ({message}) by client {remote}.";

    /**
     * Contain list of error pages.
     *
     * @var HttpConfig
     */
    protected $httpConfig = null;

    /**
     * Required to get ErrorWriter on demand and fetch proper logger.
     *
     * @invisible
     * @var ContainerInterface
     */
    protected $container = null;

    /**
     * @param HttpConfig         $httpConfig
     * @param ContainerInterface $container
     */
    public function __construct(HttpConfig $httpConfig, ContainerInterface $container)
    {
        $this->httpConfig = $httpConfig;
        $this->container = $container;
    }

    /**
     * {@inheritdoc}
     */
    public function __invoke(Request $request, Response $response, callable $next)
    {
        try {
            //Debug: ClientExceptions are isolated in this middleware.
            return $next($request, $response);
        } catch (ClientException $exception) {
            //Logging client error
            $this->logError($request, $exception);

            //Writing nice error into response
            return $this->errorWriter()->writeException($request, $response, $exception);
        }
    }

    /**
     * Add error to error log.
     *
     * @param Request         $request
     * @param ClientException $exception
     */
    private function logError(Request $request, ClientException $exception)
    {
        $this->logger()->error(\Spiral\interpolate(static::LOG_FORMAT, [
            'scheme'  => $request->getUri()->getScheme(),
            'host'    => $request->getUri()->getHost(),
            'path'    => $request->getUri()->getPath(),
            'code'    => $exception->getCode(),
            'message' => $exception->getMessage() ?: '-not specified-',
            'remote'  => $this->findIp($request)
        ]));
    }

    /**
     * Instance of ErrorWriter.
     *
     * @return ErrorWriter
     */
    protected function errorWriter(): ErrorWriter
    {
        return $this->container->get(ErrorWriter::class);
    }

    /**
     * Try to locate client ip. To be used for debug purposes only!
     *
     * @param \Psr\Http\Message\ServerRequestInterface $request
     *
     * @return string
     */
    private function findIp(ServerRequestInterface $request): string
    {
        return $request->getServerParams()['REMOTE_ADDR'] ?? '127.0.0.1';
    }
}