85b9ed5eb8
Provides a `revalidateReason` argument to `getStaticProps` ("stale" |
"on-demand" | "build").
- Build indicates it was run at build time
- On-demand indicates it was run as a side effect of [on-demand
revalidation](https://nextjs.org/docs/pages/building-your-application/data-fetching/incremental-static-regeneration#on-demand-revalidation)
- Stale indicates the resource was considered stale (either due to being
in dev mode, or an expired revalidate period)
This will allow changing behavior based on the context in which it's
called.
Closes NEXT-1900
61 lines
1.7 KiB
TypeScript
61 lines
1.7 KiB
TypeScript
import { nextTestSetup } from 'e2e-utils'
|
|
import { retry, waitFor } from 'next-test-utils'
|
|
|
|
describe('revalidate-reason', () => {
|
|
const { next, isNextDev } = nextTestSetup({
|
|
files: __dirname,
|
|
})
|
|
|
|
if (isNextDev) {
|
|
describe('development mode', () => {
|
|
// in dev mode, the revalidateReason is called on every request, and will always be considered stale
|
|
it('should support revalidateReason: "stale"', async () => {
|
|
const res = await next.fetch('/')
|
|
|
|
expect(res.status).toBe(200)
|
|
|
|
expect(next.cliOutput).toContain(
|
|
'revalidate-reason/pages/index.tsx revalidateReason: stale'
|
|
)
|
|
})
|
|
})
|
|
|
|
// skip the remaining tests as they do not apply in dev
|
|
return
|
|
}
|
|
|
|
it('should support revalidateReason: "build"', async () => {
|
|
expect(next.cliOutput).toContain(
|
|
'revalidate-reason/pages/index.tsx revalidateReason: build'
|
|
)
|
|
expect(next.cliOutput).toContain(
|
|
'revalidate-reason/pages/stale.tsx revalidateReason: build'
|
|
)
|
|
})
|
|
|
|
it('should support revalidateReason: "on-demand"', async () => {
|
|
const res = await next.fetch('/api/revalidate')
|
|
|
|
expect(res.status).toBe(200)
|
|
|
|
expect(next.cliOutput).toContain(
|
|
'revalidate-reason/pages/index.tsx revalidateReason: on-demand'
|
|
)
|
|
})
|
|
|
|
it('should support revalidateReason: "stale"', async () => {
|
|
const res = await next.fetch('/stale')
|
|
expect(res.status).toBe(200)
|
|
|
|
// wait for the revalidation period
|
|
await waitFor(5000)
|
|
|
|
await retry(async () => {
|
|
await next.fetch('/stale')
|
|
|
|
expect(next.cliOutput).toContain(
|
|
'revalidate-reason/pages/stale.tsx revalidateReason: stale'
|
|
)
|
|
})
|
|
})
|
|
})
|