Unverified Commit 0f867bb2 authored by Will Binns-Smith's avatar Will Binns-Smith Committed by GitHub

Turbopack: Enable server HMR by default for app pages (#91476)

This enables server HMR (formally, this is called server fast refresh)
by default for app router pages. For now, it's still disabled for routes
and middleware even with app router.

- Replaces `--experimental-server-fast-refresh` with
`--no-server-fast-refresh` to opt out
- Updates telemetry to record `feature.serverFastRefreshDisabled` when
the disable flag is passed

- [x] Verify `next dev` enables server HMR by default (Turbopack, app
dir, non-edge routes)
- [x] Verify `next dev --no-server-fast-refresh` disables it
- CI
parent b8564984
...@@ -368,7 +368,7 @@ pub struct ProjectOptions { ...@@ -368,7 +368,7 @@ pub struct ProjectOptions {
/// The version of Next.js that is running. /// The version of Next.js that is running.
pub next_version: RcStr, pub next_version: RcStr,
/// Whether server-side HMR is enabled (--experimental-server-fast-refresh). /// Whether server-side HMR is enabled (disabled with --no-server-fast-refresh).
pub server_hmr: bool, pub server_hmr: bool,
} }
...@@ -960,7 +960,7 @@ pub struct Project { ...@@ -960,7 +960,7 @@ pub struct Project {
/// Whether to enable persistent caching /// Whether to enable persistent caching
is_persistent_caching_enabled: bool, is_persistent_caching_enabled: bool,
/// Whether server-side HMR is enabled (--experimental-server-fast-refresh). /// Whether server-side HMR is enabled (disabled with --no-server-fast-refresh).
server_hmr: bool, server_hmr: bool,
} }
......
...@@ -212,7 +212,7 @@ pub struct NapiProjectOptions { ...@@ -212,7 +212,7 @@ pub struct NapiProjectOptions {
/// The version of Next.js that is running. /// The version of Next.js that is running.
pub next_version: RcStr, pub next_version: RcStr,
/// Whether server-side HMR is enabled (--experimental-server-fast-refresh). /// Whether server-side HMR is enabled (disabled with --no-server-fast-refresh).
pub server_hmr: Option<bool>, pub server_hmr: Option<bool>,
} }
......
...@@ -313,10 +313,7 @@ program ...@@ -313,10 +313,7 @@ program
'--experimental-https-ca, <path>', '--experimental-https-ca, <path>',
'Path to a HTTPS certificate authority file.' 'Path to a HTTPS certificate authority file.'
) )
.option( .option('--no-server-fast-refresh', 'Disable server-side Fast Refresh')
'--experimental-server-fast-refresh',
'Enable experimental server-side Fast Refresh.'
)
.option( .option(
'--experimental-upload-trace, <traceUrl>', '--experimental-upload-trace, <traceUrl>',
'Reports a subset of the debugging trace to a remote HTTP URL. Includes sensitive data.' 'Reports a subset of the debugging trace to a remote HTTP URL. Includes sensitive data.'
......
...@@ -256,7 +256,7 @@ export interface NapiProjectOptions { ...@@ -256,7 +256,7 @@ export interface NapiProjectOptions {
isPersistentCachingEnabled: boolean isPersistentCachingEnabled: boolean
/** The version of Next.js that is running. */ /** The version of Next.js that is running. */
nextVersion: RcStr nextVersion: RcStr
/** Whether server-side HMR is enabled (--experimental-server-fast-refresh). */ /** Whether server-side HMR is enabled (disabled with --no-server-fast-refresh). */
serverHmr?: boolean serverHmr?: boolean
} }
/** [NapiProjectOptions] with all fields optional. */ /** [NapiProjectOptions] with all fields optional. */
......
...@@ -55,7 +55,7 @@ export type NextDevOptions = { ...@@ -55,7 +55,7 @@ export type NextDevOptions = {
experimentalUploadTrace?: string experimentalUploadTrace?: string
experimentalNextConfigStripTypes?: boolean experimentalNextConfigStripTypes?: boolean
experimentalCpuProf?: boolean experimentalCpuProf?: boolean
experimentalServerFastRefresh?: boolean serverFastRefresh?: boolean
} }
type PortSource = 'cli' | 'default' | 'env' type PortSource = 'cli' | 'default' | 'env'
...@@ -249,7 +249,7 @@ const nextDev = async ( ...@@ -249,7 +249,7 @@ const nextDev = async (
const enabledFeatures = Object.fromEntries( const enabledFeatures = Object.fromEntries(
Object.entries({ Object.entries({
experimentalServerFastRefresh: options.experimentalServerFastRefresh, serverFastRefreshDisabled: options.serverFastRefresh === false,
experimentalCpuProf: options.experimentalCpuProf, experimentalCpuProf: options.experimentalCpuProf,
}).filter(([_, value]) => value) }).filter(([_, value]) => value)
) )
...@@ -269,7 +269,7 @@ const nextDev = async ( ...@@ -269,7 +269,7 @@ const nextDev = async (
allowRetry, allowRetry,
isDev: true, isDev: true,
hostname: host, hostname: host,
experimentalServerFastRefresh: options.experimentalServerFastRefresh, serverFastRefresh: options.serverFastRefresh,
} }
const startServerPath = require.resolve('../server/lib/start-server') const startServerPath = require.resolve('../server/lib/start-server')
......
...@@ -309,7 +309,7 @@ export async function createHotReloaderTurbopack( ...@@ -309,7 +309,7 @@ export async function createHotReloaderTurbopack(
distDir: string, distDir: string,
resetFetch: () => void, resetFetch: () => void,
lockfile: Lockfile | undefined, lockfile: Lockfile | undefined,
experimentalServerFastRefresh?: boolean serverFastRefresh?: boolean
): Promise<NextJsHotReloaderInterface> { ): Promise<NextJsHotReloaderInterface> {
const dev = true const dev = true
const buildId = 'development' const buildId = 'development'
...@@ -413,7 +413,7 @@ export async function createHotReloaderTurbopack( ...@@ -413,7 +413,7 @@ export async function createHotReloaderTurbopack(
opts.nextConfig opts.nextConfig
), ),
nextVersion: process.env.__NEXT_VERSION as string, nextVersion: process.env.__NEXT_VERSION as string,
serverHmr: experimentalServerFastRefresh, serverHmr: serverFastRefresh,
}, },
{ {
memoryLimit: opts.nextConfig.experimental?.turbopackMemoryLimit, memoryLimit: opts.nextConfig.experimental?.turbopackMemoryLimit,
...@@ -616,9 +616,7 @@ export async function createHotReloaderTurbopack( ...@@ -616,9 +616,7 @@ export async function createHotReloaderTurbopack(
// - Middleware // - Middleware
// - App Router route handlers (route.ts) // - App Router route handlers (route.ts)
const usesServerHmr = const usesServerHmr =
experimentalServerFastRefresh && serverFastRefresh && isAppPage && writtenEndpoint.type !== 'edge'
isAppPage &&
writtenEndpoint.type !== 'edge'
const filesToDelete: string[] = [] const filesToDelete: string[] = []
for (const file of serverPaths) { for (const file of serverPaths) {
...@@ -1840,7 +1838,7 @@ export async function createHotReloaderTurbopack( ...@@ -1840,7 +1838,7 @@ export async function createHotReloaderTurbopack(
process.exit(1) process.exit(1)
}) })
if (experimentalServerFastRefresh) { if (serverFastRefresh) {
serverHmrSubscriptions = setupServerHmr(project, { serverHmrSubscriptions = setupServerHmr(project, {
clear: async () => { clear: async () => {
// Clear Node's require cache of all Turbopack-built modules // Clear Node's require cache of all Turbopack-built modules
......
...@@ -90,7 +90,7 @@ export async function initialize(opts: { ...@@ -90,7 +90,7 @@ export async function initialize(opts: {
keepAliveTimeout?: number keepAliveTimeout?: number
customServer?: boolean customServer?: boolean
experimentalHttpsServer?: boolean experimentalHttpsServer?: boolean
experimentalServerFastRefresh?: boolean serverFastRefresh?: boolean
startServerSpan?: Span startServerSpan?: Span
quiet?: boolean quiet?: boolean
}): Promise<ServerInitResult> { }): Promise<ServerInitResult> {
...@@ -179,7 +179,7 @@ export async function initialize(opts: { ...@@ -179,7 +179,7 @@ export async function initialize(opts: {
port: opts.port, port: opts.port,
onDevServerCleanup: opts.onDevServerCleanup, onDevServerCleanup: opts.onDevServerCleanup,
resetFetch, resetFetch,
experimentalServerFastRefresh: opts.experimentalServerFastRefresh, serverFastRefresh: opts.serverFastRefresh,
}) })
) )
......
...@@ -117,7 +117,7 @@ export type SetupOpts = { ...@@ -117,7 +117,7 @@ export type SetupOpts = {
port: number port: number
onDevServerCleanup: ((listener: () => Promise<void>) => void) | undefined onDevServerCleanup: ((listener: () => Promise<void>) => void) | undefined
resetFetch: () => void resetFetch: () => void
experimentalServerFastRefresh?: boolean serverFastRefresh?: boolean
} }
export interface DevRoutesManifest { export interface DevRoutesManifest {
...@@ -241,7 +241,7 @@ async function startWatcher( ...@@ -241,7 +241,7 @@ async function startWatcher(
distDir, distDir,
resetFetch, resetFetch,
lockfile, lockfile,
opts.experimentalServerFastRefresh opts.serverFastRefresh
) )
})() })()
: await (async () => { : await (async () => {
......
...@@ -129,7 +129,7 @@ export interface StartServerOptions { ...@@ -129,7 +129,7 @@ export interface StartServerOptions {
keepAliveTimeout?: number keepAliveTimeout?: number
// this is dev-server only // this is dev-server only
selfSignedCertificate?: SelfSignedCertificate selfSignedCertificate?: SelfSignedCertificate
experimentalServerFastRefresh?: boolean serverFastRefresh?: boolean
} }
export async function getRequestHandlers({ export async function getRequestHandlers({
...@@ -142,7 +142,7 @@ export async function getRequestHandlers({ ...@@ -142,7 +142,7 @@ export async function getRequestHandlers({
minimalMode, minimalMode,
keepAliveTimeout, keepAliveTimeout,
experimentalHttpsServer, experimentalHttpsServer,
experimentalServerFastRefresh, serverFastRefresh,
quiet, quiet,
}: { }: {
dir: string dir: string
...@@ -154,7 +154,7 @@ export async function getRequestHandlers({ ...@@ -154,7 +154,7 @@ export async function getRequestHandlers({
minimalMode?: boolean minimalMode?: boolean
keepAliveTimeout?: number keepAliveTimeout?: number
experimentalHttpsServer?: boolean experimentalHttpsServer?: boolean
experimentalServerFastRefresh?: boolean serverFastRefresh?: boolean
quiet?: boolean quiet?: boolean
}): ReturnType<typeof initialize> { }): ReturnType<typeof initialize> {
return initialize({ return initialize({
...@@ -167,7 +167,7 @@ export async function getRequestHandlers({ ...@@ -167,7 +167,7 @@ export async function getRequestHandlers({
server, server,
keepAliveTimeout, keepAliveTimeout,
experimentalHttpsServer, experimentalHttpsServer,
experimentalServerFastRefresh, serverFastRefresh,
startServerSpan, startServerSpan,
quiet, quiet,
}) })
...@@ -188,7 +188,7 @@ export async function startServer( ...@@ -188,7 +188,7 @@ export async function startServer(
allowRetry, allowRetry,
keepAliveTimeout, keepAliveTimeout,
selfSignedCertificate, selfSignedCertificate,
experimentalServerFastRefresh, serverFastRefresh,
} = serverOptions } = serverOptions
let { port } = serverOptions let { port } = serverOptions
...@@ -489,7 +489,7 @@ export async function startServer( ...@@ -489,7 +489,7 @@ export async function startServer(
minimalMode, minimalMode,
keepAliveTimeout, keepAliveTimeout,
experimentalHttpsServer: !!selfSignedCertificate, experimentalHttpsServer: !!selfSignedCertificate,
experimentalServerFastRefresh, serverFastRefresh,
}) })
requestHandler = initResult.requestHandler requestHandler = initResult.requestHandler
upgradeHandler = initResult.upgradeHandler upgradeHandler = initResult.upgradeHandler
......
...@@ -8,7 +8,7 @@ import { parseTraceFile } from '../../../lib/parse-trace-file' ...@@ -8,7 +8,7 @@ import { parseTraceFile } from '../../../lib/parse-trace-file'
describe('enabled features in trace', () => { describe('enabled features in trace', () => {
const { next, isNextDev } = nextTestSetup({ const { next, isNextDev } = nextTestSetup({
files: __dirname, files: __dirname,
startArgs: ['--experimental-server-fast-refresh'], startArgs: ['--no-server-fast-refresh'],
}) })
if (!isNextDev) { if (!isNextDev) {
...@@ -37,9 +37,9 @@ describe('enabled features in trace', () => { ...@@ -37,9 +37,9 @@ describe('enabled features in trace', () => {
const startDevServerEvent = startDevServerEvents![0] const startDevServerEvent = startDevServerEvents![0]
expect(startDevServerEvent.tags).toBeDefined() expect(startDevServerEvent.tags).toBeDefined()
expect( expect(startDevServerEvent.tags!['feature.serverFastRefreshDisabled']).toBe(
startDevServerEvent.tags!['feature.experimentalServerFastRefresh'] true
).toBe(true) )
}) })
it('should denormalize inherited enabled features during upload', async () => { it('should denormalize inherited enabled features during upload', async () => {
...@@ -99,16 +99,14 @@ describe('enabled features in trace', () => { ...@@ -99,16 +99,14 @@ describe('enabled features in trace', () => {
const compilePathEvent = traces.find((e: any) => e.name === 'compile-path') const compilePathEvent = traces.find((e: any) => e.name === 'compile-path')
const renderPathEvent = traces.find((e: any) => e.name === 'render-path') const renderPathEvent = traces.find((e: any) => e.name === 'render-path')
// Both should have inherited feature.experimentalServerFastRefresh from their parent // Both should have inherited feature.serverFastRefreshDisabled from their parent
expect(compilePathEvent).toBeDefined() expect(compilePathEvent).toBeDefined()
expect(compilePathEvent.tags['feature.experimentalServerFastRefresh']).toBe( expect(compilePathEvent.tags['feature.serverFastRefreshDisabled']).toBe(
true true
) )
expect(renderPathEvent).toBeDefined() expect(renderPathEvent).toBeDefined()
expect(renderPathEvent.tags['feature.experimentalServerFastRefresh']).toBe( expect(renderPathEvent.tags['feature.serverFastRefreshDisabled']).toBe(true)
true
)
}) })
}) })
......
...@@ -5,7 +5,6 @@ import { retry } from 'next-test-utils' ...@@ -5,7 +5,6 @@ import { retry } from 'next-test-utils'
describe('server-hmr', () => { describe('server-hmr', () => {
const { next, isTurbopack, isNextDev } = nextTestSetup({ const { next, isTurbopack, isNextDev } = nextTestSetup({
files: __dirname, files: __dirname,
startArgs: ['--experimental-server-fast-refresh'],
}) })
// Server HMR is a Turbopack-only feature, only available in dev mode // Server HMR is a Turbopack-only feature, only available in dev mode
......
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