RoadRunnerGrpcApplicationRunner::getInvoker() - Code Metrics - Inspection of "Add error handler, add loading bootstrap and check..." - yiisoft/yii-runner-roadrunner - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#93)

unknown

created 2025-03-28 08:18 UTC

RoadRunnerGrpcApplicationRunner::getInvoker() A

↳ Parent: RoadRunnerGrpcApplicationRunner

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Runner\RoadRunner;

use Psr\Container\ContainerExceptionInterface;
use Psr\Container\ContainerInterface;
use Psr\Container\NotFoundExceptionInterface;
use Spiral\RoadRunner\GRPC\Invoker;
use Spiral\RoadRunner\GRPC\InvokerInterface;
use Spiral\RoadRunner\GRPC\Server;
use Spiral\RoadRunner\GRPC\ServiceInterface;
use Spiral\RoadRunner\Worker;
use Yiisoft\Definitions\Exception\InvalidConfigException;
use Yiisoft\Di\StateResetter;
use Yiisoft\ErrorHandler\ErrorHandler;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\ErrorHandler\Exception\ErrorException;
use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
use Yiisoft\Log\Logger;
use Yiisoft\Log\Target\File\FileTarget;
use Yiisoft\Yii\Runner\ApplicationRunner;

/**
 * `RoadRunnerGrpcApplicationRunner` runs the Yii gRPC application using RoadRunner.
 */
final class RoadRunnerGrpcApplicationRunner extends ApplicationRunner
{
    private ?ErrorHandler $temporaryErrorHandler = null;
    private ?InvokerInterface $invoker = null;
    private array $services = [];
    private ?Worker $worker = null;

    /**
     * @param string $rootPath The absolute path to the project root.
     * @param bool $debug Whether the debug mode is enabled.
     * @param bool $checkEvents Whether to check events' configuration.
     * @param string|null $environment The environment name.
     * @param string $bootstrapGroup The bootstrap configuration group name.
     * @param string $eventsGroup The events' configuration group name.
     * @param string $diGroup The container definitions' configuration group name.
     * @param string $diProvidersGroup The container providers' configuration group name.
     * @param string $diDelegatesGroup The container delegates' configuration group name.
     * @param string $diTagsGroup The container tags' configuration group name.
     * @param string $paramsGroup The configuration parameters group name.
     * @param array $nestedParamsGroups Configuration group names that are included into configuration parameters group.
     * This is needed for recursive merging of parameters.
     * @param array $nestedEventsGroups Configuration group names that are included into events' configuration group.
     * This is needed for reverse and recursive merge of events' configurations.
     *
     * @psalm-param list<string> $nestedParamsGroups
     * @psalm-param list<string> $nestedEventsGroups
     */
    public function __construct(
        string $rootPath,
        bool $debug = false,
        bool $checkEvents = false,
        ?string $environment = null,
        string $bootstrapGroup = 'bootstrap-web',
        string $eventsGroup = 'events-web',
        string $diGroup = 'di-web',
        string $diProvidersGroup = 'di-providers-web',
        string $diDelegatesGroup = 'di-delegates-web',
        string $diTagsGroup = 'di-tags-web',
        string $paramsGroup = 'params-web',
        array $nestedParamsGroups = ['params'],
        array $nestedEventsGroups = ['events'],
    ) {
        parent::__construct(
            $rootPath,
            $debug,
            $checkEvents,
            $environment,
            $bootstrapGroup,
            $eventsGroup,
            $diGroup,
            $diProvidersGroup,
            $diDelegatesGroup,
            $diTagsGroup,
            $paramsGroup,
            $nestedParamsGroups,
            $nestedEventsGroups,
        );
    }

    /**
     * @return void
     * @throws ContainerExceptionInterface
     * @throws ErrorException
     * @throws NotFoundExceptionInterface
     * @throws \ErrorException
     * @throws InvalidConfigException
     */
    public function run(): void
    {
        // Register temporary error handler to catch error while container is building.
        $temporaryErrorHandler = $this->createTemporaryErrorHandler();
        $this->registerErrorHandler($temporaryErrorHandler);

        $container = $this->getContainer();

        // Register error handler with real container-configured dependencies.
        /** @var ErrorHandler $actualErrorHandler */
        $actualErrorHandler = $container->get(ErrorHandler::class);
        $this->registerErrorHandler($actualErrorHandler, $temporaryErrorHandler);

        $this->runBootstrap();
        $this->checkEvents();

        $server = new Server($this->getInvoker(), ['debug' => $this->debug]);

        /**
         * @var class-string<ServiceInterface> $interface
         */
        foreach ($this->getServices() as $interface) {
            $server->registerService($interface, $container->get($interface));
        }

        $server->serve($this->getWorker(), finalize: function () use ($container) {
            $this->afterRespond($container);
        });
    }

    private function createTemporaryErrorHandler(): ErrorHandler {
        if ($this->temporaryErrorHandler !== null) {
            return $this->temporaryErrorHandler;
        }

        $logger = new Logger([new FileTarget("$this->rootPath/runtime/logs/app.log")]);
        return new ErrorHandler($logger, new HtmlRenderer());
    }

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

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

        $registered->register();
    }

    /**
     * @param ContainerInterface $container
     * @return void
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    private function afterRespond(ContainerInterface $container): void {
        /** @psalm-suppress MixedMethodCall */
        $container->get(StateResetter::class)->reset();
        gc_collect_cycles();
    }

    /**
     * Returns a new instance with the specified gRPC worker instance
     *
     * @return $this
     */
    public function withWorker(Worker $worker): self
    {
        $instance = clone $this;
        $instance->worker = $worker;

        return $instance;
    }

    /**
     * Transmitted services for registration gRPC server
     *
     * @param array $services Services array (key-value pairs)
     * ```php
     * [
     *      ServiceInterface::class => Service::class
     * ]
     * ```
     *
     * @return $this
     */
    public function setServices(array $services): self
    {
        $this->services = $services;

        return $this;
    }

    public function getServices(): array
    {
        return $this->services;
    }

    public function getWorker(): Worker
    {
        return $this->worker ?? Worker::create();
    }

    public function getInvoker(): InvokerInterface
    {
        return $this->invoker ?? new Invoker();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Yii\Runner\RoadRunner;
6
7		use Psr\Container\ContainerExceptionInterface;
8		use Psr\Container\ContainerInterface;
9		use Psr\Container\NotFoundExceptionInterface;
10		use Spiral\RoadRunner\GRPC\Invoker;
11		use Spiral\RoadRunner\GRPC\InvokerInterface;
12		use Spiral\RoadRunner\GRPC\Server;
13		use Spiral\RoadRunner\GRPC\ServiceInterface;
14		use Spiral\RoadRunner\Worker;
15		use Yiisoft\Definitions\Exception\InvalidConfigException;
16		use Yiisoft\Di\StateResetter;
17		use Yiisoft\ErrorHandler\ErrorHandler;
		0 ignored issues – show Bug introduced 2025-03-28 08:51 UTC by Report Bug Copy Issue Report The type `Yiisoft\ErrorHandler\ErrorHandler` 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...
18		use Yiisoft\ErrorHandler\Exception\ErrorException;
19		use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
20		use Yiisoft\Log\Logger;
21		use Yiisoft\Log\Target\File\FileTarget;
22		use Yiisoft\Yii\Runner\ApplicationRunner;
23
24		/**
25		* `RoadRunnerGrpcApplicationRunner` runs the Yii gRPC application using RoadRunner.
26		*/
27		final class RoadRunnerGrpcApplicationRunner extends ApplicationRunner
28		{
29		private ?ErrorHandler $temporaryErrorHandler = null;
30		private ?InvokerInterface $invoker = null;
31		private array $services = [];
32		private ?Worker $worker = null;
33
34		/**
35		* @param string $rootPath The absolute path to the project root.
36		* @param bool $debug Whether the debug mode is enabled.
37		* @param bool $checkEvents Whether to check events' configuration.
38		* @param string\|null $environment The environment name.
39		* @param string $bootstrapGroup The bootstrap configuration group name.
40		* @param string $eventsGroup The events' configuration group name.
41		* @param string $diGroup The container definitions' configuration group name.
42		* @param string $diProvidersGroup The container providers' configuration group name.
43	2	* @param string $diDelegatesGroup The container delegates' configuration group name.
44		* @param string $diTagsGroup The container tags' configuration group name.
45		* @param string $paramsGroup The configuration parameters group name.
46		* @param array $nestedParamsGroups Configuration group names that are included into configuration parameters group.
47		* This is needed for recursive merging of parameters.
48		* @param array $nestedEventsGroups Configuration group names that are included into events' configuration group.
49		* This is needed for reverse and recursive merge of events' configurations.
50		*
51		* @psalm-param list<string> $nestedParamsGroups
52		* @psalm-param list<string> $nestedEventsGroups
53		*/
54		public function __construct(
55		string $rootPath,
56		bool $debug = false,
57		bool $checkEvents = false,
58	2	?string $environment = null,
59	2	string $bootstrapGroup = 'bootstrap-web',
60	2	string $eventsGroup = 'events-web',
61	2	string $diGroup = 'di-web',
62	2	string $diProvidersGroup = 'di-providers-web',
63	2	string $diDelegatesGroup = 'di-delegates-web',
64	2	string $diTagsGroup = 'di-tags-web',
65	2	string $paramsGroup = 'params-web',
66	2	array $nestedParamsGroups = ['params'],
67	2	array $nestedEventsGroups = ['events'],
68	2	) {
69	2	parent::__construct(
70	2	$rootPath,
71	2	$debug,
72	2	$checkEvents,
73		$environment,
74		$bootstrapGroup,
75	1	$eventsGroup,
76		$diGroup,
77	1	$diProvidersGroup,
78		$diDelegatesGroup,
79		$diTagsGroup,
80		$paramsGroup,
81		$nestedParamsGroups,
82		$nestedEventsGroups,
83	1	);
84	1	}
85
86		/**
87	1	* @return void
88	1	* @throws ContainerExceptionInterface
89	1	* @throws ErrorException
90		* @throws NotFoundExceptionInterface
91		* @throws \ErrorException
92		* @throws InvalidConfigException
93		*/
94		public function run(): void
95		{
96		// Register temporary error handler to catch error while container is building.
97	1	$temporaryErrorHandler = $this->createTemporaryErrorHandler();
98		$this->registerErrorHandler($temporaryErrorHandler);
99	1
100	1	$container = $this->getContainer();
101
102	1	// Register error handler with real container-configured dependencies.
103		/** @var ErrorHandler $actualErrorHandler */
104		$actualErrorHandler = $container->get(ErrorHandler::class);
105		$this->registerErrorHandler($actualErrorHandler, $temporaryErrorHandler);
106
107		$this->runBootstrap();
108		$this->checkEvents();
109
110		$server = new Server($this->getInvoker(), ['debug' => $this->debug]);
111
112		/**
113		* @var class-string<ServiceInterface> $interface
114		*/
115		foreach ($this->getServices() as $interface) {
116		$server->registerService($interface, $container->get($interface));
117	2	}
118
119	2	$server->serve($this->getWorker(), finalize: function () use ($container) {
120		$this->afterRespond($container);
121	2	});
122		}
123
124	2	private function createTemporaryErrorHandler(): ErrorHandler {
125		if ($this->temporaryErrorHandler !== null) {
126	2	return $this->temporaryErrorHandler;
127		}
128
129	1	$logger = new Logger([new FileTarget("$this->rootPath/runtime/logs/app.log")]);
130		return new ErrorHandler($logger, new HtmlRenderer());
131	1	}
132
133		/**
134	1	* @throws ErrorException
135		*/
136	1	private function registerErrorHandler(ErrorHandler $registered, ErrorHandler $unregistered = null): void {
137		$unregistered?->unregister();
138
139		if ($this->debug) {
140		$registered->debug();
141		}
142
143		$registered->register();
144		}
145
146		/**
147		* @param ContainerInterface $container
148		* @return void
149		* @throws ContainerExceptionInterface
150		* @throws NotFoundExceptionInterface
151		*/
152		private function afterRespond(ContainerInterface $container): void {
153		/** @psalm-suppress MixedMethodCall */
154		$container->get(StateResetter::class)->reset();
155		gc_collect_cycles();
156		}
157
158		/**
159		* Returns a new instance with the specified gRPC worker instance
160		*
161		* @return $this
162		*/
163		public function withWorker(Worker $worker): self
164		{
165		$instance = clone $this;
166		$instance->worker = $worker;
167
168		return $instance;
169		}
170
171		/**
172		* Transmitted services for registration gRPC server
173		*
174		* @param array $services Services array (key-value pairs)
175		* ```php
176		* [
177		* ServiceInterface::class => Service::class
178		* ]
179		* ```
180		*
181		* @return $this
182		*/
183		public function setServices(array $services): self
184		{
185		$this->services = $services;
186
187		return $this;
188		}
189
190		public function getServices(): array
191		{
192		return $this->services;
193		}
194
195		public function getWorker(): Worker
196		{
197		return $this->worker ?? Worker::create();
198		}
199
200		public function getInvoker(): InvokerInterface
201		{
202		return $this->invoker ?? new Invoker();
203		}
204		}
205

yiisoft / yii-runner-roadrunner

Pull Request — master (#93)

RoadRunnerGrpcApplicationRunner::getInvoker() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like