How to load npm modules in AWS Lambda?

问题:

I've created several Lambda functions using the web based editor. So far so good. I'd now like to start extending those with modules (such as Q for promises). I can't figure out how to get the modules out to Lambda so they can be consumed by my functions.

I've read through this but it seems to involve setting up an EC2 and running Lambda functions from there. There is a mechanism to upload a zip when creating a function but that seems to involve sending up functions developed locally. Since I'm working in the web based editor that seems like a strange workflow.

How can I simply deploy some modules for use in my Lambda functions?

回答1:

I'm pretty sure you cannot load NPM modules without uploading a .zip file.

But you can actually get this process down to two quick command lines.

Here's how:

1. Put your Lambda function file(s) in a separate directory. This is because you install npm packages locally for Lambda and you want to be able to isolate and test what you will upload to Lambda.

2. Install your NPM packages locally with npm install packageName while you're in your separate Lambda directory you created in step #1.

3. Make sure your function works when run locally: node lambdaFunc.js (you can simply comment out the two export.handler lines in your code to adapt your code to run with Node locally).

4. Ok, your Lambda package works. Zip it up with a command such as zip -r lambdaFunc.zip . while in your Lambda package's directory. Make sure to not zip the directory itself but the contents of the directory.

5. If you have the aws-cli installed, which I suggest having if you want to make your life easier, you can now enter this command:

   aws lambda update-function-code --function-name lambdaFunc \
   --zip-file file://~/path/to/your/lambdaFunc.zip
   

   (no quotes around the lambdaFunc part above in case you wonder like I did)

6. Now you can click test in the Lambda console.

7. I suggest adding a short alias for both of the above commands. Here's what I have in mine for the much longer Lambda update command:

   alias up="aws lambda update-function-code --function-name lambdaFunc \
   --zip-file fileb://~/path/to/your/lambdaFunc.zip"
   

回答2:

A .zip file is required in order to include npm modules in Lambda. And you really shouldn't be using the Lambda web editor for much of anything- as with any production code, you should be developing locally, committing to git, etc.

MY FLOW:

1) My Lambda functions are usually helper utilities for a larger project, so I create a /aws/lambdas directory within that to house them.

2) Each individual lambda directory contains an index.js file containing the function code, a package.json file defining dependencies, and a /node_modules subdirectory. (The package.json file is not used by Lambda, it's just so we can locally run the npm install command.)

package.json:

{
  "name": "my_lambda",
  "dependencies": {
    "svg2png": "^4.1.1"
  }
}

3) I .gitignore all node_modules directories and .zip files so that the files generated from npm installs and zipping won't clutter our repo.

.gitignore:

# Ignore node_modules
**/node_modules

# Ignore any zip files
*.zip

4) I install modules, develop and test locally

5) I .zip the lambda directory and upload it via the console.

(IMPORTANT: Do not use Mac's 'compress' utility from Finder to zip the file! You must run zip from the CLI from within the root of the directory- see here)

zip -r ../yourfilename.zip * 

---

See also AWS Lambda Deployment Package in Node.js - AWS Lambda

---

NOTE:

You might run into a problem where a module like PhantomJS builds OS-specific binaries, and so the node package built locally on OSX ends up failing in Lambda.

The answer I found here was to use these scripts to build it within a Docker container.

回答3:

Hope this helps, with Serverless framework you can do something like this:

1. Add these things in your serverless.yml file:

plugins: - serverless-webpack custom: webpackIncludeModules: forceInclude: - <your package name> (for example: node-fetch) 2. Then create your Lambda function, deploy it by serverless deploy, the package that included in serverless.yml will be there for you.

For more information about serverless: https://serverless.com/framework/docs/providers/aws/guide/quick-start/