如何在 VS Code 中调试本地 AWS Lambda function 与 API 网关编写在 Z558B544CF685F39D8B67E4 中？

Question

我们即将开始使用 Lambda 函数。
我们有必须使用 TypeScript 的技术限制。
当从 Postman 调用相关端点时，我希望能够在 VS Code 中调试我的 ts 文件。

所以，我们有如下的开发环境：

• Windows 10
• Docker 用于 Windows（使用 Hyper-V，不使用 WSL 2）
• TypeScript 4.1
• 节点 12.17
• SAM CLI 1.13.2

我使用sam init和 Hello World 模板来生成初始文件夹结构。
我已经对其进行了增强（主要基于这篇文章）以使用 TypeScript。

文件夹结构

.
├── template.yaml
├── .aws-sam
├── .vscode
|   └── launch.json
├── events
├── hello-world
|   ├── dist
|       ├── app.js
|       └── app.js.map
|   ├── src  
|       └── app.ts
|   ├── package.json
|   └── tsconfig.json

template.yaml

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: >
  LambdaWithApiGateWayDebug

  Sample SAM Template for LambdaWithApiGateWayDebug

Resources:
  HelloWorldFunction:
    Type: AWS::Serverless::Function 
    Properties:
      CodeUri: hello-world/dist
      Handler: app.lambdaHandler
      Runtime: nodejs12.x
      Events:
        HelloWorld:
          Type: Api
          Properties:
            Path: /hello
            Method: get

tsconfig.json

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "sourceMap": true,
    "outDir": "./dist",
    "strict": true,
    "noImplicitAny": true,
    "esModuleInterop": true,
    "sourceRoot": "./src",
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"]
}

package.json

{
  "name": "hello_world",
  "version": "1.0.0",
  "description": "hello world sample for NodeJS",
  "main": "app.js",
  "repository": "https://github.com/awslabs/aws-sam-cli/tree/develop/samcli/local/init/templates/cookiecutter-aws-sam-hello-nodejs",
  "scripts": {
    "compile": "tsc",
    "start": "sam local start-api -t ../template.yaml -p 5000 -d 5678"
  },
  "dependencies": {
    "@types/aws-lambda": "^8.10.64",
    "@types/node": "^14.14.10",
    "aws-sdk": "^2.805.0",
    "source-map-support": "^0.5.19",
    "typescript": "^4.1.2"
  }
}

app.ts

import { APIGatewayProxyEvent, APIGatewayProxyResult } from "aws-lambda";

export const lambdaHandler = async (event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult> => {
    const queries = JSON.stringify(event.queryStringParameters);
    return {
      statusCode: 200,
      body: `Queries: ${queries}`
    }
}

app.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.lambdaHandler = void 0;
const lambdaHandler = async (event) => {
    const queries = JSON.stringify(event.queryStringParameters);
    return {
        statusCode: 200,
        body: `Queries: ${queries}`
    };
};
exports.lambdaHandler = lambdaHandler;
//# sourceMappingURL=app.js.map

app.js.map

{"version":3,"file":"app.js","sourceRoot":"./src/","sources":["app.ts"],"names":[],"mappings":";;;AAEO,MAAM,aAAa,GAAG,KAAK,EAAE,KAA2B,EAAkC,EAAE;IAC/F,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAC5D,OAAO;QACL,UAAU,EAAE,GAAG;QACf,IAAI,EAAE,YAAY,OAAO,EAAE;KAC5B,CAAA;AACL,CAAC,CAAA;AANY,QAAA,aAAa,iBAMzB"}

launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "attach",
            "name": "attach Program",
            "port": 5678,
            "address": "localhost",
            "localRoot": "${workspaceFolder}/hello-world/dist",
            "remoteRoot": "/var/task",
            "protocol": "inspector",
            "sourceMaps": true,
            "smartStep": true,
            "outFiles": ["${workspaceFolder}/hello-world/dist"]
        }
    ]
}

如你看到的：

• 我的 lambda function 定义在hello-world/src/app.ts
• 它符合 commonJs 和 ES2020 目标到hello-world/dist/app.js和 sourcemap
• 该模板通过localhost:5000/hello端点公开位于hello-world/dist下的处理程序
• 调试器正在监听端口 5678

因此，当我调用npm run start ，它会打印以下 output：

> hello_world@1.0.0 start C:\temp\AWS\LambdaWithApiGateWayDebug\hello-world
> sam local start-api -t ../template.yaml -p 5000 -d 5678

Mounting HelloWorldFunction at http://127.0.0.1:5000/hello [GET]
You can now browse to the above endpoints to invoke your functions. You do not need to restart/reload SAM CLI while working on your functions, changes will be reflected instantly/automatically. You only need to restart SAM CLI if you update your AWS SAM template
2020-12-08 11:40:48  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

当我通过 Postman 向端点发出请求时，控制台将扩展为以下文本：

Mounting C:\temp\AWS\LambdaWithApiGateWayDebug\hello-world\dist as /var/task:ro,delegated inside runtime container
START RequestId: 04d884cf-fa96-4d58-b41c-e4196e12de13 Version: $LATEST
Debugger listening on ws://0.0.0.0:5678/d6702717-f291-42cd-8056-22b9f029f4dd
For help, see: https://nodejs.org/en/docs/inspector

当我将 VS Code 附加到节点进程时，我只能调试app.js而不能调试app.ts 。
控制台日志结束：

Debugger attached.
END RequestId: 04d884cf-fa96-4d58-b41c-e4196e12de13
REPORT RequestId: 04d884cf-fa96-4d58-b41c-e4196e12de13  Init Duration: 0.12 ms  Duration: 7064.19 ms    Billed Duration: 7100 ms        Memory Size: 128 MB     Max Memory Used: 128 MB
No Content-Type given. Defaulting to 'application/json'.
2020-12-08 11:40:58 127.0.0.1 - - [08/Dec/2020 11:40:58] "GET /hello HTTP/1.1" 200 -

问题

我应该改变什么才能调试我的app.ts而不是app.js ？

Answer 1

我写了一篇中篇文章，解释如何创建、调用和调试 TypeScript lambda function。 请查看以下链接了解更多详情。

要求

• 山姆命令行界面
• Docker
• 节点
• 视觉工作室代码

1-创建一个nodejs12x；

1. 创建一个nodejs12x lambda；

2. 安装 TypeScript： npm i -g typescript

3. 初始化 typescript： tsc --init （它将创建 tsconfig.json 文件）

4. 将创建的 tsconfig.json 文件替换为以下代码：

    { "compilerOptions": { "module": "CommonJS", "target": "ES2017", "noImplicitAny": true, "preserveConstEnums": true, "outDir": "./built", "sourceMap": true }, "include": ["handler/**/*"], "exclude": ["node_modules", "**/*.spec.ts"] }

5. 删除 app.js 文件；

6. 在处理程序文件夹内的 TypeScript 代码中创建 lambda （您需要创建它）：

    import { APIGatewayProxyEvent, APIGatewayProxyResult } from "aws-lambda"; export const lambdaHandler = async ( event: APIGatewayProxyEvent ): Promise<APIGatewayProxyResult> => { const queries = JSON.stringify(event.queryStringParameters); return { statusCode: 200, body: `Queries: ${queries}` } }

7. 适配模板.yaml。 更改 lambda 的 CodeUri 路径： CodeUri: hello-world/built

8. 安装所需的节点包： npm install typescript @types/aws-lambda @types/node -save-dev

9. Package json：

    { "name": "typescript_lambda", "version": "1.0.0", "description": "hello world sample for TypeScript", "main": "app.js", "repository": "https://github.com/jafreitas90/AWS", "author": "Jorge Freitas", "license": "JorgeFreitas Ltd:)", "dependencies": { }, "scripts": { "compile": "tsc" }, "devDependencies": { "@types/aws-lambda": "^8.10.71", "@types/node": "^14.14.22", "aws-sdk": "^2.815.0", "typescript": "^4.1.3" } }

10. npm安装

11. npm 运行编译

12. 在 lambda function（TypeScript 代码）中设置断点。 在左侧面板上 select 调试然后开始调试（顶部的绿色按钮）。 就是这样：）

13. 项目结构

请在我的教程中找到更多详细信息。

源代码

Answer 2

事实证明，我犯了两个小错误：

源根

我在tsconfig.json中设置sourceRoot ，在这种情况下这是不必要的。 include就足够了：

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "sourceMap": true,
    "outDir": "./dist",
    "strict": true,
    "noImplicitAny": true,
    "esModuleInterop": true,
    // "sourceRoot": "./src",
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"]
}

断点

我设置了两个断点：一个在app.js中，另一个在app.ts中。
事实证明，如果app.js确实有断点，则不会触发另一个断点。

因此，在我从app.js中删除断点后，调试器在app.ts内停止。

Answer 3

您的 Lambda 运行时是 JavaScript，但您在 TypeScript 中编写代码。 当您使用 TypeScript 时，编译器会在后台将您的代码转换为可调试代码 JavaScript。

换句话说，您在 TS 中编写 lambda 代码，编译器然后将其转换为 JS，最后是可以执行并可以调试的代码。