Pool::__construct() - Code Metrics - Inspection of "Merge pull request #18 from spatie/supported-check" - spatie/async - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 48b0fa...2d803e )

by Brent

created 2018-01-02 12:05 UTC

Pool::__construct() A

↳ Parent: Pool

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Spatie\Async;

use ArrayAccess;
use Spatie\Async\Runtime\ParentRuntime;

class Pool implements ArrayAccess
{
    protected $concurrency = 20;
    protected $tasksPerProcess = 1;
    protected $timeout = 300;
    protected $sleepTime = 50000;

    /** @var \Spatie\Async\ParallelProcess[] */
    protected $queue = [];

    /** @var \Spatie\Async\ParallelProcess[] */
    protected $inProgress = [];

    /** @var \Spatie\Async\ParallelProcess[] */
    protected $finished = [];

    /** @var \Spatie\Async\ParallelProcess[] */
    protected $failed = [];

    protected $results = [];

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

    /**
     * @return static
     */
    public static function create()
    {
        return new static();
    }

    public static function isSupported(): bool
    {
        return function_exists('pcntl_async_signals') && function_exists('posix_kill');
    }

    public function concurrency(int $concurrency): self
    {
        $this->concurrency = $concurrency;

        return $this;
    }

    public function timeout(int $timeout): self
    {
        $this->timeout = $timeout;

        return $this;
    }

    public function autoload(string $autoloader): self
    {
        ParentRuntime::init($autoloader);

        return $this;
    }

    public function sleepTime(int $sleepTime): self
    {
        $this->sleepTime = $sleepTime;

        return $this;
    }

    public function notify()
    {
        if (count($this->inProgress) >= $this->concurrency) {
            return;
        }

        $process = array_shift($this->queue);

        if (! $process) {
            return;
        }

        $this->putInProgress($process);
    }

    /**
     * @param \Spatie\Async\ParallelProcess|callable $process
     *
     * @return \Spatie\Async\ParallelProcess
     */
    public function add($process): ParallelProcess
    {
        if (! $process instanceof ParallelProcess) {
            $process = ParentRuntime::createChildProcess($process);
        }

        $this->putInQueue($process);

        return $process;
    }

    public function wait(): array
    {
        while ($this->inProgress) {

            foreach ($this->inProgress as $process) {
                if ($process->getCurrentExecutionTime() > $this->timeout) {
                    $this->markAsTimedOut($process);
                }
            }

            if (! $this->inProgress) {

                break;
            }

            usleep($this->sleepTime);
        }

        return $this->results;
    }

    public function putInQueue(ParallelProcess $process)
    {
        $this->queue[$process->getId()] = $process;

        $this->notify();
    }

    public function putInProgress(ParallelProcess $process)
    {
        $process->getProcess()->setTimeout($this->timeout);

        $process->start();

        unset($this->queue[$process->getId()]);

        $this->inProgress[$process->getPid()] = $process;
    }

    public function markAsFinished(ParallelProcess $process)
    {
        $this->results[] = $process->triggerSuccess();

        unset($this->inProgress[$process->getPid()]);

        $this->finished[$process->getPid()] = $process;

        $this->notify();
    }

    public function markAsTimedOut(ParallelProcess $process)

    {
        $process->triggerTimeout();

        unset($this->inProgress[$process->getPid()]);

        $this->failed[$process->getPid()] = $process;

        $this->notify();
    }

    public function markAsFailed(ParallelProcess $process)

    {
        $process->triggerError();

        unset($this->inProgress[$process->getPid()]);

        $this->failed[$process->getPid()] = $process;

        $this->notify();
    }

    public function offsetExists($offset)
    {
        // TODO

        return false;
    }

    public function offsetGet($offset)
    {
        // TODO
    }

    public function offsetSet($offset, $value)
    {
        $this->add($value);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function offsetUnset($offset)
    {
        // TODO
    }

    /**
     * @return \Spatie\Async\ParallelProcess[]
     */
    public function getFinished(): array
    {
        return $this->finished;
    }

    /**
     * @return \Spatie\Async\ParallelProcess[]
     */
    public function getFailed(): array
    {
        return $this->failed;
    }

    protected function registerListener()
    {
        pcntl_async_signals(true);

        pcntl_signal(SIGCHLD, function ($signo, $status) {
            while (true) {
                $pid = pcntl_waitpid(-1, $processState, WNOHANG | WUNTRACED);

                if ($pid <= 0) {
                    break;
                }

                $process = $this->inProgress[$pid] ?? null;

                if (! $process) {
                    continue;
                }

                if ($status['status'] === 0) {
                    $this->markAsFinished($process);

                    continue;
                }

                $this->markAsFailed($process);
            }
        });
    }
}


1		<?php
2
3		namespace Spatie\Async;
4
5		use ArrayAccess;
6		use Spatie\Async\Runtime\ParentRuntime;
7
8		class Pool implements ArrayAccess
9		{
10		protected $concurrency = 20;
11		protected $tasksPerProcess = 1;
12		protected $timeout = 300;
13		protected $sleepTime = 50000;
14
15		/** @var \Spatie\Async\ParallelProcess[] */
16		protected $queue = [];
17
18		/** @var \Spatie\Async\ParallelProcess[] */
19		protected $inProgress = [];
20
21		/** @var \Spatie\Async\ParallelProcess[] */
22		protected $finished = [];
23
24		/** @var \Spatie\Async\ParallelProcess[] */
25		protected $failed = [];
26
27		protected $results = [];
28
29		public function __construct()
30		{
31		$this->registerListener();
32		}
33
34		/**
35		* @return static
36		*/
37		public static function create()
38		{
39		return new static();
40		}
41
42		public static function isSupported(): bool
43		{
44		return function_exists('pcntl_async_signals') && function_exists('posix_kill');
45		}
46
47		public function concurrency(int $concurrency): self
48		{
49		$this->concurrency = $concurrency;
50
51		return $this;
52		}
53
54		public function timeout(int $timeout): self
55		{
56		$this->timeout = $timeout;
57
58		return $this;
59		}
60
61		public function autoload(string $autoloader): self
62		{
63		ParentRuntime::init($autoloader);
64
65		return $this;
66		}
67
68		public function sleepTime(int $sleepTime): self
69		{
70		$this->sleepTime = $sleepTime;
71
72		return $this;
73		}
74
75		public function notify()
76		{
77		if (count($this->inProgress) >= $this->concurrency) {
78		return;
79		}
80
81		$process = array_shift($this->queue);
82
83		if (! $process) {
84		return;
85		}
86
87		$this->putInProgress($process);
88		}
89
90		/**
91		* @param \Spatie\Async\ParallelProcess\|callable $process
92		*
93		* @return \Spatie\Async\ParallelProcess
94		*/
95		public function add($process): ParallelProcess
96		{
97		if (! $process instanceof ParallelProcess) {
98		$process = ParentRuntime::createChildProcess($process);
99		}
100
101		$this->putInQueue($process);
102
103		return $process;
104		}
105
106		public function wait(): array
107		{
108		while ($this->inProgress) {
		0 ignored issues – show Bug Best Practice introduced 2017-12-21 18:42 UTC by Report Bug Copy Issue Report The expression `$this->inProgress` of type `Spatie\Async\ParallelProcess[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
109		foreach ($this->inProgress as $process) {
110		if ($process->getCurrentExecutionTime() > $this->timeout) {
111		$this->markAsTimedOut($process);
112		}
113		}
114
115		if (! $this->inProgress) {
		0 ignored issues – show Bug Best Practice introduced 2017-12-21 18:42 UTC by Report Bug Copy Issue Report The expression `$this->inProgress` of type `Spatie\Async\ParallelProcess[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
116		break;
117		}
118
119		usleep($this->sleepTime);
120		}
121
122		return $this->results;
123		}
124
125		public function putInQueue(ParallelProcess $process)
126		{
127		$this->queue[$process->getId()] = $process;
128
129		$this->notify();
130		}
131
132		public function putInProgress(ParallelProcess $process)
133		{
134		$process->getProcess()->setTimeout($this->timeout);
135
136		$process->start();
137
138		unset($this->queue[$process->getId()]);
139
140		$this->inProgress[$process->getPid()] = $process;
141		}
142
143		public function markAsFinished(ParallelProcess $process)
144		{
145		$this->results[] = $process->triggerSuccess();
146
147		unset($this->inProgress[$process->getPid()]);
148
149		$this->finished[$process->getPid()] = $process;
150
151		$this->notify();
152		}
153
154	View Code Duplication	public function markAsTimedOut(ParallelProcess $process)
		0 ignored issues – show Duplication introduced 2017-12-24 10:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
155		{
156		$process->triggerTimeout();
157
158		unset($this->inProgress[$process->getPid()]);
159
160		$this->failed[$process->getPid()] = $process;
161
162		$this->notify();
163		}
164
165	View Code Duplication	public function markAsFailed(ParallelProcess $process)
		0 ignored issues – show Duplication introduced 2017-12-21 18:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
166		{
167		$process->triggerError();
168
169		unset($this->inProgress[$process->getPid()]);
170
171		$this->failed[$process->getPid()] = $process;
172
173		$this->notify();
174		}
175
176		public function offsetExists($offset)
177		{
178		// TODO
179
180		return false;
181		}
182
183		public function offsetGet($offset)
184		{
185		// TODO
186		}
187
188		public function offsetSet($offset, $value)
189		{
190		$this->add($value);
		0 ignored issues – show Documentation introduced 2017-12-24 10:43 UTC by Report Bug Copy Issue Report `$value` is of type `*`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
191		}
192
193		public function offsetUnset($offset)
194		{
195		// TODO
196		}
197
198		/**
199		* @return \Spatie\Async\ParallelProcess[]
200		*/
201		public function getFinished(): array
202		{
203		return $this->finished;
204		}
205
206		/**
207		* @return \Spatie\Async\ParallelProcess[]
208		*/
209		public function getFailed(): array
210		{
211		return $this->failed;
212		}
213
214		protected function registerListener()
215		{
216		pcntl_async_signals(true);
217
218		pcntl_signal(SIGCHLD, function ($signo, $status) {
219		while (true) {
220		$pid = pcntl_waitpid(-1, $processState, WNOHANG \| WUNTRACED);
221
222		if ($pid <= 0) {
223		break;
224		}
225
226		$process = $this->inProgress[$pid] ?? null;
227
228		if (! $process) {
229		continue;
230		}
231
232		if ($status['status'] === 0) {
233		$this->markAsFinished($process);
234
235		continue;
236		}
237
238		$this->markAsFailed($process);
239		}
240		});
241		}
242		}
243

spatie / async

GitHub Access Token became invalid

Push — master ( 48b0fa...2d803e )

Pool::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like