-
Notifications
You must be signed in to change notification settings - Fork 2.8k
feat: crons for all bin scripts, new jobs:handle-schedules script, more reliable job system crons #13564
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
AlessioGr
wants to merge
6
commits into
main
Choose a base branch
from
feat/bin-scripts-cron-handle-schedules
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+154
−70
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
📦 esbuild Bundle Analysis for payloadThis analysis was generated by esbuild-bundle-analyzer. 🤖
Largest pathsThese visualization shows top 20 largest paths in the bundle.Meta file: packages/next/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_shared.json, Out file: esbuild/exports/shared.js
Meta file: packages/richtext-lexical/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_shared.json, Out file: esbuild/exports/shared_optimized/index.js
DetailsNext to the size is how much the size has increased or decreased compared with the base branch of this PR.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New jobs:handle-schedules bin script
Similarly to
payload jobs:run
, this PR adds a newjobs:handle-schedules
bin script which only handles scheduling.Allows jobs:run bin script to handle scheduling
Similarly to how payload autoRun handles both running and scheduling jobs by default, you can now set the
payload jobs:run
bin script to also handle scheduling. This is opt-in:Cron schedules for all bin scripts
Previously, only the
payload jobs:run
bin script accepted a cron flag. Thepayload jobs:handle-schedules
would have required the same logic to also handle a cron flag.Instead of opting for this duplicative logic, I'm now handling cron logic before we determine which script to run. This means: it's simpler and requires less duplicative code.
This allows all other bin scripts (including custom ones) to use the
--cron
flag, enabling cool use-cases like scheduling your own custom scripts - no additional config required!Example:
pnpm payload run ./myScript.ts --cron "0 * * * *"
Video Example:
Screenshot.2025-08-22.at.17.28.07.mp4
More reliable job system crons
When using autorun or
--cron
, if one cron run takes longer than the cron interval, the second cron would run before the first one finishes.This can be especially dangerous when running jobs using a bin script, potentially causing race conditions, as the first cron run will take longer due to payload initialization overhead (only for first cron run, consecutive ones use cached payload). Now, consecutive cron runs will wait for the first one to finish by using the
{ protect: true }
property of Croner.This change will affect both autorun and bin scripts.
Cleanup
getPayload
function arguments were not properly typed. Arguments likedisableOnInit: true
are already supported, but the type did not reflect that. This simplifies the type and makes it more accurate.Fixes
allQueues
argument forpayload jobs:run
was not respected