Oefenweb / cakephp-queue

src/Queue/Config.php

Indentation +56 added lines, -56 removed lines

@@ -6,66 +6,66 @@
 class Config
 {
 
-    /**
-     *
-     * @return int
-     */
-    public static function defaultWorkerTimeout()
-    {
-        return Configure::read('Queue.defaultWorkerTimeout', 600); // 10min
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function defaultWorkerTimeout()
+	{
+		return Configure::read('Queue.defaultWorkerTimeout', 600); // 10min
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function workerMaxRuntime()
-    {
-        return Configure::read('Queue.workerMaxRuntime', 120);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function workerMaxRuntime()
+	{
+		return Configure::read('Queue.workerMaxRuntime', 120);
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function cleanupTimeout()
-    {
-        return Configure::read('Queue.cleanupTimeout', 2592000); // 30 days
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function cleanupTimeout()
+	{
+		return Configure::read('Queue.cleanupTimeout', 2592000); // 30 days
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function sleepTime()
-    {
-        return Configure::read('Queue.sleepTime', 10);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function sleepTime()
+	{
+		return Configure::read('Queue.sleepTime', 10);
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function gcprob()
-    {
-        return Configure::read('Queue.gcprob', 10);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function gcprob()
+	{
+		return Configure::read('Queue.gcprob', 10);
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function defaultWorkerRetries()
-    {
-        return Configure::read('Queue.defaultWorkerRetries', 1);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function defaultWorkerRetries()
+	{
+		return Configure::read('Queue.defaultWorkerRetries', 1);
+	}
 
-    /**
-     *
-     * @return int
-     */
-    public static function maxWorkers()
-    {
-        return Configure::read('Queue.maxWorkers', 1);
-    }
+	/**
+	 *
+	 * @return int
+	 */
+	public static function maxWorkers()
+	{
+		return Configure::read('Queue.maxWorkers', 1);
+	}
 }

src/Shell/Task/AddInterface.php

Indentation +8 added lines, -8 removed lines

@@ -10,12 +10,12 @@
 interface AddInterface
 {
 
-    /**
-     * Allows adding a task to the queue.
-     *
-     * Will create one example task in the queue, which later will be executed using run().
-     *
-     * @return void
-     */
-    public function add(): void;
+	/**
+	 * Allows adding a task to the queue.
+	 *
+	 * Will create one example task in the queue, which later will be executed using run().
+	 *
+	 * @return void
+	 */
+	public function add(): void;
 }

src/Model/Entity/QueuedTask.php

Indentation +17 added lines, -17 removed lines

@@ -20,21 +20,21 @@
 class QueuedTask extends Entity
 {
 
-    /**
-     *
-     * {@inheritdoc}
-     *
-     * @var array
-     */
-    protected $_accessible = [
-        'task' => true,
-        'data' => true,
-        'not_before' => true,
-        'fetched' => true,
-        'completed' => true,
-        'failed_count' => true,
-        'failure_message' => true,
-        'worker_key' => true,
-        'created' => true
-    ];
+	/**
+	 *
+	 * {@inheritdoc}
+	 *
+	 * @var array
+	 */
+	protected $_accessible = [
+		'task' => true,
+		'data' => true,
+		'not_before' => true,
+		'fetched' => true,
+		'completed' => true,
+		'failed_count' => true,
+		'failure_message' => true,
+		'worker_key' => true,
+		'created' => true
+	];
 }

tests/config/app_queue.php

Indentation +10 added lines, -10 removed lines

@@ -1,18 +1,18 @@
 <?php
 
 return [
-    'Queue' => [
-        // time (in seconds) after which a job is requeued if the worker doesn't report back
-        'defaultWorkerTimeout' => 1800,
+	'Queue' => [
+		// time (in seconds) after which a job is requeued if the worker doesn't report back
+		'defaultWorkerTimeout' => 1800,
 
-        // seconds of running time after which the worker will terminate (0 = unlimited)
-        'workerMaxRuntime' => 120,
+		// seconds of running time after which the worker will terminate (0 = unlimited)
+		'workerMaxRuntime' => 120,
 
-        // minimum time (in seconds) which a task remains in the database before being cleaned up.
-        'cleanupTimeout' => 2592000, // 30 days
+		// minimum time (in seconds) which a task remains in the database before being cleaned up.
+		'cleanupTimeout' => 2592000, // 30 days
 
-        /* Optional */
+		/* Optional */
 
-        'isSearchEnabled' => true,
-    ],
+		'isSearchEnabled' => true,
+	],
 ];

src/Queue/TaskFinder.php

Indentation +68 added lines, -68 removed lines

@@ -8,80 +8,80 @@
 class TaskFinder
 {
 
-    /**
-     *
-     * @var array|null
-     */
-    protected $tasks;
+	/**
+	 *
+	 * @var array|null
+	 */
+	protected $tasks;
 
-    /**
-     * Returns all possible Queue tasks.
-     *
-     * Makes sure that app tasks are prioritized over plugin ones.
-     *
-     * @return array
-     */
-    public function allAppAndPluginTasks()
-    {
-        if ($this->tasks !== null) {
-            return $this->tasks;
-        }
+	/**
+	 * Returns all possible Queue tasks.
+	 *
+	 * Makes sure that app tasks are prioritized over plugin ones.
+	 *
+	 * @return array
+	 */
+	public function allAppAndPluginTasks()
+	{
+		if ($this->tasks !== null) {
+			return $this->tasks;
+		}
 
-        $paths = App::path('Shell/Task');
-        $this->tasks = [];
+		$paths = App::path('Shell/Task');
+		$this->tasks = [];
 
-        foreach ($paths as $path) {
-            $Folder = new Folder($path);
-            $this->tasks = $this->getAppPaths($Folder);
-        }
-        $plugins = Plugin::loaded();
-        foreach ($plugins as $plugin) {
-            $pluginPaths = App::path('Shell/Task', $plugin);
-            foreach ($pluginPaths as $pluginPath) {
-                $Folder = new Folder($pluginPath);
-                $pluginTasks = $this->getPluginPaths($Folder, $plugin);
-                $this->tasks = array_merge($this->tasks, $pluginTasks);
-            }
-        }
+		foreach ($paths as $path) {
+			$Folder = new Folder($path);
+			$this->tasks = $this->getAppPaths($Folder);
+		}
+		$plugins = Plugin::loaded();
+		foreach ($plugins as $plugin) {
+			$pluginPaths = App::path('Shell/Task', $plugin);
+			foreach ($pluginPaths as $pluginPath) {
+				$Folder = new Folder($pluginPath);
+				$pluginTasks = $this->getPluginPaths($Folder, $plugin);
+				$this->tasks = array_merge($this->tasks, $pluginTasks);
+			}
+		}
 
-        return $this->tasks;
-    }
+		return $this->tasks;
+	}
 
-    /**
-     *
-     * @param \Cake\Filesystem\Folder $Folder The directory
-     *
-     * @return array
-     */
-    protected function getAppPaths(Folder $Folder)
-    {
-        $res = array_merge($this->tasks, $Folder->find('Queue.+\.php'));
-        foreach ($res as &$r) {
-            $r = basename($r, 'Task.php');
-        }
+	/**
+	 *
+	 * @param \Cake\Filesystem\Folder $Folder The directory
+	 *
+	 * @return array
+	 */
+	protected function getAppPaths(Folder $Folder)
+	{
+		$res = array_merge($this->tasks, $Folder->find('Queue.+\.php'));
+		foreach ($res as &$r) {
+			$r = basename($r, 'Task.php');
+		}
 
-        return $res;
-    }
+		return $res;
+	}
 
-    /**
-     *
-     * @param \Cake\Filesystem\Folder $Folder The directory
-     * @param string $plugin The plugin name
-     *
-     * @return array
-     */
-    protected function getPluginPaths(Folder $Folder, $plugin)
-    {
-        $res = $Folder->find('Queue.+Task\.php');
-        foreach ($res as $key => $r) {
-            $name = basename($r, 'Task.php');
-            if (in_array($name, $this->tasks)) {
-                unset($res[$key]);
-                continue;
-            }
-            $res[$key] = $plugin . '.' . $name;
-        }
+	/**
+	 *
+	 * @param \Cake\Filesystem\Folder $Folder The directory
+	 * @param string $plugin The plugin name
+	 *
+	 * @return array
+	 */
+	protected function getPluginPaths(Folder $Folder, $plugin)
+	{
+		$res = $Folder->find('Queue.+Task\.php');
+		foreach ($res as $key => $r) {
+			$name = basename($r, 'Task.php');
+			if (in_array($name, $this->tasks)) {
+				unset($res[$key]);
+				continue;
+			}
+			$res[$key] = $plugin . '.' . $name;
+		}
 
-        return $res;
-    }
+		return $res;
+	}
 }

src/Shell/Task/QueueTask.php

Indentation +45 added lines, -45 removed lines

@@ -18,57 +18,57 @@
 abstract class QueueTask extends Shell implements QueueTaskInterface
 {
 
-    /**
-     *
-     * @var string
-     */
-    public $queueModelClass = 'Queue.QueuedTasks';
+	/**
+	 *
+	 * @var string
+	 */
+	public $queueModelClass = 'Queue.QueuedTasks';
 
-    /**
-     *
-     * @var \Queue\Model\Table\QueuedTasksTable
-     */
-    public $QueuedTasks;
+	/**
+	 *
+	 * @var \Queue\Model\Table\QueuedTasksTable
+	 */
+	public $QueuedTasks;
 
-    /**
-     * Timeout for run, after which the Task is reassigned to a new worker.
-     *
-     * @var int
-     */
-    public $timeout = 120;
+	/**
+	 * Timeout for run, after which the Task is reassigned to a new worker.
+	 *
+	 * @var int
+	 */
+	public $timeout = 120;
 
-    /**
-     * Number of times a failed instance of this task should be restarted before giving up.
-     *
-     * @var int
-     */
-    public $retries = 1;
+	/**
+	 * Number of times a failed instance of this task should be restarted before giving up.
+	 *
+	 * @var int
+	 */
+	public $retries = 1;
 
-    /**
-     *
-     * @param \Cake\Console\ConsoleIo|null $io IO
-     */
-    public function __construct(ConsoleIo $io = null)
-    {
-        parent::__construct($io);
+	/**
+	 *
+	 * @param \Cake\Console\ConsoleIo|null $io IO
+	 */
+	public function __construct(ConsoleIo $io = null)
+	{
+		parent::__construct($io);
 
-        $this->loadModel($this->queueModelClass);
-    }
+		$this->loadModel($this->queueModelClass);
+	}
 
-    /**
-     *
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    protected function queueTaskName()
-    {
-        $class = get_class($this);
+	/**
+	 *
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	protected function queueTaskName()
+	{
+		$class = get_class($this);
 
-        preg_match('#\\\\Queue(.+)Task$#', $class, $matches);
-        if (!$matches) {
-            throw new InvalidArgumentException('Invalid class name: ' . $class);
-        }
+		preg_match('#\\\\Queue(.+)Task$#', $class, $matches);
+		if (!$matches) {
+			throw new InvalidArgumentException('Invalid class name: ' . $class);
+		}
 
-        return $matches[1];
-    }
+		return $matches[1];
+	}
 }

src/Shell/Task/QueueExampleTask.php

Indentation +72 added lines, -72 removed lines

@@ -7,82 +7,82 @@
 class QueueExampleTask extends QueueTask implements AddInterface
 {
 
-    /**
-     * Timeout for run, after which the task is reassigned to a new worker.
-     *
-     * @var int
-     */
-    public $timeout = 10;
+	/**
+	 * Timeout for run, after which the task is reassigned to a new worker.
+	 *
+	 * @var int
+	 */
+	public $timeout = 10;
 
-    /**
-     * Timeout for cleanup, after which completed jobs are deleted (in seconds).
-     *
-     * @var int
-     */
-    public $cleanupTimeout = 600;
+	/**
+	 * Timeout for cleanup, after which completed jobs are deleted (in seconds).
+	 *
+	 * @var int
+	 */
+	public $cleanupTimeout = 600;
 
-    /**
-     * Number of times a failed instance of this task should be restarted before giving up.
-     *
-     * @var int
-     */
-    public $retries = 0;
+	/**
+	 * Number of times a failed instance of this task should be restarted before giving up.
+	 *
+	 * @var int
+	 */
+	public $retries = 0;
 
-    /**
-     * Stores any failure messages triggered during run().
-     *
-     * @var string
-     */
-    public $failureMessage = '';
+	/**
+	 * Stores any failure messages triggered during run().
+	 *
+	 * @var string
+	 */
+	public $failureMessage = '';
 
-    /**
-     * Example add functionality.
-     * Will create one example job in the queue, which later will be executed using run();
-     *
-     * To invoke from CLI execute:
-     * - bin/cake queue add Example
-     *
-     * @return void
-     */
-    public function add(): void
-    {
-        $this->out(__d('queue', 'CakePHP Queue Example task.'));
-        $this->hr();
-        $this->out(__d('queue', 'This is a very simple example of a queueTask.'));
-        $this->out(__d('queue', 'Now adding an example Task Job into the Queue.'));
-        $this->out(__d('queue', 'This task will only produce some console output on the worker that it runs on.'));
-        $this->out(' ');
-        $this->out(__d('queue', 'To run a Worker use:'));
-        $this->out(__d('queue', '	cake queue runworker'));
-        $this->out(' ');
-        $this->out(__d('queue', 'You can find the sourcecode of this task in: '));
-        $this->out(__FILE__);
-        $this->out(' ');
+	/**
+	 * Example add functionality.
+	 * Will create one example job in the queue, which later will be executed using run();
+	 *
+	 * To invoke from CLI execute:
+	 * - bin/cake queue add Example
+	 *
+	 * @return void
+	 */
+	public function add(): void
+	{
+		$this->out(__d('queue', 'CakePHP Queue Example task.'));
+		$this->hr();
+		$this->out(__d('queue', 'This is a very simple example of a queueTask.'));
+		$this->out(__d('queue', 'Now adding an example Task Job into the Queue.'));
+		$this->out(__d('queue', 'This task will only produce some console output on the worker that it runs on.'));
+		$this->out(' ');
+		$this->out(__d('queue', 'To run a Worker use:'));
+		$this->out(__d('queue', '	cake queue runworker'));
+		$this->out(' ');
+		$this->out(__d('queue', 'You can find the sourcecode of this task in: '));
+		$this->out(__FILE__);
+		$this->out(' ');
 
-        // Adding a task of type 'example' with no additionally passed data
-        if ($this->QueuedTasks->createJob('Example')) {
-            $this->out(__d('queue', 'OK, job created, now run the worker'));
-        } else {
-            $this->err(__d('queue', 'Could not create Job'));
-        }
-    }
+		// Adding a task of type 'example' with no additionally passed data
+		if ($this->QueuedTasks->createJob('Example')) {
+			$this->out(__d('queue', 'OK, job created, now run the worker'));
+		} else {
+			$this->err(__d('queue', 'Could not create Job'));
+		}
+	}
 
-    /**
-     * Example run function.
-     * This function is executed, when a worker is executing a task.
-     * The return parameter will determine, if the task will be marked completed, or be requeued.
-     *
-     * @param array $data The array passed to QueuedTasksTable::createJob()
-     * @param int $taskId The id of the QueuedTask entity
-     * @return void
-     */
-    public function run(array $data, $taskId): void
-    {
-        $this->hr();
-        $this->out(__d('queue', 'CakePHP Queue Example task.'));
-        $this->hr();
-        $this->out(__d('queue', ' ->Success, the Example Task was run.<-'));
-        $this->out(' ');
-        $this->out(' ');
-    }
+	/**
+	 * Example run function.
+	 * This function is executed, when a worker is executing a task.
+	 * The return parameter will determine, if the task will be marked completed, or be requeued.
+	 *
+	 * @param array $data The array passed to QueuedTasksTable::createJob()
+	 * @param int $taskId The id of the QueuedTask entity
+	 * @return void
+	 */
+	public function run(array $data, $taskId): void
+	{
+		$this->hr();
+		$this->out(__d('queue', 'CakePHP Queue Example task.'));
+		$this->hr();
+		$this->out(__d('queue', ' ->Success, the Example Task was run.<-'));
+		$this->out(' ');
+		$this->out(' ');
+	}
 }

src/Shell/Task/QueueTaskInterface.php

Indentation +8 added lines, -8 removed lines

@@ -13,12 +13,12 @@
 interface QueueTaskInterface
 {
 
-    /**
-     * Main execution of the task.
-     *
-     * @param array $data The array passed to QueuedTasksTable::createJob()
-     * @param int $taskId The id of the QueuedTask entity
-     * @return void
-     */
-    public function run(array $data, $taskId): void;
+	/**
+	 * Main execution of the task.
+	 *
+	 * @param array $data The array passed to QueuedTasksTable::createJob()
+	 * @param int $taskId The id of the QueuedTask entity
+	 * @return void
+	 */
+	public function run(array $data, $taskId): void;
 }

tests/bootstrap.php

Indentation +52 added lines, -52 removed lines

@@ -2,14 +2,14 @@ 
 use Cake\Datasource\ConnectionManager;
 
 if (!defined('DS')) {
-    define('DS', DIRECTORY_SEPARATOR);
+	define('DS', DIRECTORY_SEPARATOR);
 }
 if (!defined('WINDOWS')) {
-    if (DS === '\\' || substr(PHP_OS, 0, 3) === 'WIN') {
-        define('WINDOWS', true);
-    } else {
-        define('WINDOWS', false);
-    }
+	if (DS === '\\' || substr(PHP_OS, 0, 3) === 'WIN') {
+		define('WINDOWS', true);
+	} else {
+		define('WINDOWS', false);
+	}
 }
 
 define('ROOT', dirname(__DIR__));
@@ -32,25 +32,25 @@ 
 require CORE_PATH . 'config/bootstrap.php';
 
 Cake\Core\Configure::write('App', [
-    'namespace' => 'App',
-    'encoding' => 'UTF-8',
-    'paths' => [
-        'templates' => [ROOT . DS . 'tests' . DS . 'test_app' . DS . 'src' . DS . 'Template' . DS],
-    ]
+	'namespace' => 'App',
+	'encoding' => 'UTF-8',
+	'paths' => [
+		'templates' => [ROOT . DS . 'tests' . DS . 'test_app' . DS . 'src' . DS . 'Template' . DS],
+	]
 ]);
 
 Cake\Core\Configure::write('debug', true);
 
 Cake\Core\Configure::write('EmailTransport', [
-    'default' => [
-        'className' => 'Debug',
-    ],
+	'default' => [
+		'className' => 'Debug',
+	],
 ]);
 Cake\Core\Configure::write('Email', [
-    'default' => [
-        'transport' => 'default',
-        'from' => 'you@localhost',
-    ],
+	'default' => [
+		'transport' => 'default',
+		'from' => 'you@localhost',
+	],
 ]);
 
 mb_internal_encoding('UTF-8');
@@ -61,24 +61,24 @@ 
 $Tmp->create(TMP . 'cache/views', 0770);
 
 $cache = [
-    'default' => [
-        'engine' => 'File',
-        'path' => CACHE,
-    ],
-    '_cake_core_' => [
-        'className' => 'File',
-        'prefix' => 'crud_myapp_cake_core_',
-        'path' => CACHE . 'persistent/',
-        'serialize' => true,
-        'duration' => '+10 seconds',
-    ],
-    '_cake_model_' => [
-        'className' => 'File',
-        'prefix' => 'crud_my_app_cake_model_',
-        'path' => CACHE . 'models/',
-        'serialize' => 'File',
-        'duration' => '+10 seconds',
-    ],
+	'default' => [
+		'engine' => 'File',
+		'path' => CACHE,
+	],
+	'_cake_core_' => [
+		'className' => 'File',
+		'prefix' => 'crud_myapp_cake_core_',
+		'path' => CACHE . 'persistent/',
+		'serialize' => true,
+		'duration' => '+10 seconds',
+	],
+	'_cake_model_' => [
+		'className' => 'File',
+		'prefix' => 'crud_my_app_cake_model_',
+		'path' => CACHE . 'models/',
+		'serialize' => 'File',
+		'duration' => '+10 seconds',
+	],
 ];
 
 Cake\Cache\Cache::setConfig($cache);
@@ -86,37 +86,37 @@ 
 Cake\Core\Plugin::getCollection()->add(new \Queue\Plugin());
 
 Cake\Mailer\TransportFactory::setConfig('default', [
-    'className' => 'Debug',
+	'className' => 'Debug',
 ]);
 Cake\Mailer\TransportFactory::setConfig('queue', [
-    'className' => 'Queue.Queue',
+	'className' => 'Queue.Queue',
 ]);
 Cake\Mailer\Email::setConfig('default', [
-    'transport' => 'default',
+	'transport' => 'default',
 ]);
 
 // Allow local overwrite
 // E.g. in your console: export db_dsn="mysql://root:secret@127.0.0.1/cake_test"
 if (!getenv('db_class') && getenv('db_dsn')) {
-    ConnectionManager::setConfig('test', ['url' => getenv('db_dsn')]);
+	ConnectionManager::setConfig('test', ['url' => getenv('db_dsn')]);
 
-    return;
+	return;
 }
 if (!getenv('db_class')) {
-    putenv('db_class=Cake\Database\Driver\Sqlite');
-    putenv('db_dsn=sqlite::memory:');
+	putenv('db_class=Cake\Database\Driver\Sqlite');
+	putenv('db_dsn=sqlite::memory:');
 }
 
 // Uses Travis config then (MySQL, Postgres, ...)
 ConnectionManager::setConfig('test', [
-    'className' => 'Cake\Database\Connection',
-    'driver' => getenv('db_class'),
-    'dsn' => getenv('db_dsn'),
-    'database' => getenv('db_database'),
-    'username' => getenv('db_username'),
-    'password' => getenv('db_password'),
-    'timezone' => 'UTC',
-    'quoteIdentifiers' => true,
-    'cacheMetadata' => true,
+	'className' => 'Cake\Database\Connection',
+	'driver' => getenv('db_class'),
+	'dsn' => getenv('db_dsn'),
+	'database' => getenv('db_database'),
+	'username' => getenv('db_username'),
+	'password' => getenv('db_password'),
+	'timezone' => 'UTC',
+	'quoteIdentifiers' => true,
+	'cacheMetadata' => true,
 
 ]);