Unverified Commit 4e8e191a authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

RSC: handle commonjs in flight loader (#35563)

We need to handle cjs cases for client/server components when they're compiled to commonjs in some cases.
e.g. if there's an internal `_app.server.js` in nextjs, the assets in the dist files are compiled to cjs by swc. Or any 3rd party libraries are consumed could be cjs only.

### How it works

* Detect the source file is ESM or CJS first by detect if there's any ESM import/export
* Append the new exports or collect exports info based on the module type
parent 79a8651b
...@@ -6,6 +6,7 @@ ...@@ -6,6 +6,7 @@
*/ */
import { parse } from '../../swc' import { parse } from '../../swc'
import { buildExports } from './utils'
function addExportNames(names: string[], node: any) { function addExportNames(names: string[], node: any) {
switch (node.type) { switch (node.type) {
...@@ -39,7 +40,7 @@ function addExportNames(names: string[], node: any) { ...@@ -39,7 +40,7 @@ function addExportNames(names: string[], node: any) {
} }
} }
async function parseExportNamesInto( async function parseModuleInfo(
resourcePath: string, resourcePath: string,
transformedSource: string, transformedSource: string,
names: Array<string> names: Array<string>
...@@ -56,7 +57,7 @@ async function parseExportNamesInto( ...@@ -56,7 +57,7 @@ async function parseExportNamesInto(
case 'ExportDefaultExpression': case 'ExportDefaultExpression':
case 'ExportDefaultDeclaration': case 'ExportDefaultDeclaration':
names.push('default') names.push('default')
continue break
case 'ExportNamedDeclaration': case 'ExportNamedDeclaration':
if (node.declaration) { if (node.declaration) {
if (node.declaration.type === 'VariableDeclaration') { if (node.declaration.type === 'VariableDeclaration') {
...@@ -74,12 +75,26 @@ async function parseExportNamesInto( ...@@ -74,12 +75,26 @@ async function parseExportNamesInto(
addExportNames(names, specificers[j].exported) addExportNames(names, specificers[j].exported)
} }
} }
continue break
case 'ExportDeclaration': case 'ExportDeclaration':
if (node.declaration?.identifier) { if (node.declaration?.identifier) {
addExportNames(names, node.declaration.identifier) addExportNames(names, node.declaration.identifier)
} }
continue break
case 'ExpressionStatement': {
const {
expression: { left },
} = node
// exports.xxx = xxx
if (
left.type === 'MemberExpression' &&
left?.object.type === 'Identifier' &&
left.object?.value === 'exports'
) {
addExportNames(names, left.property)
}
break
}
default: default:
break break
} }
...@@ -98,28 +113,28 @@ export default async function transformSource( ...@@ -98,28 +113,28 @@ export default async function transformSource(
} }
const names: string[] = [] const names: string[] = []
await parseExportNamesInto(resourcePath, transformedSource, names) await parseModuleInfo(resourcePath, transformedSource, names)
// next.js/packages/next/<component>.js // next.js/packages/next/<component>.js
if (/[\\/]next[\\/](link|image)\.js$/.test(resourcePath)) { if (/[\\/]next[\\/](link|image)\.js$/.test(resourcePath)) {
names.push('default') names.push('default')
} }
let newSrc = const moduleRefDef =
"const MODULE_REFERENCE = Symbol.for('react.module.reference');\n" "const MODULE_REFERENCE = Symbol.for('react.module.reference');\n"
for (let i = 0; i < names.length; i++) {
const name = names[i]
if (name === 'default') {
newSrc += 'export default '
} else {
newSrc += 'export const ' + name + ' = '
}
newSrc += '{ $$typeof: MODULE_REFERENCE, filepath: '
newSrc += JSON.stringify(resourcePath)
newSrc += ', name: '
newSrc += JSON.stringify(name)
newSrc += '};\n'
}
return newSrc const clientRefsExports = names.reduce((res: any, name) => {
const moduleRef =
'{ $$typeof: MODULE_REFERENCE, filepath: ' +
JSON.stringify(resourcePath) +
', name: ' +
JSON.stringify(name) +
' };\n'
res[name] = moduleRef
return res
}, {})
// still generate module references in ESM
const output = moduleRefDef + buildExports(clientRefsExports, true)
return output
} }
import { parse } from '../../swc' import { parse } from '../../swc'
import { getRawPageExtensions } from '../../utils' import { getRawPageExtensions } from '../../utils'
import { buildExports, isEsmNodeType } from './utils'
const imageExtensions = ['jpg', 'jpeg', 'png', 'webp', 'avif'] const imageExtensions = ['jpg', 'jpeg', 'png', 'webp', 'avif']
...@@ -24,7 +25,7 @@ const createServerComponentFilter = (pageExtensions: string[]) => { ...@@ -24,7 +25,7 @@ const createServerComponentFilter = (pageExtensions: string[]) => {
return (importSource: string) => regex.test(importSource) return (importSource: string) => regex.test(importSource)
} }
async function parseImportsInfo({ async function parseModuleInfo({
resourcePath, resourcePath,
source, source,
isClientCompilation, isClientCompilation,
...@@ -39,16 +40,18 @@ async function parseImportsInfo({ ...@@ -39,16 +40,18 @@ async function parseImportsInfo({
}): Promise<{ }): Promise<{
source: string source: string
imports: string imports: string
isEsm: boolean
}> { }> {
const ast = await parse(source, { filename: resourcePath, isModule: true }) const ast = await parse(source, { filename: resourcePath, isModule: true })
const { body } = ast const { body } = ast
let transformedSource = '' let transformedSource = ''
let lastIndex = 0 let lastIndex = 0
let imports = '' let imports = ''
let isEsm = false
for (let i = 0; i < body.length; i++) { for (let i = 0; i < body.length; i++) {
const node = body[i] const node = body[i]
isEsm = isEsm || isEsmNodeType(node.type)
switch (node.type) { switch (node.type) {
case 'ImportDeclaration': { case 'ImportDeclaration': {
const importSource = node.source.value const importSource = node.source.value
...@@ -117,7 +120,7 @@ async function parseImportsInfo({ ...@@ -117,7 +120,7 @@ async function parseImportsInfo({
transformedSource += source.substring(lastIndex) transformedSource += source.substring(lastIndex)
} }
return { source: transformedSource, imports } return { source: transformedSource, imports, isEsm }
} }
export default async function transformSource( export default async function transformSource(
...@@ -152,7 +155,11 @@ export default async function transformSource( ...@@ -152,7 +155,11 @@ export default async function transformSource(
} }
} }
const { source: transformedSource, imports } = await parseImportsInfo({ const {
source: transformedSource,
imports,
isEsm,
} = await parseModuleInfo({
resourcePath, resourcePath,
source, source,
isClientCompilation, isClientCompilation,
...@@ -172,14 +179,17 @@ export default async function transformSource( ...@@ -172,14 +179,17 @@ export default async function transformSource(
* export const __next_rsc__ = { __webpack_require__, _: () => { ... } } * export const __next_rsc__ = { __webpack_require__, _: () => { ... } }
*/ */
let rscExports = `export const __next_rsc__={ const rscExports: any = {
__next_rsc__: `{
__webpack_require__, __webpack_require__,
_: () => {${imports}} _: () => {\n${imports}\n}
}` }`,
}
if (isClientCompilation) { if (isClientCompilation) {
rscExports += '\nexport default function RSC () {}' rscExports['default'] = 'function RSC() {}'
} }
return transformedSource + '\n' + rscExports const output = transformedSource + '\n' + buildExports(rscExports, isEsm)
return output
} }
export function buildExports(moduleExports: any, isESM: boolean) {
let ret = ''
Object.keys(moduleExports).forEach((key) => {
const exportExpression = isESM
? `export ${key === 'default' ? key : `const ${key} =`} ${
moduleExports[key]
}`
: `exports.${key} = ${moduleExports[key]}`
ret += exportExpression + '\n'
})
return ret
}
const esmNodeTypes = [
'ImportDeclaration',
'ExportNamedDeclaration',
'ExportDefaultExpression',
'ExportDefaultDeclaration',
]
export const isEsmNodeType = (type: string) => esmNodeTypes.includes(type)
exports.Cjs = function Cjs() {
return 'cjs-shared'
}
...@@ -4,6 +4,8 @@ import { a, b, c, d, e } from '../components/shared-exports' ...@@ -4,6 +4,8 @@ import { a, b, c, d, e } from '../components/shared-exports'
import DefaultArrow, { import DefaultArrow, {
Named as ClientNamed, Named as ClientNamed,
} from '../components/client-exports.client' } from '../components/client-exports.client'
import { Cjs as CjsShared } from '../components/cjs'
import { Cjs as CjsClient } from '../components/cjs.client'
export default function Page() { export default function Page() {
return ( return (
...@@ -21,6 +23,12 @@ export default function Page() { ...@@ -21,6 +23,12 @@ export default function Page() {
<div> <div>
<ClientNamed /> <ClientNamed />
</div> </div>
<di>
<CjsShared />
</di>
<di>
<CjsClient />
</di>
</div> </div>
) )
} }
...@@ -206,6 +206,8 @@ export default function (context, { runtime, env }) { ...@@ -206,6 +206,8 @@ export default function (context, { runtime, env }) {
expect(hydratedContent).toContain('abcde') expect(hydratedContent).toContain('abcde')
expect(hydratedContent).toContain('default-export-arrow.client') expect(hydratedContent).toContain('default-export-arrow.client')
expect(hydratedContent).toContain('named.client') expect(hydratedContent).toContain('named.client')
expect(hydratedContent).toContain('cjs-shared')
expect(hydratedContent).toContain('cjs-client')
}) })
it('should handle 404 requests and missing routes correctly', async () => { it('should handle 404 requests and missing routes correctly', 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