chore(cloudflare): refactor structure, optimize patterns

[alexanderniebuhr]

Changes

• restructured: abstracted & moved code to make adapter more maintainable (this is a on-going process)
• updated: reworded docs

Testing

• existing tests

Docs

/cc @withastro/maintainers-docs for feedback!

[changeset-bot]

🦋 Changeset detected

Latest commit: 83499e6

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

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

[alexanderniebuhr]

Current dependencies on/for this PR:

• main
  • PR chore(cloudflare): refactor structure, optimize patterns #8654 👈
    • PR feat(cloudflare): add local mocking for D1 bindings #8655
      • PR feat(cloudflare): add local mocking for R2 bindings #8656
        • PR feat(cloudflare): add local mocking for KV bindings #8657
          • PR feat(cloudflare): add local mocking for Caches bindings #8664
            • PR feat(cloudflare): add local mocking for DO bindings #8690

This comment was auto-generated by Graphite.

[jadbox]

@alexanderniebuhr very excited to see this work! This might be a dumb question, but it looks like there's a fair amount of work to get CF properly integrated for each service, and it feels that this might be hard to maintain if cloudflare makes service API changes. I wonder if you had explored ways either:

a) Try to reuse code by importing parts of Wrangler for environment setup and service mocks
b) Work with Wrangler repo to improve its ability to act as a startup engine for "astro dev" so that Astro local developers can benefit from using wrangler without having to actually build their Astro project to preview.

[alexanderniebuhr]

@jadbox thank you so much for your message. Let me try to answer it as good as I can, but feel free to ask any additional details, if you wish.

[I]t looks like there's a fair amount of work to get CF properly integrated for each service, and it feels that this might be hard to maintain if Cloudflare makes service API changes. [...]

This is not true. There is some work which we need to do, but it is not to much, don't get mislead by this PR. I'd recommend that you look into the D1, R2, KV bindings PR.

a) Try to reuse code by importing parts of Wrangler for environment setup and service mocks
b) Work with Wrangler repo to improve its ability to act as a startup engine for "astro dev" so that Astro local developers can benefit from using wrangler without having to actually build their Astro project to preview.

We are actually reusing as much code as possible, we also have a open request to get more APIs exposed.
But you are right, the main goal is to avoid to rebuild the Astro project every time.

[jadbox]

Hey @alexanderniebuhr, this may be out of scope, but I saw that Wrangler now injects a new AI binding that would be lovely to also have available.
https://github.com/cloudflare/workers-sdk/releases/tag/wrangler%403.9.1

[alexanderniebuhr]

Wrangler now injects a new AI binding

@jadbox good to know! Do you know if it is the same as Cloudflare constellation?

Also please note that we currently focus on bindings which can be mocked locally, that is similar to using wrangler --local.

If you would need to run wrangler --remote for the AI binding to work, we will implement support in a second step! But we are already working on it.

[jadbox]

@alexanderniebuhr the docs are not clear, but I think your right that it's just Constellation and will require a remote flag for binding. Good to know that remote services will come in the second phase! God speed on phase 1 and looking forward to testing 🫡

[sarah11918]

Thanks @alexanderniebuhr! I can see the new section added really incorporated some docs suggestions we've discussed before! 🙌

There's a bunch to go through here though (not all of it yours, but highlighted by the Wonderful World of Giff Diffs) so get ready for a real docs review incoming! 😄

[sarah11918]

One more pass, and probably however you choose to handle these comments will be fine and not require another review by me! If you'd like me to have another look after you think you're finished, then just ping me again in docs-ptal, otherwise I'm confident you can run with these comments and you got this!

[dario-piotrowicz]

@alexanderniebuhr incredible stuff!!! 😍

I can't help but notice that DurableObjects aren't included in your set of PRs? is there a reason as to why?

[alexanderniebuhr]

I can't help but notice that DurableObjects aren't included in your set of PRs? is there a reason as to why?

@dario-piotrowicz Thank you for your input. We're currently exploring the integration of DurableObjects. In this phase 1, we're prioritizing the addition of local bindings, analogous to the --local flag in wrangler.

However, I'm facing challenges in devising tests for these, primarily because a shared DurableObject isn't available during testing. If you have any suggestions or insights on how we can effectively test them, I'd be eager to share my preliminary merge request for inclusion.

[dario-piotrowicz]

I can't help but notice that DurableObjects aren't included in your set of PRs? is there a reason as to why?

@dario-piotrowicz Thank you for your input. We're currently exploring the integration of DurableObjects. In this phase 1, we're prioritizing the addition of local bindings, analogous to the --local flag in wrangler.

However, I'm facing challenges in devising tests for these, primarily because a shared DurableObject isn't available during testing. If you have any suggestions or insights on how we can effectively test them, I'd be eager to share my preliminary merge request for inclusion.

Sorry I am not completely sure, I'm also wondering how you instantiate the DO for standard local development, which to me sounds like it should be as tricky, but that doesn't sound like an issue based on your message? 🤔

Anyways I've brought this up with the Miniflare author which will be much more suited then me to give you some insights/suggestions on what you can do 🙂

[mrbbot]

Hey @alexanderniebuhr! 👋 Thanks for working on this. I have a few questions on the Durable Objects stuff:

However, I'm facing challenges in devising tests for these

Are you having trouble devising tests for Durable Objects in particular, or all the local bindings?

primarily because a shared DurableObject isn't available during testing

Which shared object are you referring to here? Is this an object you were hoping to implement just for the test? Or an object provided by an Astro user?

[alexanderniebuhr]

Are you having trouble devising tests for Durable Objects in particular, or all the local bindings?

Actually just Durable Objects, all other bindings work perfectly fine. Let's move the discussion to Discord.

Is this an object you were hoping to implement just for the test?

Exactly.

[matthewp]

Love the refactor!