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

Add esm entry for next/server and alias @vercel/og (#51651)

The next-metadata-route-loader emitted content with `"next/server"` is still using cjs version which is not get tree-shaked on edge runtime, This PR adds a new esm entry for it and mapped it that on edge runtime so unused exports can be tree-shaked. This case happened when users are using ImageResponse from `"@vercel/og"` instead of `"next/server"`.

2nd change is adding another alias to map `@vercel/og` package to vendored og package inside next.js, this way we could merge the two package instead of bundled both of them


Fixes: NEXT-1303

changed `require.reoslve("next/dist/xxx")` to `${NEXT_PROJECT_ROOT}/xxx}` to avoid to be traced by nft.
parent f7496849
......@@ -1077,6 +1077,9 @@ export default async function getBaseWebpackConfig(
...nodePathList, // Support for NODE_PATH environment variable
],
alias: {
// Alias 3rd party @vercel/og package to vendored og image package to reduce bundle size
'@vercel/og': 'next/dist/server/web/spec-extension/image-response',
// Alias next/dist imports to next/dist/esm assets,
// let this alias hit before `next` alias.
...(isEdgeServer
......@@ -1088,25 +1091,27 @@ export default async function getBaseWebpackConfig(
'next/dist/server': 'next/dist/esm/server',
// Alias the usage of next public APIs
[require.resolve('next/dist/client/link')]:
[`${NEXT_PROJECT_ROOT}/server`]:
'next/dist/esm/server/web/exports/index',
[`${NEXT_PROJECT_ROOT}/dist/client/link`]:
'next/dist/esm/client/link',
[require.resolve('next/dist/client/image')]:
[`${NEXT_PROJECT_ROOT}/dist/client/image`]:
'next/dist/esm/client/image',
[require.resolve('next/dist/client/script')]:
[`${NEXT_PROJECT_ROOT}/dist/client/script`]:
'next/dist/esm/client/script',
[require.resolve('next/dist/client/router')]:
[`${NEXT_PROJECT_ROOT}/dist/client/router`]:
'next/dist/esm/client/router',
[require.resolve('next/dist/shared/lib/head')]:
[`${NEXT_PROJECT_ROOT}/dist/shared/lib/head`]:
'next/dist/esm/shared/lib/head',
[require.resolve('next/dist/shared/lib/dynamic')]:
[`${NEXT_PROJECT_ROOT}/dist/shared/lib/dynamic`]:
'next/dist/esm/shared/lib/dynamic',
[require.resolve('next/dist/pages/_document')]:
[`${NEXT_PROJECT_ROOT}/dist/pages/_document`]:
'next/dist/esm/pages/_document',
[require.resolve('next/dist/pages/_app')]:
[`${NEXT_PROJECT_ROOT}/dist/pages/_app`]:
'next/dist/esm/pages/_app',
[require.resolve('next/dist/client/components/navigation')]:
[`${NEXT_PROJECT_ROOT}/dist/client/components/navigation`]:
'next/dist/esm/client/components/navigation',
[require.resolve('next/dist/client/components/headers')]:
[`${NEXT_PROJECT_ROOT}/dist/client/components/headers`]:
'next/dist/esm/client/components/headers',
}
: undefined),
......@@ -1433,8 +1438,8 @@ export default async function getBaseWebpackConfig(
resolveResult.res = require.resolve(request)
}
// Don't bundle @vercel/og nodejs bundle for nodejs runtime
// TODO-APP: bundle route.js with different layer that externals common node_module deps
// Don't bundle @vercel/og nodejs bundle for nodejs runtime.
// TODO-APP: bundle route.js with different layer that externals common node_module deps.
if (
layer === WEBPACK_LAYERS.server &&
request === 'next/dist/compiled/@vercel/og/index.node.js'
......
......@@ -570,7 +570,7 @@ function getExtractMetadata(params: {
const resource = module.resource
const hasOGImageGeneration =
resource &&
/[\\/]node_modules[\\/]@vercel[\\/]og[\\/]dist[\\/]index\.(edge|node)\.js$|[\\/]next[\\/]dist[\\/]server[\\/]web[\\/]spec-extension[\\/]image-response\.js$/.test(
/[\\/]node_modules[\\/]@vercel[\\/]og[\\/]dist[\\/]index\.(edge|node)\.js$|[\\/]next[\\/]dist[\\/](esm[\\/])?server[\\/]web[\\/]spec-extension[\\/]image-response\.js$/.test(
resource
)
......
......@@ -7,7 +7,6 @@
"@sentry/nextjs",
"@sentry/node",
"@swc/core",
"@vercel/og",
"argon2",
"autoprefixer",
"aws-crt",
......
// Alias index file of next/server for edge runtime for tree-shaking purpose
export { default as ImageResponse } from './image-response'
export { default as NextRequest } from './next-request'
export { default as NextResponse } from './next-response'
export { default as userAgent } from './user-agent'
export { default as userAgentFromString } from './user-agent-from-string'
export { default as URLPattern } from './url-pattern'
export class ImageResponse {
public static displayName = 'NextImageResponse'
constructor(
...args: ConstructorParameters<
typeof import('next/dist/compiled/@vercel/og').ImageResponse
......
import { ImageResponse } from 'next/server'
// @ts-ignore
import { ImageResponse as ImageResponse2 } from '@vercel/og'
// Node.js: Using @vercel/og external package, and should be aliased to "next/server" ImageResponse
if (ImageResponse.displayName !== 'NextImageResponse')
throw new Error('ImageResponse mismatch: ' + ImageResponse.displayName)
// @ts-ignore
if (ImageResponse2.displayName !== 'NextImageResponse')
// @ts-ignore
throw new Error('ImageResponse mismatch: ' + ImageResponse2.displayName)
export const alt = 'Twitter'
export const size = { width: 1600, height: 900 }
......
import { ImageResponse } from 'next/server'
// @ts-ignore
import { ImageResponse as ImageResponse2 } from '@vercel/og'
// Edge: Using @vercel/og external package, and should be aliased to "next/server" ImageResponse
if (ImageResponse.displayName !== 'NextImageResponse')
throw new Error('ImageResponse mismatch: ' + ImageResponse.displayName)
// @ts-ignore
if (ImageResponse2.displayName !== 'NextImageResponse')
// @ts-ignore
throw new Error('ImageResponse2 mismatch: ' + ImageResponse2.displayName)
export const alt = 'Twitter'
export const size = { width: 1600, height: 900 }
export default function twitter() {
return new ImageResponse(
(
<div
style={{
width: '100%',
height: '100%',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
fontSize: 128,
background: 'lavender',
}}
>
Twitter Image
</div>
),
size
)
}
export const runtime = 'edge'
......@@ -14,6 +14,9 @@ createNextDescribe(
'app dir - metadata dynamic routes',
{
files: __dirname,
dependencies: {
'@vercel/og': 'latest',
},
},
({ next, isNextDev, isNextStart, isNextDeploy }) => {
describe('text routes', () => {
......@@ -101,12 +104,20 @@ createNextDescribe(
})
it('should render og image with twitter-image dynamic routes', async () => {
const res = await next.fetch('/twitter-image')
// nodejs runtime
let res = await next.fetch('/twitter-image')
expect(res.headers.get('content-type')).toBe('image/png')
expect(res.headers.get('cache-control')).toBe(
isNextDev ? CACHE_HEADERS.NONE : CACHE_HEADERS.LONG
)
// edge runtime
res = await next.fetch('/twitter-image2')
expect(res.headers.get('content-type')).toBe('image/png')
expect(res.headers.get('cache-control')).toBe(
isNextDev ? CACHE_HEADERS.NONE : CACHE_HEADERS.LONG
)
})
it('should support generate multi images with generateImageMetadata', async () => {
......
module.exports = {}
// For development: analyze the bundled chunks for stats app
if (process.env.ANALYZE) {
const withBundleAnalyzer = require('@next/bundle-analyzer')({
enabled: true,
})
module.exports = withBundleAnalyzer(module.exports)
}
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