Today, I’m excited to announce a project I’ve been working on over the past few months. It provides a simple, fast and efficient way to deploy your Next.js applications to AWS using CloudFront, [email protected] and S3.
The project is the Serverless Next.js Component which you can use with the Serverless Framework to deploy Next.js apps to AWS [email protected] functions in every CloudFront edge location across the globe. These [email protected] functions do server-side rendering of your website pages, as close as possible to your end users, providing very low latency.
The project was developed with a few design principles in mind.
1. Zero configuration by default
That’s right, you can get up and running in under a minute with no configuration required.
2. Feature parity with next 9
All features of next 9 are supported:
Server-side rendered pages. No surprise here, this is what attracts most folks to use next. serverless-next.js deploys your pages to [email protected] Server side rendering happens right at the edge, close to your users.
Dynamic Pages / Route segments. Next recently introduced support in their built-in routing system for parameterised routes. serveless-next.js implements a lightweight router which is compatible with dynamic routes.
Automatic pre-rendering. Some of your pages might not be SSR. These type of pages are compiled by next to HTML at build time. serverless-next.js takes advantage of this and deploys them to S3. [email protected] in CloudFront then takes care of forwarding requests to static pages (e.g. /terms, /about, /contact etc.) to S3. These can be heavily cached.
Client assets. Build files generated by next such as webpack chunks, css files, etc. are uploaded to S3. In this case [email protected] does not need invoking as any requests to _next/* is served by CloudFront from S3.
User static / public folders. User assets like images in the static folder or root level resources in your public folder are uploaded to S3. Like build assets, CloudFront serves these assets from S3.
3. Fast deployments
The Serverless Next.js Component is fast. Deploying your application, typically takes less than a minute.
next build is used behind the scenes, no magic there. A CloudFront distribution is provisioned for you with best practices in place. The pages compiled are zipped up and deployed to [email protected] which is then associated to your distribution. An S3 bucket is also deployed for the static assets which are uploaded using S3 accelerated transfers.
The only caveat is that the first deployment you have to wait a few minutes for the CloudFront distribution to be available. However, subsequent deployments don’t have this problem. Once the distribution is up, deploying updates is fast.
CloudFormation is not used for provisioning resources. This is partly why deployments are quick. It also means the project is not bound by CloudFormation limits, which is an issue on the predecessor of this project, serverless-nextjs-plugin.
Let’s look in more detail at the architecture deployed to AWS.
Three Cache Behaviours are created in CloudFront.
The first 2.
static/* forward the requests to S3.
The 3rd. is associated to a lambda function which is responsible for handling three types of requests.
Server side rendered page. Any page that defines
getInitialPropsmethod will be rendered at this level and the response is returned immediately to the user.
Statically optimised page. Requests to pages that were pre-compiled by next to HTML are forwarded to S3 where the HTML is stored.
Public resources. These are requests to root level resources like
/manifest.jsonetc. These are also forwarded to S3 where these resources can be found.
The reason why 2. and 3. have to go through [email protected] first is because these routes don’t conform to a pattern like
static/*. Also, one cache behaviour per route is a bad idea because CloudFront only allows 25 per distribution.
Using the Serverless Next.js Component is easy, just add it to your
serverless.yml like this:
# serverless.yml myApp: component: serverless-next.js
Sane defaults are baked in, so no additional configuration is needed.
Use the Serverless Framework to deploy via the
serverless command, like this:
Remove it with the
npx serverless remove
You can set a custom domain for your application. serverless-next.js takes care of associating the domain with your CloudFront distribution, creates the sub domain in Route53 and even sets up the SSL Certificate using AWS ACM. It is optional and looks like this:
# serverless.yml myApp: component: serverless-next.js inputs: domain: ["www", "example.com"] # [ sub-domain, domain ]
Behind the Scenes
The project is powered by the amazing serverless-components. At its core it uses 4 components:
Most of the heavy lifting is done by the components themselves, serverless-next.js simply orchestrates.
Build time efficiencies, configurable caching options for users and potentially adding a separate
/api cache behaviour for API Routes. I will also be working on more complete examples that integrate with other AWS Services.
Hope you find the project useful. If you find any issues or would like to see a new feature please raise an issue. Also, contributions are welcome 🙂