vuongxuongminh / yii2-async

src/Async.php

<?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 Closure;
use Throwable;

use yii\base\Component;

use Spatie\Async\Process\Runnable;

use vxm\async\event\Event;
use vxm\async\event\ErrorEvent;
use vxm\async\event\SuccessEvent;
use vxm\async\runtime\ParentRuntime;

/**
 * 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(5);
 * });
 *
 * ```
 *
 * If you want to wait until task done, you just to call [[wait]].
 *
 * ```php
 *
 * Yii::$app->async->run(function () {
 *
 *      sleep(5);
 * })->wait();
 *
 * ```
 *
 * Run multi tasks:
 *
 * ```php
 *
 * Yii::$app->async->run(function () {
 *
 *      sleep(5);
 * });
 *
 * Yii::$app->async->run(function () {
 *
 *      sleep(5);
 * });
 *
 * Yii::$app->async->wait();
 * ```
 *
 * @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 <vuongxuongminh@gmail.com>
 * @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;

    /**
     * @var string a file config of an application run in child process.
     * Note: If an autoload file's set, it will not affect, you need to invoke an app in your autoload if needed.
     */
    protected $appConfigFile;

    /**
     * Async constructor.
     *
     * @param array $config
     * @throws \yii\base\InvalidConfigException
     */
    public function __construct($config = [])
    {
        $pool = $this->pool = Yii::createObject(Pool::class);
        $pool->autoload(__DIR__ . '/runtime/AutoloadRuntime.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
     */
    public function run($callable, array $callbacks = []): self
    {
        $process = $this->createProcess($callable);
        $this->registerProcessEvents($callbacks, $process);
        $this->registerProcessGlobalEvents($process);
        $this->pool->add($process);

$process is of type object<Spatie\Async\Process\Runnable>, but the function expects a callable.

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

    /**
     * Register events to process given.
     *
     * @param array $events register to process given.
     * @param Runnable $process need to add events.
     * @since 1.0.3
     */
    protected function registerProcessEvents(array $events, Runnable $process): void
    {
        foreach ($events as $event => $callable) {
            switch (strtolower($event)) {
                case 'success':
                    $process->then(Closure::fromCallable($callable));
                    break;
                case 'error':
                case 'catch':
                    $process->catch(Closure::fromCallable($callable));
                    break;
                case 'timeout':
                    $process->timeout(Closure::fromCallable($callable));
                    break;
                default:
                    break;
            }
        }
    }

    /**
     * Register global events to process given.
     *
     * @param Runnable $process need to add global events.
     */
    protected function registerProcessGlobalEvents(Runnable $process): void
    {
        $process->then(Closure::fromCallable([$this, 'success']));
        $process->catch(Closure::fromCallable([$this, 'error']));
        $process->timeout(Closure::fromCallable([$this, 'timeout']));
    }

    /**
     * Wait until all tasks done.
     *
     * @since 1.0.3 return results of async processes.
     */
    public function wait()
    {
        $results = $this->pool->wait();
        $this->pool->flush();

        return $results;
    }

    /**
     * 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 it can use at an alias.
     */
    public function setAutoload(string $autoload): void
    {
        $this->pool->autoload(Yii::getAlias($autoload));

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?

    }

    /**
     * Set an application config file for invoke in child runtime process.
     *
     * @param string $appConfigFile it can use at an alias.
     */
    public function setAppConfigFile(string $appConfigFile): void
    {
        $this->appConfigFile = Yii::getAlias($appConfigFile);

It seems like \Yii::getAlias($appConfigFile) can also be of type boolean. However, the property $appConfigFile is declared as type string. Maybe add an additional type check?

    }

    /**
     * Create an async process.
     *
     * @param callable|\Spatie\Async\Task|Task $callable need to execute.
     * @return Runnable process.
     */
    protected function createProcess($callable): Runnable
    {
        return ParentRuntime::createProcess([$callable, $this->appConfigFile]);
    }

}