add "async mode" to getCloudflareContext

[dario-piotrowicz]

add a new option to getCloudflareContext that makes it run in "async mode", the difference being that the returned value is a promise of the Cloudflare context instead of the context itself

The main of this is that it allows the function to also run during SSG (since the missing context can be created on demand).

---

Closes #371

Docs PR: opennextjs/docs#75

[changeset-bot]

🦋 Changeset detected

Latest commit: 621718e

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	Patch

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

[pkg-pr-new]

Open in Stackblitz

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

commit: 621718e

[vicb]

Added a few inline comments.

I'll take more time to review more closely tomorrow

[dario-piotrowicz]

@vicb sorry I had to update the logic in getCloudflareContext as I realized that in some cases users could get the wrong behavior (a wrong error being thrown), sorry for the inconvenience please have another look 🙏

---

PS: ideally all the different error cases of this (and their error messages) should be tested, for that we would need an extra app that doesn't set initOpenNextCloudflareForDev, also the build SSG aspects can't be properly tested anyways: #331. So it doesn't feel worth it to me (at least not right now, maybe after 331), especially since if things would go wrong at worst users could simply get the wrong error message.
I'm happy to add some tests here or in a followup if you disagree and thing that they'd be worth it.

[vicb]

LGTM

[vicb]

Maybe:

const InitOpenNextCloudflareForDevErrorMsg =`...`;
...
throw new Error(InitOpenNextCloudflareForDevErrorMsg);