/netlify-lambda

Helps building and serving lambda functions locally and in CI environments

Primary LanguageJavaScript

Netlify Lambda

This is an optional tool that helps with building or locally developing Netlify Functions with a simple webpack/babel build step.

The goal is to make it easy to write Lambda's with transpiled JS/TypeScript features and imported modules.

Installation

We recommend installing locally rather than globally:

yarn add -D netlify-lambda

This will ensure your build scripts don't assume a global install which is better for your CI/CD (for example with Netlify's buildbot).

If you don't have a netlify.toml file, you'll need one (example). Define the functions field where the functions will be built to and served from, e.g.

# example netlify.toml
[build]
  command = "yarn build"
  functions = "lambda" #  netlify-lambda reads this
  publish = "build"

Usage

We expose two commands:

netlify-lambda serve <folder>
netlify-lambda build <folder>

At a high level, netlify-lambda takes a source folder (e.g. src/lambda, specified in your command) and outputs it to a built folder, (e.g. built-lambda, specified in your netlify.toml file).

The build function will run a single build of the functions in the folder.

The serve function will start a dev server for the source folder and route requests with a .netlify/functions/ prefix, with a default port of 9000:

folder/hello.js -> http://localhost:9000/.netlify/functions/hello

It also watches your files and restarts the dev server on change. Note: if you add a new file you should kill and restart the process to pick up the new file.

IMPORTANT:

  • You need a netlify.toml file with a functions field.
  • Every function needs to be a top-level js/ts/mjs file. You can have subfolders inside the netlify-lambda folder, but those are only for supporting files to be imported by your top level function. Files that end with .spec.* or .test.* will be ignored so you can colocate your tests.
  • Function signatures follow the AWS event handler syntax but must be named handler. We use Node v8 so async functions are supported (beware common mistakes!). Read Netlify Functions docs for more info.
Environment variables in build and branch contextx

Read Netlify's documentation on environment variables. netlify-lambda should respect the env variables you supply in netlify.toml accordingly (except for deploy previews, which make no sense to locally emulate).

However, this is a relatively new feature, so if you encounter issues, file one.

Lambda function examples If you are new to writing Lambda functions, this section may help you. Function signatures should conform to one of either two styles. Traditional callback style: 
exports.handler = function(event, context, callback) {
// your server-side functionality
callback(null, {
  statusCode: 200,
  body: JSON.stringify({
    message: `Hello world ${Math.floor(Math.random() * 10)}`
  })
});
};

or you can use async/await:

export async function handler(event, context) {
  return {
    statusCode: 200,
    body: JSON.stringify({ message: `Hello world ${Math.floor(Math.random() * 10)}` })
  };
}

For more Functions examples, check:

Using with create-react-app, Gatsby, and other development servers

Why you need to proxy (for beginners)

react-scripts (the underlying library for create-react-app) and other popular development servers often set up catchall serving for you; in other words, if you try to request a route that doesn't exist, the dev server will try to serve you /index.html. This is problematic when you are trying to hit a local API endpoint like netlify-lambda sets up for you - your browser will attempt to parse the index.html file as JSON. This is why you may see this error:

Uncaught (in promise) SyntaxError: Unexpected token < in JSON at position 0

If this desribes your situation, then you need to proxy for local development. Read on. Don't worry it's easier than it looks.

Proxying for local development

⚠️IMPORTANT! PLEASE READ THIS ESPECIALLY IF YOU HAVE CORS ISSUES⚠️

When your function is deployed on Netlify, it will be available at /.netlify/functions/function-name for any given deploy context. It is advantageous to proxy the netlify-lambda serve development server to the same path on your primary development server.

Say you are running webpack-serve on port 8080 and netlify-lambda serve on port 9000. Mounting localhost:9000 to /.netlify/functions/ on your webpack-serve server (localhost:8080/.netlify/functions/) will closely replicate what the final production environment will look like during development, and will allow you to assume the same function url path in development and in production.

Example webpack config:

module.exports = {
  mode: 'development',
  devServer: {
    proxy: {
      '/.netlify': {
        target: 'http://localhost:9000',
        pathRewrite: { '^/.netlify/functions': '' }
      }
    }
  }
};
Using with `Angular CLI`

CORS issues when trying to use netlify-lambdas locally with angular? you need to set up a proxy.

Firstly make sure you are using relative paths in your app to ensure that your app will work locally and on Netlify, example below...

this.http.get('/.netlify/functions/jokeTypescript');

Then place a proxy.config.json file in the root of your project, the contents should look something like...

{
  "/.netlify/functions/*": {
    "target": "http://localhost:9000",
    "secure": false,
    "logLevel": "debug",
    "changeOrigin": true
  }
}
  • The key should match up with the location of your Transpiled functions as defined in your netlify.toml
  • The target should match the port that the lambdas are being served on (:9000 by default)

When you run up your Angular project you need to pass in the proxy config with the flag --proxy-config like so...

  ng serve --proxy-config proxy.config.json

To make your life easier you can add these to your scripts in package.json

  "scripts": {
    "start": "ng serve --proxy-config proxy.config.json",
    "build": "ng build --prod --aot && yarn nlb",
    "nls": "netlify-lambda serve src_functions",
    "nlb": "netlify-lambda build src_functions"
  }

Obviously you need to run up netlify-lambda & angular at the same time.

Webpack Configuration

By default the webpack configuration uses babel-loader to load all js files. Any .babelrc in the directory netlify-lambda is run from will be respected. If no .babelrc is found, a few basic settings are used.

If you need to use additional webpack modules or loaders, you can specify an additional webpack config with the -c/--config option when running either serve or build. See this issue for an example of how to write a webpack override file.

The additional webpack config will be merged into the default config via webpack-merge's merge.smart method.

Babel configuration

The default webpack configuration uses babel-loader with a few basic settings.

However, if any .babelrc is found in the directory netlify-lambda is run from, or folders above it (useful for monorepos), it will be used instead of the default one.

If you need to run different babel versions for your lambda and for your app, check this issue to override your webpack babel-loader.

Use with TypeScript

We added .ts and .mjs support recently - check here for the PR and usage tips.

  1. Install @babel/preset-typescript
npm install --save-dev @babel/preset-typescript

You may also want to add typescript @types/node @types/aws-lambda.

  1. Create a custom .babelrc file:
{
  "presets": [
    "@babel/preset-typescript",
    "@babel/preset-env"
  ],
  "plugins": [
    "@babel/plugin-proposal-class-properties",
    "@babel/plugin-transform-object-assign",
    "@babel/plugin-proposal-object-rest-spread"
  ]
}
  1. (Optional) if you have @types/aws-lambda installed, your lambda functions can use the community typings for Handler, Context, Callback. See the typescript instructions in create-react-app-lambda for an example.

Check https://github.com/sw-yx/create-react-app-lambda-typescript for a CRA + Lambda full Typescript experience.

CLI flags/options

There are additional CLI options:

-h --help
-c --config
-p --port
-s --static

--config option

If you need to use additional webpack modules or loaders, you can specify an additional webpack config with the -c/--config option when running either serve or build.

--port option

The serving port can be changed with the -p/--port option.

--static option

If you need an escape hatch and are building your lambda in some way that is incompatible with our build process, you can skip the build with the -s or --static flag. More info here.

Netlify Identity

Make sure to read the docs on how Netlify Functions and Netlify Identity work together. Basically you have to make your request with an authorization header and a Bearer token with your Netlify Identity JWT supplied. You can get this JWT from any of our Identity solutions from gotrue-js to netlify-identity-widget.

Since for practical purposes we cannot fully emulate Netlify Identity locally, we provide simple JWT decoding inside the context of your function. This will give you back the user info you need to work with.

Minor note: For the identity field, since we are not fully emulating Netlify Identity, we can't give you details on the Identity instance, so we give you unambiguous strings so you know not to rely on it locally: NETLIFY_LAMBDA_LOCALLY_EMULATED_IDENTITY_URL and NETLIFY_LAMBDA_LOCALLY_EMULATED_IDENTITY_TOKEN. In production, of course, Netlify Functions will give you the correct identity.url and identity.token fields. We find we dont use this info often in our functions so it is not that big of a deal in our judgment.

Debugging

To debug lambdas, prepend the serve command with npm's package runner npx npx --node-arg=--inspect netlify-lambda serve .... Additionally:

  1. make sure that sourcemaps are built along the way (e.g. in the webpack configuration and the tsconfig.json if typescript is used)
  2. webpack's uglification is turned off with optimization: { minimize: false }. If using VSCode, it is likely that the sourceMapPathOverrides have to be adapted for breakpoints to work.

Netlify Functions run in Node v8.10 and you may need to run the same version to mirror the environment locally. Also make sure to check that you aren't committing one of these common Node 8 mistakes in Lambda!

Don't forget to search our issues in case someone has run into a similar problem you have!

Example functions and Tutorials

You can do a great deal with lambda functions! Here are some examples for inspiration:

These libraries pair very well for extending your functions capability:

Other community approaches

If you wish to serve the full website from lambda, check this issue.

If you wish to run this server for testing, check this issue.

If you wish to emulate more Netlify functionality locally, check this repo: https://github.com/8eecf0d2/netlify-local. We are considering merging the projects here.

All of the above are community maintained and not officially supported by Netlify.

Changelog

License

MIT