Skip to content

Clarify testing cron triggers locally #21942

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 28, 2025
Merged

Clarify testing cron triggers locally #21942

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ccf024
Update cron-triggers.mdx
penalosa Apr 23, 2025
9846cf9
Update cron-triggers.mdx
penalosa Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions src/content/docs/workers/configuration/cron-triggers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ Refer to the following additional examples to write your code:

### 2. Update configuration

:::note[Cron Trigger changes take time to propagate.]

Changes such as adding a new Cron Trigger, updating an old Cron Trigger, or deleting a Cron Trigger may take several minutes (up to 15 minutes) to propagate to the Cloudflare global network.

:::

After you have updated your Worker code to include a `"scheduled"` event, you must update your Worker project configuration.

#### Via the [Wrangler configuration file](/workers/wrangler/configuration/)
Expand Down Expand Up @@ -165,24 +171,24 @@ Some common time intervals that may be useful for setting up your Cron Trigger:
- `59 23 LW * *`
- 23:59 (UTC) on the last weekday of the month

## Test Cron Triggers
## Test Cron Triggers locally

The recommended way of testing Cron Triggers is using Wrangler.

:::note[Cron Trigger changes take time to propagate.]
Test Cron Triggers using Wrangler with [`wrangler dev`](/workers/wrangler/commands/#dev). This will expose a `/cdn-cgi/handler/scheduled` route which can be used to test using a HTTP request.

Changes such as adding a new Cron Trigger, updating an old Cron Trigger, or deleting a Cron Trigger may take several minutes (up to 15 minutes) to propagate to the Cloudflare global network.

:::
```sh
curl "http://localhost:8787/cdn-cgi/handler/scheduled"
```

Test Cron Triggers using `Wrangler` by passing in the `--test-scheduled` flag to [`wrangler dev`](/workers/wrangler/commands/#dev). This will expose a `/__scheduled` (or `/cdn-cgi/handler/scheduled` for Python Workers) route which can be used to test using a HTTP request. To simulate different cron patterns, a `cron` query parameter can be passed in.
To simulate different cron patterns, a `cron` query parameter can be passed in.

```sh
npx wrangler dev --test-scheduled
curl "http://localhost:8787/cdn-cgi/handler/scheduled?cron=*+*+*+*+*"
```

curl "http://localhost:8787/__scheduled?cron=*+*+*+*+*"
Optionally, you can also pass a `time` query parameter to override `controller.scheduledTime` in your scheduled event listener.
Copy link
Contributor

@CarmenPopoviciu CarmenPopoviciu Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be nice to have a code snippet for this as well


curl "http://localhost:8787/cdn-cgi/handler/scheduled?cron=*+*+*+*+*" # Python Workers
```sh
curl "http://localhost:8787/cdn-cgi/handler/scheduled?cron=*+*+*+*+*&time=1745856238"
```

## View past events
Expand Down