Unverified Commit 23353771 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Fix next-server trace including dev server dependencies (#45359)

This ensures we aren't including the `dev-server` dependencies in the
`next-server` tracing.

x-ref:
https://dev.azure.com/nextjs/next.js/_build/results?buildId=46884&view=logs&jobId=14d0eb3f-bc66-5450-3353-28256327ad6c
x-ref:
https://dev.azure.com/nextjs/next.js/_build/results?buildId=46889&view=logs&jobId=14d0eb3f-bc66-5450-3353-28256327ad6c
parent 1404eedf
......@@ -1950,6 +1950,7 @@ export default async function build(
'**/next/dist/compiled/webpack/(bundle4|bundle5).js',
'**/node_modules/webpack5/**/*',
'**/next/dist/server/lib/squoosh/**/*.wasm',
'**/next/dist/server/lib/route-resolver*',
...(ciEnvironment.hasNextSupport
? [
// only ignore image-optimizer code when
......
import type { IncomingMessage, ServerResponse } from 'http'
import type { UnwrapPromise } from '../../lib/coalesced-function'
import type { NextConfig } from '../config'
import type { Route } from '../router'
export async function makeResolver(dir: string, nextConfig: NextConfig) {
const url = require('url') as typeof import('url')
const { default: Router } = require('../router') as typeof import('../router')
const { getPathMatch } =
require('../../shared/lib/router/utils/path-match') as typeof import('../../shared/lib/router/utils/path-match')
const { default: DevServer } =
require('../dev/next-dev-server') as typeof import('../dev/next-dev-server')
const { NodeNextRequest, NodeNextResponse } =
require('../base-http/node') as typeof import('../base-http/node')
const { default: loadCustomRoutes } =
require('../../lib/load-custom-routes') as typeof import('../../lib/load-custom-routes')
const devServer = new DevServer({
dir,
conf: nextConfig,
}) as any as {
customRoutes: UnwrapPromise<ReturnType<typeof loadCustomRoutes>>
router: InstanceType<typeof Router>
generateRoutes: any
}
devServer.customRoutes = await loadCustomRoutes(nextConfig)
const routes = devServer.generateRoutes.bind(devServer)()
devServer.router = new Router(routes)
const routeResults = new Map<string, string>()
// @ts-expect-error internal field
devServer.router.catchAllRoute = {
match: getPathMatch('/:path*'),
name: 'catchall route',
fn: async (req, _res, _params, parsedUrl) => {
// clean up internal query values
for (const key of Object.keys(parsedUrl.query || {})) {
if (key.startsWith('_next')) {
delete parsedUrl.query[key]
}
}
routeResults.set(
(req as any)._initUrl,
url.format({
pathname: parsedUrl.pathname,
query: parsedUrl.query,
hash: parsedUrl.hash,
})
)
return { finished: true }
},
} as Route
// @ts-expect-error internal field
devServer.router.compiledRoutes = devServer.router.compiledRoutes.filter(
(route: Route) => {
return (
route.type === 'rewrite' ||
route.type === 'redirect' ||
route.type === 'header' ||
route.name === 'catchall route' ||
route.name?.includes('check')
)
}
)
return async function resolveRoute(
_req: IncomingMessage,
_res: ServerResponse
) {
const req = new NodeNextRequest(_req)
const res = new NodeNextResponse(_res)
;(req as any)._initUrl = req.url
await devServer.router.execute.bind(devServer.router)(
req,
res,
url.parse(req.url!, true)
)
if (!res.originalResponse.headersSent) {
res.setHeader('x-nextjs-route-result', '1')
const resolvedUrl = routeResults.get((req as any)._initUrl) || req.url!
const routeResult: {
url: string
statusCode: number
headers: Record<string, undefined | number | string | string[]>
isRedirect?: boolean
} = {
url: resolvedUrl,
statusCode: 200,
headers: {},
}
res.body(JSON.stringify(routeResult)).send()
}
}
}
......@@ -21,8 +21,6 @@ import { removePathPrefix } from '../shared/lib/router/utils/remove-path-prefix'
import { getRequestMeta } from './request-meta'
import { formatNextPathnameInfo } from '../shared/lib/router/utils/format-next-pathname-info'
import { getNextPathnameInfo } from '../shared/lib/router/utils/get-next-pathname-info'
import type { IncomingMessage, ServerResponse } from 'http'
import type { UnwrapPromise } from '../lib/coalesced-function'
type RouteResult = {
finished: boolean
......@@ -506,105 +504,13 @@ export default class Router {
let _makeResolver: any = () => {}
if (process.env.NEXT_RUNTIME !== 'edge') {
_makeResolver = async function makeResolver(
dir: string,
nextConfig: NextConfig
) {
// TODO: why are there double defaults here?
const { default: DevServer } =
require('./dev/next-dev-server.js') as typeof import('./dev/next-dev-server')
const { default: loadCustomRoutes } =
require('../lib/load-custom-routes') as typeof import('../lib/load-custom-routes')
const { NodeNextRequest, NodeNextResponse } =
require('./base-http/node') as typeof import('./base-http/node')
const url = require('url') as typeof import('url')
const devServer = new DevServer({
dir,
conf: nextConfig,
}) as any as {
customRoutes: UnwrapPromise<ReturnType<typeof loadCustomRoutes>>
router: Router
generateRoutes: any
}
devServer.customRoutes = await loadCustomRoutes(nextConfig)
const routes = devServer.generateRoutes.bind(devServer)()
devServer.router = new Router(routes)
const routeResults = new Map<string, string>()
// @ts-expect-error internal field
devServer.router.catchAllRoute = {
match: getPathMatch('/:path*'),
name: 'catchall route',
fn: async (req, _res, _params, parsedUrl) => {
// clean up internal query values
for (const key of Object.keys(parsedUrl.query || {})) {
if (key.startsWith('_next')) {
delete parsedUrl.query[key]
}
}
routeResults.set(
(req as any)._initUrl,
url.format({
pathname: parsedUrl.pathname,
query: parsedUrl.query,
hash: parsedUrl.hash,
})
)
return { finished: true }
},
} as Route
// @ts-expect-error internal field
devServer.router.compiledRoutes = devServer.router.compiledRoutes.filter(
(route) => {
return (
route.type === 'rewrite' ||
route.type === 'redirect' ||
route.type === 'header' ||
route.name === 'catchall route' ||
route.name?.includes('check')
)
}
)
return async function resolveRoute(
_req: IncomingMessage,
_res: ServerResponse
) {
const req = new NodeNextRequest(_req)
const res = new NodeNextResponse(_res)
;(req as any)._initUrl = req.url
await devServer.router.execute.bind(devServer.router)(
req,
res,
url.parse(req.url!, true)
)
if (!res.originalResponse.headersSent) {
res.setHeader('x-nextjs-route-result', '1')
const resolvedUrl = routeResults.get((req as any)._initUrl) || req.url!
const routeResult: {
url: string
statusCode: number
headers: Record<string, undefined | number | string | string[]>
isRedirect?: boolean
} = {
url: resolvedUrl,
statusCode: 200,
headers: {},
}
res.body(JSON.stringify(routeResult)).send()
}
}
}
if (
// ensure this isn't bundled for edge runtime
process.env.NEXT_RUNTIME !== 'edge' &&
// only load if we are inside of the turbopack handler
process.argv.some((arg) => arg.endsWith('router.js'))
) {
_makeResolver = require('./lib/route-resolver').makeResolver
}
export const makeResolver = _makeResolver
......@@ -100,7 +100,7 @@ export async function ncc_next_server(task, opts) {
externals: {
...externals,
'/(.*)next-dev-server(.*)/': '$1next-dev-server$1',
'/(.*)route-resolver/': '$1route-resolver',
sharp: 'sharp',
react: 'react',
......
......@@ -2404,37 +2404,6 @@ describe('Custom routes', () => {
runTests(true)
})
describe('dev mode turbo', () => {
let nextConfigContent
beforeAll(async () => {
// ensure cache with rewrites disabled doesn't persist
// after enabling rewrites
await fs.remove(join(appDir, '.next'))
nextConfigContent = await fs.readFile(nextConfigPath, 'utf8')
await fs.writeFile(
nextConfigPath,
nextConfigContent.replace('// no-rewrites comment', 'return []')
)
const tempPort = await findPort()
const tempApp = await launchApp(appDir, tempPort, { turbo: true })
await renderViaHTTP(tempPort, '/')
await killApp(tempApp)
await fs.writeFile(nextConfigPath, nextConfigContent)
appPort = await findPort()
app = await launchApp(appDir, appPort)
buildId = 'development'
})
afterAll(async () => {
await fs.writeFile(nextConfigPath, nextConfigContent)
await killApp(app)
})
runTests(true)
})
describe('no-op rewrite', () => {
beforeAll(async () => {
appPort = await findPort()
......
......@@ -163,6 +163,11 @@ describe('Production Usage', () => {
file.includes('next/dist/server/send-payload/index.js')
)
).toBe(true)
expect(
serverTrace.files.some((file) =>
file.includes('next/dist/server/lib/route-resolver.js')
)
).toBe(false)
const repoRoot = join(__dirname, '../../../../')
expect(
serverTrace.files.some((file) => {
......
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