Skip to content

Turbopack: enable server HMR for app route handlers#91466

Draft
wbinnssmith wants to merge 1 commit intocanaryfrom
wbinnssmith/server-hmr-routes
Draft

Turbopack: enable server HMR for app route handlers#91466
wbinnssmith wants to merge 1 commit intocanaryfrom
wbinnssmith/server-hmr-routes

Conversation

@wbinnssmith
Copy link
Member

@wbinnssmith wbinnssmith commented Mar 16, 2026

App router handlers are already built with the Turbopack runtime, so they can use server HMR. We also already get subscription events for their chunks. However, unlike app pages which use __next_app__.require() for dynamic devModuleCache lookup, route handlers capture userland exports statically in AppRouteRouteModule at construction time. This change makes routes behave a lot like pages, dynamically loading the user's code when requests are made. This way, we can freely invalidate and reload it when changes are made without evicting the entire require cache.

Only next dev uses this lazy evaluation, as next start continues to eagerly import route handlers.

This change removes the isAppPage restriction from usesServerHmr, extending server HMR coverage to all App Router entries (pages and route handlers) built with the Node.js runtime.

For route handlers, we also clear the entry chunk from Node.js require.cache on each rebuild so the next requirePage() call re-executes the entry and obtains fresh module exports from devModuleCache (which HMR updates in-place).

Test Plan: Added an additional e2e test, with-dep

@nextjs-bot nextjs-bot added created-by: Turbopack team PRs by the Turbopack team. tests Turbopack Related to Turbopack with Next.js. type: next labels Mar 16, 2026
@nextjs-bot
Copy link
Collaborator

nextjs-bot commented Mar 16, 2026

Failing test suites

Commit: c011b8e | About building and testing Next.js

pnpm test-dev-turbo test/e2e/twoslash/index.test.ts (turbopack) (job)

  • twoslash > should annotate twoslash types default (DD)
  • twoslash > should annotate twoslash types esnext (DD)
Expand output

● twoslash › should annotate twoslash types default

SyntaxError: Unexpected end of JSON input
    at JSON.parse (<anonymous>)

  12 |     'should annotate twoslash types %s',
  13 |     async (mode) => {
> 14 |       const { code, nodes, error } = JSON.parse(await next.render(`/?${mode}`))
     |                                           ^
  15 |       expect({ code, nodes, error }).toMatchInlineSnapshot(`
  16 |      {
  17 |        "code": "type X = Promise<number>;

  at parse (e2e/twoslash/index.test.ts:14:43)

● twoslash › should annotate twoslash types esnext

SyntaxError: Unexpected end of JSON input
    at JSON.parse (<anonymous>)

  12 |     'should annotate twoslash types %s',
  13 |     async (mode) => {
> 14 |       const { code, nodes, error } = JSON.parse(await next.render(`/?${mode}`))
     |                                           ^
  15 |       expect({ code, nodes, error }).toMatchInlineSnapshot(`
  16 |      {
  17 |        "code": "type X = Promise<number>;

  at parse (e2e/twoslash/index.test.ts:14:43)

pnpm test-start-turbo test/e2e/app-dir/app-client-cache/client-cache.parallel-routes.test.ts (turbopack) (job)

  • app dir client cache with parallel routes > prefetch={true} > should re-use the cache for the full page, only for 5 mins (DD)
Expand output

● app dir client cache with parallel routes › prefetch={true} › should re-use the cache for the full page, only for 5 mins

thrown: "Exceeded timeout of 60000 ms for a test.
Add a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout."

  50 |       }
  51 |
> 52 |       const result = Reflect.apply(target, thisArg, args)
     |                              ^
  53 |       return typeof result === 'function' ? wrapJestTestFn(result) : result
  54 |     },
  55 |     get(target, prop, receiver) {

  at Object.apply (lib/e2e-utils/index.ts:52:30)
  at it (e2e/app-dir/app-client-cache/client-cache.parallel-routes.test.ts:56:5)
  at describe (e2e/app-dir/app-client-cache/client-cache.parallel-routes.test.ts:30:3)
  at Object.describe (e2e/app-dir/app-client-cache/client-cache.parallel-routes.test.ts:7:1)

@codspeed-hq
Copy link

codspeed-hq bot commented Mar 16, 2026

Merging this PR will not alter performance

✅ 17 untouched benchmarks
⏩ 3 skipped benchmarks1


Comparing wbinnssmith/server-hmr-routes (c011b8e) with canary (a27a11d)

Open in CodSpeed

Footnotes

  1. 3 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@wbinnssmith wbinnssmith force-pushed the wbinnssmith/server-hmr-routes branch from aeb6fd2 to abbe1d9 Compare March 16, 2026 20:55
@nextjs-bot
Copy link
Collaborator

nextjs-bot commented Mar 16, 2026

Stats from current PR

🔴 1 regression

Metric Canary PR Change Trend
node_modules Size 483 MB 483 MB 🔴 +61.2 kB (+0%) ▁████
📊 All Metrics
📖 Metrics Glossary

Dev Server Metrics:

  • Listen = TCP port starts accepting connections
  • First Request = HTTP server returns successful response
  • Cold = Fresh build (no cache)
  • Warm = With cached build artifacts

Build Metrics:

  • Fresh = Clean build (no .next directory)
  • Cached = With existing .next directory

Change Thresholds:

  • Time: Changes < 50ms AND < 10%, OR < 2% are insignificant
  • Size: Changes < 1KB AND < 1% are insignificant
  • All other changes are flagged to catch regressions
📦 Dev Server (Webpack) (Legacy)

📦 Dev Server (Webpack)

Metric Canary PR Change Trend
Cold (Listen) 456ms 456ms ▁▁▃▁▃
Cold (Ready in log) 436ms 434ms ▂▂▆▂▃
Cold (First Request) 1.941s 1.921s ▁▁▆▁▃
Warm (Listen) 456ms 455ms ▁▁▃▁▃
Warm (Ready in log) 435ms 435ms ▂▂▅▂▄
Warm (First Request) 1.965s 1.942s ▁▁▅▂▄
📦 Production Builds (Webpack) (Legacy)

📦 Production Builds (Webpack)

Metric Canary PR Change Trend
Fresh Build 14.237s 14.227s ▁▁▅▁▄
Cached Build 14.313s 14.346s ▁▁▅▁▃
node_modules Size 483 MB 483 MB 🔴 +61.2 kB (+0%) ▁████
📦 Bundle Sizes

Bundle Sizes

📦 Webpack

Client

Main Bundles
Canary PR Change
5528-HASH.js gzip 5.54 kB N/A -
6280-HASH.js gzip 60.3 kB N/A -
6335.HASH.js gzip 169 B N/A -
912-HASH.js gzip 4.59 kB N/A -
e8aec2e4-HASH.js gzip 62.7 kB N/A -
framework-HASH.js gzip 59.7 kB 59.7 kB
main-app-HASH.js gzip 253 B 253 B
main-HASH.js gzip 39.2 kB 39.2 kB
webpack-HASH.js gzip 1.68 kB 1.68 kB
262-HASH.js gzip N/A 4.59 kB -
2889.HASH.js gzip N/A 169 B -
5602-HASH.js gzip N/A 5.55 kB -
6948ada0-HASH.js gzip N/A 62.7 kB -
9544-HASH.js gzip N/A 60.9 kB -
Total 234 kB 235 kB ⚠️ +656 B
Polyfills
Canary PR Change
polyfills-HASH.js gzip 39.4 kB 39.4 kB
Total 39.4 kB 39.4 kB
Pages
Canary PR Change
_app-HASH.js gzip 194 B 194 B
_error-HASH.js gzip 183 B 180 B 🟢 3 B (-2%)
css-HASH.js gzip 331 B 330 B
dynamic-HASH.js gzip 1.81 kB 1.81 kB
edge-ssr-HASH.js gzip 256 B 256 B
head-HASH.js gzip 351 B 352 B
hooks-HASH.js gzip 384 B 383 B
image-HASH.js gzip 580 B 581 B
index-HASH.js gzip 260 B 260 B
link-HASH.js gzip 2.51 kB 2.51 kB
routerDirect..HASH.js gzip 320 B 319 B
script-HASH.js gzip 386 B 386 B
withRouter-HASH.js gzip 315 B 315 B
1afbb74e6ecf..834.css gzip 106 B 106 B
Total 7.98 kB 7.98 kB ✅ -1 B

Server

Edge SSR
Canary PR Change
edge-ssr.js gzip 125 kB 125 kB
page.js gzip 269 kB 268 kB
Total 393 kB 393 kB ✅ -355 B
Middleware
Canary PR Change
middleware-b..fest.js gzip 617 B 614 B
middleware-r..fest.js gzip 156 B 155 B
middleware.js gzip 44 kB 43.8 kB
edge-runtime..pack.js gzip 842 B 842 B
Total 45.6 kB 45.4 kB ✅ -206 B
Build Details
Build Manifests
Canary PR Change
_buildManifest.js gzip 715 B 718 B
Total 715 B 718 B ⚠️ +3 B
Build Cache
Canary PR Change
0.pack gzip 4.26 MB 4.25 MB 🟢 7.86 kB (0%)
index.pack gzip 111 kB 110 kB
index.pack.old gzip 110 kB 110 kB
Total 4.48 MB 4.47 MB ✅ -8.2 kB

🔄 Shared (bundler-independent)

Runtimes
Canary PR Change
app-page-exp...dev.js gzip 333 kB 333 kB
app-page-exp..prod.js gzip 181 kB 181 kB
app-page-tur...dev.js gzip 332 kB 332 kB
app-page-tur..prod.js gzip 181 kB 181 kB
app-page-tur...dev.js gzip 329 kB 329 kB
app-page-tur..prod.js gzip 179 kB 179 kB
app-page.run...dev.js gzip 329 kB 329 kB
app-page.run..prod.js gzip 179 kB 179 kB
app-route-ex...dev.js gzip 76 kB 76.1 kB
app-route-ex..prod.js gzip 51.7 kB 51.8 kB
app-route-tu...dev.js gzip 76 kB 76.1 kB
app-route-tu..prod.js gzip 51.7 kB 51.8 kB
app-route-tu...dev.js gzip 75.6 kB 75.7 kB
app-route-tu..prod.js gzip 51.5 kB 51.6 kB
app-route.ru...dev.js gzip 75.6 kB 75.7 kB
app-route.ru..prod.js gzip 51.5 kB 51.6 kB
dist_client_...dev.js gzip 324 B 324 B
dist_client_...dev.js gzip 326 B 326 B
dist_client_...dev.js gzip 318 B 318 B
dist_client_...dev.js gzip 317 B 317 B
pages-api-tu...dev.js gzip 43.3 kB 43.3 kB
pages-api-tu..prod.js gzip 33 kB 33 kB
pages-api.ru...dev.js gzip 43.3 kB 43.3 kB
pages-api.ru..prod.js gzip 33 kB 33 kB
pages-turbo....dev.js gzip 52.7 kB 52.7 kB
pages-turbo...prod.js gzip 38.6 kB 38.6 kB
pages.runtim...dev.js gzip 52.7 kB 52.7 kB
pages.runtim..prod.js gzip 38.6 kB 38.6 kB
server.runti..prod.js gzip 62.4 kB 62.4 kB
Total 2.95 MB 2.95 MB ⚠️ +716 B
📝 Changed Files (8 files)

Files with changes:

  • app-route-ex..ntime.dev.js
  • app-route-ex..time.prod.js
  • app-route-tu..ntime.dev.js
  • app-route-tu..time.prod.js
  • app-route-tu..ntime.dev.js
  • app-route-tu..time.prod.js
  • app-route.runtime.dev.js
  • app-route.ru..time.prod.js
View diffs
app-route-ex..ntime.dev.js

Diff too large to display

app-route-ex..time.prod.js

Diff too large to display

app-route-tu..ntime.dev.js

Diff too large to display

app-route-tu..time.prod.js

Diff too large to display

app-route-tu..ntime.dev.js

Diff too large to display

app-route-tu..time.prod.js

Diff too large to display

app-route.runtime.dev.js

Diff too large to display

app-route.ru..time.prod.js

Diff too large to display

📎 Tarball URL
https://vercel-packages.vercel.app/next/commits/c011b8e810cb22b90f87dfbc18d3a90362a22cf5/next

@wbinnssmith wbinnssmith force-pushed the wbinnssmith/server-hmr-routes branch 3 times, most recently from 78ba0d7 to 74c72dc Compare March 17, 2026 02:50
App router handlers are already built with the Turbopack runtime, so they can use server HMR. We also already get subscription events for their chunks. However, unlike app pages which use `__next_app__.require()` for dynamic devModuleCache lookup, route handlers capture userland exports statically in AppRouteRouteModule at construction time. This change makes routes behave a lot like pages, dynamically loading the user's code when requests are made. This way, we can freely invalidate and reload it when changes are made without evicting the entire require cache.

This change removes the `isAppPage` restriction from `usesServerHmr`, extending server HMR coverage to all App Router entries (pages and route handlers) built with the Node.js runtime.

For route handlers, we also clear the entry chunk from Node.js `require.cache` on each rebuild so the next `requirePage()` call re-executes the entry and obtains fresh module exports from `devModuleCache` (which HMR updates in-place).

Test Plan: Added an additional e2e test, `with-dep`
@wbinnssmith wbinnssmith force-pushed the wbinnssmith/server-hmr-routes branch from 74c72dc to c011b8e Compare March 17, 2026 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

created-by: Turbopack team PRs by the Turbopack team. tests Turbopack Related to Turbopack with Next.js. type: next

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants