Unverified Commit 2ab39ec1 authored by Tim Neutkens's avatar Tim Neutkens Committed by GitHub

Implement hot reloader interface for Turbopack (#54632)

Implements the `NextJsHotReloaderInterface` type for the Turbopack
implementation. This removes the Proxy that had an `any` type and did
not have all methods implemented.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->
parent 41368670
...@@ -6,7 +6,7 @@ import type getBaseWebpackConfig from '../../build/webpack-config' ...@@ -6,7 +6,7 @@ import type getBaseWebpackConfig from '../../build/webpack-config'
import type { RouteMatch } from '../future/route-matches/route-match' import type { RouteMatch } from '../future/route-matches/route-match'
export interface NextJsHotReloaderInterface { export interface NextJsHotReloaderInterface {
activeConfigs?: Array<Awaited<ReturnType<typeof getBaseWebpackConfig>>> activeWebpackConfigs?: Array<Awaited<ReturnType<typeof getBaseWebpackConfig>>>
serverStats: webpack.Stats | null serverStats: webpack.Stats | null
edgeServerStats: webpack.Stats | null edgeServerStats: webpack.Stats | null
run( run(
......
...@@ -211,7 +211,7 @@ export default class HotReloader implements NextJsHotReloaderInterface { ...@@ -211,7 +211,7 @@ export default class HotReloader implements NextJsHotReloaderInterface {
public serverStats: webpack.Stats | null public serverStats: webpack.Stats | null
public edgeServerStats: webpack.Stats | null public edgeServerStats: webpack.Stats | null
public multiCompiler?: webpack.MultiCompiler public multiCompiler?: webpack.MultiCompiler
public activeConfigs?: Array< public activeWebpackConfigs?: Array<
UnwrapPromise<ReturnType<typeof getBaseWebpackConfig>> UnwrapPromise<ReturnType<typeof getBaseWebpackConfig>>
> >
...@@ -721,9 +721,9 @@ export default class HotReloader implements NextJsHotReloaderInterface { ...@@ -721,9 +721,9 @@ export default class HotReloader implements NextJsHotReloaderInterface {
// Files outside of the distDir can be "type": "module" // Files outside of the distDir can be "type": "module"
await fs.writeFile(distPackageJsonPath, '{"type": "commonjs"}') await fs.writeFile(distPackageJsonPath, '{"type": "commonjs"}')
this.activeConfigs = await this.getWebpackConfig(startSpan) this.activeWebpackConfigs = await this.getWebpackConfig(startSpan)
for (const config of this.activeConfigs) { for (const config of this.activeWebpackConfigs) {
const defaultEntry = config.entry const defaultEntry = config.entry
config.entry = async (...args) => { config.entry = async (...args) => {
const outputPath = this.multiCompiler?.outputPath || '' const outputPath = this.multiCompiler?.outputPath || ''
...@@ -995,10 +995,10 @@ export default class HotReloader implements NextJsHotReloaderInterface { ...@@ -995,10 +995,10 @@ export default class HotReloader implements NextJsHotReloaderInterface {
// Enable building of client compilation before server compilation in development // Enable building of client compilation before server compilation in development
// @ts-ignore webpack 5 // @ts-ignore webpack 5
this.activeConfigs.parallelism = 1 this.activeWebpackConfigs.parallelism = 1
this.multiCompiler = webpack( this.multiCompiler = webpack(
this.activeConfigs this.activeWebpackConfigs
) as unknown as webpack.MultiCompiler ) as unknown as webpack.MultiCompiler
// Copy over the filesystem so that it is shared between all compilers. // Copy over the filesystem so that it is shared between all compilers.
...@@ -1359,7 +1359,7 @@ export default class HotReloader implements NextJsHotReloaderInterface { ...@@ -1359,7 +1359,7 @@ export default class HotReloader implements NextJsHotReloaderInterface {
this.watcher = await new Promise((resolve) => { this.watcher = await new Promise((resolve) => {
const watcher = this.multiCompiler?.watch( const watcher = this.multiCompiler?.watch(
// @ts-ignore webpack supports an array of watchOptions when using a multiCompiler // @ts-ignore webpack supports an array of watchOptions when using a multiCompiler
this.activeConfigs.map((config) => config.watchOptions!), this.activeWebpackConfigs.map((config) => config.watchOptions!),
// Errors are handled separately // Errors are handled separately
(_err: any) => { (_err: any) => {
if (!booted) { if (!booted) {
......
...@@ -609,19 +609,71 @@ async function startWatcher(opts: SetupOpts) { ...@@ -609,19 +609,71 @@ async function startWatcher(opts: SetupOpts) {
await writeMiddlewareManifest() await writeMiddlewareManifest()
await writeOtherManifests() await writeOtherManifests()
hotReloader = new Proxy({} as any, { const turbopackHotReloader: NextJsHotReloaderInterface = {
get(_target, prop, _receiver) { activeWebpackConfigs: undefined,
if (prop === 'ensurePage') { serverStats: null,
return async ( edgeServerStats: null,
ensureOpts: Parameters<(typeof hotReloader)['ensurePage']>[0] async run(req, _res, _parsedUrl) {
) => { // intercept page chunks request and ensure them with turbopack
let page = ensureOpts.match?.definition?.pathname ?? ensureOpts.page if (req.url?.startsWith('/_next/static/chunks/pages/')) {
const params = matchNextPageBundleRequest(req.url)
if (params) {
const decodedPagePath = `/${params.path
.map((param: string) => decodeURIComponent(param))
.join('/')}`
await hotReloader
.ensurePage({
page: decodedPagePath,
clientOnly: false,
})
.catch(console.error)
}
}
// Request was not finished.
return { finished: undefined }
},
setHmrServerError(_error) {
// Not implemented yet.
},
clearHmrServerError() {
// Not implemented yet.
},
async start() {
// Not implemented yet.
},
async stop() {
// Not implemented yet.
},
send(_action, ..._args) {
// Not implemented yet.
},
async getCompilationErrors(_page) {
return []
},
onHMR(_req, _socket, _head) {
// Not implemented yet.
},
invalidate(/* Unused parameter: { reloadAfterInvalidation } */) {
// Not implemented yet.
},
async buildFallbackError() {
// Not implemented yet.
},
async ensurePage({
page: inputPage,
// Unused parameters
// clientOnly,
// appPaths,
match,
isApp,
}) {
let page = match?.definition?.pathname ?? inputPage
if (page === '/_error') { if (page === '/_error') {
await processResult( await processResult('_app', await globalEntries.app?.writeToDisk())
'_app',
await globalEntries.app?.writeToDisk()
)
await loadBuildManifest('_app') await loadBuildManifest('_app')
await loadPagesManifest('_app') await loadPagesManifest('_app')
...@@ -631,10 +683,7 @@ async function startWatcher(opts: SetupOpts) { ...@@ -631,10 +683,7 @@ async function startWatcher(opts: SetupOpts) {
) )
await loadPagesManifest('_document') await loadPagesManifest('_document')
await processResult( await processResult(page, await globalEntries.error?.writeToDisk())
page,
await globalEntries.error?.writeToDisk()
)
await loadBuildManifest('_error') await loadBuildManifest('_error')
await loadPagesManifest('_error') await loadPagesManifest('_error')
...@@ -660,16 +709,13 @@ async function startWatcher(opts: SetupOpts) { ...@@ -660,16 +709,13 @@ async function startWatcher(opts: SetupOpts) {
switch (route.type) { switch (route.type) {
case 'page': { case 'page': {
if (ensureOpts.isApp) { if (isApp) {
throw new Error( throw new Error(
`mis-matched route type: isApp && page for ${page}` `mis-matched route type: isApp && page for ${page}`
) )
} }
await processResult( await processResult('_app', await globalEntries.app?.writeToDisk())
'_app',
await globalEntries.app?.writeToDisk()
)
await loadBuildManifest('_app') await loadBuildManifest('_app')
await loadPagesManifest('_app') await loadPagesManifest('_app')
...@@ -702,7 +748,7 @@ async function startWatcher(opts: SetupOpts) { ...@@ -702,7 +748,7 @@ async function startWatcher(opts: SetupOpts) {
break break
} }
case 'page-api': { case 'page-api': {
if (ensureOpts.isApp) { if (isApp) {
throw new Error( throw new Error(
`mis-matched route type: isApp && page for ${page}` `mis-matched route type: isApp && page for ${page}`
) )
...@@ -729,10 +775,7 @@ async function startWatcher(opts: SetupOpts) { ...@@ -729,10 +775,7 @@ async function startWatcher(opts: SetupOpts) {
break break
} }
case 'app-page': { case 'app-page': {
await processResult( await processResult(page, await route.htmlEndpoint.writeToDisk())
page,
await route.htmlEndpoint.writeToDisk()
)
await loadAppBuildManifest(page) await loadAppBuildManifest(page)
await loadBuildManifest(page, 'app') await loadBuildManifest(page, 'app')
...@@ -770,41 +813,10 @@ async function startWatcher(opts: SetupOpts) { ...@@ -770,41 +813,10 @@ async function startWatcher(opts: SetupOpts) {
throw new Error(`unknown route type ${route.type} for ${page}`) throw new Error(`unknown route type ${route.type} for ${page}`)
} }
} }
} },
}
if (prop === 'run') {
return async (req: IncomingMessage, _res: ServerResponse) => {
// intercept page chunks request and ensure them with turbopack
if (req.url?.startsWith('/_next/static/chunks/pages/')) {
const params = matchNextPageBundleRequest(req.url)
if (params) {
const decodedPagePath = `/${params.path
.map((param: string) => decodeURIComponent(param))
.join('/')}`
await hotReloader
.ensurePage({
page: decodedPagePath,
clientOnly: false,
})
.catch(console.error)
}
}
return { finished: false }
}
} }
if (prop === 'activeConfigs') { hotReloader = turbopackHotReloader
return []
}
return () => {}
},
set() {
return true
},
})
} else { } else {
hotReloader = new HotReloader(opts.dir, { hotReloader = new HotReloader(opts.dir, {
appDir, appDir,
...@@ -1187,7 +1199,7 @@ async function startWatcher(opts: SetupOpts) { ...@@ -1187,7 +1199,7 @@ async function startWatcher(opts: SetupOpts) {
} }
} }
hotReloader.activeConfigs?.forEach((config, idx) => { hotReloader.activeWebpackConfigs?.forEach((config, idx) => {
const isClient = idx === 0 const isClient = idx === 0
const isNodeServer = idx === 1 const isNodeServer = idx === 1
const isEdgeServer = idx === 2 const isEdgeServer = idx === 2
......
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