Unverified Commit 7cd9de34 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Add api-utils helper for testing (#34078)

parent c0dc008f
...@@ -550,7 +550,14 @@ export default async function build( ...@@ -550,7 +550,14 @@ export default async function build(
.traceChild('generate-required-server-files') .traceChild('generate-required-server-files')
.traceFn(() => ({ .traceFn(() => ({
version: 1, version: 1,
config: { ...config, configFile: undefined }, config: {
...config,
configFile: undefined,
experimental: {
...config.experimental,
trustHostHeader: ciEnvironment.hasNextSupport,
},
},
appDir: dir, appDir: dir,
files: [ files: [
ROUTES_MANIFEST, ROUTES_MANIFEST,
......
...@@ -26,7 +26,11 @@ export async function apiResolver( ...@@ -26,7 +26,11 @@ export async function apiResolver(
res: ServerResponse, res: ServerResponse,
query: any, query: any,
resolverModule: any, resolverModule: any,
apiContext: __ApiPreviewProps, apiContext: __ApiPreviewProps & {
trustHostHeader?: boolean
hostname?: string
port?: number
},
propagateError: boolean, propagateError: boolean,
dev?: boolean, dev?: boolean,
page?: string page?: string
...@@ -95,6 +99,8 @@ export async function apiResolver( ...@@ -95,6 +99,8 @@ export async function apiResolver(
apiRes.setPreviewData = (data, options = {}) => apiRes.setPreviewData = (data, options = {}) =>
setPreviewData(apiRes, data, Object.assign({}, apiContext, options)) setPreviewData(apiRes, data, Object.assign({}, apiContext, options))
apiRes.clearPreviewData = () => clearPreviewData(apiRes) apiRes.clearPreviewData = () => clearPreviewData(apiRes)
apiRes.unstable_revalidate = (urlPath: string) =>
unstable_revalidate(urlPath, req, apiContext)
const resolver = interopDefault(resolverModule) const resolver = interopDefault(resolverModule)
let wasPiped = false let wasPiped = false
...@@ -334,6 +340,42 @@ export function sendJson(res: NextApiResponse, jsonBody: any): void { ...@@ -334,6 +340,42 @@ export function sendJson(res: NextApiResponse, jsonBody: any): void {
res.send(jsonBody) res.send(jsonBody)
} }
const PRERENDER_REVALIDATE_HEADER = 'x-prerender-revalidate'
export function checkIsManualRevalidate(
req: IncomingMessage | BaseNextRequest,
previewProps: __ApiPreviewProps
): boolean {
return req.headers[PRERENDER_REVALIDATE_HEADER] === previewProps.previewModeId
}
async function unstable_revalidate(
urlPath: string,
req: IncomingMessage | BaseNextRequest,
context: {
hostname?: string
port?: number
previewModeId: string
trustHostHeader?: boolean
}
) {
if (!context.trustHostHeader && (!context.hostname || !context.port)) {
throw new Error(
`"hostname" and "port" must be provided when starting next to use "unstable_revalidate". See more here https://nextjs.org/docs/advanced-features/custom-server`
)
}
const baseUrl = context.trustHostHeader
? `https://${req.headers.host}`
: `http://${context.hostname}:${context.port}`
return fetch(`${baseUrl}${urlPath}`, {
headers: {
[PRERENDER_REVALIDATE_HEADER]: context.previewModeId,
},
})
}
const COOKIE_NAME_PRERENDER_BYPASS = `__prerender_bypass` const COOKIE_NAME_PRERENDER_BYPASS = `__prerender_bypass`
const COOKIE_NAME_PRERENDER_DATA = `__next_preview_data` const COOKIE_NAME_PRERENDER_DATA = `__next_preview_data`
......
...@@ -58,6 +58,7 @@ import { MIDDLEWARE_ROUTE } from '../lib/constants' ...@@ -58,6 +58,7 @@ import { MIDDLEWARE_ROUTE } from '../lib/constants'
import { addRequestMeta, getRequestMeta } from './request-meta' import { addRequestMeta, getRequestMeta } from './request-meta'
import { createHeaderRoute, createRedirectRoute } from './server-route-utils' import { createHeaderRoute, createRedirectRoute } from './server-route-utils'
import { PrerenderManifest } from '../build' import { PrerenderManifest } from '../build'
import { checkIsManualRevalidate } from '../server/api-utils'
export type FindComponentsResult = { export type FindComponentsResult = {
components: LoadComponentsReturnType components: LoadComponentsReturnType
...@@ -1165,6 +1166,15 @@ export default abstract class Server { ...@@ -1165,6 +1166,15 @@ export default abstract class Server {
isPreviewMode = previewData !== false isPreviewMode = previewData !== false
} }
let isManualRevalidate = false
if (isSSG) {
isManualRevalidate = checkIsManualRevalidate(
req,
this.renderOpts.previewProps
)
}
// Compute the iSSG cache key. We use the rewroteUrl since // Compute the iSSG cache key. We use the rewroteUrl since
// pages with fallback: false are allowed to be rewritten to // pages with fallback: false are allowed to be rewritten to
// and we need to look up the path by the rewritten path // and we need to look up the path by the rewritten path
...@@ -1230,7 +1240,7 @@ export default abstract class Server { ...@@ -1230,7 +1240,7 @@ export default abstract class Server {
let ssgCacheKey = let ssgCacheKey =
isPreviewMode || !isSSG || this.minimalMode || opts.supportsDynamicHTML isPreviewMode || !isSSG || this.minimalMode || opts.supportsDynamicHTML
? null // Preview mode bypasses the cache ? null // Preview mode and manual revalidate bypasses the cache
: `${locale ? `/${locale}` : ''}${ : `${locale ? `/${locale}` : ''}${
(pathname === '/' || resolvedUrlPathname === '/') && locale (pathname === '/' || resolvedUrlPathname === '/') && locale
? '' ? ''
...@@ -1356,7 +1366,7 @@ export default abstract class Server { ...@@ -1356,7 +1366,7 @@ export default abstract class Server {
const cacheEntry = await this.responseCache.get( const cacheEntry = await this.responseCache.get(
ssgCacheKey, ssgCacheKey,
async (hasResolved) => { async (hasResolved, hadCache) => {
const isProduction = !this.renderOpts.dev const isProduction = !this.renderOpts.dev
const isDynamicPathname = isDynamicRoute(pathname) const isDynamicPathname = isDynamicRoute(pathname)
const didRespond = hasResolved || res.sent const didRespond = hasResolved || res.sent
...@@ -1372,6 +1382,12 @@ export default abstract class Server { ...@@ -1372,6 +1382,12 @@ export default abstract class Server {
fallbackMode = 'blocking' fallbackMode = 'blocking'
} }
// only allow manual revalidate for fallback: true/blocking
// or for prerendered fallback: false paths
if (isManualRevalidate && (fallbackMode !== false || hadCache)) {
fallbackMode = 'blocking'
}
// When we did not respond from cache, we need to choose to block on // When we did not respond from cache, we need to choose to block on
// rendering or return a skeleton. // rendering or return a skeleton.
// //
...@@ -1456,6 +1472,9 @@ export default abstract class Server { ...@@ -1456,6 +1472,9 @@ export default abstract class Server {
? result.revalidate ? result.revalidate
: /* default to minimum revalidate (this should be an invariant) */ 1, : /* default to minimum revalidate (this should be an invariant) */ 1,
} }
},
{
isManualRevalidate,
} }
) )
......
...@@ -451,7 +451,13 @@ export default class NextNodeServer extends BaseServer { ...@@ -451,7 +451,13 @@ export default class NextNodeServer extends BaseServer {
res.originalResponse, res.originalResponse,
query, query,
pageModule, pageModule,
this.renderOpts.previewProps, {
...this.renderOpts.previewProps,
port: this.port,
hostname: this.hostname,
// internal config so is not typed
trustHostHeader: (this.nextConfig.experimental as any).trustHostHeader,
},
this.minimalMode, this.minimalMode,
this.renderOpts.dev, this.renderOpts.dev,
page page
......
...@@ -20,7 +20,8 @@ export type ResponseCacheEntry = { ...@@ -20,7 +20,8 @@ export type ResponseCacheEntry = {
} }
type ResponseGenerator = ( type ResponseGenerator = (
hasResolved: boolean hasResolved: boolean,
hadCache: boolean
) => Promise<ResponseCacheEntry | null> ) => Promise<ResponseCacheEntry | null>
export default class ResponseCache { export default class ResponseCache {
...@@ -34,7 +35,8 @@ export default class ResponseCache { ...@@ -34,7 +35,8 @@ export default class ResponseCache {
public get( public get(
key: string | null, key: string | null,
responseGenerator: ResponseGenerator responseGenerator: ResponseGenerator,
context: { isManualRevalidate?: boolean }
): Promise<ResponseCacheEntry | null> { ): Promise<ResponseCacheEntry | null> {
const pendingResponse = key ? this.pendingResponses.get(key) : null const pendingResponse = key ? this.pendingResponses.get(key) : null
if (pendingResponse) { if (pendingResponse) {
...@@ -71,7 +73,11 @@ export default class ResponseCache { ...@@ -71,7 +73,11 @@ export default class ResponseCache {
;(async () => { ;(async () => {
try { try {
const cachedResponse = key ? await this.incrementalCache.get(key) : null const cachedResponse = key ? await this.incrementalCache.get(key) : null
if (cachedResponse) { if (
cachedResponse &&
(!context.isManualRevalidate ||
cachedResponse.revalidateAfter === false)
) {
resolve({ resolve({
revalidate: cachedResponse.curRevalidate, revalidate: cachedResponse.curRevalidate,
value: value:
...@@ -90,7 +96,7 @@ export default class ResponseCache { ...@@ -90,7 +96,7 @@ export default class ResponseCache {
} }
} }
const cacheEntry = await responseGenerator(resolved) const cacheEntry = await responseGenerator(resolved, !!cachedResponse)
resolve(cacheEntry) resolve(cacheEntry)
if (key && cacheEntry && typeof cacheEntry.revalidate !== 'undefined') { if (key && cacheEntry && typeof cacheEntry.revalidate !== 'undefined') {
......
...@@ -293,6 +293,8 @@ export type NextApiResponse<T = any> = ServerResponse & { ...@@ -293,6 +293,8 @@ export type NextApiResponse<T = any> = ServerResponse & {
} }
) => NextApiResponse<T> ) => NextApiResponse<T>
clearPreviewData: () => NextApiResponse<T> clearPreviewData: () => NextApiResponse<T>
unstable_revalidate: (urlPath: string) => Promise<Response>
} }
/** /**
......
...@@ -1890,6 +1890,147 @@ describe('Prerender', () => { ...@@ -1890,6 +1890,147 @@ describe('Prerender', () => {
} }
}) })
} }
if (!(global as any).isNextDev) {
it('should handle manual revalidate for fallback: blocking', async () => {
const html = await renderViaHTTP(
next.url,
'/blocking-fallback/test-manual-1'
)
const $ = cheerio.load(html)
const initialTime = $('#time').text()
expect($('p').text()).toMatch(/Post:.*?test-manual-1/)
const html2 = await renderViaHTTP(
next.url,
'/blocking-fallback/test-manual-1'
)
const $2 = cheerio.load(html2)
expect(initialTime).toBe($2('#time').text())
const res = await fetchViaHTTP(
next.url,
'/api/manual-revalidate',
{
pathname: '/blocking-fallback/test-manual-1',
},
{ redirect: 'manual' }
)
expect(res.status).toBe(200)
const revalidateData = await res.json()
const revalidatedText = revalidateData.text
const $3 = cheerio.load(revalidatedText)
expect(revalidateData.status).toBe(200)
expect($3('#time').text()).not.toBe(initialTime)
const html4 = await renderViaHTTP(
next.url,
'/blocking-fallback/test-manual-1'
)
const $4 = cheerio.load(html4)
expect($4('#time').text()).not.toBe(initialTime)
expect($3('#time').text()).toBe($4('#time').text())
})
it('should not manual revalidate for revalidate: false', async () => {
const html = await renderViaHTTP(
next.url,
'/blocking-fallback-once/test-manual-1'
)
const $ = cheerio.load(html)
const initialTime = $('#time').text()
expect($('p').text()).toMatch(/Post:.*?test-manual-1/)
const html2 = await renderViaHTTP(
next.url,
'/blocking-fallback-once/test-manual-1'
)
const $2 = cheerio.load(html2)
expect(initialTime).toBe($2('#time').text())
const res = await fetchViaHTTP(
next.url,
'/api/manual-revalidate',
{
pathname: '/blocking-fallback-once/test-manual-1',
},
{ redirect: 'manual' }
)
expect(res.status).toBe(200)
const revalidateData = await res.json()
const revalidatedText = revalidateData.text
const $3 = cheerio.load(revalidatedText)
expect(revalidateData.status).toBe(200)
expect($3('#time').text()).toBe(initialTime)
const html4 = await renderViaHTTP(
next.url,
'/blocking-fallback-once/test-manual-1'
)
const $4 = cheerio.load(html4)
expect($4('#time').text()).toBe(initialTime)
expect($3('#time').text()).toBe($4('#time').text())
})
it('should handle manual revalidate for fallback: false', async () => {
const res = await fetchViaHTTP(
next.url,
'/catchall-explicit/test-manual-1'
)
expect(res.status).toBe(404)
// fallback: false pages should only manually revalidate
// prerendered paths
const res2 = await fetchViaHTTP(
next.url,
'/api/manual-revalidate',
{
pathname: '/catchall-explicity/test-manual-1',
},
{ redirect: 'manual' }
)
expect(res2.status).toBe(200)
const revalidateData = await res2.json()
expect(revalidateData.status).toBe(404)
const res3 = await fetchViaHTTP(
next.url,
'/catchall-explicit/test-manual-1'
)
expect(res3.status).toBe(404)
const res4 = await fetchViaHTTP(next.url, '/catchall-explicit/first')
expect(res4.status).toBe(200)
const html = await res4.text()
const $ = cheerio.load(html)
const initialTime = $('#time').text()
const res5 = await fetchViaHTTP(
next.url,
'/api/manual-revalidate',
{
pathname: '/catchall-explicit/first',
},
{ redirect: 'manual' }
)
expect(res5.status).toBe(200)
expect((await res5.json()).status).toBe(200)
const res6 = await fetchViaHTTP(next.url, '/catchall-explicit/first')
expect(res6.status).toBe(200)
const html2 = await res6.text()
const $2 = cheerio.load(html2)
expect(initialTime).not.toBe($2('#time').text())
})
}
} }
runTests((global as any).isNextDev) runTests((global as any).isNextDev)
}) })
export default async function handler(req, res) {
// WARNING: don't use user input in production
// make sure to use trusted value for revalidating
const revalidateRes = await res.unstable_revalidate(req.query.pathname)
res.json({
revalidated: true,
status: revalidateRes.status,
text: await revalidateRes.text(),
})
}
...@@ -32,7 +32,7 @@ export default ({ post, time, params }) => { ...@@ -32,7 +32,7 @@ export default ({ post, time, params }) => {
return ( return (
<> <>
<p>Post: {post}</p> <p>Post: {post}</p>
<span>time: {time}</span> <span id="time">time: {time}</span>
<div id="params">{JSON.stringify(params)}</div> <div id="params">{JSON.stringify(params)}</div>
<div id="query">{JSON.stringify(useRouter().query)}</div> <div id="query">{JSON.stringify(useRouter().query)}</div>
<Link href="/"> <Link href="/">
......
...@@ -32,7 +32,7 @@ export default ({ post, time, params }) => { ...@@ -32,7 +32,7 @@ export default ({ post, time, params }) => {
return ( return (
<> <>
<p>Post: {post}</p> <p>Post: {post}</p>
<span>time: {time}</span> <span id="time">time: {time}</span>
<div id="params">{JSON.stringify(params)}</div> <div id="params">{JSON.stringify(params)}</div>
<div id="query">{JSON.stringify(useRouter().query)}</div> <div id="query">{JSON.stringify(useRouter().query)}</div>
<Link href="/"> <Link href="/">
......
...@@ -8,6 +8,7 @@ export async function getStaticProps({ params: { slug } }) { ...@@ -8,6 +8,7 @@ export async function getStaticProps({ params: { slug } }) {
return { return {
props: { props: {
slug, slug,
time: Date.now(),
}, },
revalidate: 1, revalidate: 1,
} }
...@@ -27,12 +28,13 @@ export async function getStaticPaths() { ...@@ -27,12 +28,13 @@ export async function getStaticPaths() {
} }
} }
export default function Page({ slug }) { export default function Page({ slug, time }) {
// Important to not check for `slug` existence (testing that build does not // Important to not check for `slug` existence (testing that build does not
// render fallback version and error) // render fallback version and error)
return ( return (
<> <>
<p id="catchall">Hi {slug.join(' ')}</p>{' '} <p id="catchall">Hi {slug.join(' ')}</p>
<p id="time">time: {time}</p>
<Link href="/"> <Link href="/">
<a id="home">to home</a> <a id="home">to home</a>
</Link> </Link>
......
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