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

rsc: skip next builtin module when apply loaders (#36202)

x-ref: https://github.com/vercel/server-components-notes-demo/pull/17

Previously in #35975 we ignore handling node_modules as a workaround for 3rd party packages, but for next buildin components we should still handle them for processing client components
parent e80c48e0
...@@ -1211,9 +1211,6 @@ export default async function getBaseWebpackConfig( ...@@ -1211,9 +1211,6 @@ export default async function getBaseWebpackConfig(
...rscCodeCondition, ...rscCodeCondition,
use: { use: {
loader: 'next-flight-server-loader', loader: 'next-flight-server-loader',
options: {
extensions: rawPageExtensions,
},
}, },
}, },
] ]
...@@ -1225,7 +1222,6 @@ export default async function getBaseWebpackConfig( ...@@ -1225,7 +1222,6 @@ export default async function getBaseWebpackConfig(
loader: 'next-flight-server-loader', loader: 'next-flight-server-loader',
options: { options: {
client: 1, client: 1,
extensions: rawPageExtensions,
}, },
}, },
}, },
......
...@@ -5,9 +5,13 @@ import { ...@@ -5,9 +5,13 @@ import {
buildExports, buildExports,
createClientComponentFilter, createClientComponentFilter,
createServerComponentFilter, createServerComponentFilter,
isNextBuiltinClientComponent,
} from './utils' } from './utils'
function createFlightServerRequest(request: string, options: object) { function createFlightServerRequest(
request: string,
options?: { client: 1 | undefined }
) {
return `next-flight-server-loader?${JSON.stringify(options)}!${request}` return `next-flight-server-loader?${JSON.stringify(options)}!${request}`
} }
...@@ -18,7 +22,6 @@ function hasFlightLoader(request: string, type: 'client' | 'server') { ...@@ -18,7 +22,6 @@ function hasFlightLoader(request: string, type: 'client' | 'server') {
async function parseModuleInfo({ async function parseModuleInfo({
resourcePath, resourcePath,
source, source,
extensions,
isClientCompilation, isClientCompilation,
isServerComponent, isServerComponent,
isClientComponent, isClientComponent,
...@@ -27,7 +30,6 @@ async function parseModuleInfo({ ...@@ -27,7 +30,6 @@ async function parseModuleInfo({
resourcePath: string resourcePath: string
source: string source: string
isClientCompilation: boolean isClientCompilation: boolean
extensions: string[]
isServerComponent: (name: string) => boolean isServerComponent: (name: string) => boolean
isClientComponent: (name: string) => boolean isClientComponent: (name: string) => boolean
resolver: (req: string) => Promise<string> resolver: (req: string) => Promise<string>
...@@ -57,7 +59,10 @@ async function parseModuleInfo({ ...@@ -57,7 +59,10 @@ async function parseModuleInfo({
const isBuiltinModule_ = builtinModules.includes(path) const isBuiltinModule_ = builtinModules.includes(path)
const resolvedPath = isBuiltinModule_ ? path : await resolver(path) const resolvedPath = isBuiltinModule_ ? path : await resolver(path)
const isNodeModuleImport_ = resolvedPath.includes('/node_modules/') const isNodeModuleImport_ =
/[\\/]node_modules[\\/]/.test(resolvedPath) &&
// exclude next built-in modules
!isNextBuiltinClientComponent(resolvedPath)
return [isBuiltinModule_, isNodeModuleImport_] as const return [isBuiltinModule_, isNodeModuleImport_] as const
} }
...@@ -71,12 +76,7 @@ async function parseModuleInfo({ ...@@ -71,12 +76,7 @@ async function parseModuleInfo({
imports.push(path) imports.push(path)
} else { } else {
// Shared component. // Shared component.
imports.push( imports.push(createFlightServerRequest(path, { client: 1 }))
createFlightServerRequest(path, {
extensions,
client: 1,
})
)
} }
} }
...@@ -119,7 +119,7 @@ async function parseModuleInfo({ ...@@ -119,7 +119,7 @@ async function parseModuleInfo({
const serverImportSource = const serverImportSource =
isReactImports || isBuiltinModule isReactImports || isBuiltinModule
? importSource ? importSource
: createFlightServerRequest(importSource, { extensions }) : createFlightServerRequest(importSource)
transformedSource += importDeclarations transformedSource += importDeclarations
transformedSource += JSON.stringify(serverImportSource) transformedSource += JSON.stringify(serverImportSource)
...@@ -191,7 +191,7 @@ export default async function transformSource( ...@@ -191,7 +191,7 @@ export default async function transformSource(
this: any, this: any,
source: string source: string
): Promise<string> { ): Promise<string> {
const { client: isClientCompilation, extensions } = this.getOptions() const { client: isClientCompilation } = this.getOptions()
const { resourcePath, resolve: resolveFn, context } = this const { resourcePath, resolve: resolveFn, context } = this
const resolver = (req: string): Promise<string> => { const resolver = (req: string): Promise<string> => {
...@@ -207,8 +207,8 @@ export default async function transformSource( ...@@ -207,8 +207,8 @@ export default async function transformSource(
throw new Error('Expected source to have been transformed to a string.') throw new Error('Expected source to have been transformed to a string.')
} }
const isServerComponent = createServerComponentFilter(extensions) const isServerComponent = createServerComponentFilter()
const isClientComponent = createClientComponentFilter(extensions) const isClientComponent = createClientComponentFilter()
const hasAppliedFlightServerLoader = this.loaders.some((loader: any) => { const hasAppliedFlightServerLoader = this.loaders.some((loader: any) => {
return hasFlightLoader(loader.path, 'server') return hasFlightLoader(loader.path, 'server')
}) })
...@@ -231,7 +231,6 @@ export default async function transformSource( ...@@ -231,7 +231,6 @@ export default async function transformSource(
} = await parseModuleInfo({ } = await parseModuleInfo({
resourcePath, resourcePath,
source, source,
extensions,
isClientCompilation, isClientCompilation,
isServerComponent, isServerComponent,
isClientComponent, isClientComponent,
......
const defaultJsFileExtensions = ['js', 'mjs', 'jsx', 'ts', 'tsx', 'json'] export const defaultJsFileExtensions = ['js', 'mjs', 'jsx', 'ts', 'tsx']
const imageExtensions = ['jpg', 'jpeg', 'png', 'webp', 'avif'] const imageExtensions = ['jpg', 'jpeg', 'png', 'webp', 'avif']
const nextClientComponents = ['link', 'image', 'head', 'script'] const nextClientComponents = ['link', 'image', 'head', 'script']
...@@ -24,16 +24,14 @@ export function buildExports(moduleExports: any, isESM: boolean) { ...@@ -24,16 +24,14 @@ export function buildExports(moduleExports: any, isESM: boolean) {
return ret return ret
} }
export const createClientComponentFilter = ( export const createClientComponentFilter = () => {
extensions: string[] = defaultJsFileExtensions
) => {
// Special cases for Next.js APIs that are considered as client components: // Special cases for Next.js APIs that are considered as client components:
// - .client.[ext] // - .client.[ext]
// - next built-in client components // - next built-in client components
// - .[imageExt] // - .[imageExt]
const regex = new RegExp( const regex = new RegExp(
'(' + '(' +
`\\.client(\\.(${extensions.join('|')}))?|` + `\\.client(\\.(${defaultJsFileExtensions.join('|')}))?|` +
`next/(${nextClientComponents.join('|')})(\\.js)?|` + `next/(${nextClientComponents.join('|')})(\\.js)?|` +
`\\.(${imageExtensions.join('|')})` + `\\.(${imageExtensions.join('|')})` +
')$' ')$'
...@@ -42,7 +40,9 @@ export const createClientComponentFilter = ( ...@@ -42,7 +40,9 @@ export const createClientComponentFilter = (
return (importSource: string) => regex.test(importSource) return (importSource: string) => regex.test(importSource)
} }
export const createServerComponentFilter = (extensions: string[]) => { export const createServerComponentFilter = () => {
const regex = new RegExp(`\\.server(\\.(${extensions.join('|')}))?$`) const regex = new RegExp(
`\\.server(\\.(${defaultJsFileExtensions.join('|')}))?$`
)
return (importSource: string) => regex.test(importSource) return (importSource: string) => regex.test(importSource)
} }
...@@ -23,6 +23,7 @@ type Options = { ...@@ -23,6 +23,7 @@ type Options = {
const PLUGIN_NAME = 'FlightManifestPlugin' const PLUGIN_NAME = 'FlightManifestPlugin'
const isClientComponent = createClientComponentFilter()
export class FlightManifestPlugin { export class FlightManifestPlugin {
dev: boolean = false dev: boolean = false
pageExtensions: string[] pageExtensions: string[]
...@@ -64,7 +65,6 @@ export class FlightManifestPlugin { ...@@ -64,7 +65,6 @@ export class FlightManifestPlugin {
createAsset(assets: any, compilation: any) { createAsset(assets: any, compilation: any) {
const manifest: any = {} const manifest: any = {}
const isClientComponent = createClientComponentFilter(this.pageExtensions)
compilation.chunkGroups.forEach((chunkGroup: any) => { compilation.chunkGroups.forEach((chunkGroup: any) => {
function recordModule(id: string, _chunk: any, mod: any) { function recordModule(id: string, _chunk: any, mod: any) {
const resource = mod.resource const resource = mod.resource
......
...@@ -65,8 +65,15 @@ describe('react 18 streaming SSR with custom next configs', () => { ...@@ -65,8 +65,15 @@ describe('react 18 streaming SSR with custom next configs', () => {
} }
`, `,
'pages/hello.js': ` 'pages/hello.js': `
import Link from 'next/link'
export default function Page() { export default function Page() {
return <p>hello nextjs</p> return (
<div>
<p>hello nextjs</p>
<Link href='/'><a>home></a></Link>
</div>
)
} }
`, `,
'pages/multi-byte.js': ` 'pages/multi-byte.js': `
...@@ -114,6 +121,7 @@ describe('react 18 streaming SSR with custom next configs', () => { ...@@ -114,6 +121,7 @@ describe('react 18 streaming SSR with custom next configs', () => {
expect(redirectRes.status).toBe(308) expect(redirectRes.status).toBe(308)
expect(res.status).toBe(200) expect(res.status).toBe(200)
expect(html).toContain('hello nextjs') expect(html).toContain('hello nextjs')
expect(html).toContain('home')
}) })
it('should render multi-byte characters correctly in streaming', async () => { it('should render multi-byte characters correctly in streaming', async () => {
......
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