Unverified Commit 98e0c4a5 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

External vercel og for nodejs runtime (#48844)

### Why

Default font file of `@vercel/og` is not loaded, because the og package is bundled by webpack and we should external it so that `fs.readFileSync` is bundled and manged that can't be traced by nft.


### How
This PR externals `@vercel/og` so that they don't need to be bundled and files can be properly traced

Closes NEXT-1047
Fixes #48704
parent 219d1d49
...@@ -1286,7 +1286,9 @@ export default async function getBaseWebpackConfig( ...@@ -1286,7 +1286,9 @@ export default async function getBaseWebpackConfig(
// so that the DefinePlugin can inject process.env values. // so that the DefinePlugin can inject process.env values.
// Treat next internals as non-external for server layer // Treat next internals as non-external for server layer
if (layer === WEBPACK_LAYERS.server) return if (layer === WEBPACK_LAYERS.server) {
return
}
const isNextExternal = const isNextExternal =
/next[/\\]dist[/\\](esm[\\/])?(shared|server)[/\\](?!lib[/\\](router[/\\]router|dynamic|app-dynamic|lazy-dynamic|head[^-]))/.test( /next[/\\]dist[/\\](esm[\\/])?(shared|server)[/\\](?!lib[/\\](router[/\\]router|dynamic|app-dynamic|lazy-dynamic|head[^-]))/.test(
...@@ -1332,6 +1334,15 @@ export default async function getBaseWebpackConfig( ...@@ -1332,6 +1334,15 @@ export default async function getBaseWebpackConfig(
resolveResult.res = require.resolve(request) 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
if (
layer === WEBPACK_LAYERS.server &&
request === 'next/dist/compiled/@vercel/og/index.node.js'
) {
return `module ${request}`
}
const { res, isEsm } = resolveResult const { res, isEsm } = resolveResult
// If the request cannot be resolved we need to have // If the request cannot be resolved we need to have
...@@ -1413,6 +1424,7 @@ export default async function getBaseWebpackConfig( ...@@ -1413,6 +1424,7 @@ export default async function getBaseWebpackConfig(
if (layer === WEBPACK_LAYERS.server) { if (layer === WEBPACK_LAYERS.server) {
// All packages should be bundled for the server layer if they're not opted out. // All packages should be bundled for the server layer if they're not opted out.
// This option takes priority over the transpilePackages option. // This option takes priority over the transpilePackages option.
if (optOutBundlingPackageRegex.test(res)) { if (optOutBundlingPackageRegex.test(res)) {
return `${externalType} ${request}` return `${externalType} ${request}`
} }
......
...@@ -17,8 +17,8 @@ export class ImageResponse { ...@@ -17,8 +17,8 @@ export class ImageResponse {
( (
await import( await import(
process.env.NEXT_RUNTIME === 'edge' process.env.NEXT_RUNTIME === 'edge'
? 'next/dist/compiled/@vercel/og/index.edge' ? 'next/dist/compiled/@vercel/og/index.edge.js'
: 'next/dist/compiled/@vercel/og/index.node' : 'next/dist/compiled/@vercel/og/index.node.js'
) )
).ImageResponse ).ImageResponse
const imageResponse = new OGImageResponse(...args) as Response const imageResponse = new OGImageResponse(...args) as Response
......
...@@ -13,7 +13,6 @@ createNextDescribe( ...@@ -13,7 +13,6 @@ createNextDescribe(
'app dir - metadata dynamic routes', 'app dir - metadata dynamic routes',
{ {
files: __dirname, files: __dirname,
skipDeployment: true,
}, },
({ next, isNextDev, isNextStart, isNextDeploy }) => { ({ next, isNextDev, isNextStart, isNextDeploy }) => {
describe('text routes', () => { describe('text routes', () => {
...@@ -109,6 +108,8 @@ createNextDescribe( ...@@ -109,6 +108,8 @@ createNextDescribe(
) )
}) })
if (!isNextDeploy) {
// TODO-APP: investigate the dynamic routes failing in deployment tests
it('should support generate multi images with generateImageMetadata', async () => { it('should support generate multi images with generateImageMetadata', async () => {
const $ = await next.render$('/dynamic/big') const $ = await next.render$('/dynamic/big')
const iconUrls = $('link[rel="icon"]') const iconUrls = $('link[rel="icon"]')
...@@ -168,7 +169,9 @@ createNextDescribe( ...@@ -168,7 +169,9 @@ createNextDescribe(
for (const id of ids) { for (const id of ids) {
const text = await fetchSitemap(id) const text = await fetchSitemap(id)
expect(text).toContain(`<loc>https://example.com/dynamic/${id}</loc>`) expect(text).toContain(
`<loc>https://example.com/dynamic/${id}</loc>`
)
} }
}) })
...@@ -200,6 +203,7 @@ createNextDescribe( ...@@ -200,6 +203,7 @@ createNextDescribe(
expect([sizeBig.width, sizeBig.height]).toEqual([1200, 630]) expect([sizeBig.width, sizeBig.height]).toEqual([1200, 630])
expect([sizeSmall.width, sizeSmall.height]).toEqual([600, 315]) expect([sizeSmall.width, sizeSmall.height]).toEqual([600, 315])
}) })
}
it('should fill params into routes groups url of static images', async () => { it('should fill params into routes groups url of static images', async () => {
const $ = await next.render$('/static') const $ = await next.render$('/static')
...@@ -294,8 +298,8 @@ createNextDescribe( ...@@ -294,8 +298,8 @@ createNextDescribe(
let twitterImageUrlPattern let twitterImageUrlPattern
if (isNextDeploy) { if (isNextDeploy) {
// absolute urls // absolute urls
ogImageUrlPattern = /https:\/\/\w+.vercel.app\/opengraph-image\?/ ogImageUrlPattern = /https:\/\/[\w-]+.vercel.app\/opengraph-image\?/
twitterImageUrlPattern = /https:\/\/\w+.vercel.app\/twitter-image\?/ twitterImageUrlPattern = /https:\/\/[\w-]+.vercel.app\/twitter-image\?/
} else if (isNextStart) { } else if (isNextStart) {
// configured metadataBase for next start // configured metadataBase for next start
ogImageUrlPattern = /https:\/\/mydomain.com\/opengraph-image\?/ ogImageUrlPattern = /https:\/\/mydomain.com\/opengraph-image\?/
...@@ -325,7 +329,7 @@ createNextDescribe( ...@@ -325,7 +329,7 @@ createNextDescribe(
if (isNextDeploy) { if (isNextDeploy) {
expect(twitterImage).toMatch( expect(twitterImage).toMatch(
/https:\/\/\w+.vercel.app\/metadata-base\/unset\/twitter-image\.png/ /https:\/\/[\w-]+.vercel.app\/metadata-base\/unset\/twitter-image\.png/
) )
} else { } else {
expect(twitterImage).toMatch( expect(twitterImage).toMatch(
...@@ -347,6 +351,20 @@ createNextDescribe( ...@@ -347,6 +351,20 @@ createNextDescribe(
/\/\(group\)\/twitter-image-\w{6}\/\[\[\.\.\.__metadata_id__\]\]\/route/ /\/\(group\)\/twitter-image-\w{6}\/\[\[\.\.\.__metadata_id__\]\]\/route/
) )
}) })
it('should include default og font files in file trace', async () => {
const fileTrace = JSON.parse(
await next.readFile(
'.next/server/app/opengraph-image/[[...__metadata_id__]]/route.js.nft.json'
)
)
// @vercel/og default font should be traced
const isTraced = fileTrace.files.some((filePath) =>
filePath.includes('/noto-sans-v27-latin-regular.ttf')
)
expect(isTraced).toBe(true)
})
} }
} }
) )
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