Adding phan check, fixing CS issues

Author: Philo Hamel

.phan/config.php

@@ -30,6 +30,9 @@ matrix:
     - php: 7.1
       env:
         - PHP_STAN=1
+    - php: 7.1
+      env:
+        - PHP_PHAN=1
     - php: 7.1
       env:
         - PHP_COVERAGE=1

.travis.yml

@@ -19,6 +19,8 @@ elif [ "${PHP_MD}" = '1' ]; then
     exit 0;
 elif [ "${PHP_STAN}" = '1' ]; then
     exit 0;
+elif [ "${PHP_PHAN}" = '1' ]; then
+    exit 0;
 fi
 
 composer require "cakephp/cakephp:${CAKE_VERSION}"  --dev --no-ansi --no-progress --no-interaction;

.travis/before-script.sh

@@ -31,7 +31,9 @@ elif [ "${PHP_MD}" = '1' ]; then
 
     vendor/bin/phpmd . text phpmd.xml --suffixes php --exclude "${excludePathsJoined}" || true;
 elif [ "${PHP_STAN}" = '1' ]; then
-	vendor/bin/phpstan analyse -c phpstan.neon -l 5 src/
+	vendor/bin/phpstan analyse -c phpstan.neon -l 5 src/;
+elif [ "${PHP_PHAN}" = '1' ]; then
+	vendor/bin/phan;
 elif [ "${PHP_COVERAGE}" = '1' ]; then
     vendor/bin/phpunit --coverage-clover=clover.xml;
 else

.travis/script.sh

@@ -24,7 +24,8 @@
 		"phpunit/phpunit": "^5.7.14|^6.0",
 		"psy/psysh": "@stable",
 		"sebastian/phpcpd": "^3.0",
-		"dereuromark/cakephp-tools": "^1.9"
+		"dereuromark/cakephp-tools": "^1.9",
+		"phan/phan": "^1.3"
 	},
 	"support": {
 		"issues": "https://github.com/Oefenweb/cakephp-queue/issues",

composer.json

@@ -85,7 +85,7 @@ public function beforeMarshal(Event $event, ArrayObject $data, ArrayObject $opti
      *
      * @param string $taskName Task name
      * @param array|null $data Array of data
-     * @param string $notBefore A datetime which indicates when the job may be executed
+     * @param string|null $notBefore A datetime which indicates when the job may be executed
      * @return \Queue\Model\Entity\QueuedTask Saved job entity
      */
     public function createJob($taskName, array $data = null, string $notBefore = null)
@@ -157,7 +157,7 @@ public function getStats()
     {
         $driverName = $this->_getDriverName();
         $options = [
-            'fields' => function (Query $query) use ($driverName) {
+            'fields' => function (Query $query) use ($driverName): array {
                 $alltime = $query->func()->avg('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(created)');
                 $runtime = $query->func()->avg('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(fetched)');
                 $fetchdelay = $query->func()->avg('UNIX_TIMESTAMP(fetched) - IF(not_before is NULL, UNIX_TIMESTAMP(created), UNIX_TIMESTAMP(not_before))');
@@ -205,7 +205,7 @@ public function getStats()
     public function getFullStats($taskName = null)
     {
         $driverName = $this->_getDriverName();
-        $fields = function (Query $query) use ($driverName) {
+        $fields = function (Query $query) use ($driverName): array {
             $runtime = $query->newExpr('UNIX_TIMESTAMP(completed) - UNIX_TIMESTAMP(fetched)');
             switch ($driverName) {
                 case static::DRIVER_SQLSERVER:
@@ -339,7 +339,7 @@ public function requestJob(array $capabilities, array $types = [])
         }
 
         /** @var \Queue\Model\Entity\QueuedTask|null $task */
-        $task = $this->getConnection()->transactional(function () use ($query, $options, $now) {
+        $task = $this->getConnection()->transactional(function () use ($query, $options, $now): ?QueuedTask {
             $task = $query->find('all', $options)
                 ->enableAutoFields(true)
                 ->epilog('FOR UPDATE')
@@ -350,6 +350,7 @@ public function requestJob(array $capabilities, array $types = [])
             }
 
             $key = sha1(microtime());
+            /* @phan-suppress-next-line PhanPartialTypeMismatchArgument */
             $task = $this->patchEntity($task, [
                 'worker_key' => $key,
                 'fetched' => $now
@@ -507,7 +508,7 @@ public function truncate()
     protected function _getDriverName()
     {
         $className = explode('\\', $this->getConnection()->config()['driver']);
-        $name = end($className);
+        $name = end($className) ?: '';
 
         return $name;
     }

src/Model/Table/QueuedTasksTable.php

@@ -7,7 +7,6 @@
 use Cake\Log\Log;
 use Cake\Utility\Inflector;
 use Cake\Utility\Text;
-use Exception;
 use Queue\Model\Entity\QueuedTask;
 use Queue\Model\QueueException;
 use Queue\Queue\Config;
@@ -142,7 +141,7 @@ public function add()
     protected function _taskName($task)
     {
         if (strpos($task, 'Queue') === 0) {
-            return substr($task, 5);
+            return substr($task, 5) ?: '';
         }
 
         return $task;
@@ -182,7 +181,9 @@ public function runworker()
         $this->_exit = false;
 
         $startTime = time();
-        $types = $this->_stringToArray($this->param('type'));
+
+        $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);
@@ -237,6 +238,7 @@ protected function runJob(QueuedTask $queuedTask)
                 throw new RuntimeException('Task must implement ' . QueueTaskInterface::class);
             }
 
+            /* @phan-suppress-next-line PhanTypeVoidAssignment */
             $return = $task->run((array)$data, $queuedTask->id);
             if ($return !== null) {
                 trigger_error('run() should be void and throw exception in error case now.', E_USER_DEPRECATED);
@@ -251,11 +253,6 @@ protected function runJob(QueuedTask $queuedTask)
             }
 
             $this->_logError($taskName . ' (job ' . $queuedTask->id . ')' . "\n" . $failureMessage);
-        } catch (Exception $e) {
-            $return = false;
-
-            $failureMessage = get_class($e) . ': ' . $e->getMessage();
-            $this->_logError($taskName . "\n" . $failureMessage);
         }
 
         if ($return === false) {
@@ -473,7 +470,7 @@ protected function _getTaskConf()
      */
     protected function _exit($signal)
     {
-        $this->out(__d('queue', 'Caught signal {0}, exiting.', $signal));
+        $this->out(__d('queue', 'Caught signal {0}, exiting.', [$signal]));
         $this->_exit = true;
     }
 
@@ -544,6 +541,9 @@ protected function _stringToArray($param)
         }
 
         $array = Text::tokenize($param);
+        if (is_string($array)) {
+            return [$array];
+        }
 
         return array_filter($array);
     }