WebApplicationRunner::run() - Code Metrics - Inspection of "Runner class improvements (#183)" - yiisoft/app - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Retried Inspection

Push — master ( c4a6de...2fae60 )

by Alexander

created 2021-08-30 20:56 UTC

WebApplicationRunner::run() A

↳ Parent: WebApplicationRunner

Complexity

Conditions	3
Paths	32

Size

Total Lines	60
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	31
c	0
b	0
f	0
dl	0
loc	60
rs	9.424
cc	3
nc	32
nop	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace App\Runner;

use App\Handler\ThrowableHandler;
use ErrorException;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Throwable;
use Yiisoft\Config\Config;
use Yiisoft\Di\Container;
use Yiisoft\ErrorHandler\ErrorHandler;
use Yiisoft\ErrorHandler\Middleware\ErrorCatcher;
use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
use Yiisoft\Factory\Exception\CircularReferenceException;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\Factory\Exception\InvalidConfigException;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\Factory\Exception\NotFoundException;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\Factory\Exception\NotInstantiableException;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\Http\Method;
use Yiisoft\Log\Logger;
use Yiisoft\Log\Target\File\FileTarget;
use Yiisoft\Yii\Event\ListenerConfigurationChecker;
use Yiisoft\Yii\Web\Application;
use Yiisoft\Yii\Web\Exception\HeadersHaveBeenSentException;
use Yiisoft\Yii\Web\SapiEmitter;
use Yiisoft\Yii\Web\ServerRequestFactory;

use function dirname;
use function microtime;

final class WebApplicationRunner
{
    private bool $debug = false;

    public function debug(bool $enable = true): void
    {
        $this->debug = $enable;
    }

    /**
     * @throws CircularReferenceException|ErrorException|HeadersHaveBeenSentException|InvalidConfigException
     * @throws NotFoundException|NotInstantiableException|
     */
    public function run(): void
    {
        $startTime = microtime(true);

        // Register temporary error handler to catch error while container is building.
        $errorHandler = $this->createTemporaryErrorHandler();
        $this->registerErrorHandler($errorHandler);

        $config = new Config(
            dirname(__DIR__, 2),
            '/config/packages', // Configs path.
            null,
            [
                'params',
                'events',
                'events-web',
                'events-console',
            ],
        );

        $container = new Container($config->get('web'), $config->get('providers-web'));

        // Register error handler with real container-configured dependencies.
        $this->registerErrorHandler($container->get(ErrorHandler::class), $errorHandler);

        // Run bootstrap
        $this->runBootstrap($container, $config->get('bootstrap-web'));

        $container = $container->get(ContainerInterface::class);

        if ($this->debug) {
            /** @psalm-suppress MixedMethodCall */
            $container->get(ListenerConfigurationChecker::class)->check($config->get('events-web'));
        }

        /** @var Application */
        $application = $container->get(Application::class);

        /**
         * @var ServerRequestInterface
         * @psalm-suppress MixedMethodCall
         */
        $serverRequest = $container->get(ServerRequestFactory::class)->createFromGlobals();
        $request = $serverRequest->withAttribute('applicationStartTime', $startTime);

        try {
            $application->start();
            $response = $application->handle($request);
            $this->emit($request, $response);
        } catch (Throwable $throwable) {
            $handler = new ThrowableHandler($throwable);
            /**
             * @var ResponseInterface
             * @psalm-suppress MixedMethodCall
             */
            $response = $container->get(ErrorCatcher::class)->process($request, $handler);
            $this->emit($request, $response);
        } finally {
            $application->afterEmit($response ?? null);
            $application->shutdown();
        }
    }

    private function createTemporaryErrorHandler(): ErrorHandler
    {
        $logger = new Logger([new FileTarget(dirname(__DIR__) . '/runtime/logs/app.log')]);
        return new ErrorHandler($logger, new HtmlRenderer());
    }

    /**
     * @throws HeadersHaveBeenSentException
     */
    private function emit(RequestInterface $request, ResponseInterface $response): void
    {
        (new SapiEmitter())->emit($response, $request->getMethod() === Method::HEAD);
    }

    /**
     * @throws ErrorException
     */
    private function registerErrorHandler(ErrorHandler $registered, ErrorHandler $unregistered = null): void
    {
        if ($unregistered !== null) {
            $unregistered->unregister();
        }

        if ($this->debug) {
            $registered->debug();
        }

        $registered->register();
    }

    private function runBootstrap(Container $container, array $bootstrapList): void
    {
        (new BootstrapRunner($container, $bootstrapList))->run();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace App\Runner;
6
7			use App\Handler\ThrowableHandler;
8			use ErrorException;
9			use Psr\Container\ContainerInterface;
10			use Psr\Http\Message\RequestInterface;
11			use Psr\Http\Message\ResponseInterface;
12			use Psr\Http\Message\ServerRequestInterface;
13			use Throwable;
14			use Yiisoft\Config\Config;
15			use Yiisoft\Di\Container;
16			use Yiisoft\ErrorHandler\ErrorHandler;
17			use Yiisoft\ErrorHandler\Middleware\ErrorCatcher;
18			use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
19			use Yiisoft\Factory\Exception\CircularReferenceException;
			0 ignored issues – show Bug introduced 2021-08-30 21:09 UTC by Report Bug Copy Issue Report The type `Yiisoft\Factory\Exceptio...cularReferenceException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
20			use Yiisoft\Factory\Exception\InvalidConfigException;
			0 ignored issues – show Bug introduced 2021-08-30 21:09 UTC by Report Bug Copy Issue Report The type `Yiisoft\Factory\Exception\InvalidConfigException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
21			use Yiisoft\Factory\Exception\NotFoundException;
			0 ignored issues – show Bug introduced 2021-08-30 21:09 UTC by Report Bug Copy Issue Report The type `Yiisoft\Factory\Exception\NotFoundException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
22			use Yiisoft\Factory\Exception\NotInstantiableException;
			0 ignored issues – show Bug introduced 2021-08-30 21:09 UTC by Report Bug Copy Issue Report The type `Yiisoft\Factory\Exception\NotInstantiableException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
23			use Yiisoft\Http\Method;
24			use Yiisoft\Log\Logger;
25			use Yiisoft\Log\Target\File\FileTarget;
26			use Yiisoft\Yii\Event\ListenerConfigurationChecker;
27			use Yiisoft\Yii\Web\Application;
28			use Yiisoft\Yii\Web\Exception\HeadersHaveBeenSentException;
29			use Yiisoft\Yii\Web\SapiEmitter;
30			use Yiisoft\Yii\Web\ServerRequestFactory;
31
32			use function dirname;
33			use function microtime;
34
35			final class WebApplicationRunner
36			{
37			private bool $debug = false;
38
39			public function debug(bool $enable = true): void
40			{
41			$this->debug = $enable;
42			}
43
44			/**
45			* @throws CircularReferenceException\|ErrorException\|HeadersHaveBeenSentException\|InvalidConfigException
46			* @throws NotFoundException\|NotInstantiableException\|
47			*/
48			public function run(): void
49			{
50			$startTime = microtime(true);
51
52			// Register temporary error handler to catch error while container is building.
53			$errorHandler = $this->createTemporaryErrorHandler();
54			$this->registerErrorHandler($errorHandler);
55
56			$config = new Config(
57			dirname(__DIR__, 2),
58			'/config/packages', // Configs path.
59			null,
60			[
61			'params',
62			'events',
63			'events-web',
64			'events-console',
65			],
66			);
67
68			$container = new Container($config->get('web'), $config->get('providers-web'));
69
70			// Register error handler with real container-configured dependencies.
71			$this->registerErrorHandler($container->get(ErrorHandler::class), $errorHandler);
72
73			// Run bootstrap
74			$this->runBootstrap($container, $config->get('bootstrap-web'));
75
76			$container = $container->get(ContainerInterface::class);
77
78			if ($this->debug) {
79			/** @psalm-suppress MixedMethodCall */
80			$container->get(ListenerConfigurationChecker::class)->check($config->get('events-web'));
81			}
82
83			/** @var Application */
84			$application = $container->get(Application::class);
85
86			/**
87			* @var ServerRequestInterface
88			* @psalm-suppress MixedMethodCall
89			*/
90			$serverRequest = $container->get(ServerRequestFactory::class)->createFromGlobals();
91			$request = $serverRequest->withAttribute('applicationStartTime', $startTime);
92
93			try {
94			$application->start();
95			$response = $application->handle($request);
96			$this->emit($request, $response);
97			} catch (Throwable $throwable) {
98			$handler = new ThrowableHandler($throwable);
99			/**
100			* @var ResponseInterface
101			* @psalm-suppress MixedMethodCall
102			*/
103			$response = $container->get(ErrorCatcher::class)->process($request, $handler);
104			$this->emit($request, $response);
105			} finally {
106			$application->afterEmit($response ?? null);
107			$application->shutdown();
108			}
109			}
110
111			private function createTemporaryErrorHandler(): ErrorHandler
112			{
113			$logger = new Logger([new FileTarget(dirname(__DIR__) . '/runtime/logs/app.log')]);
114			return new ErrorHandler($logger, new HtmlRenderer());
115			}
116
117			/**
118			* @throws HeadersHaveBeenSentException
119			*/
120			private function emit(RequestInterface $request, ResponseInterface $response): void
121			{
122			(new SapiEmitter())->emit($response, $request->getMethod() === Method::HEAD);
123			}
124
125			/**
126			* @throws ErrorException
127			*/
128			private function registerErrorHandler(ErrorHandler $registered, ErrorHandler $unregistered = null): void
129			{
130			if ($unregistered !== null) {
131			$unregistered->unregister();
132			}
133
134			if ($this->debug) {
135			$registered->debug();
136			}
137
138			$registered->register();
139			}
140
141			private function runBootstrap(Container $container, array $bootstrapList): void
142			{
143			(new BootstrapRunner($container, $bootstrapList))->run();
144			}
145			}
146

yiisoft / app

Push — master ( c4a6de...2fae60 )

WebApplicationRunner::run() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like