ExceptionHandler::addReporter() - Code Metrics - Inspection of "[spiral/exceptions] Add non-reportable exceptions" - spiral/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1044)

by Maxim

created 2024-01-02 08:18 UTC

ExceptionHandler::addReporter() A

↳ Parent: ExceptionHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Spiral\Exceptions;

use Closure;
use Spiral\Exceptions\Renderer\PlainRenderer;
use Spiral\Filters\Exception\AuthorizationException;
use Spiral\Filters\Exception\ValidationException;
use Spiral\Http\Exception\ClientException;

/**
 * The class is responsible for:
 *   - Global error handling (outside of dispatchers) using the {@see handleGlobalException()} method.
 *     Use the {@see register()} method to register the handler as a global exception/error catcher.
 *   - Runtime error handling (in a dispatcher after booting) using reporters and renderers.
 *     Use the {@see render()} method to prepare a formatted exception output.
 *     Use the {@see report()} method to send a debug information to configured channels.
 */
class ExceptionHandler implements ExceptionHandlerInterface
{
    public ?Verbosity $verbosity = Verbosity::BASIC;

    /** @var array<int, ExceptionRendererInterface> */
    protected array $renderers = [];
    /** @var array<int, ExceptionReporterInterface|Closure> */
    protected array $reporters = [];
    protected mixed $output = null;
    protected array $nonReportableExceptions = [
        ClientException::class,
        AuthorizationException::class,
        ValidationException::class,
    ];

    public function __construct()
    {
        $this->bootBasicHandlers();
    }

    public function register(): void
    {
        \register_shutdown_function($this->handleShutdown(...));
        \set_error_handler($this->handleError(...));
        \set_exception_handler($this->handleGlobalException(...));
    }

    public function getRenderer(?string $format = null): ?ExceptionRendererInterface
    {
        if ($format !== null) {
            foreach ($this->renderers as $renderer) {
                if ($renderer->canRender($format)) {
                    return $renderer;
                }
            }
        }
        return \end($this->renderers) ?: null;
    }

    public function render(
        \Throwable $exception,
        ?Verbosity $verbosity = null,
        string $format = null,
    ): string {
        return (string)$this->getRenderer($format)?->render($exception, $verbosity ?? $this->verbosity, $format);
    }

    public function canRender(string $format): bool
    {
        return $this->getRenderer($format) !== null;
    }

    public function report(\Throwable $exception): void
    {
        if ($this->shouldNotReport($exception)) {
            return;
        }

        foreach ($this->reporters as $reporter) {
            try {
                if ($reporter instanceof ExceptionReporterInterface) {
                    $reporter->report($exception);
                } else {
                    $reporter($exception);
                }
            } catch (\Throwable) {
                // Do nothing
            }
        }
    }

    public function handleGlobalException(\Throwable $e): void
    {
        if (\in_array(PHP_SAPI, ['cli', 'cli-server'], true)) {
            $this->output ??= \defined('STDERR') ? \STDERR : \fopen('php://stderr', 'wb+');
            $format = 'cli';
        } else {
            $this->output ??= \defined('STDOUT') ? \STDOUT : \fopen('php://stdout', 'wb+');
            $format = 'html';
        }

        // we are safe to handle global exceptions (system level) with maximum verbosity
        $this->report($e);

        // There is possible an exception on the application termination
        try {
            \fwrite($this->output, $this->render($e, verbosity: $this->verbosity, format: $format));
        } catch (\Throwable) {
            $this->output = null;
        }
    }

    /**
     * Add renderer to the beginning of the renderers list
     */
    public function addRenderer(ExceptionRendererInterface $renderer): void
    {
        \array_unshift($this->renderers, $renderer);
    }

    /**
     * @param class-string<\Throwable> $exception

     */
    public function dontReport(string $exception): void
    {
        $this->nonReportableExceptions[] = $exception;
    }

    /**
     * @param ExceptionReporterInterface|Closure(\Throwable):void $reporter
     */
    public function addReporter(ExceptionReporterInterface|Closure $reporter): void
    {
        $this->reporters[] = $reporter;
    }

    /**
     * @param resource $output
     */
    public function setOutput(mixed $output): void
    {
        $this->output = $output;
    }

    /**
     * Handle php shutdown and search for fatal errors.
     */
    protected function handleShutdown(): void
    {
        if (empty($error = \error_get_last())) {
            return;
        }

        try {
            $this->handleError($error['type'], $error['message'], $error['file'], $error['line']);
        } catch (\Throwable $e) {
            $this->handleGlobalException($e);
        }
    }

    /**
     * Convert application error into exception.
     * Handler for the {@see \set_error_handler()}.
     * @throws \ErrorException
     */
    protected function handleError(
        int $errno,
        string $errstr,
        string $errfile = '',
        int $errline = 0,
    ): bool {
        if (!(\error_reporting() & $errno)) {
            return false;
        }

        throw new \ErrorException($errstr, $errno, 0, $errfile, $errline);
    }

    protected function bootBasicHandlers(): void
    {
        $this->addRenderer(new PlainRenderer());
    }

    protected function shouldNotReport(\Throwable $exception): bool
    {
        foreach ($this->nonReportableExceptions as $nonReportableException) {
            if ($exception instanceof $nonReportableException) {
                return true;
            }
        }

        return false;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Spiral\Exceptions;
6
7		use Closure;
8		use Spiral\Exceptions\Renderer\PlainRenderer;
9		use Spiral\Filters\Exception\AuthorizationException;
10		use Spiral\Filters\Exception\ValidationException;
11		use Spiral\Http\Exception\ClientException;
12
13		/**
14		* The class is responsible for:
15		* - Global error handling (outside of dispatchers) using the {@see handleGlobalException()} method.
16		* Use the {@see register()} method to register the handler as a global exception/error catcher.
17		* - Runtime error handling (in a dispatcher after booting) using reporters and renderers.
18		* Use the {@see render()} method to prepare a formatted exception output.
19		* Use the {@see report()} method to send a debug information to configured channels.
20		*/
21		class ExceptionHandler implements ExceptionHandlerInterface
22		{
23		public ?Verbosity $verbosity = Verbosity::BASIC;
24
25		/** @var array<int, ExceptionRendererInterface> */
26		protected array $renderers = [];
27		/** @var array<int, ExceptionReporterInterface\|Closure> */
28		protected array $reporters = [];
29		protected mixed $output = null;
30		protected array $nonReportableExceptions = [
31		ClientException::class,
32		AuthorizationException::class,
33		ValidationException::class,
34		];
35
36	458	public function __construct()
37		{
38	458	$this->bootBasicHandlers();
39		}
40
41	40	public function register(): void
42		{
43	40	\register_shutdown_function($this->handleShutdown(...));
44	40	\set_error_handler($this->handleError(...));
45	40	\set_exception_handler($this->handleGlobalException(...));
46		}
47
48	7	public function getRenderer(?string $format = null): ?ExceptionRendererInterface
49		{
50	7	if ($format !== null) {
51	5	foreach ($this->renderers as $renderer) {
52	5	if ($renderer->canRender($format)) {
53	5	return $renderer;
54		}
55		}
56		}
57	2	return \end($this->renderers) ?: null;
58		}
59
60	4	public function render(
61		\Throwable $exception,
62		?Verbosity $verbosity = null,
63		string $format = null,
64		): string {
65	4	return (string)$this->getRenderer($format)?->render($exception, $verbosity ?? $this->verbosity, $format);
66		}
67
68		public function canRender(string $format): bool
69		{
70		return $this->getRenderer($format) !== null;
71		}
72
73	22	public function report(\Throwable $exception): void
74		{
75	22	if ($this->shouldNotReport($exception)) {
76	13	return;
77		}
78
79	9	foreach ($this->reporters as $reporter) {
80		try {
81	3	if ($reporter instanceof ExceptionReporterInterface) {
82	3	$reporter->report($exception);
83		} else {
84	3	$reporter($exception);
85		}
86	1	} catch (\Throwable) {
87		// Do nothing
88		}
89		}
90		}
91
92	1	public function handleGlobalException(\Throwable $e): void
93		{
94	1	if (\in_array(PHP_SAPI, ['cli', 'cli-server'], true)) {
95	1	$this->output ??= \defined('STDERR') ? \STDERR : \fopen('php://stderr', 'wb+');
96	1	$format = 'cli';
97		} else {
98		$this->output ??= \defined('STDOUT') ? \STDOUT : \fopen('php://stdout', 'wb+');
99		$format = 'html';
100		}
101
102		// we are safe to handle global exceptions (system level) with maximum verbosity
103	1	$this->report($e);
104
105		// There is possible an exception on the application termination
106		try {
107	1	\fwrite($this->output, $this->render($e, verbosity: $this->verbosity, format: $format));
108		} catch (\Throwable) {
109		$this->output = null;
110		}
111		}
112
113		/**
114		* Add renderer to the beginning of the renderers list
115		*/
116	440	public function addRenderer(ExceptionRendererInterface $renderer): void
117		{
118	440	\array_unshift($this->renderers, $renderer);
119		}
120
121		/**
122		* @param class-string<\Throwable> $exception
		0 ignored issues – show Documentation Bug introduced 2023-12-28 12:11 UTC by Report Bug Copy Issue Report The doc comment `class-string<\Throwable>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<\Throwable>. Loading history...
123		*/
124	1	public function dontReport(string $exception): void
125		{
126	1	$this->nonReportableExceptions[] = $exception;
127		}
128
129		/**
130		* @param ExceptionReporterInterface\|Closure(\Throwable):void $reporter
131		*/
132	14	public function addReporter(ExceptionReporterInterface\|Closure $reporter): void
133		{
134	14	$this->reporters[] = $reporter;
135		}
136
137		/**
138		* @param resource $output
139		*/
140	1	public function setOutput(mixed $output): void
141		{
142	1	$this->output = $output;
143		}
144
145		/**
146		* Handle php shutdown and search for fatal errors.
147		*/
148		protected function handleShutdown(): void
149		{
150		if (empty($error = \error_get_last())) {
151		return;
152		}
153
154		try {
155		$this->handleError($error['type'], $error['message'], $error['file'], $error['line']);
156		} catch (\Throwable $e) {
157		$this->handleGlobalException($e);
158		}
159		}
160
161		/**
162		* Convert application error into exception.
163		* Handler for the {@see \set_error_handler()}.
164		* @throws \ErrorException
165		*/
166	10	protected function handleError(
167		int $errno,
168		string $errstr,
169		string $errfile = '',
170		int $errline = 0,
171		): bool {
172	10	if (!(\error_reporting() & $errno)) {
173	2	return false;
174		}
175
176	10	throw new \ErrorException($errstr, $errno, 0, $errfile, $errline);
177		}
178
179	438	protected function bootBasicHandlers(): void
180		{
181	438	$this->addRenderer(new PlainRenderer());
182		}
183
184	22	protected function shouldNotReport(\Throwable $exception): bool
185		{
186	22	foreach ($this->nonReportableExceptions as $nonReportableException) {
187	22	if ($exception instanceof $nonReportableException) {
188	13	return true;
189		}
190		}
191
192	9	return false;
193		}
194		}
195

spiral / framework

Pull Request — master (#1044)

ExceptionHandler::addReporter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like