具有依赖项的AWS Lambda打包

时间:2020-08-18 06:01:07

标签: node.js aws-lambda node-modules lerna monorepo

进一步概述是在NodeJS和Monorepo(基于Lerna)的背景下进行的。

我有一个AWS堆栈,其中通过AWS CloudFormation部署了多个AWS Lambda。一些lambda很简单(单个小模块),可以内联:

https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Code.html#static-from-wbr-inlinecode

const someLambda = new Function(this, 'some-lambda', {
  code: Code.fromInline(fs.readFileSync(require.resolve(<relative path to lambda module>), 'utf-8')),
  handler: 'index.handler',
  runtime: Runtime.NODEJS_12_X
});

有些没有依赖项,并且打包如下:

const someLambda = new Function(this, 'some-lambda', {
  code: Code.fromAsset(<relative path to folder with lambda>),
  handler: 'index.handler',
  runtime: Runtime.NODEJS_12_X
});

但是,据我所知,在具有依赖项的lambda相对较大的情况下,我们唯一的打包方式(由API提出)是@aws-cdk/aws-lambda-nodejs

import * as lambdaNJS from "@aws-cdk/aws-lambda-nodejs";

export function createNodeJSFunction(
  scope: cdk.Construct, id: string, nodejsFunctionProps: Partial<NodejsFunctionProps>
) {
  const params: NodejsFunctionProps = Object.assign({
    parcelEnvironment: { NODE_ENV: 'production' },
  }, nodejsFunctionProps);

  return new lambdaNJS.NodejsFunction(scope, id, params);
}

对于独立的软件包,它可以很好地工作,但是在monorepo的情况下,它仅挂在堆栈的synth上。 我只是在寻找替代方法,因为我认为捆绑(parcel)BE来源不是一个好主意。

3 个答案:

答案 0 :(得分:1)

尽管软件包zip,我却只需要node_modules就为hoisting创建了以下原始库。

https://github.com/redneckz/slice-node-modules

用法(从monorepo根开始):

$ npx @redneckz/slice-node-modules \
  -e packages/some-lambda/lib/index.js \
  --exclude 'aws-*' \
  --zip some-lambda.zip

--exclude 'aws-*'-默认情况下包含AWS运行时,因此无需打包。

答案 1 :(得分:0)

以下是使用cloudformationtemplate.yml的示例。

创建一个制作文件:Makefile,其目标如下

# Application
APPLICATION=applicatin-name

# AWS
PROFILE=your-profile
REGION=us-east-1
S3_BUCKET=${APPLICATION}-deploy

install:
    rm -rf node_modules
    npm install

clean:
    rm -rf build

build: clean
    mkdir build
    zip -qr build/package.zip src node_modules
    ls -lah build/package.*

deploy:
    sam package \
        --profile ${PROFILE} \
        --region ${REGION} \
        --template-file template.yaml \
        --s3-bucket ${S3_BUCKET} \
        --output-template-file ./build/package.yaml

    sam deploy \
    --profile ${PROFILE} \
    --region ${REGION} \
    --template-file ./build/package.yaml \
    --stack-name ${APPLICATION}-lambda \
    --capabilities CAPABILITY_NAMED_IAM

确保已创建s3存储桶,您可以将此步骤添加为Makefile中的另一个目标。

如何在AWS上构建和部署?

make build
make deploy

答案 2 :(得分:0)

我也遇到过这个问题,我成功地使用了您的 slice-node-modules 有一段时间了。随着我将更多项目整合到 monorepos 中,并开始使用作为兄弟姐妹而不是外部发布的共享依赖项,我遇到了这种方法的缺点。

我创建了一个名为 lerna-to-lambda 的新工具,专门针对我的用例量身定制。我用最少的文档公开发布了它,希望足以帮助处于类似情况的其他人。其要点是,在安装所有依赖项后,在捆绑步骤中运行 l2l,并将所需内容复制到输出目录中,然后准备好使用 SAM 或其他方式部署到 Lambda .

例如,在自述文件中,您的 Lambda 函数的 package.json 中可能有这样的内容:

"scripts": {
  ...
  "clean": "rimraf build lambda",
  "compile": "tsc -p tsconfig.build.json",
  "package": "l2l -i build -o lambda",
  "build": "yarn run clean && yarn run compile && yarn run package"
},

在本例中,compile 步骤是将源目录中的 TypeScript 文件编译为 build 目录中的 JavaScript 文件。然后 package 步骤将 build 中的所有代码以及 Lambda 的所有依赖项(aws-sdk 除外)打包到目录 lambda 中,这就是您要部署的到 AWS。如果有人使用纯 JavaScript 而不是 TypeScript,他们可以在打包前将必要的 .js 文件复制到 build 目录中。

很可能您的解决方案仍然可以很好地满足您的需求,但我想我会在这里分享这个作为替代方案,以防其他人处于类似情况并且在使用 slice-node-modules 时遇到问题。