[v12.x backport] async_hooks: add AsyncLocalStorage by puzpuzpuz · Pull Request #32318 · nodejs/node

puzpuzpuz · 2020-03-17T06:30:46Z

Depends on #32131

Backports AsyncLocalStorage into v12. Includes the following PRs:

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

HarshithaKP · 2020-03-17T06:53:29Z

LGTM.

puzpuzpuz · 2020-04-02T13:16:20Z

Rebased to the latest v12.x-staging and included #32503

Remove the need for the destroy hook in the basic APM case. Co-authored-by: Stephen Belanger <admin@stephenbelanger.com> PR-URL: nodejs#30959 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Ensure that resource returned by executionAsyncResource() in before and after hook matches that resource causing this before/after calls. PR-URL: nodejs#31821 Refs: nodejs#30959 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Minwoo Jung <nodecorelab@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>

PR-URL: nodejs#31944 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

This was an oversight in 9fdb6e6. Fixing this is necessary to make `executionAsyncResource()` work as expected. Refs: nodejs#30959 Fixes: nodejs#32060 PR-URL: nodejs#32063 Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Adding AsyncLocalStorage class to async_hooks module. This API provide a simple CLS-like set of features. Co-authored-by: Andrey Pechkurov <apechkurov@gmail.com> PR-URL: nodejs#26540 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

This commit introduces store as the first argument in AsyncLocalStorage's run methods. The change is motivated by the following expectation: most users are going to use a custom object as the store and an extra Map created by the previous implementation is an overhead for their use case. Important note. This is a backwards incompatible change. It was discussed and agreed an incompatible change is ok since the API is still experimental and the modified methods were only added within the last week so usage will be minimal to none. PR-URL: nodejs#31930 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

PR-URL: nodejs#31998 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: nodejs#31995 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

PR-URL: nodejs#32085 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

This allows transitioning the entire following sync and async execution sub-tree to the given async storage context. With this one can be sure the context binding will remain for any following sync activity and all descending async execution whereas the `run*(...)` methods must wrap everything that is intended to exist within the context. This is helpful for scenarios such as prepending a `'connection'` event to an http server which binds everything that occurs within each request to the given context. This is helpful for APMs to minimize the need for patching and especially adding closures. PR-URL: nodejs#31945 Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Add a new scenario of multiple clients sharing a single data callback function managing their response data through AsyncLocalStorage APIs Refs: nodejs#32063 Refs: nodejs#32060 Refs: nodejs#32062 (comment) Co-authored-by: Gireesh Punathil <gpunathi@in.ibm.com> PR-URL: nodejs#32082 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: nodejs#32503 Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

PR-URL: nodejs#31950 Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>

puzpuzpuz · 2020-04-14T07:47:45Z

Included #31950 and #32757 into this backport. Also rebased on the latest v12.x-staging.

nodejs-github-bot · 2020-04-14T07:49:07Z

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

targos · 2020-04-14T11:05:21Z

@puzpuzpuz thank you for maintaining the PR. The next v12.x release will be semver-patch so we can't merge this yet.

puzpuzpuz · 2020-04-14T11:38:37Z

@puzpuzpuz thank you for maintaining the PR. The next v12.x release will be semver-patch so we can't merge this yet.

@targos Thanks for the heads-up. 👍

No problem with that. I'm just trying to keep an eye on this backport and keep it in up-to-date state.

PR-URL: nodejs#31950 Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>

PR-URL: nodejs#32757 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

targos · 2020-04-25T20:14:38Z

Landed on my release preparation branch: https://github.com/targos/node/commits/prepare-minor

nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. v12.x labels Mar 17, 2020

targos added the semver-minor PRs that contain new features and should be released in the next minor version. label Mar 17, 2020

puzpuzpuz mentioned this pull request Mar 17, 2020

[v12.x backport] async_hooks: add executionAsyncResource #32131

Closed

4 tasks

vdeturckheim approved these changes Mar 17, 2020

View reviewed changes

Qard approved these changes Mar 17, 2020

View reviewed changes

codebytere force-pushed the v12.x-staging branch from a01fb4a to e5dc2fb Compare March 23, 2020 16:01

codebytere force-pushed the v12.x-staging branch 2 times, most recently from 63a03d2 to d577190 Compare March 31, 2020 23:57

puzpuzpuz mentioned this pull request Apr 2, 2020

benchmark: fix error on server close in AsyncLocalStorage benchmark #32503

Closed

3 tasks

puzpuzpuz force-pushed the async-local-storage-backport branch from e1ef03f to d2c7cc4 Compare April 2, 2020 13:15

mcollina and others added 10 commits April 14, 2020 10:45

src: move InternalCallbackScope to StartExecution

adc1afb

PR-URL: nodejs#31944 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

test: improve disable AsyncLocalStorage test

be305fe

PR-URL: nodejs#31998 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

async_hooks: fix ctx loss after nested ALS calls

5036117

PR-URL: nodejs#32085 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

HarshithaKP and others added 3 commits April 14, 2020 10:45

async_hooks: prevent sync methods of async storage exiting outer context

4cd19bc

PR-URL: nodejs#31950 Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>

puzpuzpuz force-pushed the async-local-storage-backport branch from d2c7cc4 to aa8419d Compare April 14, 2020 07:45

This was referenced Apr 14, 2020

doc: improve AsyncLocalStorage sample #32757

Closed

async_hooks: prevent async storage methods leaking to outer context #31950

Closed

puzpuzpuz added 2 commits April 14, 2020 15:54

async_hooks: merge run and exit methods

c6f7f55

PR-URL: nodejs#31950 Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>

puzpuzpuz force-pushed the async-local-storage-backport branch from aa8419d to fce0272 Compare April 14, 2020 12:56

thorough-developer mentioned this pull request Apr 22, 2020

Use AsyncLocalStorage if available thorough-developer/fastify-http-context#5

Closed

targos closed this Apr 25, 2020

puzpuzpuz deleted the async-local-storage-backport branch April 26, 2020 06:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[v12.x backport] async_hooks: add AsyncLocalStorage#32318

[v12.x backport] async_hooks: add AsyncLocalStorage#32318
puzpuzpuz wants to merge 15 commits intonodejs:v12.x-stagingfrom
puzpuzpuz:async-local-storage-backport

puzpuzpuz commented Mar 17, 2020 •

edited

Loading

Uh oh!

HarshithaKP commented Mar 17, 2020

Uh oh!

puzpuzpuz commented Apr 2, 2020

Uh oh!

puzpuzpuz commented Apr 14, 2020 •

edited

Loading

Uh oh!

nodejs-github-bot commented Apr 14, 2020

Uh oh!

targos commented Apr 14, 2020

Uh oh!

puzpuzpuz commented Apr 14, 2020

Uh oh!

targos commented Apr 25, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Uh oh!

Conversation

puzpuzpuz commented Mar 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

HarshithaKP commented Mar 17, 2020

Uh oh!

puzpuzpuz commented Apr 2, 2020

Uh oh!

puzpuzpuz commented Apr 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented Apr 14, 2020

Uh oh!

targos commented Apr 14, 2020

Uh oh!

puzpuzpuz commented Apr 14, 2020

Uh oh!

targos commented Apr 25, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

puzpuzpuz commented Mar 17, 2020 •

edited

Loading

puzpuzpuz commented Apr 14, 2020 •

edited

Loading