Unverified Commit 59c767b2 authored by Zack Tanner's avatar Zack Tanner Committed by GitHub

Allow `next/headers` in middleware & `draftMode` in edge runtime (#53465)

## What
Using methods from `next/headers` in middleware would throw a `requestAsyncStorage` invariant. Additionally, using `draftMode()` in middleware/an edge runtime is not possible

## Why
We do not expose `requestAsyncStorage` to the middleware adapter. Also, the prerender manifest wasn't available to the `EdgeRouteModuleWrapper` & middleware adapter, so it wasn't possible to enable/disable it.

## How
This makes `requestAsyncStorage` available for middleware, and makes the preview mode data available from build to the edge runtime/middleware. 

Fixes #52557
parent 57788b56
...@@ -870,6 +870,19 @@ export default async function build( ...@@ -870,6 +870,19 @@ export default async function build(
) )
) )
// We need to write a partial prerender manifest to make preview mode settings available in edge middleware
const partialManifest: Partial<PrerenderManifest> = {
preview: previewProps,
}
await fs.writeFile(
path.join(distDir, PRERENDER_MANIFEST).replace(/\.json$/, '.js'),
`self.__PRERENDER_MANIFEST=${JSON.stringify(
JSON.stringify(partialManifest)
)}`,
'utf8'
)
const outputFileTracingRoot = const outputFileTracingRoot =
config.experimental.outputFileTracingRoot || dir config.experimental.outputFileTracingRoot || dir
...@@ -904,6 +917,7 @@ export default async function build( ...@@ -904,6 +917,7 @@ export default async function build(
path.relative(distDir, manifestPath), path.relative(distDir, manifestPath),
BUILD_MANIFEST, BUILD_MANIFEST,
PRERENDER_MANIFEST, PRERENDER_MANIFEST,
PRERENDER_MANIFEST.replace(/\.json$/, '.js'),
path.join(SERVER_DIRECTORY, MIDDLEWARE_MANIFEST), path.join(SERVER_DIRECTORY, MIDDLEWARE_MANIFEST),
path.join(SERVER_DIRECTORY, MIDDLEWARE_BUILD_MANIFEST + '.js'), path.join(SERVER_DIRECTORY, MIDDLEWARE_BUILD_MANIFEST + '.js'),
path.join( path.join(
......
...@@ -20,6 +20,7 @@ import { ...@@ -20,6 +20,7 @@ import {
SUBRESOURCE_INTEGRITY_MANIFEST, SUBRESOURCE_INTEGRITY_MANIFEST,
NEXT_FONT_MANIFEST, NEXT_FONT_MANIFEST,
SERVER_REFERENCE_MANIFEST, SERVER_REFERENCE_MANIFEST,
PRERENDER_MANIFEST,
} from '../../../shared/lib/constants' } from '../../../shared/lib/constants'
import { MiddlewareConfig } from '../../analysis/get-page-static-info' import { MiddlewareConfig } from '../../analysis/get-page-static-info'
import { Telemetry } from '../../../telemetry/storage' import { Telemetry } from '../../../telemetry/storage'
...@@ -127,6 +128,10 @@ function getEntryFiles( ...@@ -127,6 +128,10 @@ function getEntryFiles(
files.push(`server/edge-${INSTRUMENTATION_HOOK_FILENAME}.js`) files.push(`server/edge-${INSTRUMENTATION_HOOK_FILENAME}.js`)
} }
if (process.env.NODE_ENV === 'production') {
files.push(PRERENDER_MANIFEST.replace('json', 'js'))
}
files.push( files.push(
...entryFiles ...entryFiles
.filter((file) => !file.endsWith('.hot-update.js')) .filter((file) => !file.endsWith('.hot-update.js'))
......
...@@ -16,6 +16,7 @@ declare global { ...@@ -16,6 +16,7 @@ declare global {
__BUILD_MANIFEST_CB?: Function __BUILD_MANIFEST_CB?: Function
__MIDDLEWARE_MATCHERS?: MiddlewareMatcher[] __MIDDLEWARE_MATCHERS?: MiddlewareMatcher[]
__MIDDLEWARE_MANIFEST_CB?: Function __MIDDLEWARE_MANIFEST_CB?: Function
__PRERENDER_MANIFEST?: string
} }
} }
......
...@@ -139,6 +139,7 @@ export type RenderOptsPartial = { ...@@ -139,6 +139,7 @@ export type RenderOptsPartial = {
originalPathname?: string originalPathname?: string
isDraftMode?: boolean isDraftMode?: boolean
deploymentId?: string deploymentId?: string
onUpdateCookies?: (cookies: string[]) => void
loadConfig?: ( loadConfig?: (
phase: string, phase: string,
dir: string, dir: string,
......
...@@ -38,10 +38,10 @@ function getCookies( ...@@ -38,10 +38,10 @@ function getCookies(
function getMutableCookies( function getMutableCookies(
headers: Headers | IncomingHttpHeaders, headers: Headers | IncomingHttpHeaders,
res: ServerResponse | BaseNextResponse | undefined onUpdateCookies?: (cookies: string[]) => void
): ResponseCookies { ): ResponseCookies {
const cookies = new RequestCookies(HeadersAdapter.from(headers)) const cookies = new RequestCookies(HeadersAdapter.from(headers))
return MutableRequestCookiesAdapter.wrap(cookies, res) return MutableRequestCookiesAdapter.wrap(cookies, onUpdateCookies)
} }
export type RequestContext = { export type RequestContext = {
...@@ -75,6 +75,12 @@ export const RequestAsyncStorageWrapper: AsyncStorageWrapper< ...@@ -75,6 +75,12 @@ export const RequestAsyncStorageWrapper: AsyncStorageWrapper<
previewProps = (renderOpts as any).previewProps previewProps = (renderOpts as any).previewProps
} }
function defaultOnUpdateCookies(cookies: string[]) {
if (res) {
res.setHeader('Set-Cookie', cookies)
}
}
const cache: { const cache: {
headers?: ReadonlyHeaders headers?: ReadonlyHeaders
cookies?: ReadonlyRequestCookies cookies?: ReadonlyRequestCookies
...@@ -103,7 +109,11 @@ export const RequestAsyncStorageWrapper: AsyncStorageWrapper< ...@@ -103,7 +109,11 @@ export const RequestAsyncStorageWrapper: AsyncStorageWrapper<
}, },
get mutableCookies() { get mutableCookies() {
if (!cache.mutableCookies) { if (!cache.mutableCookies) {
cache.mutableCookies = getMutableCookies(req.headers, res) cache.mutableCookies = getMutableCookies(
req.headers,
renderOpts?.onUpdateCookies ||
(res ? defaultOnUpdateCookies : undefined)
)
} }
return cache.mutableCookies return cache.mutableCookies
}, },
......
...@@ -18,6 +18,9 @@ import { ...@@ -18,6 +18,9 @@ import {
} from '../../client/components/app-router-headers' } from '../../client/components/app-router-headers'
import { NEXT_QUERY_PARAM_PREFIX } from '../../lib/constants' import { NEXT_QUERY_PARAM_PREFIX } from '../../lib/constants'
import { ensureInstrumentationRegistered } from './globals' import { ensureInstrumentationRegistered } from './globals'
import { RequestAsyncStorageWrapper } from '../async-storage/request-async-storage-wrapper'
import { requestAsyncStorage } from '../../client/components/request-async-storage'
import { PrerenderManifest } from '../../build'
class NextRequestHint extends NextRequest { class NextRequestHint extends NextRequest {
sourcePage: string sourcePage: string
...@@ -65,6 +68,10 @@ export async function adapter( ...@@ -65,6 +68,10 @@ export async function adapter(
// TODO-APP: use explicit marker for this // TODO-APP: use explicit marker for this
const isEdgeRendering = typeof self.__BUILD_MANIFEST !== 'undefined' const isEdgeRendering = typeof self.__BUILD_MANIFEST !== 'undefined'
const prerenderManifest: PrerenderManifest | undefined =
typeof self.__PRERENDER_MANIFEST === 'string'
? JSON.parse(self.__PRERENDER_MANIFEST)
: undefined
params.request.url = normalizeRscPath(params.request.url, true) params.request.url = normalizeRscPath(params.request.url, true)
...@@ -177,13 +184,42 @@ export async function adapter( ...@@ -177,13 +184,42 @@ export async function adapter(
} }
const event = new NextFetchEvent({ request, page: params.page }) const event = new NextFetchEvent({ request, page: params.page })
let response = await params.handler(request, event) let response
let cookiesFromResponse
// we only care to make async storage available for middleware
if (params.page === '/middleware') {
response = await RequestAsyncStorageWrapper.wrap(
requestAsyncStorage,
{
req: request,
renderOpts: {
onUpdateCookies: (cookies) => {
cookiesFromResponse = cookies
},
// @ts-expect-error: TODO: investigate why previewProps isn't on RenderOpts
previewProps: prerenderManifest?.preview || {
previewModeId: 'development-id',
previewModeEncryptionKey: '',
previewModeSigningKey: '',
},
},
},
() => params.handler(request, event)
)
} else {
response = await params.handler(request, event)
}
// check if response is a Response object // check if response is a Response object
if (response && !(response instanceof Response)) { if (response && !(response instanceof Response)) {
throw new TypeError('Expected an instance of Response to be returned') throw new TypeError('Expected an instance of Response to be returned')
} }
if (response && cookiesFromResponse) {
response.headers.set('set-cookie', cookiesFromResponse)
}
/** /**
* For rewrites we must always include the locale in the final pathname * For rewrites we must always include the locale in the final pathname
* so we re-create the NextURL forcing it to include it when the it is * so we re-create the NextURL forcing it to include it when the it is
......
...@@ -11,6 +11,7 @@ import { IncrementalCache } from '../lib/incremental-cache' ...@@ -11,6 +11,7 @@ import { IncrementalCache } from '../lib/incremental-cache'
import { RouteMatcher } from '../future/route-matchers/route-matcher' import { RouteMatcher } from '../future/route-matchers/route-matcher'
import { removeTrailingSlash } from '../../shared/lib/router/utils/remove-trailing-slash' import { removeTrailingSlash } from '../../shared/lib/router/utils/remove-trailing-slash'
import { removePathPrefix } from '../../shared/lib/router/utils/remove-path-prefix' import { removePathPrefix } from '../../shared/lib/router/utils/remove-path-prefix'
import { PrerenderManifest } from '../../build'
type WrapOptions = Partial<Pick<AdapterOptions, 'page'>> type WrapOptions = Partial<Pick<AdapterOptions, 'page'>>
...@@ -81,6 +82,11 @@ export class EdgeRouteModuleWrapper { ...@@ -81,6 +82,11 @@ export class EdgeRouteModuleWrapper {
) )
} }
const prerenderManifest: PrerenderManifest | undefined =
typeof self.__PRERENDER_MANIFEST === 'string'
? JSON.parse(self.__PRERENDER_MANIFEST)
: undefined
// Create the context for the handler. This contains the params from the // Create the context for the handler. This contains the params from the
// match (if any). // match (if any).
const context: AppRouteRouteHandlerContext = { const context: AppRouteRouteHandlerContext = {
...@@ -89,9 +95,9 @@ export class EdgeRouteModuleWrapper { ...@@ -89,9 +95,9 @@ export class EdgeRouteModuleWrapper {
version: 4, version: 4,
routes: {}, routes: {},
dynamicRoutes: {}, dynamicRoutes: {},
preview: { preview: prerenderManifest?.preview || {
previewModeEncryptionKey: '', previewModeEncryptionKey: '',
previewModeId: '', previewModeId: 'development-id',
previewModeSigningKey: '', previewModeSigningKey: '',
}, },
notFoundRoutes: [], notFoundRoutes: [],
......
import type { RequestCookies } from '../cookies' import type { RequestCookies } from '../cookies'
import type { BaseNextResponse } from '../../../base-http'
import type { ServerResponse } from 'http'
import { StaticGenerationStore } from '../../../../client/components/static-generation-async-storage' import { StaticGenerationStore } from '../../../../client/components/static-generation-async-storage'
import { ResponseCookies } from '../cookies' import { ResponseCookies } from '../cookies'
...@@ -97,7 +95,7 @@ type ResponseCookie = NonNullable< ...@@ -97,7 +95,7 @@ type ResponseCookie = NonNullable<
export class MutableRequestCookiesAdapter { export class MutableRequestCookiesAdapter {
public static wrap( public static wrap(
cookies: RequestCookies, cookies: RequestCookies,
res: ServerResponse | BaseNextResponse | undefined onUpdateCookies?: (cookies: string[]) => void
): ResponseCookies { ): ResponseCookies {
const responseCookes = new ResponseCookies(new Headers()) const responseCookes = new ResponseCookies(new Headers())
for (const cookie of cookies.getAll()) { for (const cookie of cookies.getAll()) {
...@@ -117,14 +115,15 @@ export class MutableRequestCookiesAdapter { ...@@ -117,14 +115,15 @@ export class MutableRequestCookiesAdapter {
const allCookies = responseCookes.getAll() const allCookies = responseCookes.getAll()
modifiedValues = allCookies.filter((c) => modifiedCookies.has(c.name)) modifiedValues = allCookies.filter((c) => modifiedCookies.has(c.name))
if (res) { if (onUpdateCookies) {
const serializedCookies: string[] = [] const serializedCookies: string[] = []
for (const cookie of modifiedValues) { for (const cookie of modifiedValues) {
const tempCookies = new ResponseCookies(new Headers()) const tempCookies = new ResponseCookies(new Headers())
tempCookies.set(cookie) tempCookies.set(cookie)
serializedCookies.push(tempCookies.toString()) serializedCookies.push(tempCookies.toString())
} }
res.setHeader('Set-Cookie', serializedCookies)
onUpdateCookies(serializedCookies)
} }
} }
......
...@@ -124,6 +124,15 @@ createNextDescribe( ...@@ -124,6 +124,15 @@ createNextDescribe(
res.headers.get('x-middleware-request-x-from-client3') res.headers.get('x-middleware-request-x-from-client3')
).toBeNull() ).toBeNull()
}) })
it(`Supports draft mode`, async () => {
const res = await next.fetch(`${path}?draft=true`)
const headers: string = res.headers.get('set-cookie') || ''
const bypassCookie = headers
.split(';')
.find((c) => c.startsWith('__prerender_bypass'))
expect(bypassCookie).toBeDefined()
})
}) })
} }
) )
......
import { NextResponse } from 'next/server' import { NextResponse } from 'next/server'
// It should be able to import `headers` inside middleware import { headers as nextHeaders, draftMode } from 'next/headers'
import { headers } from 'next/headers'
console.log(!!headers)
/** /**
* @param {import('next/server').NextRequest} request * @param {import('next/server').NextRequest} request
*/ */
export async function middleware(request) { export async function middleware(request) {
const headers = new Headers(request.headers) const headersFromRequest = new Headers(request.headers)
headers.set('x-from-middleware', 'hello-from-middleware') // It should be able to import and use `headers` inside middleware
const headersFromNext = nextHeaders()
headersFromRequest.set('x-from-middleware', 'hello-from-middleware')
// make sure headers() from `next/headers` is behaving properly
if (
headersFromRequest.get('x-from-client') &&
headersFromNext.get('x-from-client') !==
headersFromRequest.get('x-from-client')
) {
throw new Error('Expected headers from client to match')
}
if (request.nextUrl.searchParams.get('draft')) {
draftMode().enable()
}
const removeHeaders = request.nextUrl.searchParams.get('remove-headers') const removeHeaders = request.nextUrl.searchParams.get('remove-headers')
if (removeHeaders) { if (removeHeaders) {
for (const key of removeHeaders.split(',')) { for (const key of removeHeaders.split(',')) {
headers.delete(key) headersFromRequest.delete(key)
} }
} }
...@@ -22,7 +35,7 @@ export async function middleware(request) { ...@@ -22,7 +35,7 @@ export async function middleware(request) {
if (updateHeader) { if (updateHeader) {
for (const kv of updateHeader.split(',')) { for (const kv of updateHeader.split(',')) {
const [key, value] = kv.split('=') const [key, value] = kv.split('=')
headers.set(key, value) headersFromRequest.set(key, value)
} }
} }
...@@ -33,7 +46,7 @@ export async function middleware(request) { ...@@ -33,7 +46,7 @@ export async function middleware(request) {
return NextResponse.next({ return NextResponse.next({
request: { request: {
headers, headers: headersFromRequest,
}, },
}) })
} }
import { draftMode } from 'next/headers'
export function GET() {
draftMode().disable()
return new Response(
'Disabled in Route Handler using draftMode().enable(), check cookies'
)
}
import { draftMode } from 'next/headers'
import { redirect } from 'next/navigation'
export function GET(req: Request) {
draftMode().enable()
const to = new URL(req.url).searchParams.get('to') ?? '/some-other-page'
return redirect(to)
}
import { draftMode } from 'next/headers'
export function GET() {
draftMode().enable()
return new Response(
'Enabled in Route Handler using draftMode().enable(), check cookies'
)
}
import React from 'react'
export const runtime = 'edge'
export default function Layout({ children }) {
return <div>{children}</div>
}
import React from 'react' import React from 'react'
import { draftMode } from 'next/headers' import { draftMode } from 'next/headers'
export const runtime = 'experimental-edge'
export default function Page() { export default function Page() {
const { isEnabled } = draftMode() const { isEnabled } = draftMode()
......
import { draftMode } from 'next/headers' import { draftMode } from 'next/headers'
export const runtime = 'edge'
export function GET() { export function GET() {
const { isEnabled } = draftMode() const { isEnabled } = draftMode()
return new Response(isEnabled ? 'ENABLED' : 'DISABLED') return new Response(isEnabled ? 'ENABLED' : 'DISABLED')
......
import React from 'react'
import { cookies, draftMode } from 'next/headers'
export default function Page() {
const { isEnabled } = draftMode()
let data: string | undefined
if (isEnabled) {
data = cookies().get('data')?.value
}
return (
<>
<h1>Draft Mode with dynamic cookie</h1>
<p>
Random: <em id="rand">{Math.random()}</em>
</p>
<p>
State: <strong id="mode">{isEnabled ? 'ENABLED' : 'DISABLED'}</strong>
</p>
<p>
Data: <em id="data">{data}</em>
</p>
</>
)
}
import { createNextDescribe } from 'e2e-utils'
createNextDescribe(
'app dir - draft mode',
{
files: __dirname,
},
({ next }) => {
let Cookie = ''
it('should be disabled', async () => {
const $ = await next.render$('/')
expect($('#mode').text()).toBe('DISABLED')
})
it('should be disabled from api route handler', async () => {
const res = await next.fetch('/state')
expect(await res.text()).toBe('DISABLED')
})
it('should have set-cookie header on enable', async () => {
const res = await next.fetch('/enable')
const h = res.headers.get('set-cookie') || ''
Cookie = h.split(';').find((c) => c.startsWith('__prerender_bypass'))
expect(Cookie).toBeDefined()
})
it('should have set-cookie header with redirect location', async () => {
const res = await next.fetch('/enable-and-redirect', {
redirect: 'manual',
})
expect(res.status).toBe(307)
expect(res.headers.get('location')).toContain('/some-other-page')
const h = res.headers.get('set-cookie') || ''
const c = h.split(';').find((c) => c.startsWith('__prerender_bypass'))
expect(c).toBeDefined()
})
it('should be enabled from page when draft mode enabled', async () => {
const opts = { headers: { Cookie } }
const $ = await next.render$('/', {}, opts)
expect($('#mode').text()).toBe('ENABLED')
})
it('should be enabled from api route handler when draft mode enabled', async () => {
const opts = { headers: { Cookie } }
const res = await next.fetch('/state', opts)
expect(await res.text()).toBe('ENABLED')
})
}
)
import { createNextDescribe } from 'e2e-utils'
import { waitFor } from 'next-test-utils'
createNextDescribe(
'app dir - draft mode',
{
files: __dirname,
},
({ next, isNextDev }) => {
let origRandHome = 'unintialized'
let origRandWithCookies = 'unintialized'
let Cookie = ''
it('should use initial rand when draft mode is disabled on /index', async () => {
const $ = await next.render$('/')
expect($('#mode').text()).toBe('DISABLED')
expect($('#rand').text()).toBeDefined()
origRandHome = $('#rand').text()
})
it('should use initial rand when draft mode is disabled on /with-cookies', async () => {
const $ = await next.render$('/with-cookies')
expect($('#mode').text()).toBe('DISABLED')
expect($('#rand').text()).toBeDefined()
expect($('#data').text()).toBe('')
origRandWithCookies = $('#rand').text()
})
if (!isNextDev) {
it('should not generate rand when draft mode disabled during next start', async () => {
const $ = await next.render$('/')
expect($('#mode').text()).toBe('DISABLED')
expect($('#rand').text()).toBe(origRandHome)
})
it('should not read other cookies when draft mode disabled during next start', async () => {
const opts = { headers: { Cookie: `data=cool` } }
const $ = await next.render$('/with-cookies', {}, opts)
expect($('#mode').text()).toBe('DISABLED')
expect($('#rand').text()).toBe(origRandWithCookies)
expect($('#data').text()).toBe('')
})
}
it('should be disabled from api route handler', async () => {
const res = await next.fetch('/state')
expect(await res.text()).toBe('DISABLED')
})
it('should have set-cookie header on enable', async () => {
const res = await next.fetch('/enable')
const h = res.headers.get('set-cookie') || ''
Cookie = h.split(';').find((c) => c.startsWith('__prerender_bypass'))
expect(Cookie).toBeDefined()
})
it('should have set-cookie header with redirect location', async () => {
const res = await next.fetch('/enable-and-redirect', {
redirect: 'manual',
})
expect(res.status).toBe(307)
expect(res.headers.get('location')).toContain('/some-other-page')
const h = res.headers.get('set-cookie') || ''
const c = h.split(';').find((c) => c.startsWith('__prerender_bypass'))
expect(c).toBeDefined()
})
it('should genenerate rand when draft mode enabled', async () => {
const opts = { headers: { Cookie } }
const $ = await next.render$('/', {}, opts)
expect($('#mode').text()).toBe('ENABLED')
expect($('#rand').text()).not.toBe(origRandHome)
})
it('should read other cookies when draft mode enabled', async () => {
const opts = { headers: { Cookie: `${Cookie};data=cool` } }
const $ = await next.render$('/with-cookies', {}, opts)
expect($('#mode').text()).toBe('ENABLED')
expect($('#rand').text()).not.toBe(origRandWithCookies)
expect($('#data').text()).toBe('cool')
})
it('should be enabled from api route handler when draft mode enabled', async () => {
const opts = { headers: { Cookie } }
const res = await next.fetch('/state', opts)
expect(await res.text()).toBe('ENABLED')
})
it('should not perform full page navigation on router.refresh()', async () => {
const to = encodeURIComponent('/generate/foo')
const browser = await next.browser(`/enable-and-redirect?to=${to}`)
await browser.eval('window._test = 42')
await browser.elementById('refresh').click()
const start = Date.now()
while (Date.now() - start < 5000) {
const value = await browser.eval('window._test')
if (value !== 42) {
throw new Error('Detected a full page navigation')
}
await waitFor(200)
}
expect(await browser.eval('window._test')).toBe(42)
})
}
)
import { createNextDescribe } from 'e2e-utils'
import { waitFor } from 'next-test-utils'
createNextDescribe(
'app dir - draft mode',
{
files: __dirname,
},
({ next, isNextDev }) => {
async function runTests({ basePath = '/' }: { basePath: string }) {
let origRandHome = 'unintialized'
let origRandWithCookies = 'unintialized'
let Cookie = ''
it(`should use initial rand when draft mode is disabled on ${basePath}index`, async () => {
const $ = await next.render$(basePath)
expect($('#mode').text()).toBe('DISABLED')
expect($('#rand').text()).toBeDefined()
origRandHome = $('#rand').text()
})
it(`should use initial rand when draft mode is disabled on ${basePath}with-cookies`, async () => {
const $ = await next.render$(`${basePath}with-cookies`)
expect($('#mode').text()).toBe('DISABLED')
expect($('#rand').text()).toBeDefined()
expect($('#data').text()).toBe('')
origRandWithCookies = $('#rand').text()
})
if (!isNextDev) {
if (basePath === '/') {
it('should not generate rand when draft mode disabled during next start', async () => {
const $ = await next.render$(basePath)
expect($('#mode').text()).toBe('DISABLED')
expect($('#rand').text()).toBe(origRandHome)
})
}
it('should not read other cookies when draft mode disabled during next start', async () => {
const opts = { headers: { Cookie: `data=cool` } }
const $ = await next.render$(`${basePath}with-cookies`, {}, opts)
expect($('#mode').text()).toBe('DISABLED')
expect($('#data').text()).toBe('')
})
}
it('should be disabled from api route handler', async () => {
const res = await next.fetch(`${basePath}state`)
expect(await res.text()).toBe('DISABLED')
})
it('should have set-cookie header on enable', async () => {
const res = await next.fetch(`${basePath}enable`)
const h = res.headers.get('set-cookie') || ''
Cookie = h.split(';').find((c) => c.startsWith('__prerender_bypass'))
expect(Cookie).toBeDefined()
})
it('should have set-cookie header with redirect location', async () => {
const res = await next.fetch(`${basePath}enable-and-redirect`, {
redirect: 'manual',
})
expect(res.status).toBe(307)
expect(res.headers.get('location')).toContain('/some-other-page')
const h = res.headers.get('set-cookie') || ''
const c = h.split(';').find((c) => c.startsWith('__prerender_bypass'))
expect(c).toBeDefined()
})
it('should genenerate rand when draft mode enabled', async () => {
const opts = { headers: { Cookie } }
const $ = await next.render$(basePath, {}, opts)
expect($('#mode').text()).toBe('ENABLED')
expect($('#rand').text()).not.toBe(origRandHome)
})
it('should read other cookies when draft mode enabled', async () => {
const opts = { headers: { Cookie: `${Cookie};data=cool` } }
const $ = await next.render$(`${basePath}with-cookies`, {}, opts)
expect($('#mode').text()).toBe('ENABLED')
expect($('#rand').text()).not.toBe(origRandWithCookies)
expect($('#data').text()).toBe('cool')
})
it('should be enabled from api route handler when draft mode enabled', async () => {
const opts = { headers: { Cookie } }
const res = await next.fetch(`${basePath}state`, opts)
expect(await res.text()).toBe('ENABLED')
})
it('should not perform full page navigation on router.refresh()', async () => {
const to = encodeURIComponent('/generate/foo')
const browser = await next.browser(
`${basePath}enable-and-redirect?to=${to}`
)
await browser.eval('window._test = 42')
await browser.elementById('refresh').click()
const start = Date.now()
while (Date.now() - start < 5000) {
const value = await browser.eval('window._test')
if (value !== 42) {
throw new Error('Detected a full page navigation')
}
await waitFor(200)
}
expect(await browser.eval('window._test')).toBe(42)
})
}
describe('in nodejs runtime', () => {
runTests({ basePath: '/' })
})
describe('in edge runtime', () => {
runTests({ basePath: '/with-edge/' })
})
}
)
...@@ -111,7 +111,11 @@ describe('Middleware Runtime trailing slash', () => { ...@@ -111,7 +111,11 @@ describe('Middleware Runtime trailing slash', () => {
) )
expect(manifest.middleware).toEqual({ expect(manifest.middleware).toEqual({
'/': { '/': {
files: ['server/edge-runtime-webpack.js', 'server/middleware.js'], files: [
'prerender-manifest.js',
'server/edge-runtime-webpack.js',
'server/middleware.js',
],
name: 'middleware', name: 'middleware',
page: '/', page: '/',
matchers: [{ regexp: '^/.*$', originalSource: '/:path*' }], matchers: [{ regexp: '^/.*$', originalSource: '/:path*' }],
......
...@@ -622,6 +622,7 @@ describe('Switchable runtime', () => { ...@@ -622,6 +622,7 @@ describe('Switchable runtime', () => {
functions: { functions: {
'/api/hello': { '/api/hello': {
files: [ files: [
'prerender-manifest.js',
'server/edge-runtime-webpack.js', 'server/edge-runtime-webpack.js',
'server/pages/api/hello.js', 'server/pages/api/hello.js',
], ],
...@@ -634,6 +635,7 @@ describe('Switchable runtime', () => { ...@@ -634,6 +635,7 @@ describe('Switchable runtime', () => {
}, },
'/api/edge': { '/api/edge': {
files: [ files: [
'prerender-manifest.js',
'server/edge-runtime-webpack.js', 'server/edge-runtime-webpack.js',
'server/pages/api/edge.js', 'server/pages/api/edge.js',
], ],
......
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