RoadRunnerApplicationRunner::runRoadRunner() - Code Metrics - Inspection of "Add temporal support and fallback to usual http ru..." - yiisoft/yii-runner-roadrunner - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#39)

by Dmitriy

created 2022-11-19 20:57 UTC

RoadRunnerApplicationRunner::runRoadRunner() A

↳ Parent: RoadRunnerApplicationRunner

Complexity

Conditions	5
Paths	2

Size

Total Lines	33
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	5

Importance

Changes

Metric	Value
cc	5
eloc	20
nc	2
nop	1
dl	0
loc	33
ccs	19
cts	19
cp	1
crap	5
rs	9.2888
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Runner\RoadRunner;

use ErrorException;
use Exception;
use JsonException;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\ContainerInterface;
use Psr\Container\NotFoundExceptionInterface;
use Psr\Http\Message\ResponseInterface;
use RuntimeException;
use Spiral\RoadRunner\Environment;
use Spiral\RoadRunner\Environment\Mode;
use Spiral\RoadRunner\Http\PSR7WorkerInterface;
use Temporal\Worker\WorkerOptions;
filter:
    dependency_paths: ["lib/*"]
use Temporal\WorkerFactory;
filter:
    dependency_paths: ["lib/*"]
use Throwable;
use Yiisoft\Definitions\Exception\CircularReferenceException;
use Yiisoft\Definitions\Exception\InvalidConfigException;
use Yiisoft\Definitions\Exception\NotInstantiableException;
use Yiisoft\Di\NotFoundException;
use Yiisoft\Di\StateResetter;
use Yiisoft\ErrorHandler\ErrorHandler;
use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
use Yiisoft\Log\Logger;
use Yiisoft\Log\Target\File\FileTarget;
use Yiisoft\Yii\Http\Application;
use Yiisoft\Yii\Runner\ApplicationRunner;
use Yiisoft\Yii\Runner\Http\HttpApplicationRunner;

use function gc_collect_cycles;

/**
 * `RoadRunnerApplicationRunner` runs the Yii HTTP application using RoadRunner.
 */
final class RoadRunnerApplicationRunner extends ApplicationRunner
{
    private ?ErrorHandler $temporaryErrorHandler = null;
    private ?PSR7WorkerInterface $psr7Worker = null;
    private bool $isTemporalEnabled = false;

    /**
     * @param string $rootPath The absolute path to the project root.
     * @param bool $debug Whether the debug mode is enabled.
     * @param string|null $environment The environment name.
     */
    public function __construct(string $rootPath, bool $debug, ?string $environment)
    {
        parent::__construct($rootPath, $debug, $environment);
        $this->bootstrapGroup = 'bootstrap-web';
        $this->eventsGroup = 'events-web';
    }

    /**
     * Returns a new instance with the specified temporary error handler instance {@see ErrorHandler}.
     *
     * A temporary error handler is needed to handle the creation of configuration and container instances,
     * then the error handler configured in your application configuration will be used.
     *
     * @param ErrorHandler $temporaryErrorHandler The temporary error handler instance.
     */
    public function withTemporaryErrorHandler(ErrorHandler $temporaryErrorHandler): self
    {
        $new = clone $this;
        $new->temporaryErrorHandler = $temporaryErrorHandler;
        return $new;
    }

    /**
     * Returns a new instance with the specified PSR-7 worker instance {@see PSR7WorkerInterface}.
     *
     * @param PSR7WorkerInterface $worker The PSR-7 worker instance.
     */
    public function withPsr7Worker(PSR7WorkerInterface $worker): self
    {
        $new = clone $this;
        $new->psr7Worker = $worker;
        return $new;
    }

    /**
     * Returns a new instance with enabled temporal support.
     */
    public function withEnabledTemporal(bool $value): self
    {
        if (!$this->isTemporalSDKInstalled()) {
            throw new Exception('Temporal SDK is not installed. To install the SDK run `composer require temporal/sdk`');
        }
        $new = clone $this;
        $new->isTemporalEnabled = $value;
        return $new;
    }

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

        $config = $this->getConfig();
        $container = $this->getContainer($config, 'web');

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

        $this->runBootstrap($config, $container);
        $this->checkEvents($config, $container);

        $env = Environment::fromGlobals();

        if ($env->getMode() === Mode::MODE_TEMPORAL) {
            if (!$this->isTemporalEnabled) {
                throw new RuntimeException(
                    'Temporal support is disabled. You should call `withEnabledTemporal(true)` to enable temporal support.',
                );
            }
            $this->runTemporal($container);
            return;
        }
        if ($env->getMode() === Mode::MODE_HTTP) {
            $this->runRoadRunner($container);
            return;
        }

        // Leave support to run the application with built-in php server with: php -S 127.0.0.0:8080 public/index.php
        $runner = new HttpApplicationRunner($this->rootPath, $this->debug, $this->environment);
        $runner->run();
    }

    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();
    }

    private function afterRespond(
        Application $application,
        ContainerInterface $container,
        ?ResponseInterface $response,
    ): void {
        $application->afterEmit($response);
        /** @psalm-suppress MixedMethodCall */
        $container
            ->get(StateResetter::class)
            ->reset(); // We should reset the state of such services every request.
        gc_collect_cycles();
    }

    private function runRoadRunner(ContainerInterface $container): void
    {
        $worker = new RoadRunnerWorker($container, $this->psr7Worker);

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

        while (true) {
            $request = $worker->waitRequest();
            $response = null;

            if ($request === null) {
                break;
            }

            if ($request instanceof Throwable) {
                $response = $worker->respondWithError($request);
                $this->afterRespond($application, $container, $response);
                continue;
            }

            try {
                $response = $application->handle($request);
                $worker->respond($response);
            } catch (Throwable $t) {
                $response = $worker->respondWithError($t, $request);
            } finally {
                $this->afterRespond($application, $container, $response);
            }
        }

        $application->shutdown();
    }

    private function runTemporal(ContainerInterface $container): void
    {
        $factory = $container->get(WorkerFactory::class);

        $worker = $factory->newWorker(
            'default',
            $container->get(WorkerOptions::class),
        );
        $workflows = $container->get('[email protected]');
        $activities = $container->get('[email protected]');

        foreach ($workflows as $workflow) {
            $worker->registerWorkflowTypes($workflow::class);
        }

        foreach ($activities as $activity) {
            $worker->registerActivity($activity::class);
        }

        $factory->run();
    }

    private function isTemporalSDKInstalled(): bool
    {
        return class_exists(WorkerFactory::class);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Yii\Runner\RoadRunner;
6
7		use ErrorException;
8		use Exception;
9		use JsonException;
10		use Psr\Container\ContainerExceptionInterface;
11		use Psr\Container\ContainerInterface;
12		use Psr\Container\NotFoundExceptionInterface;
13		use Psr\Http\Message\ResponseInterface;
14		use RuntimeException;
15		use Spiral\RoadRunner\Environment;
16		use Spiral\RoadRunner\Environment\Mode;
17		use Spiral\RoadRunner\Http\PSR7WorkerInterface;
18		use Temporal\Worker\WorkerOptions;
		0 ignored issues – show Bug introduced 2022-11-19 20:43 UTC by Report Bug Copy Issue Report The type `Temporal\Worker\WorkerOptions` 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...
19		use Temporal\WorkerFactory;
		0 ignored issues – show Bug introduced 2022-11-19 20:43 UTC by Report Bug Copy Issue Report The type `Temporal\WorkerFactory` 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 Throwable;
21		use Yiisoft\Definitions\Exception\CircularReferenceException;
22		use Yiisoft\Definitions\Exception\InvalidConfigException;
23		use Yiisoft\Definitions\Exception\NotInstantiableException;
24		use Yiisoft\Di\NotFoundException;
25		use Yiisoft\Di\StateResetter;
26		use Yiisoft\ErrorHandler\ErrorHandler;
27		use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
28		use Yiisoft\Log\Logger;
29		use Yiisoft\Log\Target\File\FileTarget;
30		use Yiisoft\Yii\Http\Application;
31		use Yiisoft\Yii\Runner\ApplicationRunner;
32		use Yiisoft\Yii\Runner\Http\HttpApplicationRunner;
33
34		use function gc_collect_cycles;
35
36		/**
37		* `RoadRunnerApplicationRunner` runs the Yii HTTP application using RoadRunner.
38		*/
39		final class RoadRunnerApplicationRunner extends ApplicationRunner
40		{
41		private ?ErrorHandler $temporaryErrorHandler = null;
42		private ?PSR7WorkerInterface $psr7Worker = null;
43		private bool $isTemporalEnabled = false;
44
45		/**
46		* @param string $rootPath The absolute path to the project root.
47		* @param bool $debug Whether the debug mode is enabled.
48		* @param string\|null $environment The environment name.
49		*/
50	9	public function __construct(string $rootPath, bool $debug, ?string $environment)
51		{
52	9	parent::__construct($rootPath, $debug, $environment);
53	9	$this->bootstrapGroup = 'bootstrap-web';
54	9	$this->eventsGroup = 'events-web';
55		}
56
57		/**
58		* Returns a new instance with the specified temporary error handler instance {@see ErrorHandler}.
59		*
60		* A temporary error handler is needed to handle the creation of configuration and container instances,
61		* then the error handler configured in your application configuration will be used.
62		*
63		* @param ErrorHandler $temporaryErrorHandler The temporary error handler instance.
64		*/
65	2	public function withTemporaryErrorHandler(ErrorHandler $temporaryErrorHandler): self
66		{
67	2	$new = clone $this;
68	2	$new->temporaryErrorHandler = $temporaryErrorHandler;
69	2	return $new;
70		}
71
72		/**
73		* Returns a new instance with the specified PSR-7 worker instance {@see PSR7WorkerInterface}.
74		*
75		* @param PSR7WorkerInterface $worker The PSR-7 worker instance.
76		*/
77	9	public function withPsr7Worker(PSR7WorkerInterface $worker): self
78		{
79	9	$new = clone $this;
80	9	$new->psr7Worker = $worker;
81	9	return $new;
82		}
83
84		/**
85		* Returns a new instance with enabled temporal support.
86		*/
87		public function withEnabledTemporal(bool $value): self
88		{
89		if (!$this->isTemporalSDKInstalled()) {
90		throw new Exception('Temporal SDK is not installed. To install the SDK run `composer require temporal/sdk`');
91		}
92		$new = clone $this;
93		$new->isTemporalEnabled = $value;
94		return $new;
95		}
96
97		/**
98		* {@inheritDoc}
99		*
100		* @throws CircularReferenceException\|ErrorException\|InvalidConfigException\|JsonException
101		* @throws ContainerExceptionInterface\|NotFoundException\|NotFoundExceptionInterface\|NotInstantiableException
102		*/
103	8	public function run(): void
104		{
105		// Register temporary error handler to catch error while container is building.
106	8	$temporaryErrorHandler = $this->createTemporaryErrorHandler();
107	8	$this->registerErrorHandler($temporaryErrorHandler);
108
109	8	$config = $this->getConfig();
110	8	$container = $this->getContainer($config, 'web');
111
112		// Register error handler with real container-configured dependencies.
113		/** @var ErrorHandler $actualErrorHandler */
114	8	$actualErrorHandler = $container->get(ErrorHandler::class);
115	8	$this->registerErrorHandler($actualErrorHandler, $temporaryErrorHandler);
116
117	8	$this->runBootstrap($config, $container);
118	8	$this->checkEvents($config, $container);
119
120	7	$env = Environment::fromGlobals();
121
122	7	if ($env->getMode() === Mode::MODE_TEMPORAL) {
123		if (!$this->isTemporalEnabled) {
124		throw new RuntimeException(
125		'Temporal support is disabled. You should call `withEnabledTemporal(true)` to enable temporal support.',
126		);
127		}
128		$this->runTemporal($container);
129		return;
130		}
131	7	if ($env->getMode() === Mode::MODE_HTTP) {
132	7	$this->runRoadRunner($container);
133	7	return;
134		}
135
136		// Leave support to run the application with built-in php server with: php -S 127.0.0.0:8080 public/index.php
137		$runner = new HttpApplicationRunner($this->rootPath, $this->debug, $this->environment);
138		$runner->run();
139		}
140
141	8	private function createTemporaryErrorHandler(): ErrorHandler
142		{
143	8	if ($this->temporaryErrorHandler !== null) {
144	1	return $this->temporaryErrorHandler;
145		}
146
147	7	$logger = new Logger([new FileTarget("$this->rootPath/runtime/logs/app.log")]);
148	7	return new ErrorHandler($logger, new HtmlRenderer());
149		}
150
151		/**
152		* @throws ErrorException
153		*/
154	8	private function registerErrorHandler(ErrorHandler $registered, ErrorHandler $unregistered = null): void
155		{
156	8	$unregistered?->unregister();
157
158	8	if ($this->debug) {
159	8	$registered->debug();
160		}
161
162	8	$registered->register();
163		}
164
165	6	private function afterRespond(
166		Application $application,
167		ContainerInterface $container,
168		?ResponseInterface $response,
169		): void {
170	6	$application->afterEmit($response);
171		/** @psalm-suppress MixedMethodCall */
172		$container
173	6	->get(StateResetter::class)
174	6	->reset(); // We should reset the state of such services every request.
175	6	gc_collect_cycles();
176		}
177
178	7	private function runRoadRunner(ContainerInterface $container): void
179		{
180	7	$worker = new RoadRunnerWorker($container, $this->psr7Worker);
181
182		/** @var Application $application */
183	7	$application = $container->get(Application::class);
184	7	$application->start();
185
186	7	while (true) {
187	7	$request = $worker->waitRequest();
188	7	$response = null;
189
190	7	if ($request === null) {
191	7	break;
192		}
193
194	6	if ($request instanceof Throwable) {
195	1	$response = $worker->respondWithError($request);
196	1	$this->afterRespond($application, $container, $response);
197	1	continue;
198		}
199
200		try {
201	5	$response = $application->handle($request);
202	4	$worker->respond($response);
203	1	} catch (Throwable $t) {
204	1	$response = $worker->respondWithError($t, $request);
205		} finally {
206	5	$this->afterRespond($application, $container, $response);
207		}
208		}
209
210	7	$application->shutdown();
211		}
212
213		private function runTemporal(ContainerInterface $container): void
214		{
215		$factory = $container->get(WorkerFactory::class);
216
217		$worker = $factory->newWorker(
218		'default',
219		$container->get(WorkerOptions::class),
220		);
221		$workflows = $container->get('[email protected]');
222		$activities = $container->get('[email protected]');
223
224		foreach ($workflows as $workflow) {
225		$worker->registerWorkflowTypes($workflow::class);
226		}
227
228		foreach ($activities as $activity) {
229		$worker->registerActivity($activity::class);
230		}
231
232		$factory->run();
233		}
234
235		private function isTemporalSDKInstalled(): bool
236		{
237		return class_exists(WorkerFactory::class);
238		}
239		}
240

yiisoft / yii-runner-roadrunner

Pull Request — master (#39)

RoadRunnerApplicationRunner::runRoadRunner() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like