magemojo / m2-ce-cron

magemojo/m2-ce-cron

Replacement package for Magento 2 Cron Functionality

magento2-module Compatibility: 2.4.7-2.4.8 Code Quality: Fail Tests: N/A Security: Pass MIT

Are you the maintainer of magemojo?

Packagento pulls magemojo's Composer packages from the public registry so buyers can find them here.

Claim the namespace to take ownership, publish new releases directly, and start charging for premium versions.

Claim this namespace →

MageMojo

Cron

This module for Magento 2 overrides base magento cron functionality, fixes known bugs, and provides a cron service model to control cron process execution.

Version 1.4.2

NOTICE: Version 1.3x is only supported for Magento 2.3 and above. Older Magento 2 version use module version 1.2

The default cron can overlap and fill the cron_schedule table, which can cause exponentially more jobs to run on each cron interval, until finally the crons run continuously and never complete. The high number of cron jobs can also crash servers hosting Magento 2.

This module replaces the cron management with a service that accepts jobs. As jobs are scheduled, they are picked up by this service for execution. If a job is already running and another is picked up with the same job code, the new one is marked as missed. Duplicate jobs are prevented from running, reducing server overhead.

Think of the default cron as a factory that suddenly appears and runs any number of tasks. If those tasks do not complete by the next cron interval, they keep processing but another factory spontaneously appears and run another set of jobs which can overlap with the original factory.

The module removes the possibility of overlapping jobs by having a single source service that processes jobs in proper order without duplication. There is one factory working all the time to get your jobs done.

In addition to the service model many other enhancements have been made. For example a re-write of left join on update statement that forced a full table scan on cron_schedule for history. Statement would lock because it's reading from same table it was trying to update.

In version 1.1 Cron Reporting was added to the admin to show job code statistics and list cron run errors.

In version 1.2.5 Cron execution will run if in maintenance mode with exempt IPs, allowing for full internal verification including necessary crons.

In version 1.3 fixes are implemented for the consumers_runner cron job. This job code is a throwback from magento 1 and is more frequently used in Magento 2.3. It runs under its own scheduler which can execute many child jobs and bomb the system. In this version of the module this parent job is intercepted and written as individual jobs in the cron_schedule table and then run in a sane manner from there. These consumer jobs can also go into infinite loops, so a timeout is imposed on them by default of 30 seconds. This setting can be adjusted in the admin.

In version 1.3.7 the consumers governor was added to terminate idle consumers jobs. Bugs in these jobs otherwise prevent these jobs from completing.

In version 1.4.2 Support for clusters was added and fix for honoring disabled consumers jobs

In version 1.4.3 Support for PHP 8.1

Contributing

See CONTRIBUTING.md.

Benefits

  • Speeds up execution of cron.

  • Stops db locking.

  • Prevents cron history records from exploding.

  • Stops cron processes from overrunning each other.

  • Stops the cron from running while system is under configurable load conditions.

  • Sets the max number of simultaneous cron processes.

  • Sets the amount of history.

Admin Options

Cron Enabled - Turn the cron on/off.

Cluster Support - REQUIRED for Magento Commerce Cloud or any scaled/clustered environment. If more than one app server could potentially execute the cron:run command,
enable this. This will allow the service to gracefully switch between "leader" servers as required.

Maximum Cron Processes - The number of cron threads running in parallel. This option is the sum of all defined jobs. Example: If you have 5 jobs set to run at midnight, Maximum Cron Processes set to 1, only 1 job will execute sequentially until all 5 are completed. Default 3.

PHP Binary Name / Path - The name of your php binary you run from the shell. Usually php or php70. You can optionally include the full path to the binary. Default php. You can also add inline options here such as php -dmemory_limit=8096M If you want to have a custom ini value.

Max Load Average - Defined by the php function sys.getloadavg() / number of cpu cores. The function sys.getloadavg() is reported 1.0 for each core in use, just like the load average reported in top. The number of cpu cores is pulled from /proc/cpuinfo and load average is divided by this number. Example: If you have 8 cores and you're using 6 then this is returned as 0.75. If your Max Load Average is 0.76 your crons will not run. Your load average falls to 0.74. Your crons will run. Any cron that was scheduled to run but didn't will be run. If the same cron was missed multiple times, the most recent job will run, and the rest will be marked as missed. Default is 0.75 (75% of your available cpu).

History Retention - The number of days history to keep in the cron_schedule table. Default 1 (1 day).

Consumers Job Timeout - The number of seconds to allow a consumer job to run. These jobs can infinitely run under some conditions.

Exporters Job Timeout - The number of seconds to allow the exportProcessor job to run. Default 3600 seconds.

Consumers Govenor: - Many bugs in consumers processes cause them to run infinitely. The consumers governor will detect these states and terminate the processes.

Composer Install

  • Run these commands in your terminal:

  • For Magento Versions 2.3 and up

composer require magemojo/m2-ce-cron
  • Otherwise
composer require magemojo/m2-ce-cron:1.2.9
  • Then run the following
php bin/magento module:enable MageMojo_Cron
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

License

License: MIT

No changelog yet

The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.

Versions
Version Stability QA Status Compatibility Released
1.4.3-stable stable Fail Magento 2.4.7-2.4.8 Details 2022-12-13 20:06:18
1.4.2-stable stable Not tested Not yet tested Details 2022-02-23 17:11:58
1.3.8-stable stable Not tested Not yet tested Details 2021-03-17 17:51:30
1.3.7-stable stable Not tested Not yet tested Details 2020-11-16 15:55:02
1.3.5 stable Not tested Not yet tested Details 2020-06-25 14:54:12
1.3.4 stable Not tested Not yet tested Details 2020-06-18 06:20:45
1.3.3-stable stable Not tested Not yet tested Details 2020-06-12 13:43:55
1.3.2-stable stable Not tested Not yet tested Details 2020-04-22 19:12:13
1.3.1-stable stable Not tested Not yet tested Details 2020-02-07 18:19:16
1.3.0-stable stable Not tested Not yet tested Details 2020-01-07 19:14:25
1.2.9-stable stable Not tested Not yet tested Details 2019-12-04 19:16:27
1.2.8-stable stable Not tested Not yet tested Details 2019-04-12 17:04:12
1.2.7-stable stable Not tested Not yet tested Details 2018-10-31 18:33:47
1.2.6-stable stable Not tested Not yet tested Details 2018-10-03 16:17:22
1.2.5-stable stable Not tested Not yet tested Details 2018-08-02 18:49:00
1.2.4-stable stable Not tested Not yet tested Details 2018-07-28 01:23:37
1.2.3-stable stable Not tested Not yet tested Details 2018-07-22 11:52:15
1.2.2-stable stable Not tested Not yet tested Details 2018-06-18 21:56:22
1.2.1-stable stable Not tested Not yet tested Details 2018-06-06 14:34:52
1.2.0-stable stable Not tested Not yet tested Details 2018-05-17 19:23:03

Requires 1

Package Constraint
php >=7.0.0

Suggests 4

Package Reason
magento/module-cron *
magento/module-config *
magento/framework *
magento/module-store *

Compatibility

Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.

Compatibility matrix (Magento × PHP)
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Pass Pass
2.4.8 Pass Pass
2.4.9 Fail di error Fail di error

Code Quality

Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge. A phpcs finding can't make a module incompatible.

Static analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

Static analysis results
Tool Status Findings Summary
PHPCS Fail 940 38 errors, 902 warnings (ruleset: Magento2) — 726 auto-fixable with phpcbf
PHPMD Warning 19 19 rule violations (CyclomaticComplexity:3, UnusedFormalParameter:3, UnusedPrivateField:2, NPathComplexity:2, TooManyFields:1)
Cpd Pass 0
Composer validate Pass 0

PHPStan

Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 23 23
2.4.8 23 24
2.4.9 26 26

Tests

Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.

Unit tests

Unit tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Integration tests

Integration tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Security

Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.

Security results
Tool Status Findings Summary
Composer audit Pass 0
Malware scan Pass 0
License
MIT
Homepage
https://github.com/magemojo/
Authors
  • MageMojo
Make it pay

Turn an existing module into recurring revenue.

If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.