aws / aws-lambda-nodejs-runtime-interface-client

Apache License 2.0
177 stars 57 forks source link

Unable to debug lambda code on first request because RIC waits to load handler #75

Open govindrai opened 1 year ago

govindrai commented 1 year ago

I use the following command to run Runtime Interface Emulator/Runtime Interface Client: /usr/local/bin/aws-lambda-rie /usr/bin/npx --node-options="--inspect-brk=0.0.0.0:9229" aws-lambda-ric index.handler

I use VS Code to debug my containerized lambda.

Because of the way the RIE or RIC is instrumented, it doesn't load the node process until the first request is initiated. Because of this the node debugger process doesn't get launched until after the first request. To get around this, I have to issue the request, it hangs because the debugger is waiting for me to attach to it and give it action, then I attach to it, and only then does the debugger start, otherwise the request just sits.

Note: If I use --inspect instead of --inspect-brk then I have to issue two requests. The first request is when the debugger starts. Once the file is loaded, then I attach to the debugger. Now on the second request I can get proper debugging.

Neither solution is adequate. Ideally, I would

  1. Start the RIE/RIC
  2. RIE/RIC would start the node process. This would allow the debugger process to start and the dev could attach to it.
  3. I'd issue my request and it'd stop exactly at the breakpoint where I needed it to be.

Here is my launch.json file

{
    "configurations": [
        {
            "address": "0.0.0.0",
            "localRoot": "${workspaceFolder}",
            "name": "Attach to Lambda's Node Debugger Process",
            "port": 9229,
            "remoteRoot": "/var/task",
            "request": "attach",
            "skipFiles": [
                "<node_internals>/**"
            ],
            "type": "node",
            "continueOnAttach": true
        },
    ]
}

When I start the program here's what happens:

[INFO] (rapid) exec '/usr/bin/npx' (cwd=/var/task, handler=index.handler)

Then I issue an request. Here's what happens:

[INFO] (rapid) Configuring and starting Operator Domain
[INFO] (rapid) Starting runtime domain
START RequestId: d6fe2e68-87d3-4918-bf02-e96665ad7dfa Version: $LATEST
Debugger listening on ws://0.0.0.0:9229/00b2748e-8cc0-492e-8ecf-5d8517802ef7
For help, see: https://nodejs.org/en/docs/inspector
Debugger attached.   

The program stops here because I've initialized it with the --inspect-brk flag so that I don't need to the request twice. (This is where the inefficiency occurs: The process which starts the runtime domain should get initialized earlier and allow the debugger process to get started.)

I then attach to the debugger port and am able to get to my line of code.

lgt commented 1 month ago

I'm interested too, how can we run debugger properly with RIC in VSCODE