Skip to content

Added notes for cache request hostnames #18634

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 8 commits into from
Apr 22, 2025
Merged

Added notes for cache request hostnames #18634

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8fecb56
Added two notes
ToriLindsay Dec 9, 2024
bc2a26c
Update src/content/docs/workers/runtime-apis/cache.mdx
ToriLindsay Dec 13, 2024
8f74b36
Update src/content/docs/workers/runtime-apis/cache.mdx
ToriLindsay Dec 13, 2024
42cbc17
update with example
ToriLindsay Jan 22, 2025
3d7bdaa
Fixed
ToriLindsay Jan 22, 2025
a2cb294
made into note, simplified code example
ToriLindsay Feb 26, 2025
ebeb2d8
Update src/content/docs/workers/runtime-apis/cache.mdx
ToriLindsay Mar 31, 2025
077b5f7
Changed to recommended approach
ToriLindsay Mar 31, 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: 10 additions & 8 deletions src/content/docs/workers/runtime-apis/cache.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,17 @@ You may create and manage additional Cache instances via the [`caches.open`](htt
let myCache = await caches.open('custom:cache');
await myCache.match(request);
```
When using the cache API, avoid overriding the hostname in cache requests, as this can lead to unnecessary DNS lookups and cache inefficiencies. Always use the hostname that matches the domain associated with your Worker.

```js
async fetch(request, env, ctx) {
Copy link
Contributor

@mikenomitch mikenomitch Feb 4, 2025

Choose a reason for hiding this comment

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

Indentation on this JS is a bit off. Everything within the brackets should be indented once.

Though actually, this also isn't valid fetch code. You would need to return the response from myCache.match(request) in order for it to be valid.

But... that doesn't really make sense because you might have a cache miss and you'd have to handle that (see this full code - https://developers.cloudflare.com/workers/examples/cache-api/)

I think since we don't want to show all of that code in here, what we should do is just drop the fetch() bits completely? It might be a tad less clear where request is coming from in this case, but I think it's fine.

So I'd just do

// avoid overriding the URL in request or passing a new request into the cache API
request.url = "https://some-overridden-value.com/";

let myCache = await caches.open('custom:cache');
let response = await myCache.match(request);

If it'll never work then I'd add this above the last line "// will never work because URL doesn't match Worker's domain"

// avoid overriding the request URL or passing a new request into the cache API
request.url = "https://some-overridden-value.com";

let myCache = await caches.open('custom:cache');
await myCache.match(request);
},
```
***

## Headers
Expand Down Expand Up @@ -105,10 +115,6 @@ cache.put(request, response);


The `stale-while-revalidate` and `stale-if-error` directives are not supported when using the `cache.put` or `cache.match` methods.


:::

#### Parameters


Expand Down Expand Up @@ -152,10 +158,6 @@ cache.match(request, options);


The `stale-while-revalidate` and `stale-if-error` directives are not supported when using the `cache.put` or `cache.match` methods.


:::

#### Parameters


Expand Down
Loading