Is it possible to use {proxy+} in my route for template-based API Gateway debugging?

Desktop (please complete the following information):

• OS: Windows 10
• VS Code version: 1.63.2
• AWS Toolkit extension version: 1.35.0

Question

I have an SAM template setup such that my API Gateway has a single route that consists only of /{proxy+} and with it I’m using Express JS. In the documentation, it states that the api.path value…

Must be a valid API path resolved from the template.yaml specified by invokeTarget.templatePath.

I tried setting up api.path in the launch.json configuration with both a valid route and with /{proxy+} (which I knew wouldn’t work, but hey), but I get the follow error in either case:

[ERROR]: Local API failed to respond (ECONNREFUSED) after 30 retries, path: /{proxy+}, error: connect ECONNREFUSED 127.0.0.1:5860

Is it possible to use AWS Toolkit debugging with this setup?

Thanks.

[ryancabanas]

@JadenSimon,

Sorry. I forgot to provide the launch.json configuration, which I created using the AWS: SAM Debug Configuration Editor in VSCode, which is pretty neat. Didn’t know that existed. Anyway, here’s my configuration.

{
    "configurations": [
        {
            "type": "aws-sam",
            "request": "direct-invoke",
            "invokeTarget": {
                "target": "api",
                "logicalId": "HelloWorldFunction",
                "templatePath": "C:\\Users\\Ryan\\Desktop\\projects\\tests\\sam-app\\template.yaml"
            },
            "lambda": {
                "runtime": "nodejs14.x"
            },
            "sam": {
                "containerBuild": false,
                "skipNewImageCheck": false
            },
            "api": {
                "path": "/hello",
                "httpMethod": "get"
            },
            "name": "Test"
        }
    ]
}

[JadenSimon]

For example, I use -p for different ports sometimes, I needed to use --parameter-overrides today, I often use -l for logging, and I’ve come to appreciate --warm-containers too. Not to make better debugger support more difficult to implement, but just thought I’d mention some of those often-used switches while we’re on the topic. 😁

That’s definitely a pain-point. Right now the toolkits have an ‘escape-hatch’ in the launch configurations via localArguments (or buildArguments for building) that forwards arguments to SAM CLI:

  "sam": {
        "localArguments": ["-p", "4040"]
    },

But this specific example would break debugging sam local start-api as the toolkit expects the ports to be in a certain way. And I’m sure there’s plenty of things SAM CLI supports that just wouldn’t work nicely with the toolkit. Definitely appreciate the feedback though, very helpful!

Thanks so much again! Have a good weekend!

You’re welcome! You as well. I’m closing out this issue and opening a new one to track API debugging improvements which I’ll link back here.