archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(next/image)!: error when src has leading or trailing space (#65637)

Browse source 
BREAKING CHANGE:

Using the built-in image optimization API, the URL is parsed with `new
URL()` constructor which automatically trims spaces.

However, the developer may choose a 3rd party image optimization API via
`loader` or `loaderFile` (or perhaps a deployment platform that has its
own built in loader), so we shouldn't assume the API will parse the URL
in the same way as
[WHATWG](https://url.spec.whatwg.org/#:~:text=If%20input%20contains%20any%20leading%20or%20trailing%20C0%20control%20or%20space%2C%20invalid%2DURL%2Dunit%20validation%20error.).

While we could trim on the client, its probably best to fail fast and
let the developer make a conscience decision if a trailing space should
be removed or remain (by explicitly using `%20`).
This commit is contained in:
Steven 2024-05-14 14:00:27 -04:00 committed by GitHub
parent 46f89b095a
commit f169b08901
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 88 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
packages/next/src/shared/lib/get-img-props.ts
View file

@ -465,6 +465,18 @@ export function getImgProps(
`Image with src "${src}" has invalid "height" property. Expected a numeric value in pixels but received "${height}".`
)
}
// eslint-disable-next-line no-control-regex
if (/^[\x00-\x20]/.test(src)) {
throw new Error(
`Image with src "${src}" cannot start with a space or control character. Use src.trimStart() to remove it or encodeURIComponent(src) to keep it.`
)
}
// eslint-disable-next-line no-control-regex
if (/[\x00-\x20]$/.test(src)) {
throw new Error(
`Image with src "${src}" cannot end with a space or control character. Use src.trimEnd() to remove it or encodeURIComponent(src) to keep it.`
)
}
}
}
if (!VALID_LOADING_VALUES.includes(loading)) {

11
test/integration/next-image-new/app-dir/app/invalid-src-leading-space/page.js Normal file
View file

@ -0,0 +1,11 @@
import React from 'react'
import Image from 'next/image'
export default function Page() {
return (
<div>
<h2>Invalid src with leading space</h2>
<Image src=" /test.jpg" width={200} height={200} />
</div>
)
}

11
test/integration/next-image-new/app-dir/app/invalid-src-trailing-space/page.js Normal file
View file

@ -0,0 +1,11 @@
import React from 'react'
import Image from 'next/image'
export default function Page() {
return (
<div>
<h2>Invalid src with trailing space</h2>
<Image src="/test.png " width={200} height={200} />
</div>
)
}

16
test/integration/next-image-new/app-dir/test/index.test.ts
View file

@ -915,6 +915,22 @@ function runTests(mode) {
)
})
it('should show invalid src with leading space', async () => {
const browser = await webdriver(appPort, '/invalid-src-leading-space')
expect(await hasRedbox(browser)).toBe(true)
expect(await getRedboxHeader(browser)).toContain(
'Image with src " /test.jpg" cannot start with a space or control character.'
)
})
it('should show invalid src with trailing space', async () => {
const browser = await webdriver(appPort, '/invalid-src-trailing-space')
expect(await hasRedbox(browser)).toBe(true)
expect(await getRedboxHeader(browser)).toContain(
'Image with src "/test.png " cannot end with a space or control character.'
)
})
it('should show error when string src and placeholder=blur and blurDataURL is missing', async () => {
const browser = await webdriver(appPort, '/invalid-placeholder-blur')

11
test/integration/next-image-new/default/pages/invalid-src-leading-space.js Normal file
View file

@ -0,0 +1,11 @@
import React from 'react'
import Image from 'next/image'
export default function Page() {
return (
<div>
<h2>Invalid src with leading space</h2>
<Image src=" /test.jpg" width={200} height={200} />
</div>
)
}

11
test/integration/next-image-new/default/pages/invalid-src-trailing-space.js Normal file
View file

@ -0,0 +1,11 @@
import React from 'react'
import Image from 'next/image'
export default function Page() {
return (
<div>
<h2>Invalid src with trailing space</h2>
<Image src="/test.png " width={200} height={200} />
</div>
)
}

16
test/integration/next-image-new/default/test/index.test.ts
View file

@ -916,6 +916,22 @@ function runTests(mode) {
)
})
it('should show invalid src with leading space', async () => {
const browser = await webdriver(appPort, '/invalid-src-leading-space')
expect(await hasRedbox(browser)).toBe(true)
expect(await getRedboxHeader(browser)).toContain(
'Image with src " /test.jpg" cannot start with a space or control character.'
)
})
it('should show invalid src with trailing space', async () => {
const browser = await webdriver(appPort, '/invalid-src-trailing-space')
expect(await hasRedbox(browser)).toBe(true)
expect(await getRedboxHeader(browser)).toContain(
'Image with src "/test.png " cannot end with a space or control character.'
)
})
it('should show error when string src and placeholder=blur and blurDataURL is missing', async () => {
const browser = await webdriver(appPort, '/invalid-placeholder-blur')