Add experimental_waitUntil API for long-running tasks - #296
Merged
Conversation
Introduces an internal keep-alive WebSocket endpoint and the experimental_waitUntil method to allow Durable Objects to remain alive while executing long-running async functions. This mechanism uses a self-connecting WebSocket with periodic pings and requires the 'enable_ctx_exports' compatibility flag. Additional handling is added to ignore keep-alive sockets in WebSocket event methods. Based on @eastlondoner's https://github.com/eastlondoner/better-wait-until
🦋 Changeset detectedLatest commit: e4d4f6d The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
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 |
Replaces manual timeout tracking with a Promise.race approach for cleaner and more reliable timeout handling in the async function. This improves code clarity and ensures the function properly rejects if the timeout is reached.
mattzcarey
reviewed
Dec 19, 2025
Comment on lines
+645
to
+663
| const exports = ( | ||
| this.ctx as DurableObjectState & { exports?: Record<string, unknown> } | ||
| ).exports; | ||
| if (!exports) { | ||
| throw new Error( | ||
| "waitUntil requires the 'enable_ctx_exports' compatibility flag. " + | ||
| 'Add it to your wrangler.jsonc: { "compatibility_flags": ["enable_ctx_exports"] }' | ||
| ); | ||
| } | ||
|
|
||
| const namespace = exports[this.#ParentClass.name] as | ||
| | DurableObjectNamespace | ||
| | undefined; | ||
| if (!namespace) { | ||
| throw new Error( | ||
| `Could not find namespace for ${this.#ParentClass.name} in ctx.exports. ` + | ||
| "Make sure the class name matches your Durable Object binding." | ||
| ); | ||
| } |
Collaborator
Author
There was a problem hiding this comment.
the flag is actually on by default now too
mattzcarey
approved these changes
Dec 19, 2025
Merged
10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduces an internal keep-alive WebSocket endpoint and the experimental_waitUntil method to allow Durable Objects to remain alive while executing long-running async functions. This mechanism uses a self-connecting WebSocket with periodic pings and requires the 'enable_ctx_exports' compatibility flag. Additional handling is added to ignore keep-alive sockets in WebSocket event methods.
Based on @eastlondoner's https://github.com/eastlondoner/better-wait-until