Serverless

Attention Readers:

The sample provided allows you to easily build serverless web applications/services and RESTful APIs using Fastify on top of AWS Lambda and Amazon API Gateway.

Note: Using aws-lambda-fastify is just one possible way.

app.js

When executed in your lambda function we don’t need to listen to a specific port, so we just export the wrapper function in this case. The lambda.js file will use this export.

When you execute your Fastify application like always, i.e. node app.js (the detection for this could be require.main === module), you can normally listen to your port, so you can still run your Fastify function locally.

lambda.js

  1. const awsLambdaFastify = require('aws-lambda-fastify')
  2. const init = require('./app');
  4. const proxy = awsLambdaFastify(init())
  5. // or
  6. // const proxy = awsLambdaFastify(init(), { binaryMimeTypes: ['application/octet-stream'] })
  8. exports.handler = proxy;
  9. // or
  10. // exports.handler = (event, context, callback) => proxy(event, context, callback);
  11. // or
  12. // exports.handler = (event, context) => proxy(event, context);
  13. // or
  14. // exports.handler = async (event, context) => proxy(event, context);

We just require aws-lambda-fastify (make sure you install the dependency npm i --save aws-lambda-fastify) and our file and call the exported awsLambdaFastify function with the app as the only parameter. The resulting proxy function has the correct signature to be used as lambda handler function. This way all the incoming events (API Gateway requests) are passed to the proxy function of aws-lambda-fastify.

Example

An example deployable with claudia.js can be found .

  • API Gateway doesn’t support streams yet, so you’re not able to handle streams.
  • API Gateway has a timeout of 29 seconds, so it’s important to provide a reply during this time.

Follow the steps below to deploy to Google Cloud Run if you are already familiar with gcloud or just follow their .

Adjust Fastfiy server

In order for Fastify to properly listen for requests within the container, be sure to set the correct port and address:

  1. function build() {
  2.   const fastify = Fastify({ trustProxy: true })
  3.   return fastify
  4. }
  6. async function start() {
  7.   // Google Cloud Run will set this environment variable for you, so
  8.   // you can also use it to detect if you are running in Cloud Run
  9.   const IS_GOOGLE_CLOUD_RUN = process.env.K_SERVICE !== undefined
  11.   // You must listen on the port Cloud Run provides
  12.   const port = process.env.PORT || 3000
  14.   // You must listen on all IPV4 addresses in Cloud Run
  15.   const address = IS_GOOGLE_CLOUD_RUN ? "0.0.0.0" : undefined
  17.   try {
  18.     const server = build()
  19.     const address = await server.listen(port, address)
  20.     console.log(`Listening on ${address}`)
  21.   } catch (err) {
  22.     console.error(err)
  23.   }
  24. }
  26. module.exports = build
  28. if (require.main === module) {
  29.   start()
  30. }

Add a Dockerfile

You can add any valid Dockerfile that packages and runs a Node app. A basic Dockerfile can be found in the official gcloud docs.

  1. # Use the official Node.js 10 image.
  2. # https://hub.docker.com/_/node
  3. FROM node:10
  5. # Create and change to the app directory.
  6. WORKDIR /usr/src/app
  8. # Copy application dependency manifests to the container image.
  9. # A wildcard is used to ensure both package.json AND package-lock.json are copied.
  10. # Copying this separately prevents re-running npm install on every code change.
  11. COPY package*.json ./
  13. # Install production dependencies.
  14. RUN npm install --only=production
  16. # Copy local code to the container image.
  17. COPY . .
  19. # Run the web service on container startup.
  20. CMD [ "npm", "start" ]

Add a .dockerignore

To keep build artifacts out of your container (which keeps it small and improves build times), add a .dockerignore file like the one below:

  1. Dockerfile
  2. README.md
  3. node_modules
  4. npm-debug.log

Submit build

Next, submit your app to be built into a Docker image by running the following command (replacing PROJECT-ID and APP-NAME with your GCP project id and an app name):

After your image has built, you can deploy it with the following command:

  1. gcloud beta run deploy --image gcr.io/PROJECT-ID/APP-NAME --platform managed

Your app will be accessible from the URL GCP provides.

Create folder called functions then create server.js (and your endpoint path will be server.js) inside functions folder.

functions/server.js

  1. export { handler } from '../lambda.js'; // Change `lambda.js` path to your `lambda.js` path

netlify.toml

  1. [build]
  2.   # This will be run the site build
  3.   command = "npm run build:functions"
  4.   # This is the directory is publishing to netlify's CDN
  5.   # and this is directory of your front of your app
  6.   # publish = "build"
  7.   # functions build directory
  8.   functions = "functions-build" # always appends `-build` folder to your `functions` folder for builds

webpack.config.netlify.js

Don’t forget add this Webpack config, else a lot of problems can occur

  1. const nodeExternals = require('webpack-node-externals');
  2. const dotenv = require('dotenv-safe');
  3. const webpack = require('webpack');
  5. const env = process.env.NODE_ENV || 'production';
  6. const dev = env === 'development';
  8. if (dev) {
  9.   dotenv.config({ allowEmptyValues: true });
  10. }
  12. module.exports = {
  13.   mode: env,
  14.   devtool: dev ? 'eval-source-map' : 'none',
  15.   externals: [nodeExternals()],
  16.   devServer: {
  17.     proxy: {
  18.       '/.netlify': {
  19.         target: 'http://localhost:9000',
  20.       }
  21.     }
  22.   },
  24.     rules: []
  25.   },
  26.   plugins: [
  27.     new webpack.DefinePlugin({
  28.       'process.env.APP_ROOT_PATH': JSON.stringify('/'),
  29.       'process.env.NETLIFY_ENV': true,
  30.       'process.env.CONTEXT': env
  31.     })
  32.   ]
  33. };

Scripts

Add this command to your package.json scripts

Then it should work fine

provides zero configuration deployment for Node.js applications. In order to use now, it is as simple as configuring your now.json file like the following:

  1. {
  2.   "version": 2,
  3.   "builds": [
  4.     {
  5.       "src": "api/serverless.js",
  6.       "use": "@now/node",
  7.       "config": {
  8.         "helpers": false
  9.       }
  10.     }
  11.   ],
  12.   "routes": [
  13.     { "src": "/.*", "dest": "/api/serverless.js"}
  14.   ]
  15. }

Then, write a api/serverless.js like so:

  1. 'use strict'
  3. const build = require('./index')
  5. const app = build()
  7. module.exports = async function (req, res) {
  8.   await app.ready()
  9.   app.server.emit('request', req, res)
  10. }

And a api/index.js file:

  1. 'use strict'
  3. const fastify = require('fastify')
  5. function build () {
  6.   const app = fastify({
  7.     logger: true
  8.   })
  10.   app.get('/', async (req, res) => {
  11.     const { name = 'World' } = req.query
  12.     req.log.info({ name }, 'hello world!')
  13.     return `Hello ${name}!`
  14.   })
  16.   return app
  17. }
  19. module.exports = build
  1.   "engines": {
  3.   },