Factory::parent() - Code Metrics - Inspection of "Handle child process unexpectedly dying, emit exce..." - WyriHaximus/reactphp-child-process-messenger - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a10806...afde92 )

by Cees-Jan

created 2018-03-23 21:26 UTC

Factory::parent() A

↳ Parent: Factory

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace WyriHaximus\React\ChildProcess\Messenger;

use React\ChildProcess\Process;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use React\EventLoop\LoopInterface;
use React\Promise;
use React\Socket\ConnectionInterface;
use React\Socket\Connector;
use React\Socket\Server;
use WyriHaximus\React\ChildProcess\Messenger\Messages\Factory as MessengesFactory;
use WyriHaximus\React\ChildProcess\Messenger\Messages\Payload;

final class Factory
{
    const INTERVAL = 0.1;
    const TIMEOUT = 13;
    const TERMINATE_TIMEOUT = 1;
    const PROCESS_REGISTER = 'wyrihaximus.react.child-process.messenger.child.register';

    public static function parent(
        Process $process,
        LoopInterface $loop,
        array $options = []
    ) {
        return new Promise\Promise(function ($resolve, $reject) use ($process, $loop, $options) {
            $server = new Server('127.0.0.1:0', $loop);
            $argvString = \escapeshellarg(ArgvEncoder::encode([
                'address' => $server->getAddress(),
            ]));

            $process = new Process($process->getCommand() . ' ' . $argvString);
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)

            self::startParent($process, $server, $loop, $options)->done($resolve, $reject);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        });
    }

    /**
     * @param  string                              $process
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param  LoopInterface                       $loop
     * @param  array                               $options
     * @param  mixed                               $class
     * @return Promise\PromiseInterface<Messenger>

     */
    public static function parentFromClass(
        $class,
        LoopInterface $loop,
        array $options = []
    ) {
        if (!is_subclass_of($class, 'WyriHaximus\React\ChildProcess\Messenger\ChildInterface')) {
            throw new \Exception('Given class doesn\'t implement ChildInterface');
        }

        return new Promise\Promise(function ($resolve, $reject) use ($class, $loop, $options) {
            $server = new Server('127.0.0.1:0', $loop);
            $options['address'] = $server->getAddress();
            $options['random'] = bin2hex(random_bytes(512));

            $template = '%s';
            if (isset($options['cmdTemplate'])) {
                $template = $options['cmdTemplate'];
                unset($options['cmdTemplate']);
            }

            $phpBinary = \escapeshellarg(PHP_BINARY . (PHP_SAPI === 'phpdbg' ? ' -qrr --' : ''));
            $childProcessPath = \escapeshellarg(__DIR__ . DIRECTORY_SEPARATOR . 'child-process.php');
            $argvString = \escapeshellarg(ArgvEncoder::encode($options));
            $command = $phpBinary . ' ' . $childProcessPath;
            $process = new Process(
                sprintf(
                    $template,
                    $command . ' ' . $argvString
                )
            );

            self::startParent($process, $server, $loop, $options)->then(function (Messenger $messenger) use ($class) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                return $messenger->rpc(MessengesFactory::rpc(Factory::PROCESS_REGISTER, [
                    'className' => $class,
                ]))->then(function ($p) use ($messenger) {

                    return Promise\resolve($messenger);
                });
            })->done($resolve, $reject);
        });
    }

    /**
     * @param  LoopInterface                       $loop
     * @param  array                               $options
     * @param  callable                            $termiteCallable
     * @return Promise\PromiseInterface<Messenger>

     */
    public static function child(LoopInterface $loop, array $options = [], callable $termiteCallable = null)
    {
        return (new Connector($loop))->connect($options['address'])->then(function (ConnectionInterface $connection) use ($options) {
            return new Promise\Promise(function ($resolve, $reject) use ($connection, $options) {

                $connection->write(hash_hmac('sha512', $options['address'], $options['random']) . PHP_EOL);
                Promise\Stream\first($connection)->then(function ($chunk) use ($resolve, $connection, $options) {

                    list($confirmation) = explode(PHP_EOL, $chunk);
                    if ($confirmation === 'syn') {
                        $connection->write('ack' . PHP_EOL);
                        $resolve(new Messenger($connection, $options));
                    }
                });
            });
        })->then(function (Messenger $messenger) use ($loop, $termiteCallable) {
            if ($termiteCallable === null) {
                $termiteCallable = function () use ($loop) {
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)
                    $loop->addTimer(
                        self::TERMINATE_TIMEOUT,
                        [
                            $loop,
                            'stop',
                        ]
                    );
                };
            }

            $messenger->registerRpc(
                Messenger::TERMINATE_RPC,
                function (Payload $payload, Messenger $messenger) use ($termiteCallable) {
                    $messenger->emit('terminate', [
                        $messenger,
                    ]);
                    $termiteCallable($payload, $messenger);

                    return Promise\resolve([]);
                }
            );

            return $messenger;
        });
    }

    private static function startParent(
        Process $process,
        Server $server,
        LoopInterface $loop,
        array $options
    ) {
        return (new Promise\Promise(function ($resolve, $reject) use ($process, $server, $loop, $options) {
            $server->on(
                'connection',
                function (ConnectionInterface $connection) use ($server, $resolve, $reject, $options) {
                    Promise\Stream\first($connection)->then(function ($chunk) use ($server, $options, $connection, $resolve) {
                        list($confirmation) = explode(PHP_EOL, $chunk);
                        if ($confirmation === hash_hmac('sha512', $options['address'], $options['random'])) {
                            $connection->write('syn' . PHP_EOL);
                            $server->close();

                            return Promise\Stream\first($connection);
                        }
                    })->then(function ($chunk) use ($options, $connection, $resolve) {

                        list($confirmation) = explode(PHP_EOL, $chunk);
                        if ($confirmation === 'ack') {
                            $resolve(new Messenger($connection, $options));
                        }
                    });
                }
            );
            $server->on('error', function ($et) use ($reject) {
                $reject($et);
            });

            $process->start($loop);
        }))->then(function (Messenger $messenger) use ($loop, $process) {
            $loop->addPeriodicTimer(self::INTERVAL, function ($timer) use ($messenger, $loop, $process) {
                if (!$process->isRunning()) {
                    $loop->cancelTimer($timer);

                    $exitCode = $process->getExitCode();
                    if ($exitCode === 0) {
                        return;
                    }

                    $messenger->crashed($exitCode);
                }
            });

            return $messenger;
        });
    }
}


1			<?php
2
3			namespace WyriHaximus\React\ChildProcess\Messenger;
4
5			use React\ChildProcess\Process;
			0 ignored issues – show Bug introduced 2015-12-26 20:25 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `WyriHaximus\React\ChildProcess\Messenger\Process`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
6			use React\EventLoop\LoopInterface;
7			use React\Promise;
8			use React\Socket\ConnectionInterface;
9			use React\Socket\Connector;
10			use React\Socket\Server;
11			use WyriHaximus\React\ChildProcess\Messenger\Messages\Factory as MessengesFactory;
12			use WyriHaximus\React\ChildProcess\Messenger\Messages\Payload;
13
14			final class Factory
15			{
16			const INTERVAL = 0.1;
17			const TIMEOUT = 13;
18			const TERMINATE_TIMEOUT = 1;
19			const PROCESS_REGISTER = 'wyrihaximus.react.child-process.messenger.child.register';
20
21			public static function parent(
22			Process $process,
23			LoopInterface $loop,
24			array $options = []
25			) {
26			return new Promise\Promise(function ($resolve, $reject) use ($process, $loop, $options) {
27			$server = new Server('127.0.0.1:0', $loop);
28			$argvString = \escapeshellarg(ArgvEncoder::encode([
29			'address' => $server->getAddress(),
30			]));
31
32			$process = new Process($process->getCommand() . ' ' . $argvString);
			0 ignored issues – show Bug introduced 2018-01-31 15:13 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$process`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
33
34			self::startParent($process, $server, $loop, $options)->done($resolve, $reject);
			0 ignored issues – show Bug introduced 2018-03-23 21:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Promise\PromiseInterface` as the method `done()` does only exist in the following implementations of said interface: `React\Promise\FulfilledPromise`, `React\Promise\LazyPromise`, `React\Promise\Promise`, `React\Promise\RejectedPromise`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
35			});
36			}
37
38			/**
39			* @param string $process
			0 ignored issues – show Bug introduced 2017-10-17 06:04 UTC by Report Bug Copy Issue Report There is no parameter named `$process`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
40			* @param LoopInterface $loop
41			* @param array $options
42			* @param mixed $class
43			* @return Promise\PromiseInterface<Messenger>
			0 ignored issues – show Documentation introduced 2017-10-17 06:04 UTC by Report Bug Copy Issue Report The doc-type `Promise\PromiseInterface<Messenger>` could not be parsed: Expected "\|" or "end of type", but got "<" at position 24. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
44			*/
45	2		public static function parentFromClass(
46			$class,
47			LoopInterface $loop,
48			array $options = []
49			) {
50	2		if (!is_subclass_of($class, 'WyriHaximus\React\ChildProcess\Messenger\ChildInterface')) {
51	1		throw new \Exception('Given class doesn\'t implement ChildInterface');
52			}
53
54			return new Promise\Promise(function ($resolve, $reject) use ($class, $loop, $options) {
55	1		$server = new Server('127.0.0.1:0', $loop);
56	1		$options['address'] = $server->getAddress();
57	1		$options['random'] = bin2hex(random_bytes(512));
58
59	1		$template = '%s';
60	1		if (isset($options['cmdTemplate'])) {
61			$template = $options['cmdTemplate'];
62			unset($options['cmdTemplate']);
63			}
64
65	1		$phpBinary = \escapeshellarg(PHP_BINARY . (PHP_SAPI === 'phpdbg' ? ' -qrr --' : ''));
66	1		$childProcessPath = \escapeshellarg(__DIR__ . DIRECTORY_SEPARATOR . 'child-process.php');
67	1		$argvString = \escapeshellarg(ArgvEncoder::encode($options));
68	1		$command = $phpBinary . ' ' . $childProcessPath;
69	1		$process = new Process(
70	1		sprintf(
71	1		$template,
72	1		$command . ' ' . $argvString
73			)
74			);
75
76			self::startParent($process, $server, $loop, $options)->then(function (Messenger $messenger) use ($class) {
			0 ignored issues – show Bug introduced 2018-03-23 21:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Promise\PromiseInterface` as the method `done()` does only exist in the following implementations of said interface: `React\Promise\FulfilledPromise`, `React\Promise\LazyPromise`, `React\Promise\Promise`, `React\Promise\RejectedPromise`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
77	1		return $messenger->rpc(MessengesFactory::rpc(Factory::PROCESS_REGISTER, [
78	1		'className' => $class,
79			]))->then(function ($p) use ($messenger) {
			0 ignored issues – show Unused Code introduced 2018-03-01 21:51 UTC by Report Bug Copy Issue Report The parameter `$p` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
80	1		return Promise\resolve($messenger);
81	1		});
82	1		})->done($resolve, $reject);
83	1		});
84			}
85
86			/**
87			* @param LoopInterface $loop
88			* @param array $options
89			* @param callable $termiteCallable
90			* @return Promise\PromiseInterface<Messenger>
			0 ignored issues – show Documentation introduced 2018-01-31 15:13 UTC by Report Bug Copy Issue Report The doc-type `Promise\PromiseInterface<Messenger>` could not be parsed: Expected "\|" or "end of type", but got "<" at position 24. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
91			*/
92			public static function child(LoopInterface $loop, array $options = [], callable $termiteCallable = null)
93			{
94			return (new Connector($loop))->connect($options['address'])->then(function (ConnectionInterface $connection) use ($options) {
95			return new Promise\Promise(function ($resolve, $reject) use ($connection, $options) {
			0 ignored issues – show Unused Code introduced 2018-03-01 21:51 UTC by Report Bug Copy Issue Report The parameter `$reject` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
96			$connection->write(hash_hmac('sha512', $options['address'], $options['random']) . PHP_EOL);
97		View Code Duplication	Promise\Stream\first($connection)->then(function ($chunk) use ($resolve, $connection, $options) {
			0 ignored issues – show Duplication introduced 2018-03-01 21:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
98			list($confirmation) = explode(PHP_EOL, $chunk);
99			if ($confirmation === 'syn') {
100			$connection->write('ack' . PHP_EOL);
101			$resolve(new Messenger($connection, $options));
102			}
103			});
104			});
105			})->then(function (Messenger $messenger) use ($loop, $termiteCallable) {
106			if ($termiteCallable === null) {
107			$termiteCallable = function () use ($loop) {
			0 ignored issues – show Bug introduced 2017-10-17 06:04 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$termiteCallable`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
108			$loop->addTimer(
109			self::TERMINATE_TIMEOUT,
110			[
111			$loop,
112			'stop',
113			]
114			);
115			};
116			}
117
118			$messenger->registerRpc(
119			Messenger::TERMINATE_RPC,
120			function (Payload $payload, Messenger $messenger) use ($termiteCallable) {
121			$messenger->emit('terminate', [
122			$messenger,
123			]);
124			$termiteCallable($payload, $messenger);
125
126			return Promise\resolve([]);
127			}
128			);
129
130			return $messenger;
131			});
132			}
133
134	1		private static function startParent(
135			Process $process,
136			Server $server,
137			LoopInterface $loop,
138			array $options
139			) {
140			return (new Promise\Promise(function ($resolve, $reject) use ($process, $server, $loop, $options) {
141	1		$server->on(
142	1		'connection',
143			function (ConnectionInterface $connection) use ($server, $resolve, $reject, $options) {
144			Promise\Stream\first($connection)->then(function ($chunk) use ($server, $options, $connection, $resolve) {
145	1		list($confirmation) = explode(PHP_EOL, $chunk);
146	1		if ($confirmation === hash_hmac('sha512', $options['address'], $options['random'])) {
147	1		$connection->write('syn' . PHP_EOL);
148	1		$server->close();
149
150	1		return Promise\Stream\first($connection);
151			}
152		View Code Duplication	})->then(function ($chunk) use ($options, $connection, $resolve) {
			0 ignored issues – show Duplication introduced 2018-03-01 21:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
153	1		list($confirmation) = explode(PHP_EOL, $chunk);
154	1		if ($confirmation === 'ack') {
155	1		$resolve(new Messenger($connection, $options));
156			}
157	1		});
158	1		}
159			);
160			$server->on('error', function ($et) use ($reject) {
161			$reject($et);
162	1		});
163
164	1		$process->start($loop);
165			}))->then(function (Messenger $messenger) use ($loop, $process) {
166	1		$loop->addPeriodicTimer(self::INTERVAL, function ($timer) use ($messenger, $loop, $process) {
167	1		if (!$process->isRunning()) {
168	1		$loop->cancelTimer($timer);
169
170	1		$exitCode = $process->getExitCode();
171	1		if ($exitCode === 0) {
172	1		return;
173			}
174
175			$messenger->crashed($exitCode);
176			}
177	1		});
178
179	1		return $messenger;
180	1		});
181			}
182			}
183

WyriHaximus / reactphp-child-process-messenger

GitHub Access Token became invalid

Push — master ( a10806...afde92 )

Factory::parent() A

Complexity

Size

Duplication

Code Coverage

Importance

Change not visible in outer-scope

Change visible in outer-scope

Available Fixes

Available Fixes

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like