Unverified Commit f6e5a816 authored by Lee Robinson's avatar Lee Robinson Committed by GitHub

[examples] Fix ssr-caching example. (#26540)

Closes https://github.com/vercel/next.js/issues/12019 with a better example of proper SSR caching.
parent 1dd9c4b8
# Example app where it caches SSR'ed pages in the memory # Server-Side Rendering Caching Headers
React Server Side rendering is very costly and takes a lot of server's CPU power for that. One of the best solutions for this problem is cache already rendered pages. This example uses [`stale-while-revalidate`](https://web.dev/stale-while-revalidate/) [cache-control headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control) in combination with `getServerSideProps` for server-rendering.
That's what this example demonstrate.
This app uses Next's [custom server and routing](https://nextjs.org/docs/advanced-features/custom-server) mode. It also uses [express](https://expressjs.com/) to handle routing and page serving. `pages/index.js` uses `getServerSideProps` to forward the request header to the React component, as well as setting a response header. This `cache-control` header uses `stale-while-revalidate` to cache the server response.
`pages/index.js` is considered fresh for ten seconds (`s-maxage=10`). If a request is repeated within the next 10 seconds, the previously cached value will still be fresh. If the request is repeated before 59 seconds, the cached value will be stale but still render (`stale-while-revalidate=59`).
In the background, a revalidation request will be made to populate the cache with a fresh value. If you refresh the page, you will see the new value shown.
## Preview
Preview the example live on [StackBlitz](http://stackblitz.com/):
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/ssr-caching)
## Deploy your own
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/ssr-caching&project-name=ssr-caching&repository-name=ssr-caching)
## How to use ## How to use
......
...@@ -2,14 +2,11 @@ ...@@ -2,14 +2,11 @@
"name": "ssr-caching", "name": "ssr-caching",
"version": "1.0.0", "version": "1.0.0",
"scripts": { "scripts": {
"dev": "node server.js", "dev": "next",
"build": "next build", "build": "next build",
"start": "cross-env NODE_ENV=production node server.js" "start": "next start"
}, },
"dependencies": { "dependencies": {
"cacheable-response": "^2.1.6",
"cross-env": "^7.0.2",
"express": "^4.17.1",
"next": "latest", "next": "latest",
"react": "^17.0.2", "react": "^17.0.2",
"react-dom": "^17.0.2" "react-dom": "^17.0.2"
......
export default function Post(props) {
return (
<div>
<h1>My {props.id} blog post</h1>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.
</p>
</div>
)
}
export async function getStaticProps({ params: { id } }) {
return { props: { id } }
}
export async function getStaticPaths() {
return {
paths: [
{ params: { id: 'first' } },
{ params: { id: 'second' } },
{ params: { id: 'last' } },
],
fallback: true,
}
}
import Link from 'next/link' export default function Index({ time }) {
export default function Home() {
return ( return (
<ul> <main>
<li> <h1>SSR Caching with Next.js</h1>
<Link href="/blog?id=first" as="/blog/first"> <time dateTime={time}>{time}</time>
<a>My first blog post</a> </main>
</Link>
</li>
<li>
<Link href="/blog?id=second" as="/blog/second">
<a>My second blog post</a>
</Link>
</li>
<li>
<Link href="/blog?id=last" as="/blog/last">
<a>My last blog post</a>
</Link>
</li>
</ul>
) )
} }
export async function getServerSideProps({ req, res }) {
res.setHeader(
'Cache-Control',
'public, s-maxage=10, stale-while-revalidate=59'
)
return {
props: {
time: new Date().toISOString(),
},
}
}
const cacheableResponse = require('cacheable-response')
const express = require('express')
const next = require('next')
const port = parseInt(process.env.PORT, 10) || 3000
const dev = process.env.NODE_ENV !== 'production'
const app = next({ dev })
const handle = app.getRequestHandler()
const ssrCache = cacheableResponse({
ttl: 1000 * 60 * 60, // 1hour
get: async ({ req, res }) => {
const rawResEnd = res.end
const data = await new Promise((resolve) => {
res.end = (payload) => {
resolve(res.statusCode === 200 && payload)
}
app.render(req, res, req.path, {
...req.query,
...req.params,
})
})
res.end = rawResEnd
return { data }
},
send: ({ data, res }) => res.send(data),
})
app.prepare().then(() => {
const server = express()
server.get('/', (req, res) => ssrCache({ req, res }))
server.get('/blog/:id', (req, res) => ssrCache({ req, res }))
server.get('*', (req, res) => handle(req, res))
server.listen(port, (err) => {
if (err) throw err
console.log(`> Ready on http://localhost:${port}`)
})
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment