QueueShell::getOptionParser() - Code Metrics - Inspection of "Disable GC on exit" - Oefenweb/cakephp-queue - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#44)

by Mischa ter
created 2020-08-17 13:59 UTC
QueueShell::getOptionParser() A

↳ Parent: QueueShell
Complexity

Conditions	1
Paths	1
Size

Total Lines	51
Code Lines	38
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
cc	1
eloc	38
c	2
b	0
f	0
nc	1
nop	0
dl	0
loc	51
rs	9.312
How to fix Long Method

<?php
App::uses('Folder', 'Utility');
App::uses('QueuedTask', 'Model');
App::uses('AppShell', 'Console/Command');
App::uses('CakeText', 'Utility');

declare(ticks = 1);

/**
 * Queue Shell.
 *
 * @property Queue.QueuedTask $QueuedTask
 */

class QueueShell extends AppShell {
filter:
    dependency_paths: ["lib/*"]

/**
 * An array of names of models to load.
 *
 * @var array
 */
	public $uses = ['Queue.QueuedTask'];

/**
 * A list of available queue tasks and their individual configurations.
 *
 * @var array
 */
	protected $_taskConf;

/**
 * Indicates whether or not the worker should exit on next the iteration.
 *
 * @var bool
 */
	private $__exit;

/**
 * Overwrite shell initialize to dynamically load all queue related tasks.
 *
 * @return void
 */
	public function initialize() {
		// Check for tasks inside plugins and application
		$paths = App::path('Console/Command/Task');

		foreach ($paths as $path) {
			$Folder = new Folder($path);
filter:
    dependency_paths: ["lib/*"]
			$res = array_merge($this->tasks, $Folder->find('Queue.*\.php'));
			foreach ($res as &$r) {
				$r = basename($r, 'Task.php');
			}

			$this->tasks = $res;

		}

		$plugins = App::objects('plugin');
		foreach ($plugins as $plugin) {
			$pluginPaths = App::path('Console/Command/Task', $plugin);
			foreach ($pluginPaths as $pluginPath) {
				$Folder = new Folder($pluginPath);
				$res = $Folder->find('Queue.*Task\.php');
				foreach ($res as &$r) {
					$r = $plugin . '.' . basename($r, 'Task.php');
				}

				$this->tasks = array_merge($this->tasks, $res);
			}
		}

		$conf = Configure::read('Queue');
filter:
    dependency_paths: ["lib/*"]
		if (!is_array($conf)) {
			$conf = [];
		}

		// Merge with default configuration vars.
		Configure::write('Queue', array_merge(
				[
					'workers' => 3,
					'sleepTime' => 10,
					'gcprop' => 10,
					'defaultWorkerTimeout' => 2 * MINUTE,

					'defaultWorkerRetries' => 4,
					'workerMaxRuntime' => 0,
					'cleanupTimeout' => DAY,

					'exitWhenNothingToDo' => false,
					'gcOnExit' => true,
				],
				$conf
			)
		);

		parent::initialize();
	}

/**
 * Gets and configures the option parser.
 *
 * @return ConsoleOptionParser
filter:
    dependency_paths: ["lib/*"]
 */
	public function getOptionParser() {
		$parser = parent::getOptionParser();
		$parser->addSubcommand('add', [
			'help' => __d('queue', 'Tries to call the cli `add()` function on a task.'),
			'help' => /** @scrutinizer ignore-call */ __d('queue', 'Tries to call the cli `add()` function on a task.'),
			'parser' => [
				'description' => [
					__d('queue', 'Tries to call the cli `add()` function on a task.'),
					__d('queue', 'Tasks may or may not provide this functionality.')
				],
				'arguments' => [
					'taskname' => [
						'help' => __d('queue', 'Name of the task.'),
						'required' => true,
						'choices' => $this->taskNames
					],
					'taskdata' => [
						'help' => __d('queue', 'Data needed by task.'),
						'required' => false,
					]
				]
			]
		])->addSubcommand('runworker', [
			'help' => __d('queue', 'Run a queue worker.'),
			'parser' => [
				'description' => [__d('queue', 'Run a queue worker, which will look for a pending task it can execute.')],
				'options' => [
					'type' => [
						'short' => 't',
						'help' => 'Type (comma separated list possible)',
						'default' => null
					]
				]
			]
		])->addSubcommand('stats', [
			'help' => __d('queue', 'Display general statistics.'),
			'parser' => [
				'description' => __d('queue', 'Display general statistics.'),
			]
		])->addSubcommand('clean', [
			'help' => __d('queue', 'Manually call cleanup function to delete task data of completed tasks.'),
			'parser' => [
				'description' => __d('queue', 'Manually call cleanup function to delete task data of completed tasks.')
			]
		])->addSubcommand('clean_failed', [
			'help' => __d('queue', 'Manually call cleanup function to delete task data of failed tasks.'),
			'parser' => [
				'description' => __d('queue', 'Manually call cleanup function to delete task data of failed tasks.')
			]
		])->description(__d('queue', 'CakePHP Queue Plugin.'));

		return $parser;
	}

/**
 * Looks for a queue task of the passed name and try to call add() on it.
 *
 *	A queue task may provide an add function to enable the user to create new tasks via commandline.
 *
 * @return void
 */
	public function add() {
		$name = Inflector::camelize($this->args[0]);
filter:
    dependency_paths: ["lib/*"]

		if (in_array($name, $this->taskNames)) {
			$this->{$name}->add();
		} elseif (in_array('Queue' . $name, $this->taskNames)) {
			$this->{'Queue' . $name}->add();
		} else {
			$this->out(__d('queue', 'Error: Task not Found: %s', $name));
			$this->out(/** @scrutinizer ignore-call */ __d('queue', 'Error: Task not Found: %s', $name));
			$this->out('Available Tasks:');
			foreach ($this->taskNames as $loadedTask) {
				$this->out(' * ' . $this->_taskName($loadedTask));
			}
		}
	}

/**
 * Output the task without Queue or Task
 * example: QueueImageTask becomes Image on display
 *
 * @param string $task A task name
 * @return string Cleaned task name
 */
	protected function _taskName($task) {
		if (strpos($task, 'Queue') === 0) {
			return substr($task, 5);
		}

		return $task;
	}

/**
 * Run a queue worker loop.
 *
 *	Runs a queue worker process which will try to find unassigned tasks in the queue
 *	which it may run and try to fetch and execute them.
 *
 * @return void
 */
	public function runworker() {
		// Enable garbage collector (PHP >= 5.3)
		if (function_exists('gc_enable')) {
			gc_enable();
		}

		// Register signal handler(s) if possible
		if (function_exists('pcntl_signal')) {
			pcntl_signal(SIGTERM, [$this, 'signalHandler']);
			pcntl_signal(SIGINT, [$this, 'signalHandler']);
		} else {
			$this->err(__d('queue', 'Signal handler(s) could not be registered.'));
			$this->err(/** @scrutinizer ignore-call */ __d('queue', 'Signal handler(s) could not be registered.'));
		}

		$this->__exit = false;

		$workerStartTime = time();

		$typesParam = $this->param('type');
		$types = is_string($typesParam) ? $this->_stringToArray($typesParam) : [];

		while (!$this->__exit) {
			$this->out(__d('queue', 'Looking for a job.'), 1, Shell::VERBOSE);
filter:
    dependency_paths: ["lib/*"]

			$data = $this->QueuedTask->requestJob($this->_getTaskConf(), $types);
			if ($this->QueuedTask->exit === true) {
				$this->__exit = true;
			} else {
				if ($data !== false) {
					$jobId = $data['id'];
					$taskname = 'Queue' . $data['task'];
					$this->out(__d('queue', 'Running job of task \'%s\' \'%d\'.', $data['task'], $jobId));

					$taskStartTime = time();
					$return = $this->{$taskname}->run(unserialize($data['data']));
					$took = time() - $taskStartTime;
					if ($return) {
						$this->QueuedTask->markJobDone($jobId);
						$this->out(
							__d(
								'queue',
								'Job \'%d\' finished (took %s).',
								$jobId,
								__dn('queue', '%d second', '%d seconds', $took, $took)
        __dn('queue', '%d second', '%d seconds', $took, $took)
							)
						);
					} else {
						$failureMessage = null;
						if (isset($this->{$taskname}->failureMessage) && !empty($this->{$taskname}->failureMessage)) {
							$failureMessage = $this->{$taskname}->failureMessage;
						}
						$this->QueuedTask->markJobFailed($jobId, $failureMessage);
						$this->out(__d('queue', 'Job \'%d\' did not finish, requeued.', $jobId));
					}
				} elseif (Configure::read('Queue.exitWhenNothingToDo')) {
					$this->out(__d('queue', 'Nothing to do, exiting.'));
					$this->__exit = true;
				} else {
					$this->out(
						__d('queue', 'Nothing to do, sleeping for %d second(s).', Configure::read('Queue.sleepTime')),
						1, Shell::VERBOSE
					);

					sleep(Configure::read('Queue.sleepTime'));
				}

				// Check if we are over the maximum runtime and end processing if so.
				if (Configure::read('Queue.workerMaxRuntime') != 0
						&& (time() - $workerStartTime) >= Configure::read('Queue.workerMaxRuntime')
				) {
					$this->__exit = true;
					$this->out(__d('queue',
						'Reached runtime of %s seconds (max. %s), terminating.',
						(time() - $workerStartTime),
						Configure::read('Queue.workerMaxRuntime')
					));
				}

				if (($this->_exit && Configure::read('Queue.gcOnExit')) || rand(0, 100) > (100 - Configure::read('Queue.gcprop'))) {
					$this->out(__d('queue', 'Performing old job cleanup.'));
					$this->QueuedTask->cleanOldJobs($this->_getTaskConf());
				}
			}
		}
	}

/**
 * Triggers manual job cleanup of completed jobs.
 *
 * @return void
 */
	public function clean() {
		$this->out(__d('queue', 'Deleting old completed jobs, that have had cleanup timeout.'));
		$this->out(/** @scrutinizer ignore-call */ __d('queue', 'Deleting old completed jobs, that have had cleanup timeout.'));
		$this->QueuedTask->cleanOldJobs($this->_getTaskConf());
	}

/**
 * Triggers manual job cleanup of failed jobs.
 *
 * @return void
 */
	public function clean_failed() {
		$this->out(__d('queue', 'Deleting failed Jobs, that have had maximum worker retries.'));
		$this->out(/** @scrutinizer ignore-call */ __d('queue', 'Deleting failed Jobs, that have had maximum worker retries.'));
		$this->QueuedTask->cleanFailedJobs($this->_getTaskConf());
	}

/**
 * Displays some statistics about finished Jobs.
 *
 * @return void
 */
	public function stats() {
		$this->hr();
		$this->out(__d('queue', 'Jobs currenty in the queue:'));
		$this->out(/** @scrutinizer ignore-call */ __d('queue', 'Jobs currenty in the queue:'));
		$this->hr();

		$types = $this->QueuedTask->getTypes();
		foreach ($types as $type) {
			$this->out(sprintf('- %s: %s', $type, $this->QueuedTask->getLength($type)));
		}
		$this->out();

		$this->hr();
		$this->out(__d('queue', 'Total unfinished jobs: %s', $this->QueuedTask->getLength()));
		$this->hr();
		$this->out();

		$this->hr();
		$this->out(__d('queue', 'Finished job statistics:'));
		$this->hr();

		$data = $this->QueuedTask->getStats();
		foreach ($data as $item) {
			$this->out(sprintf('- %s: ', $item['QueuedTask']['task']));
			$this->out(sprintf('  - %s', __d('queue', 'Finished jobs in database: %s', $item[0]['num'])));
			$this->out(sprintf('  - %s', __d('queue', 'Average job existence: %ss', $item[0]['alltime'])));
			$this->out(sprintf('  - %s', __d('queue', 'Average execution delay: %ss', $item[0]['fetchdelay'])));
			$this->out(sprintf('  - %s', __d('queue', 'Average execution time: %ss', $item[0]['runtime'])));
			$this->out();
		}
	}

/**
 * Returns a list of available queue tasks and their individual configurations.
 *
 * @return array A list of available queue tasks and their individual configurations
 */
	protected function _getTaskConf() {
		if (!is_array($this->_taskConf)) {

			$this->_taskConf = [];
			foreach ($this->tasks as $task) {
				list($pluginName, $taskName) = pluginSplit($task);
				list($pluginName, $taskName) = /** @scrutinizer ignore-call */ pluginSplit($task);

				$this->_taskConf[$taskName]['name'] = substr($taskName, 5);
				$this->_taskConf[$taskName]['plugin'] = $pluginName;

				if (property_exists($this->{$taskName}, 'timeout')) {
					$this->_taskConf[$taskName]['timeout'] = $this->{$taskName}->timeout;
				} else {
					$this->_taskConf[$taskName]['timeout'] = Configure::read('Queue.defaultWorkerTimeout');
				}
				if (property_exists($this->{$taskName}, 'retries')) {
					$this->_taskConf[$taskName]['retries'] = $this->{$taskName}->retries;
				} else {
					$this->_taskConf[$taskName]['retries'] = Configure::read('Queue.defaultWorkerRetries');
				}
				if (property_exists($this->{$taskName}, 'cleanupTimeout')) {
					$this->_taskConf[$taskName]['cleanupTimeout'] = $this->{$taskName}->cleanupTimeout;
				} else {
					$this->_taskConf[$taskName]['cleanupTimeout'] = Configure::read('Queue.cleanupTimeout');
				}
			}
		}

		return $this->_taskConf;
	}

/**
 * Signal handler (for SIGTERM and SIGINT signal)
 *
 * @param int $signalNumber A signal number
 * @return void
 */
	public function signalHandler($signalNumber) {
		switch($signalNumber) {
			case SIGTERM:
				$this->out(__d('queue', 'Caught %s signal, exiting.', sprintf('SIGTERM (%d)', SIGTERM)));
				$this->out(/** @scrutinizer ignore-call */ __d('queue', 'Caught %s signal, exiting.', sprintf('SIGTERM (%d)', SIGTERM)));

				$this->__exit = true;
				break;
			case SIGINT:
				$this->out(__d('queue', 'Caught %s signal, exiting.', sprintf('SIGINT (%d)', SIGINT)));

				$this->__exit = true;
				break;
		}
	}

/**
 * Converts string to array
 *
 * @param string|null $param String to convert
 * @return array
 */
	protected function _stringToArray(string $param = null) : array {
		if (!$param) {
			return [];
		}

		$array = CakeText::tokenize($param);
filter:
    dependency_paths: ["lib/*"]
		if (is_string($array)) {
			return [
				$array
			];
		}

		return array_filter($array);
	}

}

Oefenweb / cakephp-queue

Pull Request — master (#44)

QueueShell::getOptionParser() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
