How is a «Cron script readiness check» implemented on a Magento 2 upgrade?

dmitry_fedyuk · April 3, 2016, 1:08pm

A generic part for an installation and upgrade: How is a «Cron script readiness check» implemented?

magento/magento2/blob/1f7a63dc97/setup/src/Magento/Setup/Model/CronScriptReadinessCheck.php#L72-L80


/**
 * Check Updater Cron job status file
 *
 * @return array
 */
public function checkUpdater()
{
    return $this->checkJson(self::UPDATER);
}

github.com

magento/magento2/blob/1f7a63dc97/setup/src/Magento/Setup/Model/CronScriptReadinessCheck.php#L26-L29


/**
 * Updater type
 */
const UPDATER = 'updater';

github.com

magento/magento2/blob/1f7a63dc97/setup/src/Magento/Setup/Model/CronScriptReadinessCheck.php#L82-L90


/**
 * Check JSON file created by Setup cron command and Updater cron script
 *
 * @param string $type
 * @return array
 */
private function checkJson($type)
{
    $read = $this->filesystem->getDirectoryRead(DirectoryList::VAR_DIR);

https://github.com/magento/magento2/blob/1f7a63dc97/setup/src/Magento/Setup/Model/CronScriptReadinessCheck.php#L91-L111

https://github.com/magento/magento2/blob/1f7a63dc97/setup/src/Magento/Setup/Model/CronScriptReadinessCheck.php#L31-L34

github.com

magento/magento2/blob/1f7a63dc97/setup/src/Magento/Setup/Model/CronScriptReadinessCheck.php#L115-L130


if (isset($jsonData[ReadinessCheck::KEY_READINESS_CHECKS])
    && isset($jsonData[ReadinessCheck::KEY_READINESS_CHECKS][$key])
) {
    if ($jsonData[ReadinessCheck::KEY_READINESS_CHECKS][$key]) {
        return $this->checkCronTime($jsonData);
    }
    return ['success' => false, 'error' => $jsonData[ReadinessCheck::KEY_READINESS_CHECKS]['error']];
}
$error = 'Cron job has not been configured yet';
if ($type == self::SETUP) {
    $error .= self::OTHER_CHECKS_WILL_FAIL_MSG;
}
return [
    'success' => false,
    'error' => $error
];

Bug: Magento 2 checks the «.update_cronjob_status» file but never generates it so the «Cron script readiness check» will always fail on a Magento 2 upgrade

dmitry_fedyuk · April 3, 2016, 1:40pm