MAGETWO-94369 [Forwardport] Move cron improvements from 2.2 to 2.3

Author: Bohdan Korablov

app/code/Magento/Cron/Model/Schedule.php

@@ -71,14 +71,16 @@ public function __construct(
     }
 
     /**
-     * @return void
+     * @inheritdoc
      */
     public function _construct()
     {
         $this->_init(\Magento\Cron\Model\ResourceModel\Schedule::class);
     }
 
     /**
+     * Set cron expression.
+     *
      * @param string $expr
      * @return $this
      * @throws \Magento\Framework\Exception\CronException
@@ -95,7 +97,7 @@ public function setCronExpr($expr)
     }
 
     /**
-     * Checks the observer's cron expression against time
+     * Checks the observer's cron expression against time.
      *
      * Supports $this->setCronExpr('* 0-5,10-59/5 2-10,15-25 january-june/2 mon-fri')
      *
@@ -125,6 +127,8 @@ public function trySchedule()
     }
 
     /**
+     * Match cron expression.
+     *
      * @param string $expr
      * @param int $num
      * @return bool
@@ -191,6 +195,8 @@ public function matchCronExpression($expr, $num)
     }
 
     /**
+     * Get number of a month.
+     *
      * @param int|string $value
      * @return bool|int|string
      */

app/code/Magento/Cron/Observer/ProcessCronQueueObserver.php

@@ -17,6 +17,8 @@
 use Magento\Framework\Profiler\Driver\Standard\StatFactory;
 
 /**
+ * The observer for processing cron jobs.
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class ProcessCronQueueObserver implements ObserverInterface
@@ -154,8 +156,9 @@ class ProcessCronQueueObserver implements ObserverInterface
      * @param \Magento\Framework\Stdlib\DateTime\DateTime $dateTime
      * @param \Magento\Framework\Process\PhpExecutableFinderFactory $phpExecutableFinderFactory
      * @param \Psr\Log\LoggerInterface $logger
-     * @param \Magento\Framework\App\State $state
+     * @param State $state
      * @param StatFactory $statFactory
+     * @param \Magento\Framework\Lock\LockManagerInterface $lockManager
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -378,8 +381,9 @@ private function getProfilingStat()
     }
 
     /**
-     * Return job collection from data base with status 'pending'
+     * Return job collection from data base with status 'pending'.
      *
+     * @param string $groupId
      * @return \Magento\Cron\Model\ResourceModel\Schedule\Collection
      */
     private function getPendingSchedules($groupId)
@@ -464,8 +468,8 @@ protected function _generateJobs($jobs, $exists, $groupId)
     /**
      * Clean expired jobs
      *
-     * @param $groupId
-     * @param $currentTime
+     * @param string $groupId
+     * @param int $currentTime
      * @return void
      */
     private function cleanupJobs($groupId, $currentTime)
@@ -516,6 +520,8 @@ private function cleanupJobs($groupId, $currentTime)
     }
 
     /**
+     * Get config of schedule.
+     *
      * @param array $jobConfig
      * @return mixed
      */
@@ -530,6 +536,8 @@ protected function getConfigSchedule($jobConfig)
     }
 
     /**
+     * Save a schedule of cron job.
+     *
      * @param string $jobCode
      * @param string $cronExpression
      * @param int $timeInterval
@@ -562,6 +570,8 @@ protected function saveSchedule($jobCode, $cronExpression, $timeInterval, $exist
     }
 
     /**
+     * Create a schedule of cron job.
+     *
      * @param string $jobCode
      * @param string $cronExpression
      * @param int $time
@@ -580,6 +590,8 @@ protected function createSchedule($jobCode, $cronExpression, $time)
     }
 
     /**
+     * Get time interval for scheduling.
+     *
      * @param string $groupId
      * @return int
      */
@@ -592,8 +604,9 @@ protected function getScheduleTimeInterval($groupId)
     }
 
     /**
-     * Clean up scheduled jobs that are disabled in the configuration
-     * This can happen when you turn off a cron job in the config and flush the cache
+     * Clean up scheduled jobs that are disabled in the configuration.
+     *
+     * This can happen when you turn off a cron job in the config and flush the cache.
      *
      * @param string $groupId
      * @return void
@@ -624,6 +637,8 @@ private function cleanupDisabledJobs($groupId)
     }
 
     /**
+     * Get cron expression of cron job.
+     *
      * @param array $jobConfig
      * @return null|string
      */
@@ -643,8 +658,9 @@ private function getCronExpression($jobConfig)
     }
 
     /**
-     * Clean up scheduled jobs that do not match their cron expression anymore
-     * This can happen when you change the cron expression and flush the cache
+     * Clean up scheduled jobs that do not match their cron expression anymore.
+     *
+     * This can happen when you change the cron expression and flush the cache.
      *
      * @return $this
      */
@@ -663,9 +679,10 @@ private function cleanupScheduleMismatches()
     }
 
     /**
-     * Get CronGroup Configuration Value
+     * Get CronGroup Configuration Value.
      *
-     * @param $groupId
+     * @param string $groupId
+     * @param string $path
      * @return int
      */
     private function getCronGroupConfigurationValue($groupId, $path)
@@ -677,9 +694,9 @@ private function getCronGroupConfigurationValue($groupId, $path)
     }
 
     /**
-     * Is Group In Filter
+     * Is Group In Filter.
      *
-     * @param $groupId
+     * @param string $groupId
      * @return bool
      */
     private function isGroupInFilter($groupId): bool
@@ -689,11 +706,11 @@ private function isGroupInFilter($groupId): bool
     }
 
     /**
-     * Process pending jobs
+     * Process pending jobs.
      *
-     * @param $groupId
-     * @param $jobsRoot
-     * @param $currentTime
+     * @param string $groupId
+     * @param array $jobsRoot
+     * @param int $currentTime
      */
     private function processPendingJobs($groupId, $jobsRoot, $currentTime)
     {
@@ -730,6 +747,8 @@ private function processPendingJobs($groupId, $jobsRoot, $currentTime)
     }
 
     /**
+     * Process error messages.
+     *
      * @param Schedule $schedule
      * @param \Exception $exception
      * @return void