QueueWorkBatchCommand::gatherWorkerOptions() - Code Metrics - Inspection of "Fix #27, queue should run" - lukewaite/laravel-queue-aws-batch - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

by Luke

created 2017-04-14 01:25 UTC

QueueWorkBatchCommand::gatherWorkerOptions() A

↳ Parent: QueueWorkBatchCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	8
ccs	0
cts	6
cp	0
rs	9.4285
cc	1
eloc	5
nc	1
nop	0
crap	2

<?php
/**
 * Laravel Queue for AWS Batch.
 *
 * @author    Luke Waite <[email protected]>
 * @copyright 2017 Luke Waite
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 *
 * @link      https://github.com/lukewaite/laravel-queue-aws-batch
 */

namespace LukeWaite\LaravelQueueAwsBatch\Console;

use Illuminate\Console\Command;
use Illuminate\Foundation\Exceptions\Handler;
use Illuminate\Queue\Console\WorkCommand;
use Illuminate\Queue\QueueManager;
use Illuminate\Queue\Worker;
use Illuminate\Queue\WorkerOptions;
use LukeWaite\LaravelQueueAwsBatch\Exceptions\JobNotFoundException;
use LukeWaite\LaravelQueueAwsBatch\Exceptions\UnsupportedException;
use LukeWaite\LaravelQueueAwsBatch\Queues\BatchQueue;
use Symfony\Component\Debug\Exception\FatalThrowableError;

class QueueWorkBatchCommand extends WorkCommand
{
    protected $name = 'queue:work-batch';

    protected $description = 'Run a Job for the AWS Batch queue';

//    protected $signature = 'queue:work-batch {connection} {job_id} {--tries=}';

    protected $signature = 'queue:work-batch
                            {job_id : The job id in the database}
                            {connection? : The name of the queue connection to work}
                            {--memory=128 : The memory limit in megabytes}
                            {--timeout=60 : The number of seconds a child process can run}
                            {--tries=0 : Number of times to attempt a job before logging it failed}';


    protected $manager;
    protected $exceptions;

    public function __construct(QueueManager $manager, Worker $worker, Handler $exceptions)
    {
        parent::__construct($worker);
        $this->manager = $manager;
        $this->exceptions = $exceptions;
    }

    public function fire()
    {
        $this->listenForEvents();

        try {
            $this->runJob();
        } catch (\Exception $e) {
            $this->exceptions->report($e);
            throw $e;
        } catch (\Throwable $e) {

            $this->exceptions->report(new FatalThrowableError($e));
            throw $e;
        }
    }

    // TOOD: Refactor out the logic here into an extension of the Worker class
    protected function runJob()
    {
        $connectionName = $this->argument('connection');
        $jobId = $this->argument('job_id');

        /** @var BatchQueue $connection */
        $connection = $this->manager->connection($connectionName);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        if (!$connection instanceof BatchQueue) {
            throw new UnsupportedException('queue:work-batch can only be run on batch queues');
        }

        $job = $connection->getJobById($jobId, $connectionName);


        // If we're able to pull a job off of the stack, we will process it and
        // then immediately return back out.
        if (!is_null($job)) {
            return $this->worker->process(
                $this->manager->getName($connectionName),
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $job,
                $this->gatherWorkerOptions()
            );
        }

        // If we hit this point, we haven't processed our job
        throw new JobNotFoundException('No job was returned');
    }

    /**
     * Gather all of the queue worker options as a single object.
     *
     * @return \Illuminate\Queue\WorkerOptions
     */
    protected function gatherWorkerOptions()
    {
        return new WorkerOptions(
            0, $this->option('memory'),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->option('timeout'), 0,
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->option('tries'), false
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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


1			<?php
2			/**
3			* Laravel Queue for AWS Batch.
4			*
5			* @author Luke Waite <[email protected]>
6			* @copyright 2017 Luke Waite
7			* @license http://www.opensource.org/licenses/mit-license.php MIT
8			*
9			* @link https://github.com/lukewaite/laravel-queue-aws-batch
10			*/
11
12			namespace LukeWaite\LaravelQueueAwsBatch\Console;
13
14			use Illuminate\Console\Command;
15			use Illuminate\Foundation\Exceptions\Handler;
16			use Illuminate\Queue\Console\WorkCommand;
17			use Illuminate\Queue\QueueManager;
18			use Illuminate\Queue\Worker;
19			use Illuminate\Queue\WorkerOptions;
20			use LukeWaite\LaravelQueueAwsBatch\Exceptions\JobNotFoundException;
21			use LukeWaite\LaravelQueueAwsBatch\Exceptions\UnsupportedException;
22			use LukeWaite\LaravelQueueAwsBatch\Queues\BatchQueue;
23			use Symfony\Component\Debug\Exception\FatalThrowableError;
24
25			class QueueWorkBatchCommand extends WorkCommand
26			{
27			protected $name = 'queue:work-batch';
28
29			protected $description = 'Run a Job for the AWS Batch queue';
30
31			// protected $signature = 'queue:work-batch {connection} {job_id} {--tries=}';
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-04-14 01:27 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
32			protected $signature = 'queue:work-batch
33			{job_id : The job id in the database}
34			{connection? : The name of the queue connection to work}
35			{--memory=128 : The memory limit in megabytes}
36			{--timeout=60 : The number of seconds a child process can run}
37			{--tries=0 : Number of times to attempt a job before logging it failed}';
38
39
40			protected $manager;
41			protected $exceptions;
42
43			public function __construct(QueueManager $manager, Worker $worker, Handler $exceptions)
44			{
45			parent::__construct($worker);
46			$this->manager = $manager;
47			$this->exceptions = $exceptions;
48			}
49
50			public function fire()
51			{
52			$this->listenForEvents();
53
54			try {
55			$this->runJob();
56			} catch (\Exception $e) {
57			$this->exceptions->report($e);
58			throw $e;
59			} catch (\Throwable $e) {
			0 ignored issues – show Bug introduced 2017-04-08 00:31 UTC by Report Bug Copy Issue Report The class `Throwable` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
60			$this->exceptions->report(new FatalThrowableError($e));
61			throw $e;
62			}
63			}
64
65			// TOOD: Refactor out the logic here into an extension of the Worker class
66			protected function runJob()
67			{
68			$connectionName = $this->argument('connection');
69			$jobId = $this->argument('job_id');
70
71			/** @var BatchQueue $connection */
72			$connection = $this->manager->connection($connectionName);
			0 ignored issues – show Bug introduced 2017-04-08 00:31 UTC by Report Bug Copy Issue Report It seems like `$connectionName` defined by `$this->argument('connection')` on line `68` can also be of type `array`; however, `Illuminate\Queue\QueueManager::connection()` does only seem to accept `string\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
73
74			if (!$connection instanceof BatchQueue) {
75			throw new UnsupportedException('queue:work-batch can only be run on batch queues');
76			}
77
78			$job = $connection->getJobById($jobId, $connectionName);
			0 ignored issues – show Unused Code introduced 2017-04-14 01:27 UTC by Report Bug Copy Issue Report The call to `BatchQueue::getJobById()` has too many arguments starting with `$connectionName`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
79
80			// If we're able to pull a job off of the stack, we will process it and
81			// then immediately return back out.
82			if (!is_null($job)) {
83			return $this->worker->process(
84			$this->manager->getName($connectionName),
			0 ignored issues – show Bug introduced 2017-04-08 00:31 UTC by Report Bug Copy Issue Report It seems like `$connectionName` defined by `$this->argument('connection')` on line `68` can also be of type `array`; however, `Illuminate\Queue\QueueManager::getName()` does only seem to accept `string\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
85			$job,
86			$this->gatherWorkerOptions()
87			);
88			}
89
90			// If we hit this point, we haven't processed our job
91			throw new JobNotFoundException('No job was returned');
92			}
93
94			/**
95			* Gather all of the queue worker options as a single object.
96			*
97			* @return \Illuminate\Queue\WorkerOptions
98			*/
99			protected function gatherWorkerOptions()
100			{
101			return new WorkerOptions(
102			0, $this->option('memory'),
			0 ignored issues – show Documentation introduced 2017-04-14 01:27 UTC by Report Bug Copy Issue Report `$this->option('memory')` is of type `string\|array`, but the function expects a `integer`. 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...
103			$this->option('timeout'), 0,
			0 ignored issues – show Documentation introduced 2017-04-14 01:27 UTC by Report Bug Copy Issue Report `$this->option('timeout')` is of type `string\|array`, but the function expects a `integer`. 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...
104			$this->option('tries'), false
			0 ignored issues – show Documentation introduced 2017-04-14 01:27 UTC by Report Bug Copy Issue Report `$this->option('tries')` is of type `string\|array`, but the function expects a `integer`. 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...
105			);
106			}
107			}
108

lukewaite / laravel-queue-aws-batch

Pull Request — master (#28)

QueueWorkBatchCommand::gatherWorkerOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like