Skip to content

[Cache] Updates cache api workers override cache rules information #22690

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 3 commits into from
May 28, 2025
Merged

[Cache] Updates cache api workers override cache rules information #22690

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
132209a
Updates cache api workers override cache rules information
angelampcosta May 27, 2025
7338758
Apply suggestions from code review
angelampcosta May 28, 2025
9ec01e3
Update src/content/docs/cache/interaction-cloudflare-products/workers…
angelampcosta May 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
18 changes: 16 additions & 2 deletions src/content/docs/cache/interaction-cloudflare-products/workers-cache-rules.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,22 @@ This override behavior is controlled by [compatibility flags](/workers/configura

These flags must be enabled to allow Workers scripts to override cache rules.

If your Worker has a compatibility date of 2025-04-02 or earlier, these flags are not enabled by default. In that case, cache settings defined in the Worker will not override existing cache rules.
### Compatibility date behavior

Whether these flags are enabled by default depends on your Worker's compatibility date:

- **Fetch API (`request_cf_overrides_cache_rules`)**
- Enabled by default for compatibility dates **on or after 2025-04-02**.
- **Cache API (`cache_api_request_cf_overrides_cache_rules`)**
- Enabled by default for compatibility dates **on or after 2025-05-19**.
- **Important:** For `cache_api_request_cf_overrides_cache_rules` to be recognized, you must also enable `cache_api_compat_flags`.
- `cache_api_compat_flags` enables the compatibility flag functionality for Workers. If `cache_api_compat_flags` is not set, then no compatibility flags — even if configured — will be recognized by the Cache API.
- This flag is enabled by default for compatibility dates **on or after 2025-04-19**.

If your Worker has an earlier compatibility date than the ones listed above, the corresponding flags must be manually enabled; otherwise, cache behavior will follow the original cache rules instead of the Worker's settings.

### Example (Older compatibility date)

If a cache rule is configured to bypass cache for `example.com/foo`, and a Worker with a compatibility date of `2025-04-02` or earlier tries to set `cacheEverything: true`, the cache rule will take effect — and the response will not be cached.
If a cache rule is configured to bypass cache for `example.com/foo`, and a Worker with a compatibility date of `2025-04-02` or earlier tries to set `cacheEverything: true`, the cache rule will take effect, and the response will not be cached.

Likewise, if using the Cache API without `cache_api_compat_flags` enabled, even if you enable `cache_api_request_cf_overrides_cache_rules`, the Cache API will not take effect.
Loading