Node Debug serverless offline using vscode

Question

I am using VS Code for development of AWS Lambda functions, I started using the serverless framework and the serverless offline library but, I am unable to use VS Code's debug mode to locally debug the code.

I am referring many sites, Following is one of them: https://medium.com/@OneMuppet_/debugging-lambada-functions-locally-in-vscode-with-actual-break-points-deee6235f590

My project structure is as follows:

Package.json:

launch.json:

I get the following error when I start debug:

Can someone please guide, with the correct configuration?

what does your launch.json config look like? – joeCarpenter May 01 '19 at 19:58 — joeCarpenter, May 01 '19 at 19:58
@joeCarpenter updated the question with launch.json – Dev1ce May 02 '19 at 02:53 — Dev1ce, May 02 '19 at 02:53
Thank you Aniruddha. Still not able to get it going – joeCarpenter May 02 '19 at 12:44 — joeCarpenter, May 02 '19 at 12:44

score 10 · Answer 1 · answered Jan 24 '20 at 09:31

in the package.json add debug script:

"scripts": {
.......
    "debug": "node --inspect node_modules/serverless/bin/serverless offline -s dev",
.........
}

VS code lunch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "cwd": "${workspaceFolder}",
      "name": "Serverless",
      "runtimeExecutable": "npm",
      "runtimeArgs": [
        "run",
        "debug"
      ],
      "port": 9229
    }
  ]
}

Then start debugging from VS code

Why on vscode output panel I wont get the same logging msgs as I would on a normal terminal session? — koalaok, Nov 17 '21 at 13:31

score 4 · Answer 2 · answered Apr 30 '19 at 02:53

4

The warning you are seeing is a deprecation warning; the legacy debugger (--debug) has been deprecated since Node 7.7.0. The correct way to attach a node debugger to serverless offline is by using --inspect:

node --inspect $(npm bin)/sls offline start

answered Apr 30 '19 at 02:53

Daniel Cottone

4,257
24
39

with this I get the the Debugger listening, however how do I actually get my debugging profile configured? – joeCarpenter May 01 '19 at 20:01
Do I put this in the debug script in package.json? – Dev1ce May 02 '19 at 02:55
@AniruddhaRaje yeah, you can replace the `debug` script in `package.json`. – Daniel Cottone May 02 '19 at 08:36
hmmm ok, so what does $(npm bin) mean? I tried to run that exact code but no luck. – Alex Coroza Jan 17 '20 at 09:45
thanks, it was exactly the answer I needed! – David Peer Oct 12 '21 at 13:22
try using $(which sls) offline – piyushkantm Jan 16 '22 at 17:36

score 0 · Answer 3 · answered Feb 03 '23 at 03:25

If you have a valid sample event in JSON format AND you are OK with debugging one function at a time, then here is a configuration that has worked great for me. It enables breakpoints and step-through debuggin exactly as you'd expect:

    {
      "type": "node",
      "request": "launch",
      "cwd": "${workspaceFolder}",
      "name": "sls invoke local: myFunction",
      "runtimeExecutable": "sls",
      "runtimeArgs": [
        "invoke",
        "local",
        "-f",
        "loadOptions",
        "-p",
        "activities/myFunction/myFunction-event.json"
      ],
    },

Node Debug serverless offline using vscode

3 Answers3