Unverified Commit cc684d02 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Add export runtime test for pages and fully remove experimental.runtime (#48630)

### What 

`export const runtime = 'experimental-edge'` also work for pages. This
PR add tests for that.

Closes NEXT-426

Follow up for #46631 that to fully remove all related code of the
`experimental.runtime`
parent 682fb27a
...@@ -312,8 +312,8 @@ function warnAboutUnsupportedValue( ...@@ -312,8 +312,8 @@ function warnAboutUnsupportedValue(
* Related discussion: https://github.com/vercel/next.js/discussions/34179 * Related discussion: https://github.com/vercel/next.js/discussions/34179
*/ */
export async function getPageStaticInfo(params: { export async function getPageStaticInfo(params: {
nextConfig: Partial<NextConfig>
pageFilePath: string pageFilePath: string
nextConfig: Partial<NextConfig>
isDev?: boolean isDev?: boolean
page?: string page?: string
pageType: 'pages' | 'app' | 'root' pageType: 'pages' | 'app' | 'root'
...@@ -382,10 +382,9 @@ export async function getPageStaticInfo(params: { ...@@ -382,10 +382,9 @@ export async function getPageStaticInfo(params: {
const isAnAPIRoute = isAPIRoute(page?.replace(/^(?:\/src)?\/pages\//, '/')) const isAnAPIRoute = isAPIRoute(page?.replace(/^(?:\/src)?\/pages\//, '/'))
resolvedRuntime = isEdgeRuntime(resolvedRuntime) resolvedRuntime =
isEdgeRuntime(resolvedRuntime) || requiresServerRuntime
? resolvedRuntime ? resolvedRuntime
: requiresServerRuntime
? resolvedRuntime || nextConfig.experimental?.runtime
: undefined : undefined
if (resolvedRuntime === SERVER_RUNTIME.experimentalEdge) { if (resolvedRuntime === SERVER_RUNTIME.experimentalEdge) {
...@@ -425,6 +424,6 @@ export async function getPageStaticInfo(params: { ...@@ -425,6 +424,6 @@ export async function getPageStaticInfo(params: {
ssr: false, ssr: false,
ssg: false, ssg: false,
rsc: RSC_MODULE_TYPES.server, rsc: RSC_MODULE_TYPES.server,
runtime: nextConfig.experimental?.runtime, runtime: undefined,
} }
} }
...@@ -705,7 +705,10 @@ export default async function getBaseWebpackConfig( ...@@ -705,7 +705,10 @@ export default async function getBaseWebpackConfig(
const enableTypedRoutes = !!config.experimental.typedRoutes && hasAppDir const enableTypedRoutes = !!config.experimental.typedRoutes && hasAppDir
if (isClient) { if (isClient) {
if (isEdgeRuntime(config.experimental.runtime)) { if (
// @ts-expect-error: experimental.runtime is deprecated
isEdgeRuntime(config.experimental.runtime)
) {
Log.warn( Log.warn(
'You are using `experimental.runtime` which was removed. Check https://nextjs.org/docs/api-routes/edge-api-routes on how to use edge runtime.' 'You are using `experimental.runtime` which was removed. Check https://nextjs.org/docs/api-routes/edge-api-routes on how to use edge runtime.'
) )
......
import { NextConfig } from './config' import { NextConfig } from './config'
import type { JSONSchemaType } from 'ajv' import type { JSONSchemaType } from 'ajv'
import { VALID_LOADERS } from '../shared/lib/image-config' import { VALID_LOADERS } from '../shared/lib/image-config'
import { SERVER_RUNTIME } from '../lib/constants'
const configSchema = { const configSchema = {
type: 'object', type: 'object',
...@@ -373,11 +372,6 @@ const configSchema = { ...@@ -373,11 +372,6 @@ const configSchema = {
minimum: 0, minimum: 0,
type: 'number', type: 'number',
}, },
runtime: {
// automatic typing doesn't like enum
enum: Object.values(SERVER_RUNTIME) as any,
type: 'string',
},
serverComponentsExternalPackages: { serverComponentsExternalPackages: {
items: { items: {
type: 'string', type: 'string',
......
...@@ -6,7 +6,6 @@ import { ...@@ -6,7 +6,6 @@ import {
ImageConfigComplete, ImageConfigComplete,
imageConfigDefault, imageConfigDefault,
} from '../shared/lib/image-config' } from '../shared/lib/image-config'
import { ServerRuntime } from 'next/types'
import { SubresourceIntegrityAlgorithm } from '../build/webpack/plugins/subresource-integrity-plugin' import { SubresourceIntegrityAlgorithm } from '../build/webpack/plugins/subresource-integrity-plugin'
import { WEB_VITALS } from '../shared/lib/utils' import { WEB_VITALS } from '../shared/lib/utils'
import type { NextParsedUrlQuery } from './request-meta' import type { NextParsedUrlQuery } from './request-meta'
...@@ -195,7 +194,6 @@ export interface ExperimentalConfig { ...@@ -195,7 +194,6 @@ export interface ExperimentalConfig {
craCompat?: boolean craCompat?: boolean
esmExternals?: boolean | 'loose' esmExternals?: boolean | 'loose'
isrMemoryCacheSize?: number isrMemoryCacheSize?: number
runtime?: Exclude<ServerRuntime, undefined>
fullySpecified?: boolean fullySpecified?: boolean
urlImports?: NonNullable<webpack.Configuration['experiments']>['buildHttp'] urlImports?: NonNullable<webpack.Configuration['experiments']>['buildHttp']
outputFileTracingRoot?: string outputFileTracingRoot?: string
...@@ -662,7 +660,6 @@ export const defaultConfig: NextConfig = { ...@@ -662,7 +660,6 @@ export const defaultConfig: NextConfig = {
fetchCacheKeyPrefix: '', fetchCacheKeyPrefix: '',
middlewarePrefetch: 'flexible', middlewarePrefetch: 'flexible',
optimisticClientCache: true, optimisticClientCache: true,
runtime: undefined,
manualClientBasePath: false, manualClientBasePath: false,
legacyBrowsers: false, legacyBrowsers: false,
newNextLinkBehavior: true, newNextLinkBehavior: true,
......
...@@ -2,6 +2,4 @@ export default function page() { ...@@ -2,6 +2,4 @@ export default function page() {
return 'edge-ssr' return 'edge-ssr'
} }
export const config = { export const runtime = 'experimental-edge'
runtime: 'experimental-edge',
}
import { createNextDescribe } from 'e2e-utils'
createNextDescribe(
'app-dir global edge configuration',
{
files: __dirname,
skipDeployment: true,
},
({ next }) => {
it('should handle edge only routes', async () => {
const html = await next.render('/app-edge')
expect(html).toContain('<p>Edge!</p>')
})
}
)
'use client'
// TODO-APP: support typing for useSelectedLayoutSegment
// @ts-ignore
import { useSelectedLayoutSegments } from 'next/navigation'
export default function Layout({ children }: { children: React.ReactNode }) {
// useSelectedLayoutSegment should not be thrown
useSelectedLayoutSegments()
return children
}
export default function Page() {
if ('EdgeRuntime' in globalThis) {
return <p>Edge!</p>
}
return <p>Node!</p>
}
export default function Root({ children }: { children: React.ReactNode }) {
return (
<html>
<head></head>
<body>{children}</body>
</html>
)
}
module.exports = {
experimental: {
appDir: true,
runtime: 'experimental-edge',
},
}
{
"compilerOptions": {
"target": "ES6",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"noEmit": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "preserve",
"incremental": true,
"baseUrl": ".",
"paths": {
"@/ui/*": ["ui/*"]
},
"plugins": [
{
"name": "next"
}
]
},
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
"exclude": ["node_modules"]
}
...@@ -2,4 +2,4 @@ export default function Page() { ...@@ -2,4 +2,4 @@ export default function Page() {
return <p>pages-edge-ssr</p> return <p>pages-edge-ssr</p>
} }
export const config = { runtime: 'experimental-edge' } export const runtime = 'experimental-edge'
export const config = { export const runtime = 'experimental-edge'
runtime: 'edge',
}
export default (req) => { export default (req) => {
return Response.json(Object.fromEntries(req.headers.entries()), { return Response.json(Object.fromEntries(req.headers.entries()), {
......
...@@ -2,6 +2,4 @@ export default function api(req) { ...@@ -2,6 +2,4 @@ export default function api(req) {
return new Response('hello') return new Response('hello')
} }
export const config = { export const runtime = 'edge'
runtime: 'edge',
}
...@@ -2,7 +2,7 @@ import B from 'node:buffer' ...@@ -2,7 +2,7 @@ import B from 'node:buffer'
import B2 from 'buffer' import B2 from 'buffer'
import { NextResponse } from 'next/server' import { NextResponse } from 'next/server'
export const config = { runtime: 'edge' } export const runtime = 'edge'
/** /**
* @param {Request} req * @param {Request} req
......
export const config = { runtime: 'edge' } export const runtime = 'edge'
import cookies from '../../../cookies' import cookies from '../../../cookies'
......
export const config = { runtime: 'experimental-edge' }
import cookies from '../../../cookies' import cookies from '../../../cookies'
export const runtime = 'edge'
export default async function handler() { export default async function handler() {
const headers = new Headers() const headers = new Headers()
for (const cookie of cookies) { for (const cookie of cookies) {
......
...@@ -157,9 +157,6 @@ if (isNextProd) { ...@@ -157,9 +157,6 @@ if (isNextProd) {
}`, }`,
}, },
nextConfig: { nextConfig: {
experimental: {
runtime: 'nodejs',
},
webpack(config, { nextRuntime }) { webpack(config, { nextRuntime }) {
const path = require('path') const path = require('path')
const fs = require('fs') const fs = require('fs')
......
...@@ -3,7 +3,4 @@ module.exports = { ...@@ -3,7 +3,4 @@ module.exports = {
loader: 'custom', loader: 'custom',
loaderFile: './dummy-loader.js', loaderFile: './dummy-loader.js',
}, },
experimental: {
runtime: 'experimental-edge',
},
} }
module.exports = { module.exports = {
// reactStrictMode: true, reactStrictMode: true,
experimental: {
// runtime: 'experimental-edge',
},
images: { images: {
deviceSizes: [480, 1024, 1600, 2000], deviceSizes: [480, 1024, 1600, 2000],
imageSizes: [16, 32, 48, 64], imageSizes: [16, 32, 48, 64],
......
...@@ -2,65 +2,24 @@ ...@@ -2,65 +2,24 @@
import { join } from 'path' import { join } from 'path'
import { import { File, renderViaHTTP, runDevSuite, runProdSuite } from 'next-test-utils'
File,
findPort,
killApp,
launchApp,
renderViaHTTP,
hasRedbox,
getRedboxHeader,
runDevSuite,
runProdSuite,
} from 'next-test-utils'
import concurrent from './concurrent' import concurrent from './concurrent'
import basics from './basics' import basics from './basics'
import strictMode from './strict-mode' import strictMode from './strict-mode'
import webdriver from 'next-webdriver'
const appDir = join(__dirname, '../app') const appDir = join(__dirname, '../app')
const nextConfig = new File(join(appDir, 'next.config.js'))
const invalidPage = new File(join(appDir, 'pages/invalid.js'))
const indexPage = new File(join(appDir, 'pages/index.js')) const indexPage = new File(join(appDir, 'pages/index.js'))
describe('Basics', () => { describe('Basics', () => {
runTests('default setting with react 18', basics) runTests('default setting with react 18', basics)
}) })
// React 18 with Strict Mode enabled might cause double invocation of lifecycle methods.
describe('Strict mode - dev', () => {
const context = { appDir }
beforeAll(async () => {
nextConfig.replace('// reactStrictMode: true,', 'reactStrictMode: true,')
context.appPort = await findPort()
context.server = await launchApp(context.appDir, context.appPort)
})
afterAll(() => {
nextConfig.restore()
killApp(context.server)
})
strictMode(context)
})
function runTestsAgainstRuntime(runtime) { function runTestsAgainstRuntime(runtime) {
runTests( runTests(
`Concurrent mode in the ${runtime} runtime`, `Concurrent mode in the ${runtime} runtime`,
(context, env) => { (context, env) => {
concurrent(context, (p, q) => renderViaHTTP(context.appPort, p, q)) concurrent(context, (p, q) => renderViaHTTP(context.appPort, p, q))
strictMode(context)
if (env === 'dev') {
it('should recover after undefined exported as default', async () => {
const browser = await webdriver(context.appPort, '/invalid')
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxHeader(browser)).toMatch(
`Error: The default export is not a React Component in page: "/invalid"`
)
})
}
it('should not have invalid config warning', async () => { it('should not have invalid config warning', async () => {
await renderViaHTTP(context.appPort, '/') await renderViaHTTP(context.appPort, '/')
...@@ -69,23 +28,12 @@ function runTestsAgainstRuntime(runtime) { ...@@ -69,23 +28,12 @@ function runTestsAgainstRuntime(runtime) {
}, },
{ {
beforeAll: (env) => { beforeAll: (env) => {
if (env === 'dev') {
invalidPage.write(`export const value = 1`)
}
nextConfig.replace(
"// runtime: 'experimental-edge'",
`runtime: '${runtime}'`
)
indexPage.replace( indexPage.replace(
"// runtime: 'experimental-edge'", "// runtime: 'experimental-edge'",
`runtime: '${runtime}'` `runtime: '${runtime}'`
) )
}, },
afterAll: (env) => { afterAll: (env) => {
if (env === 'dev') {
invalidPage.delete()
}
nextConfig.restore()
indexPage.restore() indexPage.restore()
}, },
} }
......
module.exports = {
// reactStrictMode: true,
// onDemandEntries: {
// maxInactiveAge: 1000 * 60 * 60,
// },
// pageExtensions: ['js', 'ts', 'jsx'], // .tsx won't be treat as page,
experimental: {
runtime: 'nodejs',
},
}
import { Suspense } from 'react'
let result
let promise
function Data() {
if (result) return result
if (!promise)
promise = new Promise((res) => {
setTimeout(() => {
result = 'next_streaming_data'
res()
}, 500)
})
throw promise
}
export default function Page() {
return (
<Suspense fallback="next_streaming_fallback">
<Data />
</Suspense>
)
}
export const runtime = 'experimental-edge'
...@@ -22,6 +22,7 @@ export default function Page() { ...@@ -22,6 +22,7 @@ export default function Page() {
) )
} }
// Use config export
export const config = { export const config = {
runtime: 'experimental-edge', runtime: 'experimental-edge',
} }
...@@ -12,11 +12,10 @@ export default function Page500() { ...@@ -12,11 +12,10 @@ export default function Page500() {
const appDir = join(__dirname, '../app') const appDir = join(__dirname, '../app')
const error500Page = new File(join(appDir, 'pages/500.js')) const error500Page = new File(join(appDir, 'pages/500.js'))
const nextConfig = new File(join(appDir, 'next.config.js'))
const edgeRuntimeBasicSuite = { const testSuite = {
runTests: (context, env) => { runTests: (context, env) => {
const options = { runtime: 'experimental-edge', env } const options = { env }
streaming(context, options) streaming(context, options)
}, },
beforeAll: () => { beforeAll: () => {
...@@ -27,21 +26,5 @@ const edgeRuntimeBasicSuite = { ...@@ -27,21 +26,5 @@ const edgeRuntimeBasicSuite = {
}, },
} }
const nodejsRuntimeBasicSuite = { runDevSuite('streaming dev', appDir, testSuite)
runTests: (context, env) => { runProdSuite('streaming prod', appDir, testSuite)
const options = { runtime: 'nodejs', env }
streaming(context, options)
},
beforeAll: () => {
error500Page.write(page500)
},
afterAll: () => {
error500Page.delete()
nextConfig.restore()
},
}
runDevSuite('Node.js runtime', appDir, nodejsRuntimeBasicSuite)
runProdSuite('Node.js runtime', appDir, nodejsRuntimeBasicSuite)
runDevSuite('Edge runtime', appDir, edgeRuntimeBasicSuite)
runProdSuite('Edge runtime', appDir, edgeRuntimeBasicSuite)
...@@ -22,9 +22,10 @@ async function resolveStreamResponse(response, onData) { ...@@ -22,9 +22,10 @@ async function resolveStreamResponse(response, onData) {
return result return result
} }
export default function (context, { env, runtime }) { export default function (context, { env }) {
it('should support streaming for fizz response', async () => { it('should support streaming for fizz response', async () => {
await fetchViaHTTP(context.appPort, '/streaming', null, {}).then( async function testStreamingResponse(pathname) {
await fetchViaHTTP(context.appPort, pathname, null, {}).then(
async (response) => { async (response) => {
let gotFallback = false let gotFallback = false
let gotData = false let gotData = false
...@@ -46,9 +47,13 @@ export default function (context, { env, runtime }) { ...@@ -46,9 +47,13 @@ export default function (context, { env, runtime }) {
) )
// Should end up with "next_streaming_data". // Should end up with "next_streaming_data".
const browser = await webdriver(context.appPort, '/streaming') const browser = await webdriver(context.appPort, pathname)
const content = await browser.eval(`window.document.body.innerText`) const content = await browser.eval(`window.document.body.innerText`)
expect(content).toMatchInlineSnapshot('"next_streaming_data"') expect(content).toMatchInlineSnapshot('"next_streaming_data"')
}
await testStreamingResponse('/streaming')
await testStreamingResponse('/streaming-single-export')
}) })
it('should not stream to crawlers or google pagerender bot', async () => { it('should not stream to crawlers or google pagerender bot', async () => {
...@@ -84,10 +89,8 @@ export default function (context, { env, runtime }) { ...@@ -84,10 +89,8 @@ export default function (context, { env, runtime }) {
// Resolve data instead of fallback // Resolve data instead of fallback
expect(body.text()).toBe('next_streaming_data') expect(body.text()).toBe('next_streaming_data')
if (runtime === 'nodejs') {
expect(res1.headers.get('etag')).toBeDefined() expect(res1.headers.get('etag')).toBeDefined()
expect(res2.headers.get('etag')).toBeDefined() expect(res2.headers.get('etag')).toBeDefined()
}
}) })
it('should render 500 error correctly', async () => { it('should render 500 error correctly', async () => {
......
...@@ -3,10 +3,8 @@ import { join } from 'path' ...@@ -3,10 +3,8 @@ import { join } from 'path'
const fixtureDir = join(__dirname, 'fixtures') const fixtureDir = join(__dirname, 'fixtures')
function createNextConfig(runtime?: 'experimental-edge' | 'nodejs') { function createNextConfig() {
return { return {}
experimental: { runtime },
}
} }
describe('parse page static info', () => { describe('parse page static info', () => {
...@@ -60,38 +58,3 @@ describe('parse page static info', () => { ...@@ -60,38 +58,3 @@ describe('parse page static info', () => {
expect(ssg).toBe(false) expect(ssg).toBe(false)
}) })
}) })
describe('fallback to the global runtime configuration', () => {
it('should fallback when gSP is defined and exported', async () => {
const { runtime, ssr, ssg } = await getPageStaticInfo({
pageFilePath: join(fixtureDir, 'page-runtime/fallback-with-gsp.js'),
nextConfig: createNextConfig('experimental-edge'),
pageType: 'pages',
})
expect(runtime).toBe('experimental-edge')
expect(ssr).toBe(false)
expect(ssg).toBe(true)
})
it('should fallback when gSP is re-exported from other module', async () => {
const { runtime, ssr, ssg } = await getPageStaticInfo({
pageFilePath: join(fixtureDir, 'page-runtime/fallback-re-export-gsp.js'),
nextConfig: createNextConfig('experimental-edge'),
pageType: 'pages',
})
expect(runtime).toBe('experimental-edge')
expect(ssr).toBe(false)
expect(ssg).toBe(true)
})
it('should always fallback to the global runtime for app', async () => {
const { runtime, ssr, ssg } = await getPageStaticInfo({
pageFilePath: join(fixtureDir, 'page-runtime/static.js'),
nextConfig: createNextConfig('experimental-edge'),
pageType: 'app',
})
expect(runtime).toBe('experimental-edge')
expect(ssr).toBe(false)
expect(ssg).toBe(false)
})
})
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