Skip to content
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

feat: use the cache api if there is no kv cache available #136

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

james-elicx
Copy link
Collaborator

Changes

  • Adds an abstraction for cache stores that the cache handler interact with.
  • Moves the KV interaction to a new store.
  • Adds a new Cache API store.
  • Defaults to the Cache API store if there is no KV binding available.

resolves #134

Copy link

changeset-bot bot commented Nov 17, 2024

🦋 Changeset detected

Latest commit: 5cd4724

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@opennextjs/cloudflare Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

pkg-pr-new bot commented Nov 17, 2024

Open in Stackblitz

pnpm add https://pkg.pr.new/@opennextjs/cloudflare@136

commit: 5cd4724

@james-elicx james-elicx marked this pull request as ready for review November 17, 2024 19:54

export function getCacheStore() {
const kvName = process.env.__OPENNEXT_KV_BINDING_NAME;
if (process.env[kvName]) {
Copy link
Contributor

@vicb vicb Nov 18, 2024

Choose a reason for hiding this comment

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

I think we should remove the bindings from process.env and we should move to getCloudflareContext - could be done in a follow up PR, in which case it would be nice to add a // TODO: ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

getCloudflareContext is async at the moment because of local dev, so it won't work here unless we move the retrieving of the cache to be part of an interaction with the cache instead of when the cache handler is instantiated.

Copy link
Contributor

Choose a reason for hiding this comment

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

yep, you can create a TODO/issue for that. thanks.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

};

export type CacheStore = {
get: (key: string) => Promise<CacheEntry | null>;
Copy link
Contributor

Choose a reason for hiding this comment

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

async?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

They are - the return type is a promise

}
}

class CacheAPIStore implements CacheStore {
Copy link
Contributor

@vicb vicb Nov 18, 2024

Choose a reason for hiding this comment

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

@petebacondarwin @dario-piotrowicz I'm not familiar the cf cache API, do you have thoughts about this class?

With my limited understanding of the cache API, I'm not sure if we should use it for the fetch cache (as long as the cache headers are set correctly on the fetch call).

I'm also wondering about custom keys.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Support Cloudflare Cache API as alternative to KV
2 participants