Async local storage doesn't work with debuggers

[jaysson]

Package version

5.8.0

Node.js and npm version

Node: v18.6.0, NPM: 8.13.2

Sample Code (to reproduce the issue)

// config/app.ts
export const http = {
  // other config
  useAsyncLocalStorage: true,
}

// app/Services/MyService.ts

import HttpContext from '@ioc:Adonis/Core/HttpContext'

export default class MyService {
  public myFunction() {
    const context = HttpContext.get()
    console.log(context)
  }
}

It works fine when run normally. However context is null if I try to run it with yarn debug, vscode, or webstorm.

VSCode launch config

{
      "type": "node",
      "request": "launch",
      "name": "Debug Backend",
      "runtimeExecutable": "node",
      "runtimeArgs": ["ace", "serve", "--watch"],
      "internalConsoleOptions": "openOnSessionStart",
      "skipFiles": ["<node_internals>/**", "${workspaceRoot}/node_modules/**/*"]
}

[quangthienit1994]

HttpContext working on each request, You can't use like that.

[jaysson]

HttpContext working on each request

That's exactly what I am using it for.

You can't use like that.

Do you mean I can't use debuggers for async local storage? As in that's a node issue?

[quangthienit1994]

I don't know what is "yarn debug", but can you use "const context = HttpContext.get()" in controllers or not ?

[jaysson]

I am able to const context = HttpContext.get() when a debugger is not attached to the node process, irrespective of whether it is a controller or a plain TS class. But I cannot use it if a debugger is attached to the process.

[quangthienit1994]

It's working, No problem. Please check your config and logic.

[jaysson]

You did not run the debugger. Please do that. The issue is about whether it works in conjunction with debugger. Also, I am running it on MacOS if that helps.

[quangthienit1994]

{ "version": "0.2.0", "configurations": [ { "type": "node", "request": "launch", "name": "Launch Program", "runtimeExecutable": "node", "runtimeArgs": ["ace", "serve"], "skipFiles": [ "<node_internals>/**" ], "program": "${file}" } ] }
It's running on debug of VS Code

[jaysson]

I am afraid you are either still not working with the debugger when the request is processing or it just works on Windows. In any case, I am attaching a video of the issue demonstrating it on a fresh AdonisJS project.

https://www.youtube.com/watch?v=SBEwUXcQb1o

[thetutlage]

@jaysson The context you have imported inside your service (in the shared video) is from the incorrect path. Look at the usage section https://docs.adonisjs.com/guides/async-local-storage#usage

[thetutlage]

Also, I am not sure how VSCode debugger works under the hood. What happens when you use the official chrome dev-tools debugger?

Run the following command to start the server in debugging mode.

node ace serve --watch --node-args="--inspect"

Here is Node.js documentation on debugging https://nodejs.org/en/docs/guides/debugging-getting-started/

[jaysson]

Thank you for the response @thetutlage . While I did import the wrong path in the video, I had imported the right one earlier following the guide itself. node ace serve --watch --node-args="--inspect" also has the same problem.

Another video: https://youtu.be/_4ywWADRh1I

[thetutlage]

Alright. Can you share this project as a repo and I will try to reproduce the issue on my end

[thetutlage]

CC @targos Pinging in case you can share some insights on using debugger with Async local storage

[jaysson]

Repo of the same code from the video. It has one route -> controller -> calls a plain TS class.

https://github.com/jaysson/adonis-als-debug

[thetutlage]

After going through this PR nodejs/node#13870. I can see that somewhere between 8.5.0 and the latest release of Node, the issue was fixed.

If you upgrade to the latest version of (ie 18.8.0 as of today) and then try with --inspect flag, then it should work

[jaysson]

I am running node 18.6.0. Let me upgrade to 18.8.0 and see.

[jaysson]

Same issue on 18.8.0 (installed from homebrew). I am still on macOS big sur if that matters.

[thetutlage]

Yup, I can confirm the issue still exists. Have to decouple it from AdonisJS and see if it still exists and then report it with Node

[thetutlage]

I can reproduce it outside of AdonisJS as well. Here is a sample project. https://github.com/thetutlage/node-als-debugging

Going to confirm with @targos before opening an issue

[thetutlage]

Related issue nodejs/node#44415

[targos]

This is fixed in Node.js and will be in the next release. In the mean time, you can use Node.js v16.x, which is not affected by the bug.