Unverified Commit a5cb28d9 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Ensure redirects are handled properly from cache (#18806)

This updates the GS(S)P redirect handling to make sure to handle redirects correctly when coming from the incremental-cache. Additional tests have been added to ensure the redirects work correctly after the cache is populated. 

Fixes: https://github.com/vercel/next.js/issues/18735
Fixes: https://github.com/vercel/next.js/issues/18783
parent 8f7f1018
...@@ -477,6 +477,8 @@ const nextServerlessLoader: loader.Loader = function () { ...@@ -477,6 +477,8 @@ const nextServerlessLoader: loader.Loader = function () {
const { denormalizePagePath } = require('next/dist/next-server/server/denormalize-page-path') const { denormalizePagePath } = require('next/dist/next-server/server/denormalize-page-path')
const { setLazyProp, getCookieParser } = require('next/dist/next-server/server/api-utils') const { setLazyProp, getCookieParser } = require('next/dist/next-server/server/api-utils')
const {sendPayload} = require('next/dist/next-server/server/send-payload'); const {sendPayload} = require('next/dist/next-server/server/send-payload');
const {getRedirectStatus} = require('next/dist/lib/load-custom-routes');
const {PERMANENT_REDIRECT_STATUS} = require('next/dist/next-server/lib/constants')
const buildManifest = require('${buildManifest}'); const buildManifest = require('${buildManifest}');
const reactLoadableManifest = require('${reactLoadableManifest}'); const reactLoadableManifest = require('${reactLoadableManifest}');
...@@ -819,6 +821,21 @@ const nextServerlessLoader: loader.Loader = function () { ...@@ -819,6 +821,21 @@ const nextServerlessLoader: loader.Loader = function () {
revalidate: renderOpts.revalidate, revalidate: renderOpts.revalidate,
}) })
return null return null
} else if (renderOpts.isRedirect && !_nextData) {
const redirect = {
destination: renderOpts.pageData.pageProps.__N_REDIRECT,
statusCode: renderOpts.pageData.pageProps.__N_REDIRECT_STATUS
}
const statusCode = getRedirectStatus(redirect)
if (statusCode === PERMANENT_REDIRECT_STATUS) {
res.setHeader('Refresh', \`0;url=\${redirect.destination}\`)
}
res.statusCode = statusCode
res.setHeader('Location', redirect.destination)
res.end()
return null
} else { } else {
sendPayload(req, res, _nextData ? JSON.stringify(renderOpts.pageData) : result, _nextData ? 'json' : 'html', ${ sendPayload(req, res, _nextData ? JSON.stringify(renderOpts.pageData) : result, _nextData ? 'json' : 'html', ${
generateEtags === 'true' ? true : false generateEtags === 'true' ? true : false
......
...@@ -24,7 +24,10 @@ export type Header = { ...@@ -24,7 +24,10 @@ export type Header = {
export const allowedStatusCodes = new Set([301, 302, 303, 307, 308]) export const allowedStatusCodes = new Set([301, 302, 303, 307, 308])
export function getRedirectStatus(route: Redirect): number { export function getRedirectStatus(route: {
statusCode?: number
permanent?: boolean
}): number {
return ( return (
route.statusCode || route.statusCode ||
(route.permanent ? PERMANENT_REDIRECT_STATUS : TEMPORARY_REDIRECT_STATUS) (route.permanent ? PERMANENT_REDIRECT_STATUS : TEMPORARY_REDIRECT_STATUS)
......
...@@ -14,6 +14,7 @@ type IncrementalCacheValue = { ...@@ -14,6 +14,7 @@ type IncrementalCacheValue = {
pageData?: any pageData?: any
isStale?: boolean isStale?: boolean
isNotFound?: boolean isNotFound?: boolean
isRedirect?: boolean
curRevalidate?: number | false curRevalidate?: number | false
// milliseconds to revalidate after // milliseconds to revalidate after
revalidateAfter: number | false revalidateAfter: number | false
...@@ -69,7 +70,7 @@ export class IncrementalCache { ...@@ -69,7 +70,7 @@ export class IncrementalCache {
// default to 50MB limit // default to 50MB limit
max: max || 50 * 1024 * 1024, max: max || 50 * 1024 * 1024,
length(val) { length(val) {
if (val.isNotFound) return 25 if (val.isNotFound || val.isRedirect) return 25
// rough estimate of size of cache value // rough estimate of size of cache value
return val.html!.length + JSON.stringify(val.pageData).length return val.html!.length + JSON.stringify(val.pageData).length
}, },
...@@ -161,6 +162,7 @@ export class IncrementalCache { ...@@ -161,6 +162,7 @@ export class IncrementalCache {
html?: string html?: string
pageData?: any pageData?: any
isNotFound?: boolean isNotFound?: boolean
isRedirect?: boolean
}, },
revalidateSeconds?: number | false revalidateSeconds?: number | false
) { ) {
......
...@@ -26,6 +26,7 @@ import { ...@@ -26,6 +26,7 @@ import {
CLIENT_STATIC_FILES_PATH, CLIENT_STATIC_FILES_PATH,
CLIENT_STATIC_FILES_RUNTIME, CLIENT_STATIC_FILES_RUNTIME,
PAGES_MANIFEST, PAGES_MANIFEST,
PERMANENT_REDIRECT_STATUS,
PHASE_PRODUCTION_SERVER, PHASE_PRODUCTION_SERVER,
PRERENDER_MANIFEST, PRERENDER_MANIFEST,
ROUTES_MANIFEST, ROUTES_MANIFEST,
...@@ -1263,6 +1264,22 @@ export default class Server { ...@@ -1263,6 +1264,22 @@ export default class Server {
return path return path
} }
const handleRedirect = (pageData: any) => {
const redirect = {
destination: pageData.pageProps.__N_REDIRECT,
statusCode: pageData.pageProps.__N_REDIRECT_STATUS,
}
const statusCode = getRedirectStatus(redirect)
if (statusCode === PERMANENT_REDIRECT_STATUS) {
res.setHeader('Refresh', `0;url=${redirect.destination}`)
}
res.statusCode = statusCode
res.setHeader('Location', redirect.destination)
res.end()
}
// remove /_next/data prefix from urlPathname so it matches // remove /_next/data prefix from urlPathname so it matches
// for direct page visit and /_next/data visit // for direct page visit and /_next/data visit
if (isDataReq) { if (isDataReq) {
...@@ -1299,26 +1316,30 @@ export default class Server { ...@@ -1299,26 +1316,30 @@ export default class Server {
? JSON.stringify(cachedData.pageData) ? JSON.stringify(cachedData.pageData)
: cachedData.html : cachedData.html
sendPayload( if (!isDataReq && cachedData.pageData?.pageProps?.__N_REDIRECT) {
req, await handleRedirect(cachedData.pageData)
res, } else {
data, sendPayload(
isDataReq ? 'json' : 'html', req,
{ res,
generateEtags: this.renderOpts.generateEtags, data,
poweredByHeader: this.renderOpts.poweredByHeader, isDataReq ? 'json' : 'html',
}, {
!this.renderOpts.dev generateEtags: this.renderOpts.generateEtags,
? { poweredByHeader: this.renderOpts.poweredByHeader,
private: isPreviewMode, },
stateful: false, // GSP response !this.renderOpts.dev
revalidate: ? {
cachedData.curRevalidate !== undefined private: isPreviewMode,
? cachedData.curRevalidate stateful: false, // GSP response
: /* default to minimum revalidate (this should be an invariant) */ 1, revalidate:
} cachedData.curRevalidate !== undefined
: undefined ? cachedData.curRevalidate
) : /* default to minimum revalidate (this should be an invariant) */ 1,
}
: undefined
)
}
// Stop the request chain here if the data we sent was up-to-date // Stop the request chain here if the data we sent was up-to-date
if (!cachedData.isStale) { if (!cachedData.isStale) {
...@@ -1340,11 +1361,13 @@ export default class Server { ...@@ -1340,11 +1361,13 @@ export default class Server {
pageData: any pageData: any
sprRevalidate: number | false sprRevalidate: number | false
isNotFound?: boolean isNotFound?: boolean
isRedirect?: boolean
}> => { }> => {
let pageData: any let pageData: any
let html: string | null let html: string | null
let sprRevalidate: number | false let sprRevalidate: number | false
let isNotFound: boolean | undefined let isNotFound: boolean | undefined
let isRedirect: boolean | undefined
let renderResult let renderResult
// handle serverless // handle serverless
...@@ -1365,6 +1388,7 @@ export default class Server { ...@@ -1365,6 +1388,7 @@ export default class Server {
pageData = renderResult.renderOpts.pageData pageData = renderResult.renderOpts.pageData
sprRevalidate = renderResult.renderOpts.revalidate sprRevalidate = renderResult.renderOpts.revalidate
isNotFound = renderResult.renderOpts.isNotFound isNotFound = renderResult.renderOpts.isNotFound
isRedirect = renderResult.renderOpts.isRedirect
} else { } else {
const origQuery = parseUrl(req.url || '', true).query const origQuery = parseUrl(req.url || '', true).query
const resolvedUrl = formatUrl({ const resolvedUrl = formatUrl({
...@@ -1407,9 +1431,10 @@ export default class Server { ...@@ -1407,9 +1431,10 @@ export default class Server {
pageData = (renderOpts as any).pageData pageData = (renderOpts as any).pageData
sprRevalidate = (renderOpts as any).revalidate sprRevalidate = (renderOpts as any).revalidate
isNotFound = (renderOpts as any).isNotFound isNotFound = (renderOpts as any).isNotFound
isRedirect = (renderOpts as any).isRedirect
} }
return { html, pageData, sprRevalidate, isNotFound } return { html, pageData, sprRevalidate, isNotFound, isRedirect }
} }
) )
...@@ -1491,7 +1516,7 @@ export default class Server { ...@@ -1491,7 +1516,7 @@ export default class Server {
const { const {
isOrigin, isOrigin,
value: { html, pageData, sprRevalidate, isNotFound }, value: { html, pageData, sprRevalidate, isNotFound, isRedirect },
} = await doRender() } = await doRender()
let resHtml = html let resHtml = html
...@@ -1500,23 +1525,27 @@ export default class Server { ...@@ -1500,23 +1525,27 @@ export default class Server {
!isNotFound && !isNotFound &&
(isSSG || isDataReq || isServerProps) (isSSG || isDataReq || isServerProps)
) { ) {
sendPayload( if (isRedirect && !isDataReq) {
req, await handleRedirect(pageData)
res, } else {
isDataReq ? JSON.stringify(pageData) : html, sendPayload(
isDataReq ? 'json' : 'html', req,
{ res,
generateEtags: this.renderOpts.generateEtags, isDataReq ? JSON.stringify(pageData) : html,
poweredByHeader: this.renderOpts.poweredByHeader, isDataReq ? 'json' : 'html',
}, {
!this.renderOpts.dev || (isServerProps && !isDataReq) generateEtags: this.renderOpts.generateEtags,
? { poweredByHeader: this.renderOpts.poweredByHeader,
private: isPreviewMode, },
stateful: !isSSG, !this.renderOpts.dev || (isServerProps && !isDataReq)
revalidate: sprRevalidate, ? {
} private: isPreviewMode,
: undefined stateful: !isSSG,
) revalidate: sprRevalidate,
}
: undefined
)
}
resHtml = null resHtml = null
} }
...@@ -1524,7 +1553,7 @@ export default class Server { ...@@ -1524,7 +1553,7 @@ export default class Server {
if (isOrigin && ssgCacheKey) { if (isOrigin && ssgCacheKey) {
await this.incrementalCache.set( await this.incrementalCache.set(
ssgCacheKey, ssgCacheKey,
{ html: html!, pageData, isNotFound }, { html: html!, pageData, isNotFound, isRedirect },
sprRevalidate sprRevalidate
) )
} }
......
...@@ -20,10 +20,8 @@ import { isInAmpMode } from '../lib/amp' ...@@ -20,10 +20,8 @@ import { isInAmpMode } from '../lib/amp'
import { AmpStateContext } from '../lib/amp-context' import { AmpStateContext } from '../lib/amp-context'
import { import {
AMP_RENDER_TARGET, AMP_RENDER_TARGET,
PERMANENT_REDIRECT_STATUS,
SERVER_PROPS_ID, SERVER_PROPS_ID,
STATIC_PROPS_ID, STATIC_PROPS_ID,
TEMPORARY_REDIRECT_STATUS,
} from '../lib/constants' } from '../lib/constants'
import { defaultHead } from '../lib/head' import { defaultHead } from '../lib/head'
import { HeadManagerContext } from '../lib/head-manager-context' import { HeadManagerContext } from '../lib/head-manager-context'
...@@ -52,7 +50,10 @@ import { FontManifest, getFontDefinitionFromManifest } from './font-utils' ...@@ -52,7 +50,10 @@ import { FontManifest, getFontDefinitionFromManifest } from './font-utils'
import { LoadComponentsReturnType, ManifestItem } from './load-components' import { LoadComponentsReturnType, ManifestItem } from './load-components'
import { normalizePagePath } from './normalize-page-path' import { normalizePagePath } from './normalize-page-path'
import optimizeAmp from './optimize-amp' import optimizeAmp from './optimize-amp'
import { allowedStatusCodes } from '../../lib/load-custom-routes' import {
allowedStatusCodes,
getRedirectStatus,
} from '../../lib/load-custom-routes'
function noRouter() { function noRouter() {
const message = const message =
...@@ -351,22 +352,6 @@ function checkRedirectValues( ...@@ -351,22 +352,6 @@ function checkRedirectValues(
} }
} }
function handleRedirect(res: ServerResponse, redirect: Redirect) {
const statusCode = redirect.statusCode
? redirect.statusCode
: redirect.permanent
? PERMANENT_REDIRECT_STATUS
: TEMPORARY_REDIRECT_STATUS
if (statusCode === PERMANENT_REDIRECT_STATUS) {
res.setHeader('Refresh', `0;url=${redirect.destination}`)
}
res.statusCode = statusCode
res.setHeader('Location', redirect.destination)
res.end()
}
export async function renderToHTML( export async function renderToHTML(
req: IncomingMessage, req: IncomingMessage,
res: ServerResponse, res: ServerResponse,
...@@ -660,6 +645,16 @@ export async function renderToHTML( ...@@ -660,6 +645,16 @@ export async function renderToHTML(
throw new Error(invalidKeysMsg('getStaticProps', invalidKeys)) throw new Error(invalidKeysMsg('getStaticProps', invalidKeys))
} }
if (process.env.NODE_ENV !== 'production') {
if ('notFound' in data && 'redirect' in data) {
throw new Error(
`\`redirect\` and \`notFound\` can not both be returned from ${
isSSG ? 'getStaticProps' : 'getServerSideProps'
} at the same time. Page: ${pathname}`
)
}
}
if ('notFound' in data && data.notFound) { if ('notFound' in data && data.notFound) {
if (pathname === '/404') { if (pathname === '/404') {
throw new Error( throw new Error(
...@@ -686,14 +681,11 @@ export async function renderToHTML( ...@@ -686,14 +681,11 @@ export async function renderToHTML(
) )
} }
if (isDataReq) { ;(data as any).props = {
;(data as any).props = { __N_REDIRECT: data.redirect.destination,
__N_REDIRECT: data.redirect.destination, __N_REDIRECT_STATUS: getRedirectStatus(data.redirect),
}
} else {
handleRedirect(res, data.redirect)
return null
} }
;(renderOpts as any).isRedirect = true
} }
if ( if (
...@@ -815,15 +807,11 @@ export async function renderToHTML( ...@@ -815,15 +807,11 @@ export async function renderToHTML(
if ('redirect' in data && typeof data.redirect === 'object') { if ('redirect' in data && typeof data.redirect === 'object') {
checkRedirectValues(data.redirect, req, 'getServerSideProps') checkRedirectValues(data.redirect, req, 'getServerSideProps')
;(data as any).props = {
if (isDataReq) { __N_REDIRECT: data.redirect.destination,
;(data as any).props = { __N_REDIRECT_STATUS: getRedirectStatus(data.redirect),
__N_REDIRECT: data.redirect.destination,
}
} else {
handleRedirect(res, data.redirect)
return null
} }
;(renderOpts as any).isRedirect = true
} }
if ( if (
...@@ -864,7 +852,9 @@ export async function renderToHTML( ...@@ -864,7 +852,9 @@ export async function renderToHTML(
// Avoid rendering page un-necessarily for getServerSideProps data request // Avoid rendering page un-necessarily for getServerSideProps data request
// and getServerSideProps/getStaticProps redirects // and getServerSideProps/getStaticProps redirects
if (isDataReq && (!isSSG || props.pageProps.__N_REDIRECT)) return props if ((isDataReq && !isSSG) || (renderOpts as any).isRedirect) {
return props
}
// We don't call getStaticProps or getServerSideProps while generating // We don't call getStaticProps or getServerSideProps while generating
// the fallback so make sure to set pageProps to an empty object // the fallback so make sure to set pageProps to an empty object
......
export default function Index() { export default function Index() {
if (typeof window !== 'undefined' && !window.initialHref) {
window.initialHref = window.location.href
}
return <p id="index">Index Page</p> return <p id="index">Index Page</p>
} }
...@@ -7,6 +7,7 @@ import { Builder, By } from 'selenium-webdriver' ...@@ -7,6 +7,7 @@ import { Builder, By } from 'selenium-webdriver'
import { Options as ChromeOptions } from 'selenium-webdriver/chrome' import { Options as ChromeOptions } from 'selenium-webdriver/chrome'
import { Options as SafariOptions } from 'selenium-webdriver/safari' import { Options as SafariOptions } from 'selenium-webdriver/safari'
import { Options as FireFoxOptions } from 'selenium-webdriver/firefox' import { Options as FireFoxOptions } from 'selenium-webdriver/firefox'
import { waitFor } from 'next-test-utils'
const { const {
BROWSER_NAME: browserName = 'chrome', BROWSER_NAME: browserName = 'chrome',
...@@ -210,8 +211,10 @@ export default async ( ...@@ -210,8 +211,10 @@ export default async (
} catch (err) { } catch (err) {
if (allowHydrationRetry) { if (allowHydrationRetry) {
// re-try in case the page reloaded during check // re-try in case the page reloaded during check
await waitFor(2000)
await checkHydrated() await checkHydrated()
} else { } else {
console.error('failed to check hydration')
throw err throw err
} }
} }
......
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