From 51ae57673dabe0546f796151839c632e7a8dd079 Mon Sep 17 00:00:00 2001
From: Stephen Belanger <admin@stephenbelanger.com>
Date: Sat, 2 Nov 2024 16:14:28 +0100
Subject: [PATCH] lib: make ALS default to AsyncContextFrame
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

PR-URL: https://github.com/nodejs/node/pull/55552
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
---
 doc/api/cli.md                                | 30 +++++++++----------
 lib/internal/async_context_frame.js           |  2 +-
 src/node_options.cc                           |  5 ++--
 ...s => test-without-async-context-frame.mjs} |  4 +--
 4 files changed, 20 insertions(+), 21 deletions(-)
 rename test/parallel/{test-async-context-frame.mjs => test-without-async-context-frame.mjs} (94%)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index eeb7f25f4f82d9..685de52107d153 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -930,21 +930,6 @@ and `"` are usable.
 It is possible to run code containing inline types by passing
 [`--experimental-strip-types`][].
 
-### `--experimental-async-context-frame`
-
-<!-- YAML
-added: v22.7.0
--->
-
-> Stability: 1 - Experimental
-
-Enables the use of [`AsyncLocalStorage`][] backed by `AsyncContextFrame` rather
-than the default implementation which relies on async\_hooks. This new model is
-implemented very differently and so could have differences in how context data
-flows within the application. As such, it is presently recommended to be sure
-your application behaviour is unaffected by this change before using it in
-production.
-
 ### `--experimental-default-type=type`
 
 <!-- YAML
@@ -1663,6 +1648,19 @@ Disable the `node-addons` exports condition as well as disable loading
 native addons. When `--no-addons` is specified, calling `process.dlopen` or
 requiring a native C++ addon will fail and throw an exception.
 
+### `--no-async-context-frame`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 2 - Stable
+
+Disables the use of [`AsyncLocalStorage`][] backed by `AsyncContextFrame` and
+uses the prior implementation which relied on async\_hooks. The previous model
+is retained for compatibility with Electron and for cases where the context
+flow may differ. However, if a difference in flow is found please report it.
+
 ### `--no-deprecation`
 
 <!-- YAML
@@ -3051,7 +3049,6 @@ one is included in the list below.
 * `--enable-source-maps`
 * `--entry-url`
 * `--experimental-abortcontroller`
-* `--experimental-async-context-frame`
 * `--experimental-default-type`
 * `--experimental-detect-module`
 * `--experimental-eventsource`
@@ -3097,6 +3094,7 @@ one is included in the list below.
 * `--napi-modules`
 * `--network-family-autoselection-attempt-timeout`
 * `--no-addons`
+* `--no-async-context-frame`
 * `--no-deprecation`
 * `--no-experimental-global-navigator`
 * `--no-experimental-repl-await`
diff --git a/lib/internal/async_context_frame.js b/lib/internal/async_context_frame.js
index 4e76dbac3dd35a..d2c76c2cbf69e4 100644
--- a/lib/internal/async_context_frame.js
+++ b/lib/internal/async_context_frame.js
@@ -38,7 +38,7 @@ class ActiveAsyncContextFrame extends Map {
 
 function checkEnabled() {
   const enabled = require('internal/options')
-    .getOptionValue('--experimental-async-context-frame');
+    .getOptionValue('--async-context-frame');
 
   // If enabled, swap to active prototype so we don't need to check status
   // on every interaction with the async context frame.
diff --git a/src/node_options.cc b/src/node_options.cc
index e2cfb69a6ecbdf..fcf99febe91dc5 100644
--- a/src/node_options.cc
+++ b/src/node_options.cc
@@ -500,10 +500,11 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
   AddOption(
       "--experimental-wasi-unstable-preview1", "", NoOp{}, kAllowedInEnvvar);
   AddOption("--expose-gc", "expose gc extension", V8Option{}, kAllowedInEnvvar);
-  AddOption("--experimental-async-context-frame",
+  AddOption("--async-context-frame",
             "Improve AsyncLocalStorage performance with AsyncContextFrame",
             &EnvironmentOptions::async_context_frame,
-            kAllowedInEnvvar);
+            kAllowedInEnvvar,
+            true);
   AddOption("--expose-internals", "", &EnvironmentOptions::expose_internals);
   AddOption("--frozen-intrinsics",
             "experimental frozen intrinsics support",
diff --git a/test/parallel/test-async-context-frame.mjs b/test/parallel/test-without-async-context-frame.mjs
similarity index 94%
rename from test/parallel/test-async-context-frame.mjs
rename to test/parallel/test-without-async-context-frame.mjs
index 87f0792702f9d5..dda8f5eaeb77c0 100644
--- a/test/parallel/test-async-context-frame.mjs
+++ b/test/parallel/test-without-async-context-frame.mjs
@@ -41,7 +41,7 @@ const tests = testSets.reduce((m, v) => {
   return m;
 }, []);
 
-describe('AsyncContextFrame', {
+describe('without AsyncContextFrame', {
   // TODO(qard): I think high concurrency causes memory problems on Windows
   // concurrency: tests.length
 }, () => {
@@ -49,7 +49,7 @@ describe('AsyncContextFrame', {
     it(test, async () => {
       const proc = spawn(python, [
         testRunner,
-        '--node-args=--experimental-async-context-frame',
+        '--node-args=--no-async-context-frame',
         test,
       ], {
         stdio: ['ignore', 'ignore', 'inherit'],