@pckilgore/now-builder-s3

🌀 now-builder-s3

Deploy your files and AWS lambdas to AWS S3 using now.sh builders.

Supports arbitrary files, Buckets, and bucket paths.

Compile, minify, and/or bundle your lambdas (or push them as is with dependencies)!

Use Cases

Handles:

• Uploading one or many files/objects.
• Zipping one or many objects, and then uploading:
  • Deploy pre-compiled or no-compile AWS lambda functions!
• Building, zipping, and uploading javascript projects:
  • Upload a node JS project, build in the cloud, and deploy as an AWS lambda!

Examples

See these fixtures for real-life examples!

Upload arbitrary folder of stuff

Note: entry point must be a file, but the builder will upload all files in the directory of the entry point.

now.json

{
  "version": 2,
  "build": {
    "env": {
      "AWS_ACCESS_KEY_ID": "@now_s3_iam_access_key",
      "AWS_SECRET_ACCESS_KEY": "@now_s3_iam_secret_key",
      "AWS_REGION": "us-east-2"
    }
  },
  "builds": [
    {
      "src": "./arbitrary-stuff/index.txt",
      "use": "@pckilgore/now-builder-s3",
      "config": {
        "Bucket": "your bucket",
        "objectPath": "an-arbitrary/nested/path/to/put/object" // (not required)
      }
    }
  ]
}

Upload a simple lambda

All files in the entry point's directory will be zipped (go ahead and deploy python lambdas, or a compiled go lambda!).

now.json

{
  "version": 2,
  "build": {
    "env": {
      /*see above*/
    }
  },
  "builds": [
    {
      "src": "src/index.js",
      "use": "@pckilgore/now-builder-s3",
      "config": {
        "Bucket": "test",
        "lambda": { "name": "my-lambda-fn" }
        // will upload to test/my-lambda-fn.zip
      }
    }
  ]
}

src/index.js

const one = require("./some-module");

exports.handler = (evt, ctx) => one();

src/some-module.js

module.exports = () => 1;

Upload a lambda (build before zipping/deploying)

If you set a package.json file as the entry point, your dependencies will be installed before compressing and uploading. (So your uploaded zip will contain all your node_modules!)

If you set config.lambda.build to true, the builder will run your scripts.now-build script. It will then only zip and upload the files in your config.build.distDir folder (defaults to dist/ if not provided).

now.json

{
  "version": 2,
  "build": {
    "env": {
      /* see above*/
    }
  },
  "builds": [
    {
      "src": "package.json",
      "use": "@pckilgore/now-builder-s3",
      "config": {
        "Bucket": "now-builder-s3-test",
        "lambda": {
          "name": "06-compiled-lambda",
          "build": true,
          "distDir": "arbitrary/"
        },
        "objectPath": "06-compiled-lambda/whynotasubfolder/"
      }
    }
  ]
}

A Note on Monorepo Support

This repo was developed to support a lerna monorepo, and should work out of the box for this use case. However, if you use lerna hoisting or yarn workspaces, or link dependencies with yarn link or npm link you will not be able to deploy the node_module style lambda.

This is because the archiving library cannot currenly identify and resolve the hoisted node_modules:

.
├── node_modules <-- Deps hoisted here!
│   └── left-pad
├── packages
│   └── module <-- But we are trying to zip this folder
│       ├── src
│       │   └── index.js
│       └── package.json
├── lerna.json
└── package.json

For this use case, you'll just have to build your lambda (there are good reasons to do this anyways!)

The compiled lambda will have all its deps along for the ride and no need to resolve a hoisted node_modules folder.

Future plans

Import and compose, rather than duplicate, official builders.

Let me know what your use cases are for this!

Right now, I use it to deploy AWS lambdas that manage features now.sh cannot yet provide (Cloudwatch, SNS, SQS, etc...).