Unverified Commit e8c02736 authored by Zack Tanner's avatar Zack Tanner Committed by GitHub

add full PPR e2e tests (#59025)

This copies over the E2E tests that were added to `vercel/vercel` in
https://github.com/vercel/vercel/pull/10808 and
https://github.com/vercel/vercel/pull/10823, with some minor adjustments
to reflect the differences in cache behavior between start & deploy.
parent 6b651b0b
import React, { Suspense } from 'react'
import { Dynamic } from '../../../components/dynamic'
export const dynamic = 'force-dynamic'
export default ({ params: { slug } }) => {
return (
<Suspense
fallback={
<Dynamic pathname={`/dynamic/force-dynamic/${slug}`} fallback />
}
>
<Dynamic pathname={`/dynamic/force-dynamic/${slug}`} />
</Suspense>
)
}
import React, { Suspense } from 'react'
import { Dynamic } from '../../../components/dynamic'
export const dynamic = 'force-static'
export const revalidate = 60
export default ({ params: { slug } }) => {
return (
<Suspense
fallback={<Dynamic pathname={`/dynamic/force-static/${slug}`} fallback />}
>
<Dynamic pathname={`/dynamic/force-static/${slug}`} />
</Suspense>
)
}
import { Links } from '../components/links'
export default ({ children }) => {
return (
<html>
<body>
<h1>Partial Prerendering</h1>
<p>
Below are links that are associated with different pages that all will
partially prerender
</p>
<aside>
<Links />
</aside>
<main>{children}</main>
</body>
</html>
)
}
import React, { Suspense } from 'react'
import { Dynamic } from '../../../components/dynamic'
export const revalidate = 60
export default ({ params: { slug } }) => {
return (
<Suspense fallback={<Dynamic pathname={`/loading/${slug}`} fallback />}>
<Dynamic pathname={`/loading/${slug}`} />
</Suspense>
)
}
export const generateStaticParams = async () => {
return [{ slug: 'a' }]
}
export default () => {
return <code>loading.jsx</code>
}
import React, { Suspense } from 'react'
import { Dynamic } from '../../../components/dynamic'
export const revalidate = 60
export default ({ params: { slug } }) => {
return (
<Suspense fallback={<Dynamic pathname={`/nested/${slug}`} fallback />}>
<Dynamic pathname={`/nested/${slug}`} />
</Suspense>
)
}
export const generateStaticParams = async () => {
return [{ slug: 'a' }]
}
import React from 'react'
import { Dynamic } from '../../../../components/dynamic'
export default ({ params: { slug } }) => {
return <Dynamic pathname={`/no-suspense/nested/${slug}`} />
}
export const generateStaticParams = async () => {
return [{ slug: 'a' }]
}
import React from 'react'
import { Dynamic } from '../../components/dynamic'
export default () => {
return <Dynamic pathname="/no-suspense" />
}
import React, { Suspense } from 'react'
import { Dynamic } from '../../../components/dynamic'
export default ({ params: { slug } }) => {
return (
<Suspense fallback={<Dynamic pathname={`/on-demand/${slug}`} fallback />}>
<Dynamic pathname={`/on-demand/${slug}`} />
</Suspense>
)
}
import React, { Suspense } from 'react'
import { Dynamic } from '../components/dynamic'
export default () => {
return (
<Suspense fallback={<Dynamic pathname="/" fallback />}>
<Dynamic pathname="/" />
</Suspense>
)
}
import React from 'react'
import { Dynamic } from '../../components/dynamic'
export default () => {
return <Dynamic pathname="/static" fallback />
}
import React from 'react'
import { headers } from 'next/headers'
export const Dynamic = ({ pathname, fallback }) => {
if (fallback) {
return <div>Loading...</div>
}
const messages = []
const names = ['x-test-input', 'user-agent']
const list = headers()
for (const name of names) {
messages.push({ name, value: list.get(name) })
}
return (
<div id="needle">
<dl>
{pathname && (
<>
<dt>Pathname</dt>
<dd>{pathname}</dd>
</>
)}
{messages.map(({ name, value }) => (
<React.Fragment key={name}>
<dt>
Header: <code>{name}</code>
</dt>
<dd>{value ?? 'null'}</dd>
</React.Fragment>
))}
</dl>
</div>
)
}
import React from 'react'
import Link from 'next/link'
const links = [
{ href: '/', tag: 'pre-generated' },
{ href: '/nested/a', tag: 'pre-generated' },
{ href: '/nested/b', tag: 'on-demand' },
{ href: '/nested/c', tag: 'on-demand' },
{ href: '/on-demand/a', tag: 'on-demand, no-gsp' },
{ href: '/on-demand/b', tag: 'on-demand, no-gsp' },
{ href: '/on-demand/c', tag: 'on-demand, no-gsp' },
{ href: '/loading/a', tag: 'loading.jsx, pre-generated' },
{ href: '/loading/b', tag: 'loading.jsx, on-demand' },
{ href: '/loading/c', tag: 'loading.jsx, on-demand' },
{ href: '/static', tag: 'static' },
{ href: '/no-suspense', tag: 'no suspense' },
{ href: '/no-suspense/nested/a', tag: 'no suspense, pre-generated' },
{ href: '/no-suspense/nested/b', tag: 'no suspense, on-demand' },
{ href: '/no-suspense/nested/c', tag: 'no suspense, on-demand' },
{ href: '/dynamic/force-dynamic', tag: "dynamic = 'force-dynamic'" },
{ href: '/dynamic/force-static', tag: "dynamic = 'force-static'" },
{ href: '/edge/suspense', tag: 'edge, pre-generated' },
{ href: '/edge/suspense/a', tag: 'edge, pre-generated' },
{ href: '/edge/suspense/b', tag: 'edge, on-demand' },
{ href: '/edge/suspense/c', tag: 'edge, on-demand' },
{ href: '/edge/no-suspense', tag: 'edge, no suspense, pre-generated' },
{ href: '/edge/no-suspense/a', tag: 'edge, no suspense, pre-generated' },
{ href: '/edge/no-suspense/b', tag: 'edge, no suspense, on-demand' },
{ href: '/edge/no-suspense/c', tag: 'edge, no suspense, on-demand' },
]
export const Links = () => {
return (
<ul>
{links.map(({ href, tag }) => (
<li key={href}>
<Link href={href}>{href}</Link> <span>{tag}</span>
</li>
))}
</ul>
)
}
/** @type {import('next').NextConfig} */
const nextConfig = {
experimental: {
ppr: true,
},
}
module.exports = nextConfig
import { createNextDescribe } from 'e2e-utils'
const pages = [
{ pathname: '/', dynamic: true },
{ pathname: '/nested/a', dynamic: true, revalidate: 60 },
{ pathname: '/nested/b', dynamic: true, revalidate: 60 },
{ pathname: '/nested/c', dynamic: true, revalidate: 60 },
{ pathname: '/on-demand/a', dynamic: true },
{ pathname: '/on-demand/b', dynamic: true },
{ pathname: '/on-demand/c', dynamic: true },
{ pathname: '/loading/a', dynamic: true, revalidate: 60 },
{ pathname: '/loading/b', dynamic: true, revalidate: 60 },
{ pathname: '/loading/c', dynamic: true, revalidate: 60 },
{ pathname: '/static', dynamic: false },
{ pathname: '/no-suspense', dynamic: true },
{ pathname: '/no-suspense/nested/a', dynamic: true },
{ pathname: '/no-suspense/nested/b', dynamic: true },
{ pathname: '/no-suspense/nested/c', dynamic: true },
// TODO: uncomment when we've fixed the 404 case for force-dynamic pages
// { pathname: '/dynamic/force-dynamic', dynamic: 'force-dynamic' },
{
pathname: '/dynamic/force-static',
dynamic: 'force-static',
revalidate: 60,
},
]
createNextDescribe(
'ppr-full',
{
files: __dirname,
},
({ next, isNextDev, isNextStart, isNextDeploy }) => {
describe('dynamic pages should resume', () => {
it.each(pages.filter((p) => p.dynamic === true))(
'should resume $pathname',
async ({ pathname }) => {
const expected = `${Date.now()}:${Math.random()}`
const res = await next.fetch(pathname, {
headers: { 'X-Test-Input': expected },
})
expect(res.status).toEqual(200)
expect(res.headers.get('content-type')).toEqual(
'text/html; charset=utf-8'
)
const html = await res.text()
expect(html).toContain(expected)
expect(html).toContain('</html>')
}
)
})
if (!isNextDev) {
describe('prefetch RSC payloads should return', () => {
it.each(pages)(
'should prefetch $pathname',
async ({ pathname, dynamic, revalidate }) => {
const unexpected = `${Date.now()}:${Math.random()}`
const res = await next.fetch(pathname, {
headers: {
RSC: '1',
'Next-Router-Prefetch': '1',
'X-Test-Input': unexpected,
},
})
expect(res.status).toEqual(200)
expect(res.headers.get('content-type')).toEqual('text/x-component')
const cache = res.headers.get('cache-control')
// cache header handling is different when in minimal mode
if (isNextDeploy) {
expect(cache).toContain('public')
expect(cache).toContain('must-revalidate')
} else {
expect(cache).toContain(`s-maxage=${revalidate || '31536000'}`)
expect(cache).toContain('stale-while-revalidate')
}
// Expect that static RSC prefetches do not contain the dynamic text.
const text = await res.text()
expect(text).not.toContain(unexpected)
if (dynamic === true) {
// The dynamic component will contain the text "needle" if it was
// rendered using dynamic content.
expect(text).not.toContain('needle')
expect(res.headers.get('X-NextJS-Postponed')).toEqual('1')
} else {
if (dynamic !== false) {
expect(text).toContain('needle')
}
expect(res.headers.has('X-NextJS-Postponed')).toEqual(false)
}
}
)
})
describe('dynamic RSC payloads should return', () => {
it.each(pages)(
'should fetch $pathname',
async ({ pathname, dynamic }) => {
const expected = `${Date.now()}:${Math.random()}`
const res = await next.fetch(pathname, {
headers: { RSC: '1', 'X-Test-Input': expected },
})
expect(res.status).toEqual(200)
expect(res.headers.get('content-type')).toEqual('text/x-component')
expect(res.headers.has('X-NextJS-Postponed')).toEqual(false)
const cache = res.headers.get('cache-control')
// cache header handling is different when in minimal mode
if (isNextDeploy) {
expect(cache).toContain('private')
expect(cache).toContain('no-store')
expect(cache).toContain('no-cache')
expect(cache).toContain('max-age=0')
expect(cache).toContain('must-revalidate')
} else {
expect(cache).toContain('s-maxage=1')
expect(cache).toContain('stale-while-revalidate')
}
const text = await res.text()
if (dynamic !== false) {
expect(text).toContain('needle')
}
if (dynamic === true) {
// Expect that dynamic RSC prefetches do contain the dynamic text.
expect(text).toContain(expected)
} else {
// Expect that dynamic RSC prefetches do not contain the dynamic text
// when we're forced static.
expect(text).not.toContain(expected)
}
}
)
})
}
}
)
......@@ -5,7 +5,6 @@ createNextDescribe(
'ppr',
{
files: __dirname,
skipDeployment: true,
},
({ next, isNextDev, isNextStart }) => {
it('should indicate the feature is experimental', async () => {
......
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