-
Notifications
You must be signed in to change notification settings - Fork 10k
Add compat flag docs for FinalizationRegistry and WeakRef #20668
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
ketanhwr
merged 3 commits into
cloudflare:production
from
ketanhwr:ketan/add-js-weak-ref
May 6, 2025
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
11 changes: 11 additions & 0 deletions
11
src/content/changelog/workers/2025-04-24-finalization-registry.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: Improved Memory Efficiency for WebAssembly Workers | ||
| description: With the introduction of FinalizationRegistry in Workers Runtime, toolchains like Emscripten and wasm-bindgen can automatically reclaim unused WebAssembly heap and reduce memory leaks. | ||
| products: | ||
| - workers | ||
| date: 2025-05-24T00:00:00Z | ||
| --- | ||
|
|
||
| [FinalizationRegistry](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry) is now available in Workers (opt-in with the `enable_weak_ref` compat flag), so toolchains such as Emscripten and wasm-bindgen can automatically free WebAssembly heap allocations. | ||
|
|
||
| While this will reduce long-running memory growth and leaks to a certain extent, the API still depends on garbage-collector timing and other non-deterministic factors, so treat it as a helpful mitigation rather than a guaranteed fix. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| _build: | ||
| publishResources: false | ||
| render: never | ||
| list: never | ||
|
|
||
| name: "Enable `FinalizationRegistry` and `WeakRef`" | ||
| sort_date: "2025-05-05" | ||
| enable_date: "2025-05-05" | ||
| enable_flag: "enable_weak_ref" | ||
| disable_flag: "disable_weak_ref" | ||
| --- | ||
|
|
||
| Enables the use of [`FinalizationRegistry`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry) and [`WeakRef`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakRef) built-ins. | ||
| * `FinalizationRegistry` allows you to register a cleanup callback that runs after an object has been garbage-collected. | ||
| * `WeakRef` creates a weak reference to an object, allowing it to be garbage-collected if no other strong references exist. | ||
|
|
||
| :::note[Behaviour] | ||
| `FinalizationRegistry` cleanup callbacks may execute at any point during your request lifecycle, even after your invoked handler has completed (similar to `ctx.waitUntil()`). These callbacks do not have an associated async context — you cannot perform any I/O within them, including emitting events to a tail Worker. | ||
| ::: | ||
|
|
||
| :::caution | ||
| These APIs are fundamentally non-deterministic — the timing and execution of garbage collection are unpredictable, and you **should not rely on them for essential program logic**. Additionally, cleanup callbacks registered with `FinalizationRegistry` may **never be executed**, including but not limited to cases where garbage collection is not triggered, or your Worker gets evicted. | ||
| ::: |
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.
Uh oh!
There was an error while loading. Please reload this page.