Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: edit async_context context loss text #41550

Merged
merged 1 commit into from
Jan 18, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 9 additions & 12 deletions doc/api/async_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,22 +316,19 @@ functions called by `foo`. Outside of `run`, calling `getStore` will return

### Troubleshooting: Context loss

In most cases your application or library code should have no issues with
`AsyncLocalStorage`. But in rare cases you may face situations when the
current store is lost in one of the asynchronous operations. In those cases,
consider the following options.
In most cases, `AsyncLocalStorage` works without issues. In rare situations, the
current store is lost in one of the asynchronous operations.

If your code is callback-based, it is enough to promisify it with
[`util.promisify()`][], so it starts working with native promises.
[`util.promisify()`][] so it starts working with native promises.

If you need to keep using callback-based API, or your code assumes
If you need to use a callback-based API or your code assumes
a custom thenable implementation, use the [`AsyncResource`][] class
to associate the asynchronous operation with the correct execution context. To
do so, you will need to identify the function call responsible for the
context loss. You can do that by logging the content of
`asyncLocalStorage.getStore()` after the calls you suspect are responsible for
the loss. When the code logs `undefined`, the last callback called is probably
responsible for the context loss.
to associate the asynchronous operation with the correct execution context.
Find the function call responsible for the context loss by logging the content
of `asyncLocalStorage.getStore()` after the calls you suspect are responsible
for the loss. When the code logs `undefined`, the last callback called is
probably responsible for the context loss.

## Class: `AsyncResource`

Expand Down