Async::wait() - Code Metrics - Inspection of "Updated logic" - vuongxuongminh/yii2-async - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5ab19a...634a5b )

by Vuong

created 2019-05-05 14:33 UTC

Async::wait() A

↳ Parent: Async

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * @link https://github.com/vuongxuongminh/yii2-async
 * @copyright Copyright (c) 2019 Vuong Xuong Minh
 * @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
 */

namespace vxm\async;

use Yii;
use Throwable;

use yii\base\Component;

use Spatie\Async\Pool;

/**
 * Support run code async. To use it, you just config it to your application components in configure file:
 *
 * ```php
 * 'components' => [
 *      'async' => 'vxm\async\Async'
 * ]
 *
 * ```
 *
 * And after that you can run an async code:
 *
 * ```php
 *
 * Yii::$app->async->run(function () {
 *
 *      sleep(15);
 * });
 *
 * ```
 *
 * If you want to wait until task done, you just to call [[wait]].
 *
 * ```php
 *
 * Yii::$app->async->run(function () {
 *
 *      sleep(15);
 * })->wait();
 *
 * ```
 *
 * Run multi tasks:
 *
 * ```php
 *
 * Yii::$app->async->run(function () {
 *
 *      sleep(15);
 * });
 *
 * Yii::$app->async->run(function () {
 *
 *      sleep(15);
 * });
 *
 * Yii::$app->async->wait(); // sleep 30s
 * ```
 *
 * @property string $autoload path of autoload file for runtime task execute environment.
 * @property int $sleepTimeWait time to sleep on wait tasks execute.
 * @property int $concurrency tasks executable.
 * @property int $timeout of task executable.
 *
 * @author Vuong Minh <[email protected]>
 * @since 1.0.0
 */
class Async extends Component
{

    /**
     * @event SuccessEvent an event that is triggered when task done.
     */
    const EVENT_SUCCESS = 'success';

    /**
     * @event ErrorEvent an event that is triggered when task error.
     */
    const EVENT_ERROR = 'error';

    /**
     * @event \yii\base\Event an event that is triggered when task timeout.
     */
    const EVENT_TIMEOUT = 'timeout';

    /**
     * @var Pool handling tasks.
     */
    protected $pool;

    /**
     * Async constructor.
     *
     * @param array $config
     * @throws \yii\base\InvalidConfigException
     */
    public function __construct($config = [])
    {
        $pool = $this->pool = Yii::createObject(Pool::class);
        $pool->autoload(__DIR__ . '/RuntimeAutoload.php');

        parent::__construct($config);
    }

    /**
     * Execute async task.
     *
     * @param callable|\Spatie\Async\Task|Task $callable need to execute.
     * @param array $callbacks event. Have key is an event name, value is a callable triggered when event happen,
     * have three events `error`, `success`, `timeout`.
     * @return static
     * @throws \yii\base\InvalidConfigException
     */
    public function run($callable, array $callbacks = []): self
    {
        $task = Yii::createObject([
            'class' => ChildRuntimeTask::class,
            'app' => Yii::$app,
            'callable' => $callable
        ]);
        $process = $this
            ->pool
            ->add($task)
            ->then([$this, 'success'])
            ->catch([$this, 'error'])
            ->timeout([$this, 'timeout']);

        foreach ($callbacks as $name => $callback) {

            switch (strtolower($name)) {
                case 'timeout':
                    $process->timeout($callback);
                    break;
                case 'success':
                    $process->then($callback);
                    break;
                case 'error':
                case 'catch':
                    $process->catch($callback);
                    break;
                default:
                    break;
            }

        }

        return $this;
    }

    /**
     * This method is called when task executed success.
     * When overriding this method, make sure you call the parent implementation to ensure the
     * event is triggered.
     *
     * @param mixed $output of task executed.
     * @throws \yii\base\InvalidConfigException
     */
    public function success($output): void
    {
        $event = Yii::createObject([
            'class' => SuccessEvent::class,
            'output' => $output
        ]);

        $this->trigger(self::EVENT_SUCCESS, $event);
    }

    /**
     * This method is called when task executed error.
     * When overriding this method, make sure you call the parent implementation to ensure the
     * event is triggered.
     *
     * @param Throwable $throwable when executing task.
     * @throws \yii\base\InvalidConfigException
     */
    public function error(Throwable $throwable): void
    {
        $event = Yii::createObject([
            'class' => ErrorEvent::class,
            'throwable' => $throwable
        ]);

        $this->trigger(self::EVENT_ERROR, $event);
    }

    /**
     * This method is called when task executed timeout.
     * When overriding this method, make sure you call the parent implementation to ensure the
     * event is triggered.
     *
     * @throws \yii\base\InvalidConfigException
     */
    public function timeout(): void
    {
        $event = Yii::createObject(Event::class);

        $this->trigger(self::EVENT_TIMEOUT, $event);
    }

    /**
     * Wait until all tasks done.
     */
    public function wait(): void
    {
        $this->pool->wait();
    }

    /**
     * Set concurrency process do tasks.
     *
     * @param int $concurrency
     */
    public function setConcurrency(int $concurrency): void
    {
        $this->pool->concurrency($concurrency);
    }

    /**
     * Set timeout of task when execute.
     *
     * @param int $timeout
     */
    public function setTimeout(int $timeout): void
    {
        $this->pool->timeout($timeout);
    }

    /**
     * Set sleep time when wait tasks execute.
     *
     * @param int $sleepTimeWait
     */
    public function setSleepTimeWait(int $sleepTimeWait): void
    {
        $this->pool->sleepTime($sleepTimeWait);
    }

    /**
     * Set autoload for environment tasks execute.
     * @param string $autoload
     */
    public function setAutoload(string $autoload): void
    {
        $this->pool->autoload(Yii::getAlias($autoload));

    }

}


1			<?php
2			/**
3			* @link https://github.com/vuongxuongminh/yii2-async
4			* @copyright Copyright (c) 2019 Vuong Xuong Minh
5			* @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
6			*/
7
8			namespace vxm\async;
9
10			use Yii;
11			use Throwable;
12
13			use yii\base\Component;
14
15			use Spatie\Async\Pool;
16
17			/**
18			* Support run code async. To use it, you just config it to your application components in configure file:
19			*
20			* ```php
21			* 'components' => [
22			* 'async' => 'vxm\async\Async'
23			* ]
24			*
25			* ```
26			*
27			* And after that you can run an async code:
28			*
29			* ```php
30			*
31			* Yii::$app->async->run(function () {
32			*
33			* sleep(15);
34			* });
35			*
36			* ```
37			*
38			* If you want to wait until task done, you just to call [[wait]].
39			*
40			* ```php
41			*
42			* Yii::$app->async->run(function () {
43			*
44			* sleep(15);
45			* })->wait();
46			*
47			* ```
48			*
49			* Run multi tasks:
50			*
51			* ```php
52			*
53			* Yii::$app->async->run(function () {
54			*
55			* sleep(15);
56			* });
57			*
58			* Yii::$app->async->run(function () {
59			*
60			* sleep(15);
61			* });
62			*
63			* Yii::$app->async->wait(); // sleep 30s
64			* ```
65			*
66			* @property string $autoload path of autoload file for runtime task execute environment.
67			* @property int $sleepTimeWait time to sleep on wait tasks execute.
68			* @property int $concurrency tasks executable.
69			* @property int $timeout of task executable.
70			*
71			* @author Vuong Minh <[email protected]>
72			* @since 1.0.0
73			*/
74			class Async extends Component
75			{
76
77			/**
78			* @event SuccessEvent an event that is triggered when task done.
79			*/
80			const EVENT_SUCCESS = 'success';
81
82			/**
83			* @event ErrorEvent an event that is triggered when task error.
84			*/
85			const EVENT_ERROR = 'error';
86
87			/**
88			* @event \yii\base\Event an event that is triggered when task timeout.
89			*/
90			const EVENT_TIMEOUT = 'timeout';
91
92			/**
93			* @var Pool handling tasks.
94			*/
95			protected $pool;
96
97			/**
98			* Async constructor.
99			*
100			* @param array $config
101			* @throws \yii\base\InvalidConfigException
102			*/
103			public function __construct($config = [])
104			{
105			$pool = $this->pool = Yii::createObject(Pool::class);
106			$pool->autoload(__DIR__ . '/RuntimeAutoload.php');
107
108			parent::__construct($config);
109			}
110
111			/**
112			* Execute async task.
113			*
114			* @param callable\|\Spatie\Async\Task\|Task $callable need to execute.
115			* @param array $callbacks event. Have key is an event name, value is a callable triggered when event happen,
116			* have three events `error`, `success`, `timeout`.
117			* @return static
118			* @throws \yii\base\InvalidConfigException
119			*/
120			public function run($callable, array $callbacks = []): self
121			{
122			$task = Yii::createObject([
123			'class' => ChildRuntimeTask::class,
124			'app' => Yii::$app,
125			'callable' => $callable
126			]);
127			$process = $this
128			->pool
129			->add($task)
130			->then([$this, 'success'])
131			->catch([$this, 'error'])
132			->timeout([$this, 'timeout']);
133
134			foreach ($callbacks as $name => $callback) {
135
136			switch (strtolower($name)) {
137			case 'timeout':
138			$process->timeout($callback);
139			break;
140			case 'success':
141			$process->then($callback);
142			break;
143			case 'error':
144			case 'catch':
145			$process->catch($callback);
146			break;
147			default:
148			break;
149			}
150
151			}
152
153			return $this;
154			}
155
156			/**
157			* This method is called when task executed success.
158			* When overriding this method, make sure you call the parent implementation to ensure the
159			* event is triggered.
160			*
161			* @param mixed $output of task executed.
162			* @throws \yii\base\InvalidConfigException
163			*/
164			public function success($output): void
165			{
166			$event = Yii::createObject([
167			'class' => SuccessEvent::class,
168			'output' => $output
169			]);
170
171			$this->trigger(self::EVENT_SUCCESS, $event);
172			}
173
174			/**
175			* This method is called when task executed error.
176			* When overriding this method, make sure you call the parent implementation to ensure the
177			* event is triggered.
178			*
179			* @param Throwable $throwable when executing task.
180			* @throws \yii\base\InvalidConfigException
181			*/
182			public function error(Throwable $throwable): void
183			{
184			$event = Yii::createObject([
185			'class' => ErrorEvent::class,
186			'throwable' => $throwable
187			]);
188
189			$this->trigger(self::EVENT_ERROR, $event);
190			}
191
192			/**
193			* This method is called when task executed timeout.
194			* When overriding this method, make sure you call the parent implementation to ensure the
195			* event is triggered.
196			*
197			* @throws \yii\base\InvalidConfigException
198			*/
199			public function timeout(): void
200			{
201			$event = Yii::createObject(Event::class);
202
203			$this->trigger(self::EVENT_TIMEOUT, $event);
204			}
205
206			/**
207			* Wait until all tasks done.
208			*/
209			public function wait(): void
210			{
211			$this->pool->wait();
212			}
213
214			/**
215			* Set concurrency process do tasks.
216			*
217			* @param int $concurrency
218			*/
219			public function setConcurrency(int $concurrency): void
220			{
221			$this->pool->concurrency($concurrency);
222			}
223
224			/**
225			* Set timeout of task when execute.
226			*
227			* @param int $timeout
228			*/
229			public function setTimeout(int $timeout): void
230			{
231			$this->pool->timeout($timeout);
232			}
233
234			/**
235			* Set sleep time when wait tasks execute.
236			*
237			* @param int $sleepTimeWait
238			*/
239			public function setSleepTimeWait(int $sleepTimeWait): void
240			{
241			$this->pool->sleepTime($sleepTimeWait);
242			}
243
244			/**
245			* Set autoload for environment tasks execute.
246			* @param string $autoload
247			*/
248			public function setAutoload(string $autoload): void
249			{
250			$this->pool->autoload(Yii::getAlias($autoload));
			0 ignored issues – show Bug introduced 2019-05-05 06:20 UTC by Report Bug Copy Issue Report It seems like `\Yii::getAlias($autoload)` targeting `yii\BaseYii::getAlias()` can also be of type `boolean`; however, `Spatie\Async\Pool::autoload()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
251			}
252
253			}
254

vuongxuongminh / yii2-async

Push — master ( 5ab19a...634a5b )

Async::wait() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like