Unverified Commit 4f260d68 authored by Jiwon Choi's avatar Jiwon Choi Committed by GitHub

fix: metadata image route Windows path escaping (#71615)

### Why?

When handling the `opengraph-image` size exceeding the limit, we mapped
with string literal between Rust and JavaScript. The Rust string literal
contains backslashes `\` on Windows, incompatible with JavaScript string
syntax.

Fixes #71582

---------
Co-authored-by: 's avatarDonny/강동윤 <kdy1997.dev@gmail.com>
parent 2490439b
...@@ -168,7 +168,7 @@ async fn static_route_source( ...@@ -168,7 +168,7 @@ async fn static_route_source(
if ({is_twitter} || {is_open_graph}) {{ if ({is_twitter} || {is_open_graph}) {{
const fileSizeInMB = buffer.byteLength / 1024 / 1024 const fileSizeInMB = buffer.byteLength / 1024 / 1024
if (fileSizeInMB > {file_size_limit}) {{ if (fileSizeInMB > {file_size_limit}) {{
throw new Error('File size for {img_name} image "{path}" exceeds {file_size_limit}MB. ' + throw new Error('File size for {img_name} image {path} exceeds {file_size_limit}MB. ' +
`(Current: ${{fileSizeInMB.toFixed(2)}}MB)\n` + `(Current: ${{fileSizeInMB.toFixed(2)}}MB)\n` +
'Read more: https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image#image-files-jpg-png-gif' 'Read more: https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image#image-files-jpg-png-gif'
) )
...@@ -193,7 +193,7 @@ async fn static_route_source( ...@@ -193,7 +193,7 @@ async fn static_route_source(
is_open_graph = is_open_graph, is_open_graph = is_open_graph,
file_size_limit = file_size_limit, file_size_limit = file_size_limit,
img_name = img_name, img_name = img_name,
path = path.to_string().await?, path = StringifyJs(&path.to_string().await?),
}; };
let file = File::from(code); let file = File::from(code);
......
...@@ -2,7 +2,7 @@ import { nextTestSetup } from 'e2e-utils' ...@@ -2,7 +2,7 @@ import { nextTestSetup } from 'e2e-utils'
import { generatePNG } from '../generate-image' import { generatePNG } from '../generate-image'
describe('app-dir - metadata-img-too-large opengraph-image', () => { describe('app-dir - metadata-img-too-large opengraph-image', () => {
const { next } = nextTestSetup({ const { next, isTurbopack } = nextTestSetup({
files: __dirname, files: __dirname,
skipStart: true, skipStart: true,
}) })
...@@ -11,11 +11,13 @@ describe('app-dir - metadata-img-too-large opengraph-image', () => { ...@@ -11,11 +11,13 @@ describe('app-dir - metadata-img-too-large opengraph-image', () => {
it('should throw when opengraph-image file size exceeds 8MB', async () => { it('should throw when opengraph-image file size exceeds 8MB', async () => {
await next.patchFile('app/opengraph-image.png', pngFile as any) await next.patchFile('app/opengraph-image.png', pngFile as any)
await next.build() await next.build()
const { cliOutput } = next
expect(cliOutput).toMatch( const regex = isTurbopack
/Error: File size for Open Graph image ".*\/app\/opengraph-image\.png" exceeds 8MB/ ? // in Turbopack, the path is simplified as [project]/...
) /Error: File size for Open Graph image "\[project\]\/app\/opengraph-image\.png" exceeds 8MB/
: /Error: File size for Open Graph image ".*\/app\/opengraph-image\.png" exceeds 8MB/
expect(next.cliOutput).toMatch(regex)
}) })
}) })
import { nextTestSetup } from 'e2e-utils' import { nextTestSetup } from 'e2e-utils'
import { generatePNG } from '../generate-image' import { generatePNG } from '../generate-image'
describe('metadata-img-too-large twitter-image', () => { describe('app-dir - metadata-img-too-large twitter-image', () => {
const { next } = nextTestSetup({ const { next, isTurbopack } = nextTestSetup({
files: __dirname, files: __dirname,
skipStart: true, skipStart: true,
}) })
const pngFile = generatePNG(6) const pngFile = generatePNG(5)
it('should throw when twitter-image file size exceeds 5MB', async () => { it('should throw when twitter-image file size exceeds 5MB', async () => {
await next.patchFile('app/twitter-image.png', pngFile as any) await next.patchFile('app/twitter-image.png', pngFile as any)
await next.build() await next.build()
const { cliOutput } = next
expect(cliOutput).toMatch( const regex = isTurbopack
/Error: File size for Twitter image ".*\/app\/twitter-image\.png" exceeds 5MB/ ? // in Turbopack, the path is simplified as [project]/...
) /Error: File size for Twitter image "\[project\]\/app\/twitter-image\.png" exceeds 5MB/
: /Error: File size for Twitter image ".*\/app\/twitter-image\.png" exceeds 5MB/
expect(next.cliOutput).toMatch(regex)
}) })
}) })
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