[DO] Adding Durable Object base class #18423
Conversation
Oxyjun
requested review from
a team,
elithrar,
joshthoward and
vy-ton
as code owners
github-actions
bot
added
size/s
product:durable-objects
Deploying cloudflare-docs with
|
| Latest commit: |
0ada43d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8053b844.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://jun-do-base-object-cleanup.cloudflare-docs-7ou.pages.dev |
|
|
||
| - <code> serializeAttachment(value <Type text="any" />)</code>: <Type text="void" /> | ||
|
|
||
| - Keeps a copy of `value` in memory (not on disk) to survive hibernation. The value can be any type supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), which is true of most types. |
There was a problem hiding this comment.
Keeps a copy of
valuein memory (not on disk)
@MellowYarker does a user need to worry about the case where the runtime crashes and potentially loses the in-memory copy? Does this count against the memory consumed by the Durable Object?
There was a problem hiding this comment.
does a user need to worry about the case where the runtime crashes and potentially loses the in-memory copy
Yes, this will not survive a "hard" eviction. The only way this survives eviction is if we do a "soft" eviction (no requests for 10 seconds).
Does this count against the memory consumed by the Durable Object?
Not when the DO is hibernating. When the DO is awake and the WebSocket is in memory (it was just created, or received a message, or was brought back in via state.getWebSockets() it does contribute (because it lives in the isolate).
There was a problem hiding this comment.
@Oxyjun I would add that
Keeps a copy of
valueassociated with the WebSocket to survive hibernation. The value can be any type supported by the structured clone algorithm, which is true of most types. If the value needs to be durable please useDurableObjectStorage(hyperlink the Durable Object storage reference)
This reverts commit 6088c07.
Actioning other PR comments.
Co-authored-by: marciocloudflare <[email protected]>
6 participants
Summary
DurableObjectbase class chapter, and listing its methods, including previously missingfetchandalarm.DurableObjectbase class chapter and Best Practices/Use WebSockets/serializeAttachmentdeserializeAttachmentScreenshots (optional)
Documentation checklist