DeamonLoggerExtraWebProcessor::getSubscribedEvents() - Code Metrics - Inspection of "Fix deprecation on rootNode of configuration file" - FrDeamon/logger-extra-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#28)

by Bastien

created 2019-10-07 08:49 UTC

DeamonLoggerExtraWebProcessor::getSubscribedEvents() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?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([]);
        $this->channelPrefix = $config['channel_prefix'];
        $this->displayConfig = $config['display'];
        $this->userClass = $config['user_class'];
        $this->userMethods = $config['user_methods'];
    }

    /**
     * @param array $record
     *
     * @return array
     */
    public function __invoke(array $record)
    {
        $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 TokenStorage) {
            return;
        }

        $token = $this->tokenStorage->getToken();
        if ($this->isUserInstanceValid($token) && null !== $user = $token->getUser()) {
            $this->appendUserMethodInfo($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
    {
        $this->addInfo('global_channel', $this->record['channel']);

        if ($this->channelPrefix !== null) {
            $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;
    }
}


1		<?php
2
3		namespace Deamon\LoggerExtraBundle\Processors\Monolog;
4
5		use Deamon\LoggerExtraBundle\Services\DeamonLoggerExtraContext;
6		use Monolog\Processor\WebProcessor as BaseWebProcessor;
7		use Symfony\Component\HttpFoundation\Request;
8		use Symfony\Component\HttpFoundation\RequestStack;
9		use Symfony\Component\HttpKernel\Event\RequestEvent;
10		use Symfony\Component\HttpKernel\KernelEvents;
11		use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
12		use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
13		use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
14		use Symfony\Component\Security\Core\User\UserInterface;
15
16		class DeamonLoggerExtraWebProcessor extends BaseWebProcessor
17		{
18		/**
19		* @var string
20		*/
21		private $environment = null;
22
23		/**
24		* @var DeamonLoggerExtraContext
25		*/
26		private $loggerExtraContext = null;
27
28		/**
29		* @var TokenStorageInterface
30		*/
31		private $tokenStorage = null;
32
33		/**
34		* @var RequestStack
35		*/
36		private $requestStack = null;
37
38		/**
39		* @var array\|null
40		*/
41		private $displayConfig;
42
43		/**
44		* @var string
45		*/
46		private $channelPrefix;
47
48		/** @var string */
49		private $userClass;
50
51		/** @var array */
52		private $userMethods;
53
54		/**
55		* @var array
56		*/
57		private $record;
58
59	10	public function __construct(?array $config = null)
60		{
61	10	parent::__construct([]);
62	10	$this->channelPrefix = $config['channel_prefix'];
63	10	$this->displayConfig = $config['display'];
64	10	$this->userClass = $config['user_class'];
65	10	$this->userMethods = $config['user_methods'];
66	10	}
67
68		/**
69		* @param array $record
70		*
71		* @return array
72		*/
73	10	public function __invoke(array $record)
74		{
75	10	$this->record = parent::__invoke($record);
76
77	10	$this->addContextInfo();
78	10	$this->addRequestInfo();
79	10	$this->addUserInfo();
80	10	$this->addChannelInfo();
81
82	10	return $this->record;
83		}
84
85		/**
86		* Add extra info about the context of the generated log.
87		*/
88	10	private function addContextInfo(): void
89		{
90	10	if (null !== $this->environment) {
91	2	$this->addInfo('env', $this->environment);
92		}
93
94	10	if (null !== $this->loggerExtraContext) {
95	2	$this->addInfo('locale', $this->loggerExtraContext->getLocale());
96	2	if ($this->configShowExtraInfo('application_name')) {
97	2	$this->record['extra']['application'] = $this->loggerExtraContext->getApplicationName();
98		}
99		}
100	10	}
101
102		/**
103		* Add extra info about the request generating the log.
104		*/
105	10	private function addRequestInfo(): void
106		{
107	10	if (null !== $this->requestStack) {
108	1	$request = $this->requestStack->getCurrentRequest();
109	1	if ($request instanceof Request) {
110	1	$this->addInfo('url', $request->getRequestUri());
111	1	$this->addInfo('route', $request->get('_route'));
112	1	$this->addInfo('user_agent', $request->server->get('HTTP_USER_AGENT'));
113	1	$this->addInfo('accept_encoding', $request->headers->get('Accept-Encoding'));
114	1	$this->addInfo('client_ip', $request->getClientIp());
115		}
116		}
117	10	}
118
119		/**
120		* Add extra info on the user generating the log.
121		*/
122	10	private function addUserInfo(): void
123		{
124	10	if (!$this->configShowExtraInfo('user')) {
125	6	return;
126		}
127
128	4	if (!class_exists($this->userClass) && !interface_exists($this->userClass)) {
129	1	return;
130		}
131
132	3	if (!$this->tokenStorage instanceof TokenStorage) {
133	1	return;
134		}
135
136	2	$token = $this->tokenStorage->getToken();
137	2	if ($this->isUserInstanceValid($token) && null !== $user = $token->getUser()) {
138	1	$this->appendUserMethodInfo($user);
139		}
140	2	}
141
142		/**
143		* append method result of user object.
144		*
145		* @param UserInterface $user
146		*/
147	1	private function appendUserMethodInfo(UserInterface $user): void
148		{
149	1	foreach ($this->userMethods as $name => $method) {
150	1	if (method_exists($user, $method)) {
151	1	$this->record['extra'][$name] = $user->$method();
152		}
153		}
154	1	}
155
156		/**
157		* Check if passed token is an instance of TokenInterface and an instance of config UserClass.
158		*
159		* @param TokenInterface\|null $token
160		*
161		* @return bool
162		*/
163	2	private function isUserInstanceValid(?TokenInterface $token): bool
164		{
165	2	return $token instanceof TokenInterface && $token->getUser() instanceof $this->userClass;
166		}
167
168		/**
169		* Add channel info to ease the log interpretation.
170		*/
171	10	private function addChannelInfo(): void
172		{
173	10	$this->addInfo('global_channel', $this->record['channel']);
174
175	10	if ($this->channelPrefix !== null) {
176	1	$this->record['channel'] = sprintf('%s.%s', $this->channelPrefix, $this->record['channel']);
177		}
178	10	}
179
180		/**
181		* Add the extra info if configured to.
182		*
183		* @param string $key
184		* @param mixed $value
185		*/
186	10	private function addInfo(string $key, $value): void
187		{
188	10	if ($this->configShowExtraInfo($key) && $value !== null) {
189	5	$this->record['extra'][$key] = $value;
190		}
191	10	}
192
193		/**
194		* Tells if the config to display the extra info is enabled or not.
195		*
196		* @param string $extraInfo
197		*
198		* @return bool
199		*/
200	10	private function configShowExtraInfo(string $extraInfo): bool
201		{
202	10	return isset($this->displayConfig[$extraInfo]) && $this->displayConfig[$extraInfo];
203		}
204
205		public function onKernelRequest(RequestEvent $event)
206		{
207		if ($event->isMasterRequest()) {
208		$this->serverData = $event->getRequest()->server->all();
209		$this->serverData['REMOTE_ADDR'] = $event->getRequest()->getClientIp();
210		}
211		}
212
213		public static function getSubscribedEvents()
214		{
215		return [
216		KernelEvents::REQUEST => ['onKernelRequest', 4096],
217		];
218		}
219
220		/**
221		* @param DeamonLoggerExtraContext $loggerExtraContext
222		*/
223	2	public function setLoggerExtraContext(DeamonLoggerExtraContext $loggerExtraContext): void
224		{
225	2	$this->loggerExtraContext = $loggerExtraContext;
226	2	}
227
228		/**
229		* @param string $environment
230		*/
231	2	public function setEnvironment(string $environment): void
232		{
233	2	$this->environment = $environment;
234	2	}
235
236		/**
237		* @param TokenStorageInterface $tokenStorage
238		*/
239	2	public function setTokenStorage(TokenStorageInterface $tokenStorage): void
240		{
241	2	$this->tokenStorage = $tokenStorage;
242	2	}
243
244		/**
245		* @param RequestStack $requestStack
246		*/
247	1	public function setRequestStack(RequestStack $requestStack): void
248		{
249	1	$this->requestStack = $requestStack;
250	1	}
251		}
252

FrDeamon / logger-extra-bundle

Pull Request — master (#28)

DeamonLoggerExtraWebProcessor::getSubscribedEvents() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like