League\Tactician\Logger\LoggerMiddleware

Complexity

Total Complexity

5

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	5
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
B	execute()	0	29	2
A	log()	0	8	2

<?php
namespace League\Tactician\Logger;

use League\Tactician\Logger\Formatter\Formatter;
use League\Tactician\Middleware;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use Exception;

/**
 * Add support for writing a message to the log whenever a command is received,
 * handled or failed.
 */
class LoggerMiddleware implements Middleware
{
    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @var Formatter
     */
    private $formatter;

    /**
     * @var string
     */
    private $commandReceivedLogLevel;

    /**
     * @var string
     */
    private $commandHandledLogLevel;

    /**
     * @var string
     */
    private $commandFailedLogLevel;

    /**
     * @param Formatter $formatter
     * @param LoggerInterface $logger
     * @param string $commandReceivedLogLevel
     * @param string $commandHandledLogLevel
     * @param string $commandFailedLogLevel
     */
    public function __construct(
        Formatter $formatter,
        LoggerInterface $logger,
        $commandReceivedLogLevel = LogLevel::DEBUG,
        $commandHandledLogLevel = LogLevel::DEBUG,
        $commandFailedLogLevel = LogLevel::ERROR
    ) {
        $this->formatter = $formatter;
        $this->logger = $logger;
        $this->commandReceivedLogLevel = $commandReceivedLogLevel;
        $this->commandHandledLogLevel = $commandHandledLogLevel;
        $this->commandFailedLogLevel = $commandFailedLogLevel;
    }

    /**
     * {@inheritdoc}
     */
    public function execute($command, callable $next)
    {
        $commandContext = $this->formatter->commandContext($command);

        $this->log(
            $this->commandReceivedLogLevel,
            $this->formatter->commandReceived($command),
            $commandContext
        );

        try {
            $returnValue = $next($command);
        } catch (Exception $e) {
            $this->log(
                $this->commandFailedLogLevel,
                $this->formatter->commandFailed($command),
                $this->formatter->failureContext($commandContext, $e)
            );
            throw $e;
        }

        $this->log(
            $this->commandHandledLogLevel,
            $this->formatter->commandHandled($command),
            $commandContext
        );

        return $returnValue;
    }

    /**
     * Write a message to the log or skip over it if the message is null
     *
     * @param string $logLevel
     * @param string|null $message
     * @param array $context
     */
    protected function log($logLevel, $message, array $context = [])
    {
        if ($message === null) {
            return;
        }

        $this->logger->log($logLevel, $message, $context);
    }
}