DeamonLoggerExtraWebProcessor::__construct() - Code Metrics - Inspection of "Fix for user methods not attached becuase of token..." - FrDeamon/logger-extra-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 849420...11d690 )

by Bastien
created 2020-12-16 15:50 UTC
DeamonLoggerExtraWebProcessor::__construct() B

↳ Parent: DeamonLoggerExtraWebProcessor
Complexity

Conditions	9
Paths	16
Size

Total Lines	14
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	10
CRAP Score	9
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	9
c	1
b	0
f	0
dl	0
loc	14
ccs	10
cts	10
cp	1
rs	8.0555
cc	9
nc	16
nop	1
crap	9
<?php

namespace Deamon\LoggerExtraBundle\Processors\Monolog;

use Deamon\LoggerExtraBundle\Services\DeamonLoggerExtraContext;
use Monolog\Processor\WebProcessor as BaseWebProcessor;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\User\UserInterface;

class DeamonLoggerExtraWebProcessor extends BaseWebProcessor
{
    /**
     * @var string
     */
    private $environment = null;

    /**
     * @var DeamonLoggerExtraContext
     */
    private $loggerExtraContext = null;

    /**
     * @var TokenStorageInterface
     */
    private $tokenStorage = null;

    /**
     * @var RequestStack
     */
    private $requestStack = null;

    /**
     * @var array|null
     */
    private $displayConfig;

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

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

    /** @var array */
    private $userMethods;

    /**
     * @var array
     */
    private $record;

    public function __construct(?array $config = null)
    {
        parent::__construct([]);
        if (!empty($config) && array_key_exists('channel_prefix', $config)) {
            $this->channelPrefix = $config['channel_prefix'];
        }
        if (!empty($config) && array_key_exists('display', $config)) {
            $this->displayConfig = $config['display'];
        }
        if (!empty($config) && array_key_exists('user_class', $config)) {
            $this->userClass = $config['user_class'];
        }
        if (!empty($config) && array_key_exists('user_methods', $config)) {
            $this->userMethods = $config['user_methods'];
        }
    }

    /**
     * @param array $record
     *
     * @return array
     */
    public function __invoke(array $record): array
    {
        $this->record = parent::__invoke($record);

        $this->addContextInfo();
        $this->addRequestInfo();
        $this->addUserInfo();
        $this->addChannelInfo();

        return $this->record;
    }

    /**
     * Add extra info about the context of the generated log.
     */
    private function addContextInfo(): void
    {
        if (null !== $this->environment) {
            $this->addInfo('env', $this->environment);
        }

        if (null !== $this->loggerExtraContext) {
            $this->addInfo('locale', $this->loggerExtraContext->getLocale());
            if ($this->configShowExtraInfo('application_name')) {
                $this->record['extra']['application'] = $this->loggerExtraContext->getApplicationName();
            }
        }
    }

    /**
     * Add extra info about the request generating the log.
     */
    private function addRequestInfo(): void
    {
        if (null !== $this->requestStack) {
            $request = $this->requestStack->getCurrentRequest();
            if ($request instanceof Request) {
                $this->addInfo('url', $request->getRequestUri());
                $this->addInfo('route', $request->get('_route'));
                $this->addInfo('user_agent', $request->server->get('HTTP_USER_AGENT'));
                $this->addInfo('accept_encoding', $request->headers->get('Accept-Encoding'));
                $this->addInfo('client_ip', $request->getClientIp());
            }
        }
    }

    /**
     * Add extra info on the user generating the log.
     */
    private function addUserInfo(): void
    {
        if (!$this->configShowExtraInfo('user')) {
            return;
        }

        if (!class_exists($this->userClass) && !interface_exists($this->userClass)) {
            return;
        }

        if (!$this->tokenStorage instanceof TokenStorageInterface) {

            return;
        }

        $token = $this->tokenStorage->getToken();
        if ($this->isUserInstanceValid($token) && null !== $user = $token->getUser()) {
            $this->appendUserMethodInfo($user);
            $this->appendUserMethodInfo(/** @scrutinizer ignore-type */ $user);
        }
    }

    /**
     * append method result of user object.
     *
     * @param UserInterface $user
     */
    private function appendUserMethodInfo(UserInterface $user): void
    {
        foreach ($this->userMethods as $name => $method) {
            if (method_exists($user, $method)) {
                $this->record['extra'][$name] = $user->$method();
            }
        }
    }

    /**
     * Check if passed token is an instance of TokenInterface and an instance of config UserClass.
     *
     * @param TokenInterface|null $token
     *
     * @return bool
     */
    private function isUserInstanceValid(?TokenInterface $token): bool
    {
        return $token instanceof TokenInterface && $token->getUser() instanceof $this->userClass;
    }

    /**
     * Add channel info to ease the log interpretation.
     */
    private function addChannelInfo(): void
    {
        if (!array_key_exists('global_channel', $this->record['extra'])) {
            $this->addInfo('global_channel', $this->record['channel']);
        }

        if ($this->channelPrefix !== null && substr($this->record['channel'], 0, strlen($this->channelPrefix)) !== $this->channelPrefix) {
            $this->record['channel'] = sprintf('%s.%s', $this->channelPrefix, $this->record['channel']);
        }
    }

    /**
     * Add the extra info if configured to.
     *
     * @param string $key
     * @param mixed  $value
     */
    private function addInfo(string $key, $value): void
    {
        if ($this->configShowExtraInfo($key) && $value !== null) {
            $this->record['extra'][$key] = $value;
        }
    }

    /**
     * Tells if the config to display the extra info is enabled or not.
     *
     * @param string $extraInfo
     *
     * @return bool
     */
    private function configShowExtraInfo(string $extraInfo): bool
    {
        return isset($this->displayConfig[$extraInfo]) && $this->displayConfig[$extraInfo];
    }

    public function onKernelRequest(RequestEvent $event)
    {
        if ($event->isMasterRequest()) {
            $this->serverData = $event->getRequest()->server->all();
            $this->serverData['REMOTE_ADDR'] = $event->getRequest()->getClientIp();
        }
    }

    public static function getSubscribedEvents()
    {
        return [
            KernelEvents::REQUEST => ['onKernelRequest', 4096],
        ];
    }

    /**
     * @param DeamonLoggerExtraContext $loggerExtraContext
     */
    public function setLoggerExtraContext(DeamonLoggerExtraContext $loggerExtraContext): void
    {
        $this->loggerExtraContext = $loggerExtraContext;
    }

    /**
     * @param string $environment
     */
    public function setEnvironment(string $environment): void
    {
        $this->environment = $environment;
    }

    /**
     * @param TokenStorageInterface $tokenStorage
     */
    public function setTokenStorage(TokenStorageInterface $tokenStorage): void
    {
        $this->tokenStorage = $tokenStorage;
    }

    /**
     * @param RequestStack $requestStack
     */
    public function setRequestStack(RequestStack $requestStack): void
    {
        $this->requestStack = $requestStack;
    }
}

FrDeamon / logger-extra-bundle

Push — master ( 849420...11d690 )

DeamonLoggerExtraWebProcessor::__construct() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
