stream: preserve asynclocalstorage context in finished()

[gurgunday]

Fixes #57844

[nodejs-github-bot]

Review requested:

• @nodejs/streams

[jasnell]

Inside the finished(...) function definition, you ought to be able to simply use AsyncLocalStore.bind(...) to wrap the callback function such that the current context is preserved. Essentially equivalent to the following except the AsyncLocalStorage.bind(...) call would be inside the finished(...) function body.

const { finished, Readable } = require('stream');
const { AsyncLocalStorage } = require('async_hooks');

const als = new AsyncLocalStorage();
const readable = new Readable();

als.run(123, () => {
  finished(readable, AsyncLocalStorage.bind(() => console.log(als.getStore())));
});

readable.destroy();

[gurgunday]

@jasnell oh you're absolutely right, I missed that, thanks!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.25%. Comparing base (964e41c) to head (cd26628).
Report is 271 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #57865      +/-   ##
==========================================
+ Coverage   90.23%   90.25%   +0.02%     
==========================================
  Files         630      630              
  Lines      185518   185674     +156     
  Branches    36369    36401      +32     
==========================================
+ Hits       167401   167580     +179     
+ Misses      11005    10992      -13     
+ Partials     7112     7102      -10     

Files with missing lines	Coverage Δ
lib/internal/streams/end-of-stream.js	97.28% <100.00%> (+0.03%)	⬆️

... and 27 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[bjohansebas]

It looks good, thanks for working on this

Also, lgtm if the CI passes

[github-actions]

Failed to start CI

   ⚠  No approving reviews found
   ✘  Refusing to run CI on potentially unsafe PR

https://github.com/nodejs/node/actions/runs/14433881994

[rluvaton]

LGTM

[mcollina]

lgtm

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/66248/ 💛

[nodejs-github-bot]

Commit Queue failed

- Loading data for nodejs/node/pull/57865
✔  Done loading data for nodejs/node/pull/57865
----------------------------------- PR info ------------------------------------
Title      stream: preserve asynclocalstorage context in finished() (#57865)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     gurgunday:fix/async-storage-stream-finished -> nodejs:main
Labels     stream, semver-minor, author ready, needs-ci, async_local_storage
Commits    4
 - stream: preserve AsyncLocalStorage context in finished()
 - lazy load asynclocalstorage and make the test more compact
 - simplify
 - revert formatting change
Committers 1
 - Gürgün Dayıoğlu <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/57865
Reviewed-By: Raz Luvaton <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: James M Snell <[email protected]>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/57865
Reviewed-By: Raz Luvaton <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: James M Snell <[email protected]>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sun, 13 Apr 2025 17:28:52 GMT
   ✔  Approvals: 5
   ✔  - Raz Luvaton (@rluvaton): https://github.com/nodejs/node/pull/57865#pullrequestreview-2762874772
   ✔  - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/57865#pullrequestreview-2763392030
   ✔  - Chengzhong Wu (@legendecas) (TSC): https://github.com/nodejs/node/pull/57865#pullrequestreview-2763644164
   ✔  - Ruben Bridgewater (@BridgeAR) (TSC): https://github.com/nodejs/node/pull/57865#pullrequestreview-2764252980
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/57865#pullrequestreview-2764677463
   ✔  Last GitHub CI successful
   ℹ  Last Full PR CI on 2025-04-14T07:42:48Z: https://ci.nodejs.org/job/node-test-pull-request/66248/
- Querying data for job/node-test-pull-request/66248/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 57865
From https://github.com/nodejs/node
 * branch                  refs/pull/57865/merge -> FETCH_HEAD
✔  Fetched commits as 91d8a524ada0..cd2662848d85
--------------------------------------------------------------------------------
[main 88c26eb3e0] stream: preserve AsyncLocalStorage context in finished()
 Author: Gürgün Dayıoğlu <[email protected]>
 Date: Sun Apr 13 20:16:12 2025 +0200
 2 files changed, 48 insertions(+), 6 deletions(-)
 create mode 100644 test/async-hooks/test-async-local-storage-stream-finished.js
[main 7378e68b86] lazy load asynclocalstorage and make the test more compact
 Author: Gürgün Dayıoğlu <[email protected]>
 Date: Sun Apr 13 21:06:27 2025 +0200
 2 files changed, 12 insertions(+), 31 deletions(-)
[main 9f4e36e170] simplify
 Author: Gürgün Dayıoğlu <[email protected]>
 Date: Sun Apr 13 21:07:36 2025 +0200
 1 file changed, 1 insertion(+), 2 deletions(-)
[main 645e86dfef] revert formatting change
 Author: Gürgün Dayıoğlu <[email protected]>
 Date: Mon Apr 14 08:25:53 2025 +0200
 1 file changed, 4 insertions(+), 2 deletions(-)
   ✔  Patches applied
There are 4 commits in the PR. Attempting autorebase.
Rebasing (2/8)
Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
stream: preserve AsyncLocalStorage context in finished()
PR-URL: #57865

Reviewed-By: Raz Luvaton <[email protected]>

Reviewed-By: Matteo Collina <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Ruben Bridgewater <[email protected]>

Reviewed-By: James M Snell <[email protected]>
[detached HEAD b9e82246ab] stream: preserve AsyncLocalStorage context in finished()

Author: Gürgün Dayıoğlu <[email protected]>

Date: Sun Apr 13 20:16:12 2025 +0200

2 files changed, 48 insertions(+), 6 deletions(-)

create mode 100644 test/async-hooks/test-async-local-storage-stream-finished.js

Rebasing (3/8)

Rebasing (4/8)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

lazy load asynclocalstorage and make the test more compact
PR-URL: #57865

Reviewed-By: Raz Luvaton <[email protected]>

Reviewed-By: Matteo Collina <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Ruben Bridgewater <[email protected]>

Reviewed-By: James M Snell <[email protected]>
[detached HEAD d7167b97f1] lazy load asynclocalstorage and make the test more compact

Author: Gürgün Dayıoğlu <[email protected]>

Date: Sun Apr 13 21:06:27 2025 +0200

2 files changed, 12 insertions(+), 31 deletions(-)

Rebasing (5/8)

Rebasing (6/8)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

simplify
PR-URL: #57865

Reviewed-By: Raz Luvaton <[email protected]>

Reviewed-By: Matteo Collina <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Ruben Bridgewater <[email protected]>

Reviewed-By: James M Snell <[email protected]>
[detached HEAD 3f09748864] simplify

Author: Gürgün Dayıoğlu <[email protected]>

Date: Sun Apr 13 21:07:36 2025 +0200

1 file changed, 1 insertion(+), 2 deletions(-)

Rebasing (7/8)

Rebasing (8/8)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

revert formatting change
PR-URL: #57865

Reviewed-By: Raz Luvaton <[email protected]>

Reviewed-By: Matteo Collina <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Ruben Bridgewater <[email protected]>

Reviewed-By: James M Snell <[email protected]>
[detached HEAD 6533a82d1c] revert formatting change

Author: Gürgün Dayıoğlu <[email protected]>

Date: Mon Apr 14 08:25:53 2025 +0200

1 file changed, 4 insertions(+), 2 deletions(-)

Successfully rebased and updated refs/heads/main.
ℹ  Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.

https://github.com/nodejs/node/actions/runs/14475821185

[bjohansebas]

Can this be integrated into node 20?

[nodejs-github-bot]

Landed in 4b2b3c0