Unverified Commit 416cf45f authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Fix next/image usage in mdx (#64875)

### What

Apply the react aliases for app dir also to the files with
`pagesExtension`

### Why

In the page bundle of mdx page:

In RSC layer react is referencing to the insatlled react 18.2.0 's
`jsx-runtime` to create each JSX element. The react 18.2 JSX runtime
access `propTypes` of the component type and then it crashes 💥
In RSC layer it should use the built-in react canary's `jsx-runtime`.

The reason that it didn't use the built-in one is we're using customized
`pageExtension` `["mdx"]` for mdx, where we didn't apply all these rules
for the files with `pageExtension`, but only the js and ts files by
default.

For mdx specifically, we cannot only applied to
`(page|layout|route).[page extension]` cause every mdx file needs to
have proper resolution. Since this doesn't break transform, it's safe to
apply for all files with page extension.

Fixes #58888 

Closes NEXT-3187
parent c09ce24a
...@@ -819,6 +819,7 @@ export default async function getBaseWebpackConfig( ...@@ -819,6 +819,7 @@ export default async function getBaseWebpackConfig(
const shouldIncludeExternalDirs = const shouldIncludeExternalDirs =
config.experimental.externalDir || !!config.transpilePackages config.experimental.externalDir || !!config.transpilePackages
const pageExtensionsRegex = new RegExp(`\\.(${pageExtensions.join('|')})$`)
const codeCondition = { const codeCondition = {
test: { or: [/\.(tsx|ts|js|cjs|mjs|jsx)$/, /__barrel_optimize__/] }, test: { or: [/\.(tsx|ts|js|cjs|mjs|jsx)$/, /__barrel_optimize__/] },
...(shouldIncludeExternalDirs ...(shouldIncludeExternalDirs
...@@ -840,6 +841,8 @@ export default async function getBaseWebpackConfig( ...@@ -840,6 +841,8 @@ export default async function getBaseWebpackConfig(
}, },
} }
const aliasCodeConditionTest = [codeCondition.test, pageExtensionsRegex]
let webpackConfig: webpack.Configuration = { let webpackConfig: webpack.Configuration = {
parallelism: Number(process.env.NEXT_WEBPACK_PARALLELISM) || undefined, parallelism: Number(process.env.NEXT_WEBPACK_PARALLELISM) || undefined,
...(isNodeServer ? { externalsPresets: { node: true } } : {}), ...(isNodeServer ? { externalsPresets: { node: true } } : {}),
...@@ -1326,7 +1329,7 @@ export default async function getBaseWebpackConfig( ...@@ -1326,7 +1329,7 @@ export default async function getBaseWebpackConfig(
// Resolve it if it is a source code file, and it has NOT been // Resolve it if it is a source code file, and it has NOT been
// opted out of bundling. // opted out of bundling.
and: [ and: [
codeCondition.test, aliasCodeConditionTest,
{ {
not: [optOutBundlingPackageRegex, asyncStoragesRegex], not: [optOutBundlingPackageRegex, asyncStoragesRegex],
}, },
...@@ -1388,7 +1391,7 @@ export default async function getBaseWebpackConfig( ...@@ -1388,7 +1391,7 @@ export default async function getBaseWebpackConfig(
// Resolve it if it is a source code file, and it has NOT been // Resolve it if it is a source code file, and it has NOT been
// opted out of bundling. // opted out of bundling.
and: [ and: [
codeCondition.test, aliasCodeConditionTest,
{ {
not: [optOutBundlingPackageRegex, asyncStoragesRegex], not: [optOutBundlingPackageRegex, asyncStoragesRegex],
}, },
...@@ -1405,7 +1408,7 @@ export default async function getBaseWebpackConfig( ...@@ -1405,7 +1408,7 @@ export default async function getBaseWebpackConfig(
}, },
}, },
{ {
test: codeCondition.test, test: aliasCodeConditionTest,
issuerLayer: WEBPACK_LAYERS.serverSideRendering, issuerLayer: WEBPACK_LAYERS.serverSideRendering,
resolve: { resolve: {
alias: createRSCAliases(bundledReactChannel, { alias: createRSCAliases(bundledReactChannel, {
...@@ -1418,7 +1421,7 @@ export default async function getBaseWebpackConfig( ...@@ -1418,7 +1421,7 @@ export default async function getBaseWebpackConfig(
], ],
}, },
{ {
test: codeCondition.test, test: aliasCodeConditionTest,
issuerLayer: WEBPACK_LAYERS.appPagesBrowser, issuerLayer: WEBPACK_LAYERS.appPagesBrowser,
resolve: { resolve: {
alias: createRSCAliases(bundledReactChannel, { alias: createRSCAliases(bundledReactChannel, {
......
import Image from 'next/image'
# Title
This is a markdown page
<Image src="/test.jpg" alt="Next.js Logo" width={180} height={37} />
...@@ -59,6 +59,13 @@ for (const type of [ ...@@ -59,6 +59,13 @@ for (const type of [
const $ = await next.render$('/') const $ = await next.render$('/')
expect($('h2').text()).toBe('This is a client component') expect($('h2').text()).toBe('This is a client component')
}) })
it('should work with next/image', async () => {
const $ = await next.render$('/image')
expect($('img').attr('src')).toBe(
'/_next/image?url=%2Ftest.jpg&w=384&q=75'
)
})
}) })
describe('pages directory', () => { describe('pages directory', () => {
......
...@@ -1793,6 +1793,7 @@ ...@@ -1793,6 +1793,7 @@
"mdx with-mdx-rs app directory should work in initial html with mdx import", "mdx with-mdx-rs app directory should work in initial html with mdx import",
"mdx with-mdx-rs app directory should work using browser", "mdx with-mdx-rs app directory should work using browser",
"mdx with-mdx-rs app directory should work using browser with mdx import", "mdx with-mdx-rs app directory should work using browser with mdx import",
"mdx with-mdx-rs app directory should work with next/image",
"mdx with-mdx-rs pages directory should allow overriding components", "mdx with-mdx-rs pages directory should allow overriding components",
"mdx with-mdx-rs pages directory should work in initial html", "mdx with-mdx-rs pages directory should work in initial html",
"mdx with-mdx-rs pages directory should work in initial html with mdx import", "mdx with-mdx-rs pages directory should work in initial html with mdx import",
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