Commit b12bcc9

Browse files
Qardaduh95
authored andcommitted
async_hooks: add using scopes to AsyncLocalStorage
Adds support for using scope = storage.withScope(data) to do the equivalent of a storage.run(data, fn) with using syntax. This enables avoiding unnecessary closures. PR-URL: #61674 Backport-PR-URL: #65291 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 980c651 commit b12bcc9

6 files changed

Lines changed: 410 additions & 0 deletions

File tree

‎doc/api/async_context.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,110 @@ try {
386386
}
387387
```
388388

389+
### `asyncLocalStorage.withScope(store)`
390+
391+
<!-- YAML
392+
added: REPLACEME
393+
-->
394+
395+
> Stability: 1 - Experimental
396+
397+
*`store` {any}
398+
* Returns: {RunScope}
399+
400+
Creates a disposable scope that enters the given store and automatically
401+
restores the previous store value when the scope is disposed. This method is
402+
designed to work with JavaScript's explicit resource management (`using` syntax).
403+
404+
Example:
405+
406+
```mjs
407+
import { AsyncLocalStorage } from'node:async_hooks';
408+
409+
constasyncLocalStorage=newAsyncLocalStorage();
410+
411+
{
412+
using _ =asyncLocalStorage.withScope('my-store');
413+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
414+
}
415+
416+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
417+
```
418+
419+
```cjs
420+
const { AsyncLocalStorage } =require('node:async_hooks');
421+
422+
constasyncLocalStorage=newAsyncLocalStorage();
423+
424+
{
425+
using _ =asyncLocalStorage.withScope('my-store');
426+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
427+
}
428+
429+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
430+
```
431+
432+
The `withScope()` method is particularly useful for managing context in
433+
synchronous code where you want to ensure the previous store value is restored
434+
when exiting a block, even if an error is thrown.
435+
436+
```mjs
437+
import { AsyncLocalStorage } from'node:async_hooks';
438+
439+
constasyncLocalStorage=newAsyncLocalStorage();
440+
441+
try {
442+
using _ =asyncLocalStorage.withScope('my-store');
443+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
444+
thrownewError('test');
445+
} catch (e) {
446+
// Store is automatically restored even after error
447+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
448+
}
449+
```
450+
451+
```cjs
452+
const { AsyncLocalStorage } =require('node:async_hooks');
453+
454+
constasyncLocalStorage=newAsyncLocalStorage();
455+
456+
try {
457+
using _ =asyncLocalStorage.withScope('my-store');
458+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
459+
thrownewError('test');
460+
} catch (e) {
461+
// Store is automatically restored even after error
462+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
463+
}
464+
```
465+
466+
**Important:** When using `withScope()` in async functions before the first
467+
`await`, be aware that the scope change will affect the caller's context. The
468+
synchronous portion of an async function (before the first `await`) runs
469+
immediately when called, and when it reaches the first `await`, it returns the
470+
promise to the caller. At that point, the scope change becomes visible in the
471+
caller's context and will persist in subsequent synchronous code until something
472+
else changes the scope value. For async operations, prefer using `run()` which
473+
properly isolates context across async boundaries.
474+
475+
```mjs
476+
import { AsyncLocalStorage } from'node:async_hooks';
477+
478+
constasyncLocalStorage=newAsyncLocalStorage();
479+
480+
asyncfunctionexample() {
481+
using _ =asyncLocalStorage.withScope('my-store');
482+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
483+
awaitsomeAsyncOperation(); // Function pauses here and returns promise
484+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
485+
}
486+
487+
// Calling without await
488+
example(); // Synchronous portion runs, then pauses at first await
489+
// After the promise is returned, the scope 'my-store' is now active in caller!
490+
console.log(asyncLocalStorage.getStore()); // Prints: my-store (unexpected!)
491+
```
492+
389493
### Usage with `async/await`
390494

391495
If, within an async function, only one `await` call is to run within a context,
@@ -420,6 +524,64 @@ of `asyncLocalStorage.getStore()` after the calls you suspect are responsible
420524
for the loss. When the code logs `undefined`, the last callback called is
421525
probably responsible for the context loss.
422526

527+
## Class: `RunScope`
528+
529+
<!-- YAML
530+
added: REPLACEME
531+
-->
532+
533+
> Stability: 1 - Experimental
534+
535+
A disposable scope returned by [`asyncLocalStorage.withScope()`][] that
536+
automatically restores the previous store value when disposed. This class
537+
implements the [Explicit Resource Management][] protocol and is designed to work
538+
with JavaScript's `using` syntax.
539+
540+
The scope automatically restores the previous store value when the `using` block
541+
exits, whether through normal completion or by throwing an error.
542+
543+
### `scope.dispose()`
544+
545+
<!-- YAML
546+
added: REPLACEME
547+
-->
548+
549+
Explicitly ends the scope and restores the previous store value. This method
550+
is idempotent: calling it multiple times has the same effect as calling it once.
551+
552+
The `[Symbol.dispose]()` method defers to `dispose()`.
553+
554+
If `withScope()` is called without the `using` keyword, `dispose()` must be
555+
called manually to restore the previous store value. Forgetting to call
556+
`dispose()` will cause the store value to persist for the remainder of the
557+
current execution context:
558+
559+
```mjs
560+
import { AsyncLocalStorage } from'node:async_hooks';
561+
562+
conststorage=newAsyncLocalStorage();
563+
564+
// Without using, the scope must be disposed manually
565+
constscope=storage.withScope('my-store');
566+
// storage.getStore() === 'my-store' here
567+
568+
scope.dispose(); // Restore previous value
569+
// storage.getStore() === undefined here
570+
```
571+
572+
```cjs
573+
const { AsyncLocalStorage } =require('node:async_hooks');
574+
575+
conststorage=newAsyncLocalStorage();
576+
577+
// Without using, the scope must be disposed manually
578+
constscope=storage.withScope('my-store');
579+
// storage.getStore() === 'my-store' here
580+
581+
scope.dispose(); // Restore previous value
582+
// storage.getStore() === undefined here
583+
```
584+
423585
## Class: `AsyncResource`
424586

425587
<!-- YAML
@@ -905,8 +1067,10 @@ const server = createServer((req, res) => {
9051067
}).listen(3000);
9061068
```
9071069
1070+
[Explicit Resource Management]: https://github.com/tc39/proposal-explicit-resource-management
9081071
[`AsyncResource`]: #class-asyncresource
9091072
[`EventEmitter`]: events.md#class-eventemitter
9101073
[`Stream`]: stream.md#stream
9111074
[`Worker`]: worker_threads.md#class-worker
1075+
[`asyncLocalStorage.withScope()`]: #asynclocalstoragewithscopestore
9121076
[`util.promisify()`]: util.md#utilpromisifyoriginal

‎lib/internal/async_local_storage/async_context_frame.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const {
1212
constAsyncContextFrame=require('internal/async_context_frame');
1313
const{ AsyncResource }=require('async_hooks');
1414

15+
constRunScope=require('internal/async_local_storage/run_scope');
16+
1517
classAsyncLocalStorage{
1618
#defaultValue =undefined;
1719
#name =undefined;
@@ -77,6 +79,10 @@ class AsyncLocalStorage {
7779
}
7880
returnframe?.get(this);
7981
}
82+
83+
withScope(store){
84+
returnnewRunScope(this,store);
85+
}
8086
}
8187

8288
module.exports=AsyncLocalStorage;

‎lib/internal/async_local_storage/async_hooks.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ const {
2424
executionAsyncResource,
2525
}=require('async_hooks');
2626

27+
constRunScope=require('internal/async_local_storage/run_scope');
28+
2729
conststorageList=[];
2830

2931
functiongetOrCreateResourceStore(resource){
@@ -156,6 +158,10 @@ class AsyncLocalStorage {
156158
}
157159
returnthis.#defaultValue;
158160
}
161+
162+
withScope(store){
163+
returnnewRunScope(this,store);
164+
}
159165
}
160166

161167
module.exports=AsyncLocalStorage;
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
'use strict';
2+
3+
const{
4+
SymbolDispose,
5+
}=primordials;
6+
7+
classRunScope{
8+
#storage;
9+
#previousStore;
10+
#disposed =false;
11+
12+
constructor(storage,store){
13+
this.#storage =storage;
14+
this.#previousStore =storage.getStore();
15+
storage.enterWith(store);
16+
}
17+
18+
dispose(){
19+
if(this.#disposed){
20+
return;
21+
}
22+
this.#disposed =true;
23+
this.#storage.enterWith(this.#previousStore);
24+
}
25+
26+
[SymbolDispose](){
27+
this.dispose();
28+
}
29+
}
30+
31+
module.exports=RunScope;

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Commit b12bcc9

Browse files
Qardaduh95
authored andcommitted
async_hooks: add using scopes to AsyncLocalStorage
Adds support for using scope = storage.withScope(data) to do the equivalent of a storage.run(data, fn) with using syntax. This enables avoiding unnecessary closures. PR-URL: #61674 Backport-PR-URL: #65291 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 980c651 commit b12bcc9

6 files changed

Lines changed: 410 additions & 0 deletions

File tree

‎doc/api/async_context.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,110 @@ try {
386386
}
387387
```
388388

389+
### `asyncLocalStorage.withScope(store)`
390+
391+
<!-- YAML
392+
added: REPLACEME
393+
-->
394+
395+
> Stability: 1 - Experimental
396+
397+
*`store` {any}
398+
* Returns: {RunScope}
399+
400+
Creates a disposable scope that enters the given store and automatically
401+
restores the previous store value when the scope is disposed. This method is
402+
designed to work with JavaScript's explicit resource management (`using` syntax).
403+
404+
Example:
405+
406+
```mjs
407+
import { AsyncLocalStorage } from'node:async_hooks';
408+
409+
constasyncLocalStorage=newAsyncLocalStorage();
410+
411+
{
412+
using _ =asyncLocalStorage.withScope('my-store');
413+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
414+
}
415+
416+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
417+
```
418+
419+
```cjs
420+
const { AsyncLocalStorage } =require('node:async_hooks');
421+
422+
constasyncLocalStorage=newAsyncLocalStorage();
423+
424+
{
425+
using _ =asyncLocalStorage.withScope('my-store');
426+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
427+
}
428+
429+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
430+
```
431+
432+
The `withScope()` method is particularly useful for managing context in
433+
synchronous code where you want to ensure the previous store value is restored
434+
when exiting a block, even if an error is thrown.
435+
436+
```mjs
437+
import { AsyncLocalStorage } from'node:async_hooks';
438+
439+
constasyncLocalStorage=newAsyncLocalStorage();
440+
441+
try {
442+
using _ =asyncLocalStorage.withScope('my-store');
443+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
444+
thrownewError('test');
445+
} catch (e) {
446+
// Store is automatically restored even after error
447+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
448+
}
449+
```
450+
451+
```cjs
452+
const { AsyncLocalStorage } =require('node:async_hooks');
453+
454+
constasyncLocalStorage=newAsyncLocalStorage();
455+
456+
try {
457+
using _ =asyncLocalStorage.withScope('my-store');
458+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
459+
thrownewError('test');
460+
} catch (e) {
461+
// Store is automatically restored even after error
462+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
463+
}
464+
```
465+
466+
**Important:** When using `withScope()` in async functions before the first
467+
`await`, be aware that the scope change will affect the caller's context. The
468+
synchronous portion of an async function (before the first `await`) runs
469+
immediately when called, and when it reaches the first `await`, it returns the
470+
promise to the caller. At that point, the scope change becomes visible in the
471+
caller's context and will persist in subsequent synchronous code until something
472+
else changes the scope value. For async operations, prefer using `run()` which
473+
properly isolates context across async boundaries.
474+
475+
```mjs
476+
import { AsyncLocalStorage } from'node:async_hooks';
477+
478+
constasyncLocalStorage=newAsyncLocalStorage();
479+
480+
asyncfunctionexample() {
481+
using _ =asyncLocalStorage.withScope('my-store');
482+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
483+
awaitsomeAsyncOperation(); // Function pauses here and returns promise
484+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
485+
}
486+
487+
// Calling without await
488+
example(); // Synchronous portion runs, then pauses at first await
489+
// After the promise is returned, the scope 'my-store' is now active in caller!
490+
console.log(asyncLocalStorage.getStore()); // Prints: my-store (unexpected!)
491+
```
492+
389493
### Usage with `async/await`
390494

391495
If, within an async function, only one `await` call is to run within a context,
@@ -420,6 +524,64 @@ of `asyncLocalStorage.getStore()` after the calls you suspect are responsible
420524
for the loss. When the code logs `undefined`, the last callback called is
421525
probably responsible for the context loss.
422526

527+
## Class: `RunScope`
528+
529+
<!-- YAML
530+
added: REPLACEME
531+
-->
532+
533+
> Stability: 1 - Experimental
534+
535+
A disposable scope returned by [`asyncLocalStorage.withScope()`][] that
536+
automatically restores the previous store value when disposed. This class
537+
implements the [Explicit Resource Management][] protocol and is designed to work
538+
with JavaScript's `using` syntax.
539+
540+
The scope automatically restores the previous store value when the `using` block
541+
exits, whether through normal completion or by throwing an error.
542+
543+
### `scope.dispose()`
544+
545+
<!-- YAML
546+
added: REPLACEME
547+
-->
548+
549+
Explicitly ends the scope and restores the previous store value. This method
550+
is idempotent: calling it multiple times has the same effect as calling it once.
551+
552+
The `[Symbol.dispose]()` method defers to `dispose()`.
553+
554+
If `withScope()` is called without the `using` keyword, `dispose()` must be
555+
called manually to restore the previous store value. Forgetting to call
556+
`dispose()` will cause the store value to persist for the remainder of the
557+
current execution context:
558+
559+
```mjs
560+
import { AsyncLocalStorage } from'node:async_hooks';
561+
562+
conststorage=newAsyncLocalStorage();
563+
564+
// Without using, the scope must be disposed manually
565+
constscope=storage.withScope('my-store');
566+
// storage.getStore() === 'my-store' here
567+
568+
scope.dispose(); // Restore previous value
569+
// storage.getStore() === undefined here
570+
```
571+
572+
```cjs
573+
const { AsyncLocalStorage } =require('node:async_hooks');
574+
575+
conststorage=newAsyncLocalStorage();
576+
577+
// Without using, the scope must be disposed manually
578+
constscope=storage.withScope('my-store');
579+
// storage.getStore() === 'my-store' here
580+
581+
scope.dispose(); // Restore previous value
582+
// storage.getStore() === undefined here
583+
```
584+
423585
## Class: `AsyncResource`
424586

425587
<!-- YAML
@@ -905,8 +1067,10 @@ const server = createServer((req, res) => {
9051067
}).listen(3000);
9061068
```
9071069
1070+
[Explicit Resource Management]: https://github.com/tc39/proposal-explicit-resource-management
9081071
[`AsyncResource`]: #class-asyncresource
9091072
[`EventEmitter`]: events.md#class-eventemitter
9101073
[`Stream`]: stream.md#stream
9111074
[`Worker`]: worker_threads.md#class-worker
1075+
[`asyncLocalStorage.withScope()`]: #asynclocalstoragewithscopestore
9121076
[`util.promisify()`]: util.md#utilpromisifyoriginal

‎lib/internal/async_local_storage/async_context_frame.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const {
1212
constAsyncContextFrame=require('internal/async_context_frame');
1313
const{ AsyncResource }=require('async_hooks');
1414

15+
constRunScope=require('internal/async_local_storage/run_scope');
16+
1517
classAsyncLocalStorage{
1618
#defaultValue =undefined;
1719
#name =undefined;
@@ -77,6 +79,10 @@ class AsyncLocalStorage {
7779
}
7880
returnframe?.get(this);
7981
}
82+
83+
withScope(store){
84+
returnnewRunScope(this,store);
85+
}
8086
}
8187

8288
module.exports=AsyncLocalStorage;

‎lib/internal/async_local_storage/async_hooks.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ const {
2424
executionAsyncResource,
2525
}=require('async_hooks');
2626

27+
constRunScope=require('internal/async_local_storage/run_scope');
28+
2729
conststorageList=[];
2830

2931
functiongetOrCreateResourceStore(resource){
@@ -156,6 +158,10 @@ class AsyncLocalStorage {
156158
}
157159
returnthis.#defaultValue;
158160
}
161+
162+
withScope(store){
163+
returnnewRunScope(this,store);
164+
}
159165
}
160166

161167
module.exports=AsyncLocalStorage;
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
'use strict';
2+
3+
const{
4+
SymbolDispose,
5+
}=primordials;
6+
7+
classRunScope{
8+
#storage;
9+
#previousStore;
10+
#disposed =false;
11+
12+
constructor(storage,store){
13+
this.#storage =storage;
14+
this.#previousStore =storage.getStore();
15+
storage.enterWith(store);
16+
}
17+
18+
dispose(){
19+
if(this.#disposed){
20+
return;
21+
}
22+
this.#disposed =true;
23+
this.#storage.enterWith(this.#previousStore);
24+
}
25+
26+
[SymbolDispose](){
27+
this.dispose();
28+
}
29+
}
30+
31+
module.exports=RunScope;

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit b12bcc9

Browse files
Qardaduh95
authored andcommitted
async_hooks: add using scopes to AsyncLocalStorage
Adds support for using scope = storage.withScope(data) to do the equivalent of a storage.run(data, fn) with using syntax. This enables avoiding unnecessary closures. PR-URL: #61674 Backport-PR-URL: #65291 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 980c651 commit b12bcc9

6 files changed

Lines changed: 410 additions & 0 deletions

File tree

‎doc/api/async_context.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,110 @@ try {
386386
}
387387
```
388388

389+
### `asyncLocalStorage.withScope(store)`
390+
391+
<!-- YAML
392+
added: REPLACEME
393+
-->
394+
395+
> Stability: 1 - Experimental
396+
397+
*`store` {any}
398+
* Returns: {RunScope}
399+
400+
Creates a disposable scope that enters the given store and automatically
401+
restores the previous store value when the scope is disposed. This method is
402+
designed to work with JavaScript's explicit resource management (`using` syntax).
403+
404+
Example:
405+
406+
```mjs
407+
import { AsyncLocalStorage } from'node:async_hooks';
408+
409+
constasyncLocalStorage=newAsyncLocalStorage();
410+
411+
{
412+
using _ =asyncLocalStorage.withScope('my-store');
413+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
414+
}
415+
416+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
417+
```
418+
419+
```cjs
420+
const { AsyncLocalStorage } =require('node:async_hooks');
421+
422+
constasyncLocalStorage=newAsyncLocalStorage();
423+
424+
{
425+
using _ =asyncLocalStorage.withScope('my-store');
426+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
427+
}
428+
429+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
430+
```
431+
432+
The `withScope()` method is particularly useful for managing context in
433+
synchronous code where you want to ensure the previous store value is restored
434+
when exiting a block, even if an error is thrown.
435+
436+
```mjs
437+
import { AsyncLocalStorage } from'node:async_hooks';
438+
439+
constasyncLocalStorage=newAsyncLocalStorage();
440+
441+
try {
442+
using _ =asyncLocalStorage.withScope('my-store');
443+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
444+
thrownewError('test');
445+
} catch (e) {
446+
// Store is automatically restored even after error
447+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
448+
}
449+
```
450+
451+
```cjs
452+
const { AsyncLocalStorage } =require('node:async_hooks');
453+
454+
constasyncLocalStorage=newAsyncLocalStorage();
455+
456+
try {
457+
using _ =asyncLocalStorage.withScope('my-store');
458+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
459+
thrownewError('test');
460+
} catch (e) {
461+
// Store is automatically restored even after error
462+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
463+
}
464+
```
465+
466+
**Important:** When using `withScope()` in async functions before the first
467+
`await`, be aware that the scope change will affect the caller's context. The
468+
synchronous portion of an async function (before the first `await`) runs
469+
immediately when called, and when it reaches the first `await`, it returns the
470+
promise to the caller. At that point, the scope change becomes visible in the
471+
caller's context and will persist in subsequent synchronous code until something
472+
else changes the scope value. For async operations, prefer using `run()` which
473+
properly isolates context across async boundaries.
474+
475+
```mjs
476+
import { AsyncLocalStorage } from'node:async_hooks';
477+
478+
constasyncLocalStorage=newAsyncLocalStorage();
479+
480+
asyncfunctionexample() {
481+
using _ =asyncLocalStorage.withScope('my-store');
482+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
483+
awaitsomeAsyncOperation(); // Function pauses here and returns promise
484+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
485+
}
486+
487+
// Calling without await
488+
example(); // Synchronous portion runs, then pauses at first await
489+
// After the promise is returned, the scope 'my-store' is now active in caller!
490+
console.log(asyncLocalStorage.getStore()); // Prints: my-store (unexpected!)
491+
```
492+
389493
### Usage with `async/await`
390494

391495
If, within an async function, only one `await` call is to run within a context,
@@ -420,6 +524,64 @@ of `asyncLocalStorage.getStore()` after the calls you suspect are responsible
420524
for the loss. When the code logs `undefined`, the last callback called is
421525
probably responsible for the context loss.
422526

527+
## Class: `RunScope`
528+
529+
<!-- YAML
530+
added: REPLACEME
531+
-->
532+
533+
> Stability: 1 - Experimental
534+
535+
A disposable scope returned by [`asyncLocalStorage.withScope()`][] that
536+
automatically restores the previous store value when disposed. This class
537+
implements the [Explicit Resource Management][] protocol and is designed to work
538+
with JavaScript's `using` syntax.
539+
540+
The scope automatically restores the previous store value when the `using` block
541+
exits, whether through normal completion or by throwing an error.
542+
543+
### `scope.dispose()`
544+
545+
<!-- YAML
546+
added: REPLACEME
547+
-->
548+
549+
Explicitly ends the scope and restores the previous store value. This method
550+
is idempotent: calling it multiple times has the same effect as calling it once.
551+
552+
The `[Symbol.dispose]()` method defers to `dispose()`.
553+
554+
If `withScope()` is called without the `using` keyword, `dispose()` must be
555+
called manually to restore the previous store value. Forgetting to call
556+
`dispose()` will cause the store value to persist for the remainder of the
557+
current execution context:
558+
559+
```mjs
560+
import { AsyncLocalStorage } from'node:async_hooks';
561+
562+
conststorage=newAsyncLocalStorage();
563+
564+
// Without using, the scope must be disposed manually
565+
constscope=storage.withScope('my-store');
566+
// storage.getStore() === 'my-store' here
567+
568+
scope.dispose(); // Restore previous value
569+
// storage.getStore() === undefined here
570+
```
571+
572+
```cjs
573+
const { AsyncLocalStorage } =require('node:async_hooks');
574+
575+
conststorage=newAsyncLocalStorage();
576+
577+
// Without using, the scope must be disposed manually
578+
constscope=storage.withScope('my-store');
579+
// storage.getStore() === 'my-store' here
580+
581+
scope.dispose(); // Restore previous value
582+
// storage.getStore() === undefined here
583+
```
584+
423585
## Class: `AsyncResource`
424586

425587
<!-- YAML
@@ -905,8 +1067,10 @@ const server = createServer((req, res) => {
9051067
}).listen(3000);
9061068
```
9071069
1070+
[Explicit Resource Management]: https://github.com/tc39/proposal-explicit-resource-management
9081071
[`AsyncResource`]: #class-asyncresource
9091072
[`EventEmitter`]: events.md#class-eventemitter
9101073
[`Stream`]: stream.md#stream
9111074
[`Worker`]: worker_threads.md#class-worker
1075+
[`asyncLocalStorage.withScope()`]: #asynclocalstoragewithscopestore
9121076
[`util.promisify()`]: util.md#utilpromisifyoriginal

‎lib/internal/async_local_storage/async_context_frame.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const {
1212
constAsyncContextFrame=require('internal/async_context_frame');
1313
const{ AsyncResource }=require('async_hooks');
1414

15+
constRunScope=require('internal/async_local_storage/run_scope');
16+
1517
classAsyncLocalStorage{
1618
#defaultValue =undefined;
1719
#name =undefined;
@@ -77,6 +79,10 @@ class AsyncLocalStorage {
7779
}
7880
returnframe?.get(this);
7981
}
82+
83+
withScope(store){
84+
returnnewRunScope(this,store);
85+
}
8086
}
8187

8288
module.exports=AsyncLocalStorage;

‎lib/internal/async_local_storage/async_hooks.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ const {
2424
executionAsyncResource,
2525
}=require('async_hooks');
2626

27+
constRunScope=require('internal/async_local_storage/run_scope');
28+
2729
conststorageList=[];
2830

2931
functiongetOrCreateResourceStore(resource){
@@ -156,6 +158,10 @@ class AsyncLocalStorage {
156158
}
157159
returnthis.#defaultValue;
158160
}
161+
162+
withScope(store){
163+
returnnewRunScope(this,store);
164+
}
159165
}
160166

161167
module.exports=AsyncLocalStorage;
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
'use strict';
2+
3+
const{
4+
SymbolDispose,
5+
}=primordials;
6+
7+
classRunScope{
8+
#storage;
9+
#previousStore;
10+
#disposed =false;
11+
12+
constructor(storage,store){
13+
this.#storage =storage;
14+
this.#previousStore =storage.getStore();
15+
storage.enterWith(store);
16+
}
17+
18+
dispose(){
19+
if(this.#disposed){
20+
return;
21+
}
22+
this.#disposed =true;
23+
this.#storage.enterWith(this.#previousStore);
24+
}
25+
26+
[SymbolDispose](){
27+
this.dispose();
28+
}
29+
}
30+
31+
module.exports=RunScope;

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit b12bcc9

Browse files
Qardaduh95
authored andcommitted
async_hooks: add using scopes to AsyncLocalStorage
Adds support for using scope = storage.withScope(data) to do the equivalent of a storage.run(data, fn) with using syntax. This enables avoiding unnecessary closures. PR-URL: #61674 Backport-PR-URL: #65291 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 980c651 commit b12bcc9

6 files changed

Lines changed: 410 additions & 0 deletions

File tree

‎doc/api/async_context.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,110 @@ try {
386386
}
387387
```
388388

389+
### `asyncLocalStorage.withScope(store)`
390+
391+
<!-- YAML
392+
added: REPLACEME
393+
-->
394+
395+
> Stability: 1 - Experimental
396+
397+
*`store` {any}
398+
* Returns: {RunScope}
399+
400+
Creates a disposable scope that enters the given store and automatically
401+
restores the previous store value when the scope is disposed. This method is
402+
designed to work with JavaScript's explicit resource management (`using` syntax).
403+
404+
Example:
405+
406+
```mjs
407+
import { AsyncLocalStorage } from'node:async_hooks';
408+
409+
constasyncLocalStorage=newAsyncLocalStorage();
410+
411+
{
412+
using _ =asyncLocalStorage.withScope('my-store');
413+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
414+
}
415+
416+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
417+
```
418+
419+
```cjs
420+
const { AsyncLocalStorage } =require('node:async_hooks');
421+
422+
constasyncLocalStorage=newAsyncLocalStorage();
423+
424+
{
425+
using _ =asyncLocalStorage.withScope('my-store');
426+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
427+
}
428+
429+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
430+
```
431+
432+
The `withScope()` method is particularly useful for managing context in
433+
synchronous code where you want to ensure the previous store value is restored
434+
when exiting a block, even if an error is thrown.
435+
436+
```mjs
437+
import { AsyncLocalStorage } from'node:async_hooks';
438+
439+
constasyncLocalStorage=newAsyncLocalStorage();
440+
441+
try {
442+
using _ =asyncLocalStorage.withScope('my-store');
443+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
444+
thrownewError('test');
445+
} catch (e) {
446+
// Store is automatically restored even after error
447+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
448+
}
449+
```
450+
451+
```cjs
452+
const { AsyncLocalStorage } =require('node:async_hooks');
453+
454+
constasyncLocalStorage=newAsyncLocalStorage();
455+
456+
try {
457+
using _ =asyncLocalStorage.withScope('my-store');
458+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
459+
thrownewError('test');
460+
} catch (e) {
461+
// Store is automatically restored even after error
462+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
463+
}
464+
```
465+
466+
**Important:** When using `withScope()` in async functions before the first
467+
`await`, be aware that the scope change will affect the caller's context. The
468+
synchronous portion of an async function (before the first `await`) runs
469+
immediately when called, and when it reaches the first `await`, it returns the
470+
promise to the caller. At that point, the scope change becomes visible in the
471+
caller's context and will persist in subsequent synchronous code until something
472+
else changes the scope value. For async operations, prefer using `run()` which
473+
properly isolates context across async boundaries.
474+
475+
```mjs
476+
import { AsyncLocalStorage } from'node:async_hooks';
477+
478+
constasyncLocalStorage=newAsyncLocalStorage();
479+
480+
asyncfunctionexample() {
481+
using _ =asyncLocalStorage.withScope('my-store');
482+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
483+
awaitsomeAsyncOperation(); // Function pauses here and returns promise
484+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
485+
}
486+
487+
// Calling without await
488+
example(); // Synchronous portion runs, then pauses at first await
489+
// After the promise is returned, the scope 'my-store' is now active in caller!
490+
console.log(asyncLocalStorage.getStore()); // Prints: my-store (unexpected!)
491+
```
492+
389493
### Usage with `async/await`
390494

391495
If, within an async function, only one `await` call is to run within a context,
@@ -420,6 +524,64 @@ of `asyncLocalStorage.getStore()` after the calls you suspect are responsible
420524
for the loss. When the code logs `undefined`, the last callback called is
421525
probably responsible for the context loss.
422526

527+
## Class: `RunScope`
528+
529+
<!-- YAML
530+
added: REPLACEME
531+
-->
532+
533+
> Stability: 1 - Experimental
534+
535+
A disposable scope returned by [`asyncLocalStorage.withScope()`][] that
536+
automatically restores the previous store value when disposed. This class
537+
implements the [Explicit Resource Management][] protocol and is designed to work
538+
with JavaScript's `using` syntax.
539+
540+
The scope automatically restores the previous store value when the `using` block
541+
exits, whether through normal completion or by throwing an error.
542+
543+
### `scope.dispose()`
544+
545+
<!-- YAML
546+
added: REPLACEME
547+
-->
548+
549+
Explicitly ends the scope and restores the previous store value. This method
550+
is idempotent: calling it multiple times has the same effect as calling it once.
551+
552+
The `[Symbol.dispose]()` method defers to `dispose()`.
553+
554+
If `withScope()` is called without the `using` keyword, `dispose()` must be
555+
called manually to restore the previous store value. Forgetting to call
556+
`dispose()` will cause the store value to persist for the remainder of the
557+
current execution context:
558+
559+
```mjs
560+
import { AsyncLocalStorage } from'node:async_hooks';
561+
562+
conststorage=newAsyncLocalStorage();
563+
564+
// Without using, the scope must be disposed manually
565+
constscope=storage.withScope('my-store');
566+
// storage.getStore() === 'my-store' here
567+
568+
scope.dispose(); // Restore previous value
569+
// storage.getStore() === undefined here
570+
```
571+
572+
```cjs
573+
const { AsyncLocalStorage } =require('node:async_hooks');
574+
575+
conststorage=newAsyncLocalStorage();
576+
577+
// Without using, the scope must be disposed manually
578+
constscope=storage.withScope('my-store');
579+
// storage.getStore() === 'my-store' here
580+
581+
scope.dispose(); // Restore previous value
582+
// storage.getStore() === undefined here
583+
```
584+
423585
## Class: `AsyncResource`
424586

425587
<!-- YAML
@@ -905,8 +1067,10 @@ const server = createServer((req, res) => {
9051067
}).listen(3000);
9061068
```
9071069
1070+
[Explicit Resource Management]: https://github.com/tc39/proposal-explicit-resource-management
9081071
[`AsyncResource`]: #class-asyncresource
9091072
[`EventEmitter`]: events.md#class-eventemitter
9101073
[`Stream`]: stream.md#stream
9111074
[`Worker`]: worker_threads.md#class-worker
1075+
[`asyncLocalStorage.withScope()`]: #asynclocalstoragewithscopestore
9121076
[`util.promisify()`]: util.md#utilpromisifyoriginal

‎lib/internal/async_local_storage/async_context_frame.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const {
1212
constAsyncContextFrame=require('internal/async_context_frame');
1313
const{ AsyncResource }=require('async_hooks');
1414

15+
constRunScope=require('internal/async_local_storage/run_scope');
16+
1517
classAsyncLocalStorage{
1618
#defaultValue =undefined;
1719
#name =undefined;
@@ -77,6 +79,10 @@ class AsyncLocalStorage {
7779
}
7880
returnframe?.get(this);
7981
}
82+
83+
withScope(store){
84+
returnnewRunScope(this,store);
85+
}
8086
}
8187

8288
module.exports=AsyncLocalStorage;

‎lib/internal/async_local_storage/async_hooks.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ const {
2424
executionAsyncResource,
2525
}=require('async_hooks');
2626

27+
constRunScope=require('internal/async_local_storage/run_scope');
28+
2729
conststorageList=[];
2830

2931
functiongetOrCreateResourceStore(resource){
@@ -156,6 +158,10 @@ class AsyncLocalStorage {
156158
}
157159
returnthis.#defaultValue;
158160
}
161+
162+
withScope(store){
163+
returnnewRunScope(this,store);
164+
}
159165
}
160166

161167
module.exports=AsyncLocalStorage;
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
'use strict';
2+
3+
const{
4+
SymbolDispose,
5+
}=primordials;
6+
7+
classRunScope{
8+
#storage;
9+
#previousStore;
10+
#disposed =false;
11+
12+
constructor(storage,store){
13+
this.#storage =storage;
14+
this.#previousStore =storage.getStore();
15+
storage.enterWith(store);
16+
}
17+
18+
dispose(){
19+
if(this.#disposed){
20+
return;
21+
}
22+
this.#disposed =true;
23+
this.#storage.enterWith(this.#previousStore);
24+
}
25+
26+
[SymbolDispose](){
27+
this.dispose();
28+
}
29+
}
30+
31+
module.exports=RunScope;

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Commit b12bcc9

Browse files
Qardaduh95
authored andcommitted
async_hooks: add using scopes to AsyncLocalStorage
Adds support for using scope = storage.withScope(data) to do the equivalent of a storage.run(data, fn) with using syntax. This enables avoiding unnecessary closures. PR-URL: #61674 Backport-PR-URL: #65291 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 980c651 commit b12bcc9

6 files changed

Lines changed: 410 additions & 0 deletions

File tree

‎doc/api/async_context.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,110 @@ try {
386386
}
387387
```
388388

389+
### `asyncLocalStorage.withScope(store)`
390+
391+
<!-- YAML
392+
added: REPLACEME
393+
-->
394+
395+
> Stability: 1 - Experimental
396+
397+
*`store` {any}
398+
* Returns: {RunScope}
399+
400+
Creates a disposable scope that enters the given store and automatically
401+
restores the previous store value when the scope is disposed. This method is
402+
designed to work with JavaScript's explicit resource management (`using` syntax).
403+
404+
Example:
405+
406+
```mjs
407+
import { AsyncLocalStorage } from'node:async_hooks';
408+
409+
constasyncLocalStorage=newAsyncLocalStorage();
410+
411+
{
412+
using _ =asyncLocalStorage.withScope('my-store');
413+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
414+
}
415+
416+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
417+
```
418+
419+
```cjs
420+
const { AsyncLocalStorage } =require('node:async_hooks');
421+
422+
constasyncLocalStorage=newAsyncLocalStorage();
423+
424+
{
425+
using _ =asyncLocalStorage.withScope('my-store');
426+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
427+
}
428+
429+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
430+
```
431+
432+
The `withScope()` method is particularly useful for managing context in
433+
synchronous code where you want to ensure the previous store value is restored
434+
when exiting a block, even if an error is thrown.
435+
436+
```mjs
437+
import { AsyncLocalStorage } from'node:async_hooks';
438+
439+
constasyncLocalStorage=newAsyncLocalStorage();
440+
441+
try {
442+
using _ =asyncLocalStorage.withScope('my-store');
443+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
444+
thrownewError('test');
445+
} catch (e) {
446+
// Store is automatically restored even after error
447+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
448+
}
449+
```
450+
451+
```cjs
452+
const { AsyncLocalStorage } =require('node:async_hooks');
453+
454+
constasyncLocalStorage=newAsyncLocalStorage();
455+
456+
try {
457+
using _ =asyncLocalStorage.withScope('my-store');
458+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
459+
thrownewError('test');
460+
} catch (e) {
461+
// Store is automatically restored even after error
462+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
463+
}
464+
```
465+
466+
**Important:** When using `withScope()` in async functions before the first
467+
`await`, be aware that the scope change will affect the caller's context. The
468+
synchronous portion of an async function (before the first `await`) runs
469+
immediately when called, and when it reaches the first `await`, it returns the
470+
promise to the caller. At that point, the scope change becomes visible in the
471+
caller's context and will persist in subsequent synchronous code until something
472+
else changes the scope value. For async operations, prefer using `run()` which
473+
properly isolates context across async boundaries.
474+
475+
```mjs
476+
import { AsyncLocalStorage } from'node:async_hooks';
477+
478+
constasyncLocalStorage=newAsyncLocalStorage();
479+
480+
asyncfunctionexample() {
481+
using _ =asyncLocalStorage.withScope('my-store');
482+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
483+
awaitsomeAsyncOperation(); // Function pauses here and returns promise
484+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
485+
}
486+
487+
// Calling without await
488+
example(); // Synchronous portion runs, then pauses at first await
489+
// After the promise is returned, the scope 'my-store' is now active in caller!
490+
console.log(asyncLocalStorage.getStore()); // Prints: my-store (unexpected!)
491+
```
492+
389493
### Usage with `async/await`
390494

391495
If, within an async function, only one `await` call is to run within a context,
@@ -420,6 +524,64 @@ of `asyncLocalStorage.getStore()` after the calls you suspect are responsible
420524
for the loss. When the code logs `undefined`, the last callback called is
421525
probably responsible for the context loss.
422526

527+
## Class: `RunScope`
528+
529+
<!-- YAML
530+
added: REPLACEME
531+
-->
532+
533+
> Stability: 1 - Experimental
534+
535+
A disposable scope returned by [`asyncLocalStorage.withScope()`][] that
536+
automatically restores the previous store value when disposed. This class
537+
implements the [Explicit Resource Management][] protocol and is designed to work
538+
with JavaScript's `using` syntax.
539+
540+
The scope automatically restores the previous store value when the `using` block
541+
exits, whether through normal completion or by throwing an error.
542+
543+
### `scope.dispose()`
544+
545+
<!-- YAML
546+
added: REPLACEME
547+
-->
548+
549+
Explicitly ends the scope and restores the previous store value. This method
550+
is idempotent: calling it multiple times has the same effect as calling it once.
551+
552+
The `[Symbol.dispose]()` method defers to `dispose()`.
553+
554+
If `withScope()` is called without the `using` keyword, `dispose()` must be
555+
called manually to restore the previous store value. Forgetting to call
556+
`dispose()` will cause the store value to persist for the remainder of the
557+
current execution context:
558+
559+
```mjs
560+
import { AsyncLocalStorage } from'node:async_hooks';
561+
562+
conststorage=newAsyncLocalStorage();
563+
564+
// Without using, the scope must be disposed manually
565+
constscope=storage.withScope('my-store');
566+
// storage.getStore() === 'my-store' here
567+
568+
scope.dispose(); // Restore previous value
569+
// storage.getStore() === undefined here
570+
```
571+
572+
```cjs
573+
const { AsyncLocalStorage } =require('node:async_hooks');
574+
575+
conststorage=newAsyncLocalStorage();
576+
577+
// Without using, the scope must be disposed manually
578+
constscope=storage.withScope('my-store');
579+
// storage.getStore() === 'my-store' here
580+
581+
scope.dispose(); // Restore previous value
582+
// storage.getStore() === undefined here
583+
```
584+
423585
## Class: `AsyncResource`
424586

425587
<!-- YAML
@@ -905,8 +1067,10 @@ const server = createServer((req, res) => {
9051067
}).listen(3000);
9061068
```
9071069
1070+
[Explicit Resource Management]: https://github.com/tc39/proposal-explicit-resource-management
9081071
[`AsyncResource`]: #class-asyncresource
9091072
[`EventEmitter`]: events.md#class-eventemitter
9101073
[`Stream`]: stream.md#stream
9111074
[`Worker`]: worker_threads.md#class-worker
1075+
[`asyncLocalStorage.withScope()`]: #asynclocalstoragewithscopestore
9121076
[`util.promisify()`]: util.md#utilpromisifyoriginal

‎lib/internal/async_local_storage/async_context_frame.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const {
1212
constAsyncContextFrame=require('internal/async_context_frame');
1313
const{ AsyncResource }=require('async_hooks');
1414

15+
constRunScope=require('internal/async_local_storage/run_scope');
16+
1517
classAsyncLocalStorage{
1618
#defaultValue =undefined;
1719
#name =undefined;
@@ -77,6 +79,10 @@ class AsyncLocalStorage {
7779
}
7880
returnframe?.get(this);
7981
}
82+
83+
withScope(store){
84+
returnnewRunScope(this,store);
85+
}
8086
}
8187

8288
module.exports=AsyncLocalStorage;

‎lib/internal/async_local_storage/async_hooks.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ const {
2424
executionAsyncResource,
2525
}=require('async_hooks');
2626

27+
constRunScope=require('internal/async_local_storage/run_scope');
28+
2729
conststorageList=[];
2830

2931
functiongetOrCreateResourceStore(resource){
@@ -156,6 +158,10 @@ class AsyncLocalStorage {
156158
}
157159
returnthis.#defaultValue;
158160
}
161+
162+
withScope(store){
163+
returnnewRunScope(this,store);
164+
}
159165
}
160166

161167
module.exports=AsyncLocalStorage;
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
'use strict';
2+
3+
const{
4+
SymbolDispose,
5+
}=primordials;
6+
7+
classRunScope{
8+
#storage;
9+
#previousStore;
10+
#disposed =false;
11+
12+
constructor(storage,store){
13+
this.#storage =storage;
14+
this.#previousStore =storage.getStore();
15+
storage.enterWith(store);
16+
}
17+
18+
dispose(){
19+
if(this.#disposed){
20+
return;
21+
}
22+
this.#disposed =true;
23+
this.#storage.enterWith(this.#previousStore);
24+
}
25+
26+
[SymbolDispose](){
27+
this.dispose();
28+
}
29+
}
30+
31+
module.exports=RunScope;

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit b12bcc9

Browse files
Qardaduh95
authored andcommitted
async_hooks: add using scopes to AsyncLocalStorage
Adds support for using scope = storage.withScope(data) to do the equivalent of a storage.run(data, fn) with using syntax. This enables avoiding unnecessary closures. PR-URL: #61674 Backport-PR-URL: #65291 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 980c651 commit b12bcc9

6 files changed

Lines changed: 410 additions & 0 deletions

File tree

‎doc/api/async_context.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,110 @@ try {
386386
}
387387
```
388388

389+
### `asyncLocalStorage.withScope(store)`
390+
391+
<!-- YAML
392+
added: REPLACEME
393+
-->
394+
395+
> Stability: 1 - Experimental
396+
397+
*`store` {any}
398+
* Returns: {RunScope}
399+
400+
Creates a disposable scope that enters the given store and automatically
401+
restores the previous store value when the scope is disposed. This method is
402+
designed to work with JavaScript's explicit resource management (`using` syntax).
403+
404+
Example:
405+
406+
```mjs
407+
import { AsyncLocalStorage } from'node:async_hooks';
408+
409+
constasyncLocalStorage=newAsyncLocalStorage();
410+
411+
{
412+
using _ =asyncLocalStorage.withScope('my-store');
413+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
414+
}
415+
416+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
417+
```
418+
419+
```cjs
420+
const { AsyncLocalStorage } =require('node:async_hooks');
421+
422+
constasyncLocalStorage=newAsyncLocalStorage();
423+
424+
{
425+
using _ =asyncLocalStorage.withScope('my-store');
426+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
427+
}
428+
429+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
430+
```
431+
432+
The `withScope()` method is particularly useful for managing context in
433+
synchronous code where you want to ensure the previous store value is restored
434+
when exiting a block, even if an error is thrown.
435+
436+
```mjs
437+
import { AsyncLocalStorage } from'node:async_hooks';
438+
439+
constasyncLocalStorage=newAsyncLocalStorage();
440+
441+
try {
442+
using _ =asyncLocalStorage.withScope('my-store');
443+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
444+
thrownewError('test');
445+
} catch (e) {
446+
// Store is automatically restored even after error
447+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
448+
}
449+
```
450+
451+
```cjs
452+
const { AsyncLocalStorage } =require('node:async_hooks');
453+
454+
constasyncLocalStorage=newAsyncLocalStorage();
455+
456+
try {
457+
using _ =asyncLocalStorage.withScope('my-store');
458+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
459+
thrownewError('test');
460+
} catch (e) {
461+
// Store is automatically restored even after error
462+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
463+
}
464+
```
465+
466+
**Important:** When using `withScope()` in async functions before the first
467+
`await`, be aware that the scope change will affect the caller's context. The
468+
synchronous portion of an async function (before the first `await`) runs
469+
immediately when called, and when it reaches the first `await`, it returns the
470+
promise to the caller. At that point, the scope change becomes visible in the
471+
caller's context and will persist in subsequent synchronous code until something
472+
else changes the scope value. For async operations, prefer using `run()` which
473+
properly isolates context across async boundaries.
474+
475+
```mjs
476+
import { AsyncLocalStorage } from'node:async_hooks';
477+
478+
constasyncLocalStorage=newAsyncLocalStorage();
479+
480+
asyncfunctionexample() {
481+
using _ =asyncLocalStorage.withScope('my-store');
482+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
483+
awaitsomeAsyncOperation(); // Function pauses here and returns promise
484+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
485+
}
486+
487+
// Calling without await
488+
example(); // Synchronous portion runs, then pauses at first await
489+
// After the promise is returned, the scope 'my-store' is now active in caller!
490+
console.log(asyncLocalStorage.getStore()); // Prints: my-store (unexpected!)
491+
```
492+
389493
### Usage with `async/await`
390494

391495
If, within an async function, only one `await` call is to run within a context,
@@ -420,6 +524,64 @@ of `asyncLocalStorage.getStore()` after the calls you suspect are responsible
420524
for the loss. When the code logs `undefined`, the last callback called is
421525
probably responsible for the context loss.
422526

527+
## Class: `RunScope`
528+
529+
<!-- YAML
530+
added: REPLACEME
531+
-->
532+
533+
> Stability: 1 - Experimental
534+
535+
A disposable scope returned by [`asyncLocalStorage.withScope()`][] that
536+
automatically restores the previous store value when disposed. This class
537+
implements the [Explicit Resource Management][] protocol and is designed to work
538+
with JavaScript's `using` syntax.
539+
540+
The scope automatically restores the previous store value when the `using` block
541+
exits, whether through normal completion or by throwing an error.
542+
543+
### `scope.dispose()`
544+
545+
<!-- YAML
546+
added: REPLACEME
547+
-->
548+
549+
Explicitly ends the scope and restores the previous store value. This method
550+
is idempotent: calling it multiple times has the same effect as calling it once.
551+
552+
The `[Symbol.dispose]()` method defers to `dispose()`.
553+
554+
If `withScope()` is called without the `using` keyword, `dispose()` must be
555+
called manually to restore the previous store value. Forgetting to call
556+
`dispose()` will cause the store value to persist for the remainder of the
557+
current execution context:
558+
559+
```mjs
560+
import { AsyncLocalStorage } from'node:async_hooks';
561+
562+
conststorage=newAsyncLocalStorage();
563+
564+
// Without using, the scope must be disposed manually
565+
constscope=storage.withScope('my-store');
566+
// storage.getStore() === 'my-store' here
567+
568+
scope.dispose(); // Restore previous value
569+
// storage.getStore() === undefined here
570+
```
571+
572+
```cjs
573+
const { AsyncLocalStorage } =require('node:async_hooks');
574+
575+
conststorage=newAsyncLocalStorage();
576+
577+
// Without using, the scope must be disposed manually
578+
constscope=storage.withScope('my-store');
579+
// storage.getStore() === 'my-store' here
580+
581+
scope.dispose(); // Restore previous value
582+
// storage.getStore() === undefined here
583+
```
584+
423585
## Class: `AsyncResource`
424586

425587
<!-- YAML
@@ -905,8 +1067,10 @@ const server = createServer((req, res) => {
9051067
}).listen(3000);
9061068
```
9071069
1070+
[Explicit Resource Management]: https://github.com/tc39/proposal-explicit-resource-management
9081071
[`AsyncResource`]: #class-asyncresource
9091072
[`EventEmitter`]: events.md#class-eventemitter
9101073
[`Stream`]: stream.md#stream
9111074
[`Worker`]: worker_threads.md#class-worker
1075+
[`asyncLocalStorage.withScope()`]: #asynclocalstoragewithscopestore
9121076
[`util.promisify()`]: util.md#utilpromisifyoriginal

‎lib/internal/async_local_storage/async_context_frame.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const {
1212
constAsyncContextFrame=require('internal/async_context_frame');
1313
const{ AsyncResource }=require('async_hooks');
1414

15+
constRunScope=require('internal/async_local_storage/run_scope');
16+
1517
classAsyncLocalStorage{
1618
#defaultValue =undefined;
1719
#name =undefined;
@@ -77,6 +79,10 @@ class AsyncLocalStorage {
7779
}
7880
returnframe?.get(this);
7981
}
82+
83+
withScope(store){
84+
returnnewRunScope(this,store);
85+
}
8086
}
8187

8288
module.exports=AsyncLocalStorage;

‎lib/internal/async_local_storage/async_hooks.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ const {
2424
executionAsyncResource,
2525
}=require('async_hooks');
2626

27+
constRunScope=require('internal/async_local_storage/run_scope');
28+
2729
conststorageList=[];
2830

2931
functiongetOrCreateResourceStore(resource){
@@ -156,6 +158,10 @@ class AsyncLocalStorage {
156158
}
157159
returnthis.#defaultValue;
158160
}
161+
162+
withScope(store){
163+
returnnewRunScope(this,store);
164+
}
159165
}
160166

161167
module.exports=AsyncLocalStorage;
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
'use strict';
2+
3+
const{
4+
SymbolDispose,
5+
}=primordials;
6+
7+
classRunScope{
8+
#storage;
9+
#previousStore;
10+
#disposed =false;
11+
12+
constructor(storage,store){
13+
this.#storage =storage;
14+
this.#previousStore =storage.getStore();
15+
storage.enterWith(store);
16+
}
17+
18+
dispose(){
19+
if(this.#disposed){
20+
return;
21+
}
22+
this.#disposed =true;
23+
this.#storage.enterWith(this.#previousStore);
24+
}
25+
26+
[SymbolDispose](){
27+
this.dispose();
28+
}
29+
}
30+
31+
module.exports=RunScope;

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit b12bcc9

Browse files
Qardaduh95
authored andcommitted
async_hooks: add using scopes to AsyncLocalStorage
Adds support for using scope = storage.withScope(data) to do the equivalent of a storage.run(data, fn) with using syntax. This enables avoiding unnecessary closures. PR-URL: #61674 Backport-PR-URL: #65291 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 980c651 commit b12bcc9

6 files changed

Lines changed: 410 additions & 0 deletions

File tree

‎doc/api/async_context.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,110 @@ try {
386386
}
387387
```
388388

389+
### `asyncLocalStorage.withScope(store)`
390+
391+
<!-- YAML
392+
added: REPLACEME
393+
-->
394+
395+
> Stability: 1 - Experimental
396+
397+
*`store` {any}
398+
* Returns: {RunScope}
399+
400+
Creates a disposable scope that enters the given store and automatically
401+
restores the previous store value when the scope is disposed. This method is
402+
designed to work with JavaScript's explicit resource management (`using` syntax).
403+
404+
Example:
405+
406+
```mjs
407+
import { AsyncLocalStorage } from'node:async_hooks';
408+
409+
constasyncLocalStorage=newAsyncLocalStorage();
410+
411+
{
412+
using _ =asyncLocalStorage.withScope('my-store');
413+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
414+
}
415+
416+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
417+
```
418+
419+
```cjs
420+
const { AsyncLocalStorage } =require('node:async_hooks');
421+
422+
constasyncLocalStorage=newAsyncLocalStorage();
423+
424+
{
425+
using _ =asyncLocalStorage.withScope('my-store');
426+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
427+
}
428+
429+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
430+
```
431+
432+
The `withScope()` method is particularly useful for managing context in
433+
synchronous code where you want to ensure the previous store value is restored
434+
when exiting a block, even if an error is thrown.
435+
436+
```mjs
437+
import { AsyncLocalStorage } from'node:async_hooks';
438+
439+
constasyncLocalStorage=newAsyncLocalStorage();
440+
441+
try {
442+
using _ =asyncLocalStorage.withScope('my-store');
443+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
444+
thrownewError('test');
445+
} catch (e) {
446+
// Store is automatically restored even after error
447+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
448+
}
449+
```
450+
451+
```cjs
452+
const { AsyncLocalStorage } =require('node:async_hooks');
453+
454+
constasyncLocalStorage=newAsyncLocalStorage();
455+
456+
try {
457+
using _ =asyncLocalStorage.withScope('my-store');
458+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
459+
thrownewError('test');
460+
} catch (e) {
461+
// Store is automatically restored even after error
462+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
463+
}
464+
```
465+
466+
**Important:** When using `withScope()` in async functions before the first
467+
`await`, be aware that the scope change will affect the caller's context. The
468+
synchronous portion of an async function (before the first `await`) runs
469+
immediately when called, and when it reaches the first `await`, it returns the
470+
promise to the caller. At that point, the scope change becomes visible in the
471+
caller's context and will persist in subsequent synchronous code until something
472+
else changes the scope value. For async operations, prefer using `run()` which
473+
properly isolates context across async boundaries.
474+
475+
```mjs
476+
import { AsyncLocalStorage } from'node:async_hooks';
477+
478+
constasyncLocalStorage=newAsyncLocalStorage();
479+
480+
asyncfunctionexample() {
481+
using _ =asyncLocalStorage.withScope('my-store');
482+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
483+
awaitsomeAsyncOperation(); // Function pauses here and returns promise
484+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
485+
}
486+
487+
// Calling without await
488+
example(); // Synchronous portion runs, then pauses at first await
489+
// After the promise is returned, the scope 'my-store' is now active in caller!
490+
console.log(asyncLocalStorage.getStore()); // Prints: my-store (unexpected!)
491+
```
492+
389493
### Usage with `async/await`
390494

391495
If, within an async function, only one `await` call is to run within a context,
@@ -420,6 +524,64 @@ of `asyncLocalStorage.getStore()` after the calls you suspect are responsible
420524
for the loss. When the code logs `undefined`, the last callback called is
421525
probably responsible for the context loss.
422526

527+
## Class: `RunScope`
528+
529+
<!-- YAML
530+
added: REPLACEME
531+
-->
532+
533+
> Stability: 1 - Experimental
534+
535+
A disposable scope returned by [`asyncLocalStorage.withScope()`][] that
536+
automatically restores the previous store value when disposed. This class
537+
implements the [Explicit Resource Management][] protocol and is designed to work
538+
with JavaScript's `using` syntax.
539+
540+
The scope automatically restores the previous store value when the `using` block
541+
exits, whether through normal completion or by throwing an error.
542+
543+
### `scope.dispose()`
544+
545+
<!-- YAML
546+
added: REPLACEME
547+
-->
548+
549+
Explicitly ends the scope and restores the previous store value. This method
550+
is idempotent: calling it multiple times has the same effect as calling it once.
551+
552+
The `[Symbol.dispose]()` method defers to `dispose()`.
553+
554+
If `withScope()` is called without the `using` keyword, `dispose()` must be
555+
called manually to restore the previous store value. Forgetting to call
556+
`dispose()` will cause the store value to persist for the remainder of the
557+
current execution context:
558+
559+
```mjs
560+
import { AsyncLocalStorage } from'node:async_hooks';
561+
562+
conststorage=newAsyncLocalStorage();
563+
564+
// Without using, the scope must be disposed manually
565+
constscope=storage.withScope('my-store');
566+
// storage.getStore() === 'my-store' here
567+
568+
scope.dispose(); // Restore previous value
569+
// storage.getStore() === undefined here
570+
```
571+
572+
```cjs
573+
const { AsyncLocalStorage } =require('node:async_hooks');
574+
575+
conststorage=newAsyncLocalStorage();
576+
577+
// Without using, the scope must be disposed manually
578+
constscope=storage.withScope('my-store');
579+
// storage.getStore() === 'my-store' here
580+
581+
scope.dispose(); // Restore previous value
582+
// storage.getStore() === undefined here
583+
```
584+
423585
## Class: `AsyncResource`
424586

425587
<!-- YAML
@@ -905,8 +1067,10 @@ const server = createServer((req, res) => {
9051067
}).listen(3000);
9061068
```
9071069
1070+
[Explicit Resource Management]: https://github.com/tc39/proposal-explicit-resource-management
9081071
[`AsyncResource`]: #class-asyncresource
9091072
[`EventEmitter`]: events.md#class-eventemitter
9101073
[`Stream`]: stream.md#stream
9111074
[`Worker`]: worker_threads.md#class-worker
1075+
[`asyncLocalStorage.withScope()`]: #asynclocalstoragewithscopestore
9121076
[`util.promisify()`]: util.md#utilpromisifyoriginal

‎lib/internal/async_local_storage/async_context_frame.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const {
1212
constAsyncContextFrame=require('internal/async_context_frame');
1313
const{ AsyncResource }=require('async_hooks');
1414

15+
constRunScope=require('internal/async_local_storage/run_scope');
16+
1517
classAsyncLocalStorage{
1618
#defaultValue =undefined;
1719
#name =undefined;
@@ -77,6 +79,10 @@ class AsyncLocalStorage {
7779
}
7880
returnframe?.get(this);
7981
}
82+
83+
withScope(store){
84+
returnnewRunScope(this,store);
85+
}
8086
}
8187

8288
module.exports=AsyncLocalStorage;

‎lib/internal/async_local_storage/async_hooks.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ const {
2424
executionAsyncResource,
2525
}=require('async_hooks');
2626

27+
constRunScope=require('internal/async_local_storage/run_scope');
28+
2729
conststorageList=[];
2830

2931
functiongetOrCreateResourceStore(resource){
@@ -156,6 +158,10 @@ class AsyncLocalStorage {
156158
}
157159
returnthis.#defaultValue;
158160
}
161+
162+
withScope(store){
163+
returnnewRunScope(this,store);
164+
}
159165
}
160166

161167
module.exports=AsyncLocalStorage;
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
'use strict';
2+
3+
const{
4+
SymbolDispose,
5+
}=primordials;
6+
7+
classRunScope{
8+
#storage;
9+
#previousStore;
10+
#disposed =false;
11+
12+
constructor(storage,store){
13+
this.#storage =storage;
14+
this.#previousStore =storage.getStore();
15+
storage.enterWith(store);
16+
}
17+
18+
dispose(){
19+
if(this.#disposed){
20+
return;
21+
}
22+
this.#disposed =true;
23+
this.#storage.enterWith(this.#previousStore);
24+
}
25+
26+
[SymbolDispose](){
27+
this.dispose();
28+
}
29+
}
30+
31+
module.exports=RunScope;

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Commit b12bcc9

Browse files
Qardaduh95
authored andcommitted
async_hooks: add using scopes to AsyncLocalStorage
Adds support for using scope = storage.withScope(data) to do the equivalent of a storage.run(data, fn) with using syntax. This enables avoiding unnecessary closures. PR-URL: #61674 Backport-PR-URL: #65291 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 980c651 commit b12bcc9

6 files changed

Lines changed: 410 additions & 0 deletions

File tree

‎doc/api/async_context.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,110 @@ try {
386386
}
387387
```
388388

389+
### `asyncLocalStorage.withScope(store)`
390+
391+
<!-- YAML
392+
added: REPLACEME
393+
-->
394+
395+
> Stability: 1 - Experimental
396+
397+
*`store` {any}
398+
* Returns: {RunScope}
399+
400+
Creates a disposable scope that enters the given store and automatically
401+
restores the previous store value when the scope is disposed. This method is
402+
designed to work with JavaScript's explicit resource management (`using` syntax).
403+
404+
Example:
405+
406+
```mjs
407+
import { AsyncLocalStorage } from'node:async_hooks';
408+
409+
constasyncLocalStorage=newAsyncLocalStorage();
410+
411+
{
412+
using _ =asyncLocalStorage.withScope('my-store');
413+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
414+
}
415+
416+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
417+
```
418+
419+
```cjs
420+
const { AsyncLocalStorage } =require('node:async_hooks');
421+
422+
constasyncLocalStorage=newAsyncLocalStorage();
423+
424+
{
425+
using _ =asyncLocalStorage.withScope('my-store');
426+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
427+
}
428+
429+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
430+
```
431+
432+
The `withScope()` method is particularly useful for managing context in
433+
synchronous code where you want to ensure the previous store value is restored
434+
when exiting a block, even if an error is thrown.
435+
436+
```mjs
437+
import { AsyncLocalStorage } from'node:async_hooks';
438+
439+
constasyncLocalStorage=newAsyncLocalStorage();
440+
441+
try {
442+
using _ =asyncLocalStorage.withScope('my-store');
443+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
444+
thrownewError('test');
445+
} catch (e) {
446+
// Store is automatically restored even after error
447+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
448+
}
449+
```
450+
451+
```cjs
452+
const { AsyncLocalStorage } =require('node:async_hooks');
453+
454+
constasyncLocalStorage=newAsyncLocalStorage();
455+
456+
try {
457+
using _ =asyncLocalStorage.withScope('my-store');
458+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
459+
thrownewError('test');
460+
} catch (e) {
461+
// Store is automatically restored even after error
462+
console.log(asyncLocalStorage.getStore()); // Prints: undefined
463+
}
464+
```
465+
466+
**Important:** When using `withScope()` in async functions before the first
467+
`await`, be aware that the scope change will affect the caller's context. The
468+
synchronous portion of an async function (before the first `await`) runs
469+
immediately when called, and when it reaches the first `await`, it returns the
470+
promise to the caller. At that point, the scope change becomes visible in the
471+
caller's context and will persist in subsequent synchronous code until something
472+
else changes the scope value. For async operations, prefer using `run()` which
473+
properly isolates context across async boundaries.
474+
475+
```mjs
476+
import { AsyncLocalStorage } from'node:async_hooks';
477+
478+
constasyncLocalStorage=newAsyncLocalStorage();
479+
480+
asyncfunctionexample() {
481+
using _ =asyncLocalStorage.withScope('my-store');
482+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
483+
awaitsomeAsyncOperation(); // Function pauses here and returns promise
484+
console.log(asyncLocalStorage.getStore()); // Prints: my-store
485+
}
486+
487+
// Calling without await
488+
example(); // Synchronous portion runs, then pauses at first await
489+
// After the promise is returned, the scope 'my-store' is now active in caller!
490+
console.log(asyncLocalStorage.getStore()); // Prints: my-store (unexpected!)
491+
```
492+
389493
### Usage with `async/await`
390494

391495
If, within an async function, only one `await` call is to run within a context,
@@ -420,6 +524,64 @@ of `asyncLocalStorage.getStore()` after the calls you suspect are responsible
420524
for the loss. When the code logs `undefined`, the last callback called is
421525
probably responsible for the context loss.
422526

527+
## Class: `RunScope`
528+
529+
<!-- YAML
530+
added: REPLACEME
531+
-->
532+
533+
> Stability: 1 - Experimental
534+
535+
A disposable scope returned by [`asyncLocalStorage.withScope()`][] that
536+
automatically restores the previous store value when disposed. This class
537+
implements the [Explicit Resource Management][] protocol and is designed to work
538+
with JavaScript's `using` syntax.
539+
540+
The scope automatically restores the previous store value when the `using` block
541+
exits, whether through normal completion or by throwing an error.
542+
543+
### `scope.dispose()`
544+
545+
<!-- YAML
546+
added: REPLACEME
547+
-->
548+
549+
Explicitly ends the scope and restores the previous store value. This method
550+
is idempotent: calling it multiple times has the same effect as calling it once.
551+
552+
The `[Symbol.dispose]()` method defers to `dispose()`.
553+
554+
If `withScope()` is called without the `using` keyword, `dispose()` must be
555+
called manually to restore the previous store value. Forgetting to call
556+
`dispose()` will cause the store value to persist for the remainder of the
557+
current execution context:
558+
559+
```mjs
560+
import { AsyncLocalStorage } from'node:async_hooks';
561+
562+
conststorage=newAsyncLocalStorage();
563+
564+
// Without using, the scope must be disposed manually
565+
constscope=storage.withScope('my-store');
566+
// storage.getStore() === 'my-store' here
567+
568+
scope.dispose(); // Restore previous value
569+
// storage.getStore() === undefined here
570+
```
571+
572+
```cjs
573+
const { AsyncLocalStorage } =require('node:async_hooks');
574+
575+
conststorage=newAsyncLocalStorage();
576+
577+
// Without using, the scope must be disposed manually
578+
constscope=storage.withScope('my-store');
579+
// storage.getStore() === 'my-store' here
580+
581+
scope.dispose(); // Restore previous value
582+
// storage.getStore() === undefined here
583+
```
584+
423585
## Class: `AsyncResource`
424586

425587
<!-- YAML
@@ -905,8 +1067,10 @@ const server = createServer((req, res) => {
9051067
}).listen(3000);
9061068
```
9071069
1070+
[Explicit Resource Management]: https://github.com/tc39/proposal-explicit-resource-management
9081071
[`AsyncResource`]: #class-asyncresource
9091072
[`EventEmitter`]: events.md#class-eventemitter
9101073
[`Stream`]: stream.md#stream
9111074
[`Worker`]: worker_threads.md#class-worker
1075+
[`asyncLocalStorage.withScope()`]: #asynclocalstoragewithscopestore
9121076
[`util.promisify()`]: util.md#utilpromisifyoriginal

‎lib/internal/async_local_storage/async_context_frame.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const {
1212
constAsyncContextFrame=require('internal/async_context_frame');
1313
const{ AsyncResource }=require('async_hooks');
1414

15+
constRunScope=require('internal/async_local_storage/run_scope');
16+
1517
classAsyncLocalStorage{
1618
#defaultValue =undefined;
1719
#name =undefined;
@@ -77,6 +79,10 @@ class AsyncLocalStorage {
7779
}
7880
returnframe?.get(this);
7981
}
82+
83+
withScope(store){
84+
returnnewRunScope(this,store);
85+
}
8086
}
8187

8288
module.exports=AsyncLocalStorage;

‎lib/internal/async_local_storage/async_hooks.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ const {
2424
executionAsyncResource,
2525
}=require('async_hooks');
2626

27+
constRunScope=require('internal/async_local_storage/run_scope');
28+
2729
conststorageList=[];
2830

2931
functiongetOrCreateResourceStore(resource){
@@ -156,6 +158,10 @@ class AsyncLocalStorage {
156158
}
157159
returnthis.#defaultValue;
158160
}
161+
162+
withScope(store){
163+
returnnewRunScope(this,store);
164+
}
159165
}
160166

161167
module.exports=AsyncLocalStorage;
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
'use strict';
2+
3+
const{
4+
SymbolDispose,
5+
}=primordials;
6+
7+
classRunScope{
8+
#storage;
9+
#previousStore;
10+
#disposed =false;
11+
12+
constructor(storage,store){
13+
this.#storage =storage;
14+
this.#previousStore =storage.getStore();
15+
storage.enterWith(store);
16+
}
17+
18+
dispose(){
19+
if(this.#disposed){
20+
return;
21+
}
22+
this.#disposed =true;
23+
this.#storage.enterWith(this.#previousStore);
24+
}
25+
26+
[SymbolDispose](){
27+
this.dispose();
28+
}
29+
}
30+
31+
module.exports=RunScope;

0 commit comments

Comments
 (0)