0298c722b1
I’ve been experimenting with Next.js and Fastify and I made the following changes to the Fastify example based on what I found: ### Use Fastify’s plugin API IMO putting Fastify’s listen call in a promise callback is an anti-pattern, b/c the Fastify plugin API is meant to solve the problem of async server bootstrapping. [From Fastify’s Getting Started docs](https://www.fastify.io/docs/latest/Getting-Started/): > Fastify provides a foundation that assists with the asynchronous bootstrapping of your application. ### Set reply.sent in handlers which return promises [From Fastify’s Routes docs](https://www.fastify.io/docs/latest/Routes/#promise-resolution): > If your handler is an `async` function or returns a promise, you should be aware of a special behaviour which is necessary to support the callback and promise control-flow. If the handler's promise is resolved with `undefined`, it will be ignored causing the request to hang and an *error* log to be emitted. > > 1. If you want to use `async/await` or promises but respond a value with `reply.send`: > - **Don't** `return` any value. > - **Don't** forget to call `reply.send`. > 2. If you want to use `async/await` or promises: > - **Don't** use `reply.send`. > - **Don't** return `undefined`. `app.render` returns a promise which contains undefined, so returning it in a Fastify handler will log an error. However, returning anything besides undefined will cause Fastify to try to write to the response which Next.js has already ended. The solution is to manually set the `reply.sent` flag to true when any Next.js rendering promise is fulfilled as an alternative to calling `reply.send`. ### Make Next.js handle 404 errors This allows any route to throw a NotFound error and let Next.js handle the rendering of the 404 page. ### Make Next.js handle any route which starts with `_next` in dev This prevents dev routes from being caught by user-defined routes. |
||
|---|---|---|
| .. | ||
| pages | ||
| package.json | ||
| README.md | ||
| server.js | ||
Custom Fastify Server example
How to use
Using create-next-app
Execute create-next-app with Yarn or npx to bootstrap the example:
npx create-next-app --example custom-server-fastify custom-server-fastify-app
# or
yarn create next-app --example custom-server-fastify custom-server-fastify-app
Download manually
Download the example:
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/custom-server-fastify
cd custom-server-fastify
Install it and run:
npm install
npm run dev
# or
yarn
yarn dev
Fastify Deploy it to the cloud with now (download)
now
The idea behind the example
Most of the times the default Next server will be enough but sometimes you want to run your own server to customize routes or other kind of the app behavior. Next provides a Custom server and routing so you can customize as much as you want.
Because the Next.js server is just a node.js module you can combine it with any other part of the node.js ecosystem. in this case we are using Fastify to build a custom router on top of Next.
The example shows a server that serves the component living in pages/a.js when the route /b is requested and pages/b.js when the route /a is accessed. This is obviously a non-standard routing strategy. You can see how this custom routing is being made inside server.js.