Unverified Commit 065d196b authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Fix dynamic transform ssr:false case for pages router with ESM (#59246)

parent f64e92ba
...@@ -97,6 +97,9 @@ pub struct TransformOptions { ...@@ -97,6 +97,9 @@ pub struct TransformOptions {
#[serde(default)] #[serde(default)]
pub is_server_compiler: bool, pub is_server_compiler: bool,
#[serde(default)]
pub prefer_esm: bool,
#[serde(default)] #[serde(default)]
pub server_components: Option<react_server_components::Config>, pub server_components: Option<react_server_components::Config>,
...@@ -238,6 +241,7 @@ where ...@@ -238,6 +241,7 @@ where
}, },
_ => false, _ => false,
}, },
opts.prefer_esm,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
file.name.clone(), file.name.clone(),
opts.pages_dir.clone() opts.pages_dir.clone()
......
...@@ -56,6 +56,7 @@ fn next_dynamic_errors(input: PathBuf) { ...@@ -56,6 +56,7 @@ fn next_dynamic_errors(input: PathBuf) {
true, true,
false, false,
false, false,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
......
...@@ -65,6 +65,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -65,6 +65,7 @@ fn next_dynamic_fixture(input: PathBuf) {
true, true,
false, false,
false, false,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
...@@ -78,6 +79,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -78,6 +79,7 @@ fn next_dynamic_fixture(input: PathBuf) {
syntax(), syntax(),
&|_tr| { &|_tr| {
next_dynamic( next_dynamic(
false,
false, false,
false, false,
false, false,
...@@ -97,6 +99,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -97,6 +99,7 @@ fn next_dynamic_fixture(input: PathBuf) {
false, false,
true, true,
false, false,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
...@@ -124,6 +127,7 @@ fn app_dir_next_dynamic_fixture(input: PathBuf) { ...@@ -124,6 +127,7 @@ fn app_dir_next_dynamic_fixture(input: PathBuf) {
true, true,
false, false,
true, true,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
...@@ -140,6 +144,7 @@ fn app_dir_next_dynamic_fixture(input: PathBuf) { ...@@ -140,6 +144,7 @@ fn app_dir_next_dynamic_fixture(input: PathBuf) {
false, false,
false, false,
true, true,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
...@@ -156,6 +161,7 @@ fn app_dir_next_dynamic_fixture(input: PathBuf) { ...@@ -156,6 +161,7 @@ fn app_dir_next_dynamic_fixture(input: PathBuf) {
false, false,
true, true,
true, true,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
...@@ -172,6 +178,7 @@ fn app_dir_next_dynamic_fixture(input: PathBuf) { ...@@ -172,6 +178,7 @@ fn app_dir_next_dynamic_fixture(input: PathBuf) {
false, false,
true, true,
false, false,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
......
import dynamic from 'next/dynamic'; import dynamic from 'next/dynamic';
export const NextDynamicNoSSRServerComponent = dynamic(async ()=>{ export const NextDynamicNoSSRServerComponent = dynamic(()=>import('../text-dynamic-no-ssr-server'), {
typeof require.resolveWeak !== "undefined" && require.resolveWeak("../text-dynamic-no-ssr-server");
}, {
loadableGenerated: { loadableGenerated: {
modules: [ modules: [
"some-file.js -> " + "../text-dynamic-no-ssr-server" "some-file.js -> " + "../text-dynamic-no-ssr-server"
......
import dynamic from 'next/dynamic'; import dynamic from 'next/dynamic';
export const NextDynamicNoSSRServerComponent = dynamic(async ()=>{ export const NextDynamicNoSSRServerComponent = dynamic(()=>import('../text-dynamic-no-ssr-server'), {
typeof require.resolveWeak !== "undefined" && require.resolveWeak("../text-dynamic-no-ssr-server");
}, {
loadableGenerated: { loadableGenerated: {
modules: [ modules: [
"some-file.js -> " + "../text-dynamic-no-ssr-server" "some-file.js -> " + "../text-dynamic-no-ssr-server"
......
...@@ -7,9 +7,7 @@ const DynamicComponentWithCustomLoading = dynamic(()=>import('../components/hell ...@@ -7,9 +7,7 @@ const DynamicComponentWithCustomLoading = dynamic(()=>import('../components/hell
}, },
loading: ()=><p>...</p> loading: ()=><p>...</p>
}); });
const DynamicClientOnlyComponent = dynamic(async ()=>{ const DynamicClientOnlyComponent = dynamic(()=>import('../components/hello'), {
typeof require.resolveWeak !== "undefined" && require.resolveWeak("../components/hello");
}, {
loadableGenerated: { loadableGenerated: {
modules: [ modules: [
"some-file.js -> " + "../components/hello" "some-file.js -> " + "../components/hello"
...@@ -17,9 +15,7 @@ const DynamicClientOnlyComponent = dynamic(async ()=>{ ...@@ -17,9 +15,7 @@ const DynamicClientOnlyComponent = dynamic(async ()=>{
}, },
ssr: false ssr: false
}); });
const DynamicClientOnlyComponentWithSuspense = dynamic(async ()=>{ const DynamicClientOnlyComponentWithSuspense = dynamic(()=>import('../components/hello'), {
typeof require.resolveWeak !== "undefined" && require.resolveWeak("../components/hello");
}, {
loadableGenerated: { loadableGenerated: {
modules: [ modules: [
"some-file.js -> " + "../components/hello" "some-file.js -> " + "../components/hello"
......
import dynamic from 'next/dynamic'; import dynamic from 'next/dynamic';
const DynamicComponent = dynamic(async ()=>{ const DynamicComponent = dynamic(()=>handleImport(import('./components/hello')), {
typeof require.resolveWeak !== "undefined" && require.resolveWeak("./components/hello");
}, {
loadableGenerated: { loadableGenerated: {
modules: [ modules: [
"some-file.js -> " + "./components/hello" "some-file.js -> " + "./components/hello"
......
...@@ -66,6 +66,7 @@ impl CustomTransformer for NextJsDynamic { ...@@ -66,6 +66,7 @@ impl CustomTransformer for NextJsDynamic {
}, },
self.is_server_compiler, self.is_server_compiler,
self.is_react_server_layer, self.is_react_server_layer,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
FileName::Real(ctx.file_path_str.into()), FileName::Real(ctx.file_path_str.into()),
self.pages_dir.clone(), self.pages_dir.clone(),
......
...@@ -28,6 +28,7 @@ pub fn next_dynamic( ...@@ -28,6 +28,7 @@ pub fn next_dynamic(
is_development: bool, is_development: bool,
is_server_compiler: bool, is_server_compiler: bool,
is_react_server_layer: bool, is_react_server_layer: bool,
prefer_esm: bool,
mode: NextDynamicMode, mode: NextDynamicMode,
filename: FileName, filename: FileName,
pages_dir: Option<PathBuf>, pages_dir: Option<PathBuf>,
...@@ -36,6 +37,7 @@ pub fn next_dynamic( ...@@ -36,6 +37,7 @@ pub fn next_dynamic(
is_development, is_development,
is_server_compiler, is_server_compiler,
is_react_server_layer, is_react_server_layer,
prefer_esm,
pages_dir, pages_dir,
filename, filename,
dynamic_bindings: vec![], dynamic_bindings: vec![],
...@@ -81,6 +83,7 @@ struct NextDynamicPatcher { ...@@ -81,6 +83,7 @@ struct NextDynamicPatcher {
is_development: bool, is_development: bool,
is_server_compiler: bool, is_server_compiler: bool,
is_react_server_layer: bool, is_react_server_layer: bool,
prefer_esm: bool,
pages_dir: Option<PathBuf>, pages_dir: Option<PathBuf>,
filename: FileName, filename: FileName,
dynamic_bindings: Vec<Id>, dynamic_bindings: Vec<Id>,
...@@ -368,6 +371,10 @@ impl Fold for NextDynamicPatcher { ...@@ -368,6 +371,10 @@ impl Fold for NextDynamicPatcher {
if has_ssr_false if has_ssr_false
&& self.is_server_compiler && self.is_server_compiler
&& !self.is_react_server_layer && !self.is_react_server_layer
// When it's not prefer to picking up ESM, as it's in the pages router, we don't need to do it as it doesn't need to enter the non-ssr module.
// Also transforming it to `require.resolveWeak` and with ESM import, like require.resolveWeak(esm asset) is not available as it's commonjs importing ESM.
&& self.prefer_esm
// Only use `require.resolveWebpack` to decouple modules for webpack, // Only use `require.resolveWebpack` to decouple modules for webpack,
// turbopack doesn't need this // turbopack doesn't need this
&& self.state == NextDynamicPatcherState::Webpack && self.state == NextDynamicPatcherState::Webpack
......
...@@ -39,6 +39,7 @@ fn next_dynamic_errors_run(input: &Path, output: &str, mode: NextDynamicMode) { ...@@ -39,6 +39,7 @@ fn next_dynamic_errors_run(input: &Path, output: &str, mode: NextDynamicMode) {
true, true,
false, false,
false, false,
false,
mode.clone(), mode.clone(),
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
......
...@@ -25,6 +25,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -25,6 +25,7 @@ fn next_dynamic_fixture(input: PathBuf) {
true, true,
false, false,
false, false,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
); );
next_dynamic_fixture_run( next_dynamic_fixture_run(
...@@ -33,6 +34,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -33,6 +34,7 @@ fn next_dynamic_fixture(input: PathBuf) {
false, false,
false, false,
false, false,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
); );
next_dynamic_fixture_run( next_dynamic_fixture_run(
...@@ -41,6 +43,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -41,6 +43,7 @@ fn next_dynamic_fixture(input: PathBuf) {
false, false,
true, true,
false, false,
false,
NextDynamicMode::Webpack, NextDynamicMode::Webpack,
); );
...@@ -50,6 +53,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -50,6 +53,7 @@ fn next_dynamic_fixture(input: PathBuf) {
true, true,
false, false,
false, false,
false,
NextDynamicMode::Turbopack { NextDynamicMode::Turbopack {
dynamic_transition_name: "next-client-chunks".into(), dynamic_transition_name: "next-client-chunks".into(),
}, },
...@@ -60,6 +64,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -60,6 +64,7 @@ fn next_dynamic_fixture(input: PathBuf) {
true, true,
true, true,
false, false,
false,
NextDynamicMode::Turbopack { NextDynamicMode::Turbopack {
dynamic_transition_name: "next-client-chunks".into(), dynamic_transition_name: "next-client-chunks".into(),
}, },
...@@ -70,6 +75,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -70,6 +75,7 @@ fn next_dynamic_fixture(input: PathBuf) {
false, false,
false, false,
false, false,
false,
NextDynamicMode::Turbopack { NextDynamicMode::Turbopack {
dynamic_transition_name: "next-dynamic".into(), dynamic_transition_name: "next-dynamic".into(),
}, },
...@@ -80,6 +86,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -80,6 +86,7 @@ fn next_dynamic_fixture(input: PathBuf) {
false, false,
true, true,
false, false,
false,
NextDynamicMode::Turbopack { NextDynamicMode::Turbopack {
dynamic_transition_name: "next-dynamic".into(), dynamic_transition_name: "next-dynamic".into(),
}, },
...@@ -90,6 +97,7 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -90,6 +97,7 @@ fn next_dynamic_fixture(input: PathBuf) {
false, false,
true, true,
true, true,
true,
NextDynamicMode::Turbopack { NextDynamicMode::Turbopack {
dynamic_transition_name: "next-dynamic".into(), dynamic_transition_name: "next-dynamic".into(),
}, },
...@@ -102,6 +110,7 @@ fn next_dynamic_fixture_run( ...@@ -102,6 +110,7 @@ fn next_dynamic_fixture_run(
is_development: bool, is_development: bool,
is_server_compiler: bool, is_server_compiler: bool,
is_react_server_layer: bool, is_react_server_layer: bool,
prefer_esm: bool,
mode: NextDynamicMode, mode: NextDynamicMode,
) { ) {
let output = input.parent().unwrap().join(output); let output = input.parent().unwrap().join(output);
...@@ -112,6 +121,7 @@ fn next_dynamic_fixture_run( ...@@ -112,6 +121,7 @@ fn next_dynamic_fixture_run(
is_development, is_development,
is_server_compiler, is_server_compiler,
is_react_server_layer, is_react_server_layer,
prefer_esm,
mode.clone(), mode.clone(),
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
......
...@@ -36,6 +36,7 @@ function getBaseSWCOptions({ ...@@ -36,6 +36,7 @@ function getBaseSWCOptions({
development, development,
hasReactRefresh, hasReactRefresh,
globalWindow, globalWindow,
esm,
modularizeImports, modularizeImports,
swcPlugins, swcPlugins,
compilerOptions, compilerOptions,
...@@ -50,6 +51,7 @@ function getBaseSWCOptions({ ...@@ -50,6 +51,7 @@ function getBaseSWCOptions({
development: boolean development: boolean
hasReactRefresh: boolean hasReactRefresh: boolean
globalWindow: boolean globalWindow: boolean
esm: boolean
modularizeImports?: NextConfig['modularizeImports'] modularizeImports?: NextConfig['modularizeImports']
compilerOptions: NextConfig['compiler'] compilerOptions: NextConfig['compiler']
swcPlugins: ExperimentalConfig['swcPlugins'] swcPlugins: ExperimentalConfig['swcPlugins']
...@@ -188,6 +190,9 @@ function getBaseSWCOptions({ ...@@ -188,6 +190,9 @@ function getBaseSWCOptions({
isReactServerLayer: !!isReactServerLayer, isReactServerLayer: !!isReactServerLayer,
} }
: undefined, : undefined,
// For app router we prefer to bundle ESM,
// On server side of pages router we prefer CJS.
preferEsm: esm,
} }
} }
...@@ -289,6 +294,7 @@ export function getJestSWCOptions({ ...@@ -289,6 +294,7 @@ export function getJestSWCOptions({
compilerOptions, compilerOptions,
jsConfig, jsConfig,
resolvedBaseUrl, resolvedBaseUrl,
esm,
// Don't apply server layer transformations for Jest // Don't apply server layer transformations for Jest
isReactServerLayer: false, isReactServerLayer: false,
// Disable server / client graph assertions for Jest // Disable server / client graph assertions for Jest
...@@ -372,6 +378,7 @@ export function getLoaderSWCOptions({ ...@@ -372,6 +378,7 @@ export function getLoaderSWCOptions({
swcCacheDir, swcCacheDir,
isReactServerLayer, isReactServerLayer,
serverComponents, serverComponents,
esm: !!esm,
}) })
baseOptions.fontLoaders = { baseOptions.fontLoaders = {
fontLoaders: [ fontLoaders: [
...@@ -423,6 +430,7 @@ export function getLoaderSWCOptions({ ...@@ -423,6 +430,7 @@ export function getLoaderSWCOptions({
isServerCompiler: isServer, isServerCompiler: isServer,
pagesDir, pagesDir,
appDir, appDir,
preferEsm: !!esm,
isPageFile, isPageFile,
env: { env: {
targets: { targets: {
......
...@@ -199,6 +199,25 @@ describe.each([ ...@@ -199,6 +199,25 @@ describe.each([
} }
} }
}) })
it('should import and render the ESM module correctly on client side', async () => {
let browser
try {
browser = await webdriver(
next.url,
basePath + '/dynamic/no-ssr-esm'
)
await check(
() => browser.elementByCss('body').text(),
/esm.mjs/
)
expect(await hasRedbox(browser, false)).toBe(false)
} finally {
if (browser) {
await browser.close()
}
}
})
}) })
describe('ssr:true option', () => { describe('ssr:true option', () => {
......
import React from 'react'
window.ua = navigator.userAgent
export default function Component() {
return <p>esm.mjs</p>
}
import dynamic from 'next/dynamic'
const Page = dynamic(() => import('../../components/esm.mjs'), { ssr: false })
export default Page
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