Inheritance diagram for ProcessCronQueueObserver:

Public Member Functions
	__construct (\Magento\Framework\ObjectManagerInterface $objectManager, \Magento\Cron\Model\ScheduleFactory $scheduleFactory, \Magento\Framework\App\CacheInterface $cache, \Magento\Cron\Model\ConfigInterface $config, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\App\Console\Request $request, \Magento\Framework\ShellInterface $shell, \Magento\Framework\Stdlib\DateTime\DateTime $dateTime, \Magento\Framework\Process\PhpExecutableFinderFactory $phpExecutableFinderFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\App\State $state, StatFactory $statFactory, \Magento\Framework\Lock\LockManagerInterface $lockManager)

	execute (\Magento\Framework\Event\Observer $observer)

Public Member Functions inherited from ObserverInterface
	execute (Observer $observer)

Data Fields
const	CACHE_KEY_LAST_SCHEDULE_GENERATE_AT = 'cron_last_schedule_generate_at'

const	CACHE_KEY_LAST_HISTORY_CLEANUP_AT = 'cron_last_history_cleanup_at'

const	STANDALONE_PROCESS_STARTED = 'standaloneProcessStarted'

const	XML_PATH_SCHEDULE_GENERATE_EVERY = 'schedule_generate_every'

const	XML_PATH_SCHEDULE_AHEAD_FOR = 'schedule_ahead_for'

const	XML_PATH_SCHEDULE_LIFETIME = 'schedule_lifetime'

const	XML_PATH_HISTORY_CLEANUP_EVERY = 'history_cleanup_every'

const	XML_PATH_HISTORY_SUCCESS = 'history_success_lifetime'

const	XML_PATH_HISTORY_FAILURE = 'history_failure_lifetime'

const	SECONDS_IN_MINUTE = 60

const	LOCK_TIMEOUT = 5

const	LOCK_PREFIX = 'CRON_GROUP_'

Protected Member Functions
	_runJob ($scheduledTime, $currentTime, $jobConfig, $schedule, $groupId)

	_generateJobs ($jobs, $exists, $groupId)

	getConfigSchedule ($jobConfig)

	saveSchedule ($jobCode, $cronExpression, $timeInterval, $exists)

	createSchedule ($jobCode, $cronExpression, $time)

	getScheduleTimeInterval ($groupId)

Protected Attributes
	$_pendingSchedules

	$_config

	$_objectManager

	$_cache

	$_scopeConfig

	$_scheduleFactory

	$_request

	$_shell

	$dateTime

	$phpExecutableFinder

Detailed Description

The observer for processing cron jobs.

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 24 of file ProcessCronQueueObserver.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\ObjectManagerInterface	$objectManager,
		\Magento\Cron\Model\ScheduleFactory	$scheduleFactory,
		\Magento\Framework\App\CacheInterface	$cache,
		\Magento\Cron\Model\ConfigInterface	$config,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\App\Console\Request	$request,
		\Magento\Framework\ShellInterface	$shell,
		\Magento\Framework\Stdlib\DateTime\DateTime	$dateTime,
		\Magento\Framework\Process\PhpExecutableFinderFactory	$phpExecutableFinderFactory,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\App\State	$state,
		StatFactory	$statFactory,
		\Magento\Framework\Lock\LockManagerInterface	$lockManager
	)

Parameters

\Magento\Framework\ObjectManagerInterface	$objectManager
\Magento\Cron\Model\ScheduleFactory	$scheduleFactory
\Magento\Framework\App\CacheInterface	$cache
\Magento\Cron\Model\ConfigInterface	$config
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\App\Console\Request	$request
\Magento\Framework\ShellInterface	$shell
\Magento\Framework\Stdlib\DateTime\DateTime	$dateTime
\Magento\Framework\Process\PhpExecutableFinderFactory	$phpExecutableFinderFactory
\Psr\Log\LoggerInterface	$logger
State	$state
StatFactory	$statFactory
\Magento\Framework\Lock\LockManagerInterface	$lockManager	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 164 of file ProcessCronQueueObserver.php.

       {
         $this->_objectManager = $objectManager;
         $this->_scheduleFactory = $scheduleFactory;
         $this->_cache = $cache;
         $this->_config = $config;
         $this->_scopeConfig = $scopeConfig;
         $this->_request = $request;
         $this->_shell = $shell;
         $this->dateTime = $dateTime;
         $this->phpExecutableFinder = $phpExecutableFinderFactory->create();
         $this->logger = $logger;
         $this->state = $state;
         $this->statProfiler = $statFactory->create();
         $this->lockManager = $lockManager;
     }

Member Function Documentation

◆ _generateJobs()

_generateJobs	(	$jobs,
		$exists,
		$groupId
	)

protected

Generate jobs for config information

Parameters

array	$jobs
array	$exists
string	$groupId

Returns: void

Definition at line 455 of file ProcessCronQueueObserver.php.

     {
         foreach ($jobs as $jobCode => $jobConfig) {
             $cronExpression = $this->getCronExpression($jobConfig);
             if (!$cronExpression) {
                 continue;
             }
 
             $timeInterval = $this->getScheduleTimeInterval($groupId);
             $this->saveSchedule($jobCode, $cronExpression, $timeInterval, $exists);
         }
     }

◆ _runJob()

_runJob	(	$scheduledTime,
		$currentTime,
		$jobConfig,
		$schedule,
		$groupId
	)

protected

Execute job by calling specific class::method

Parameters

int	$scheduledTime
int	$currentTime
	string[]	$jobConfig
Schedule	$schedule
string	$groupId

Returns: void

Exceptions

Definition at line 289 of file ProcessCronQueueObserver.php.

     {
         $jobCode = $schedule->getJobCode();
         $scheduleLifetime = $this->getCronGroupConfigurationValue($groupId, self::XML_PATH_SCHEDULE_LIFETIME);
         $scheduleLifetime = $scheduleLifetime * self::SECONDS_IN_MINUTE;
         if ($scheduledTime < $currentTime - $scheduleLifetime) {
             $schedule->setStatus(Schedule::STATUS_MISSED);
             throw new \Exception(sprintf('Cron Job %s is missed at %s', $jobCode, $schedule->getScheduledAt()));
         }
 
         if (!isset($jobConfig['instance'], $jobConfig['method'])) {
             $schedule->setStatus(Schedule::STATUS_ERROR);
             throw new \Exception('No callbacks found');
         }
         $model = $this->_objectManager->create($jobConfig['instance']);
         $callback = [$model, $jobConfig['method']];
         if (!is_callable($callback)) {
             $schedule->setStatus(Schedule::STATUS_ERROR);
             throw new \Exception(
                 sprintf('Invalid callback: %s::%s can\'t be called', $jobConfig['instance'], $jobConfig['method'])
             );
         }
 
         $schedule->setExecutedAt(strftime('%Y-%m-%d %H:%M:%S', $this->dateTime->gmtTimestamp()))->save();
 
         $this->startProfiling();
         try {
             $this->logger->info(sprintf('Cron Job %s is run', $jobCode));
             call_user_func_array($callback, [$schedule]);
         } catch (\Throwable $e) {
             $schedule->setStatus(Schedule::STATUS_ERROR);
             $this->logger->error(sprintf(
                 'Cron Job %s has an error: %s. Statistics: %s',
                 $jobCode,
                 $e->getMessage(),
                 $this->getProfilingStat()
             ));
             if (!$e instanceof \Exception) {
                 $e = new \RuntimeException(
                     'Error when running a cron job',
                     0,
                     $e
                 );
             }
             throw $e;
         } finally {
             $this->stopProfiling();
         }
 
         $schedule->setStatus(Schedule::STATUS_SUCCESS)->setFinishedAt(strftime(
             '%Y-%m-%d %H:%M:%S',
             $this->dateTime->gmtTimestamp()
         ));
 
         $this->logger->info(sprintf(
             'Cron Job %s is successfully finished. Statistics: %s',
             $jobCode,
             $this->getProfilingStat()
         ));
     }

◆ createSchedule()

createSchedule	(	$jobCode,
		$cronExpression,
		$time
	)

protected

Create a schedule of cron job.

Parameters

string	$jobCode
string	$cronExpression
int	$time

Returns: Schedule

Definition at line 580 of file ProcessCronQueueObserver.php.

     {
         $schedule = $this->_scheduleFactory->create()
             ->setCronExpr($cronExpression)
             ->setJobCode($jobCode)
             ->setStatus(Schedule::STATUS_PENDING)
             ->setCreatedAt(strftime('%Y-%m-%d %H:%M:%S', $this->dateTime->gmtTimestamp()))
             ->setScheduledAt(strftime('%Y-%m-%d %H:%M', $time));
 
         return $schedule;
     }

◆ execute()

execute ( \Magento\Framework\Event\Observer $observer )

Process cron queue Generate tasks schedule Cleanup tasks schedule

Parameters

\Magento\Framework\Event\Observer $observer

Returns: void @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity) @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 205 of file ProcessCronQueueObserver.php.

     {
 
         $currentTime = $this->dateTime->gmtTimestamp();
         $jobGroupsRoot = $this->_config->getJobs();
         // sort jobs groups to start from used in separated process
         uksort(
             $jobGroupsRoot,
             function ($a, $b) {
                 return $this->getCronGroupConfigurationValue($b, 'use_separate_process')
                     - $this->getCronGroupConfigurationValue($a, 'use_separate_process');
             }
         );
 
         $phpPath = $this->phpExecutableFinder->find() ?: 'php';
 
         foreach ($jobGroupsRoot as $groupId => $jobsRoot) {
             if (!$this->isGroupInFilter($groupId)) {
                 continue;
             }
             if ($this->_request->getParam(self::STANDALONE_PROCESS_STARTED) !== '1'
                 && $this->getCronGroupConfigurationValue($groupId, 'use_separate_process') == 1
             ) {
                 $this->_shell->execute(
                     $phpPath . ' %s cron:run --group=' . $groupId . ' --' . Cli::INPUT_KEY_BOOTSTRAP . '='
                     . self::STANDALONE_PROCESS_STARTED . '=1',
                     [
                         BP . '/bin/magento'
                     ]
                 );
                 continue;
             }
 
             $this->lockGroup(
                 $groupId,
                 function ($groupId) use ($currentTime, $jobsRoot) {
                     $this->cleanupJobs($groupId, $currentTime);
                     $this->generateSchedules($groupId);
                     $this->processPendingJobs($groupId, $jobsRoot, $currentTime);
                 }
             );
         }
     }

◆ getConfigSchedule()

getConfigSchedule ( $jobConfig )

protected

Get config of schedule.

Parameters

array $jobConfig

Returns: mixed

Definition at line 528 of file ProcessCronQueueObserver.php.

     {
         $cronExpr = $this->_scopeConfig->getValue(
             $jobConfig['config_path'],
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
 
         return $cronExpr;
     }

◆ getScheduleTimeInterval()

getScheduleTimeInterval ( $groupId )

protected

Get time interval for scheduling.

Parameters

string $groupId

Returns: int

Definition at line 598 of file ProcessCronQueueObserver.php.

     {
         $scheduleAheadFor = (int)$this->getCronGroupConfigurationValue($groupId, self::XML_PATH_SCHEDULE_AHEAD_FOR);
         $scheduleAheadFor = $scheduleAheadFor * self::SECONDS_IN_MINUTE;
 
         return $scheduleAheadFor;
     }

◆ saveSchedule()

saveSchedule	(	$jobCode,
		$cronExpression,
		$timeInterval,
		$exists
	)

protected

Save a schedule of cron job.

Parameters

string	$jobCode
string	$cronExpression
int	$timeInterval
array	$exists

Returns: void

Definition at line 547 of file ProcessCronQueueObserver.php.

     {
         $currentTime = $this->dateTime->gmtTimestamp();
         $timeAhead = $currentTime + $timeInterval;
         for ($time = $currentTime; $time < $timeAhead; $time += self::SECONDS_IN_MINUTE) {
             $scheduledAt = strftime('%Y-%m-%d %H:%M:00', $time);
             $alreadyScheduled = !empty($exists[$jobCode . '/' . $scheduledAt]);
             $schedule = $this->createSchedule($jobCode, $cronExpression, $time);
             $valid = $schedule->trySchedule();
             if (!$valid) {
                 if ($alreadyScheduled) {
                     if (!isset($this->invalid[$jobCode])) {
                         $this->invalid[$jobCode] = [];
                     }
                     $this->invalid[$jobCode][] = $scheduledAt;
                 }
                 continue;
             }
             if (!$alreadyScheduled) {
                 // time matches cron expression
                 $schedule->save();
             }
         }
     }