Workflows: add info that in local dev, pause and resume methods are not available #19988
Conversation
bruxodasilva
requested review from
GregBrimble,
irvinebroque,
mikenomitch,
WalshyDev,
ToriLindsay and
a team
as code owners
github-actions
bot
assigned GregBrimble, irvinebroque, mikenomitch, ToriLindsay and WalshyDev
There was a problem hiding this comment.
Seems much more discoverable here, no?
https://docs.sentry.io/platforms/javascript/guides/cloudflare/
If I call one of these unsupported methods locally, how do I know it's not supposed to work, without reading the docs?
|
|
||
| With any bindings that are not supported locally, you will need to use the [`--remote` command](#develop-using-remote-resources-and-bindings) in wrangler, such as `wrangler dev --remote`. | ||
|
|
||
| [^1]: Using Workers AI always accesses your Cloudflare account in order to run AI models and will incur usage charges even in local development. | ||
|
|
||
| [^2]: Using Vectorize always accesses your Cloudflare account to run queries, and will incur usage charges even in local development. | ||
|
|
||
| [^3]: `pause()` and `resume()` are not available in local development. |
There was a problem hiding this comment.
If they're not in local dev, and Workflows doesn't work in remote dev, that means...you just have to write code ship to prod and trust it will work? Or am I missing something?
There was a problem hiding this comment.
@irvinebroque No, you're correct. pause and resume are not supported locally. However, writing and running a WorkflowEntrypoint is. wrangler dev on a project that exports a WorkflowEntrypoint works and that's what I would classify as local development to assert if something works before shipping to production.
Pause and resume are unsupported at the moment due to a miniflare limitation (killing the engine DO kills all threads unless I'm mistaken). Pause and resume are also often not in the happy path for p90 Workflows use cases so we are happy with that being a foot note for now until we are unblocked.
Guessing link is incorrect. Using them locally throws an Error documenting that they are unsupported at the moment. |
Summary
Add info that for Workflows, in local dev, pause and resume methods are not available
Relates to issue 8128
Closes WOR-506