Unverified Commit 7a7e7d4f authored by Steven's avatar Steven Committed by GitHub

Remove `useState` from `next/image` (#43587)

This PR remove `React.useState()` from the `next/image` component. It
was only used in the `onError` case and it was causing Safari to become
very slow when there were many images on the same page. We were seeing
1s delay blocking the main thread when there were about 350 images on
the same page. Chrome and Firefox were not slow.
parent b0aa73b4
...@@ -6,7 +6,6 @@ import React, { ...@@ -6,7 +6,6 @@ import React, {
useCallback, useCallback,
useContext, useContext,
useMemo, useMemo,
useState,
forwardRef, forwardRef,
} from 'react' } from 'react'
import Head from '../shared/lib/head' import Head from '../shared/lib/head'
...@@ -149,8 +148,6 @@ type ImageElementProps = Omit<ImageProps, 'src' | 'alt' | 'loader'> & { ...@@ -149,8 +148,6 @@ type ImageElementProps = Omit<ImageProps, 'src' | 'alt' | 'loader'> & {
placeholder: PlaceholderValue placeholder: PlaceholderValue
onLoadRef: React.MutableRefObject<OnLoad | undefined> onLoadRef: React.MutableRefObject<OnLoad | undefined>
onLoadingCompleteRef: React.MutableRefObject<OnLoadingComplete | undefined> onLoadingCompleteRef: React.MutableRefObject<OnLoadingComplete | undefined>
setBlurComplete: (b: boolean) => void
setShowAltText: (b: boolean) => void
} }
function getWidths( function getWidths(
...@@ -264,10 +261,8 @@ function getInt(x: unknown): number | undefined { ...@@ -264,10 +261,8 @@ function getInt(x: unknown): number | undefined {
function handleLoading( function handleLoading(
img: ImgElementWithDataProp, img: ImgElementWithDataProp,
src: string, src: string,
placeholder: PlaceholderValue,
onLoadRef: React.MutableRefObject<OnLoad | undefined>, onLoadRef: React.MutableRefObject<OnLoad | undefined>,
onLoadingCompleteRef: React.MutableRefObject<OnLoadingComplete | undefined>, onLoadingCompleteRef: React.MutableRefObject<OnLoadingComplete | undefined>,
setBlurComplete: (b: boolean) => void,
unoptimized: boolean unoptimized: boolean
) { ) {
if (!img || img['data-loaded-src'] === src) { if (!img || img['data-loaded-src'] === src) {
...@@ -284,9 +279,6 @@ function handleLoading( ...@@ -284,9 +279,6 @@ function handleLoading(
// - decode() completes // - decode() completes
return return
} }
if (placeholder === 'blur') {
setBlurComplete(true)
}
if (onLoadRef?.current) { if (onLoadRef?.current) {
// Since we don't have the SyntheticEvent here, // Since we don't have the SyntheticEvent here,
// we must create one with the same shape. // we must create one with the same shape.
...@@ -383,8 +375,6 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>( ...@@ -383,8 +375,6 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>(
loader, loader,
onLoadRef, onLoadRef,
onLoadingCompleteRef, onLoadingCompleteRef,
setBlurComplete,
setShowAltText,
onLoad, onLoad,
onError, onError,
...rest ...rest
...@@ -441,20 +431,16 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>( ...@@ -441,20 +431,16 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>(
handleLoading( handleLoading(
img, img,
srcString, srcString,
placeholder,
onLoadRef, onLoadRef,
onLoadingCompleteRef, onLoadingCompleteRef,
setBlurComplete,
unoptimized unoptimized
) )
} }
}, },
[ [
srcString, srcString,
placeholder,
onLoadRef, onLoadRef,
onLoadingCompleteRef, onLoadingCompleteRef,
setBlurComplete,
onError, onError,
unoptimized, unoptimized,
forwardedRef, forwardedRef,
...@@ -465,20 +451,30 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>( ...@@ -465,20 +451,30 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>(
handleLoading( handleLoading(
img, img,
srcString, srcString,
placeholder,
onLoadRef, onLoadRef,
onLoadingCompleteRef, onLoadingCompleteRef,
setBlurComplete,
unoptimized unoptimized
) )
}} }}
onError={(event) => { onError={(event) => {
// if the real image fails to load, this will ensure "alt" is visible // Note: We removed React.useState() in the error case here
setShowAltText(true) // because it was causing Safari to become very slow when
if (placeholder === 'blur') { // there were many images on the same page.
// If the real image fails to load, this will still remove the placeholder. const { style } = event.currentTarget
setBlurComplete(true)
if (style.color === 'transparent') {
// If src image fails to load, this will ensure "alt" is visible
style.color = ''
}
if (placeholder === 'blur' && style.backgroundImage) {
// If src image fails to load, this will ensure the placeholder is removed
style.backgroundSize = ''
style.backgroundPosition = ''
style.backgroundRepeat = ''
style.backgroundImage = ''
} }
if (onError) { if (onError) {
onError(event) onError(event)
} }
...@@ -626,9 +622,6 @@ const Image = forwardRef<HTMLImageElement | null, ImageProps>( ...@@ -626,9 +622,6 @@ const Image = forwardRef<HTMLImageElement | null, ImageProps>(
unoptimized = true unoptimized = true
} }
const [blurComplete, setBlurComplete] = useState(false)
const [showAltText, setShowAltText] = useState(false)
const qualityInt = getInt(quality) const qualityInt = getInt(quality)
if (process.env.NODE_ENV !== 'production') { if (process.env.NODE_ENV !== 'production') {
...@@ -810,12 +803,12 @@ const Image = forwardRef<HTMLImageElement | null, ImageProps>( ...@@ -810,12 +803,12 @@ const Image = forwardRef<HTMLImageElement | null, ImageProps>(
objectPosition, objectPosition,
} }
: {}, : {},
showAltText ? {} : { color: 'transparent' }, { color: 'transparent' },
style style
) )
const blurStyle = const blurStyle =
placeholder === 'blur' && blurDataURL && !blurComplete placeholder === 'blur' && blurDataURL
? { ? {
backgroundSize: imgStyle.objectFit || 'cover', backgroundSize: imgStyle.objectFit || 'cover',
backgroundPosition: imgStyle.objectPosition || '50% 50%', backgroundPosition: imgStyle.objectPosition || '50% 50%',
...@@ -905,8 +898,6 @@ const Image = forwardRef<HTMLImageElement | null, ImageProps>( ...@@ -905,8 +898,6 @@ const Image = forwardRef<HTMLImageElement | null, ImageProps>(
srcString, srcString,
onLoadRef, onLoadRef,
onLoadingCompleteRef, onLoadingCompleteRef,
setBlurComplete,
setShowAltText,
...rest, ...rest,
} }
return ( return (
......
import React from 'react'
import Image from 'next/image'
export default function Page() {
return (
<div>
<p>Blurry Placeholder</p>
<Image
priority
id="blurry-placeholder-raw"
src="/test.ico"
width="400"
height="400"
placeholder="blur"
blurDataURL="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8P4nhDwAGuAKPn6cicwAAAABJRU5ErkJggg=="
/>
<div id="spacer" style={{ height: '1000vh' }} />
<Image
id="blurry-placeholder-with-lazy"
src="/test.bmp"
width="400"
height="400"
placeholder="blur"
blurDataURL="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mO0/8/wBwAE/wI85bEJ6gAAAABJRU5ErkJggg=="
/>
</div>
)
}
...@@ -599,8 +599,8 @@ function runTests(mode) { ...@@ -599,8 +599,8 @@ function runTests(mode) {
'lazy' 'lazy'
) )
expect(await browser.elementById('blur1').getAttribute('sizes')).toBeNull() expect(await browser.elementById('blur1').getAttribute('sizes')).toBeNull()
expect(await browser.elementById('blur1').getAttribute('style')).toBe( expect(await browser.elementById('blur1').getAttribute('style')).toMatch(
'color: transparent;' 'color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;'
) )
expect(await browser.elementById('blur1').getAttribute('height')).toBe( expect(await browser.elementById('blur1').getAttribute('height')).toBe(
'400' '400'
...@@ -646,8 +646,8 @@ function runTests(mode) { ...@@ -646,8 +646,8 @@ function runTests(mode) {
expect(await browser.elementById('blur2').getAttribute('loading')).toBe( expect(await browser.elementById('blur2').getAttribute('loading')).toBe(
'lazy' 'lazy'
) )
expect(await browser.elementById('blur2').getAttribute('style')).toBe( expect(await browser.elementById('blur2').getAttribute('style')).toMatch(
'color: transparent;' 'color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat'
) )
expect(await browser.elementById('blur2').getAttribute('height')).toBe( expect(await browser.elementById('blur2').getAttribute('height')).toBe(
'400' '400'
...@@ -1084,15 +1084,6 @@ function runTests(mode) { ...@@ -1084,15 +1084,6 @@ function runTests(mode) {
expect(await getComputedStyle(browser, 'img-blur', 'filter')).toBe( expect(await getComputedStyle(browser, 'img-blur', 'filter')).toBe(
'opacity(0.5)' 'opacity(0.5)'
) )
expect(await getComputedStyle(browser, 'img-blur', 'background-size')).toBe(
'30%'
)
expect(
await getComputedStyle(browser, 'img-blur', 'background-image')
).toMatch('iVBORw0KGgo=')
expect(
await getComputedStyle(browser, 'img-blur', 'background-position')
).toBe('1px 2px')
}) })
describe('Fill-mode tests', () => { describe('Fill-mode tests', () => {
let browser let browser
...@@ -1187,55 +1178,6 @@ function runTests(mode) { ...@@ -1187,55 +1178,6 @@ function runTests(mode) {
}) })
} }
it('should have blurry placeholder when enabled', async () => {
const html = await renderViaHTTP(appPort, '/blurry-placeholder')
const $html = cheerio.load(html)
$html('noscript > img').attr('id', 'unused')
expect($html('#blurry-placeholder-raw')[0].attribs.style).toContain(
`color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http%3A//www.w3.org/2000/svg' viewBox='0 0 400 400'%3E%3Cfilter id='b' color-interpolation-filters='sRGB'%3E%3CfeGaussianBlur stdDeviation='20'/%3E%3C/filter%3E%3Cimage preserveAspectRatio='none' filter='url(%23b)' x='0' y='0' height='100%25' width='100%25' href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8P4nhDwAGuAKPn6cicwAAAABJRU5ErkJggg=='/%3E%3C/svg%3E")`
)
expect($html('#blurry-placeholder-with-lazy')[0].attribs.style).toContain(
`color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http%3A//www.w3.org/2000/svg' viewBox='0 0 400 400'%3E%3Cfilter id='b' color-interpolation-filters='sRGB'%3E%3CfeGaussianBlur stdDeviation='20'/%3E%3C/filter%3E%3Cimage preserveAspectRatio='none' filter='url(%23b)' x='0' y='0' height='100%25' width='100%25' href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mO0/8/wBwAE/wI85bEJ6gAAAABJRU5ErkJggg=='/%3E%3C/svg%3E")`
)
})
it('should remove blurry placeholder after image loads', async () => {
const browser = await webdriver(appPort, '/blurry-placeholder')
await check(
async () =>
await getComputedStyle(
browser,
'blurry-placeholder-raw',
'background-image'
),
'none'
)
expect(
await getComputedStyle(
browser,
'blurry-placeholder-with-lazy',
'background-image'
)
).toBe(
`url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http%3A//www.w3.org/2000/svg' viewBox='0 0 400 400'%3E%3Cfilter id='b' color-interpolation-filters='sRGB'%3E%3CfeGaussianBlur stdDeviation='20'/%3E%3C/filter%3E%3Cimage preserveAspectRatio='none' filter='url(%23b)' x='0' y='0' height='100%25' width='100%25' href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mO0/8/wBwAE/wI85bEJ6gAAAABJRU5ErkJggg=='/%3E%3C/svg%3E")`
)
await browser.eval('document.getElementById("spacer").remove()')
await check(
async () =>
await getComputedStyle(
browser,
'blurry-placeholder-with-lazy',
'background-image'
),
'none'
)
})
it('should be valid HTML', async () => { it('should be valid HTML', async () => {
let browser let browser
try { try {
......
...@@ -1301,7 +1301,7 @@ describe('Production Usage', () => { ...@@ -1301,7 +1301,7 @@ describe('Production Usage', () => {
}) })
} }
it('should remove placeholder for next/image correctly', async () => { it('should loading next/image correctly', async () => {
const browser = await webdriver(context.appPort, '/') const browser = await webdriver(context.appPort, '/')
await browser.eval(`(function() { await browser.eval(`(function() {
...@@ -1312,10 +1312,16 @@ describe('Production Usage', () => { ...@@ -1312,10 +1312,16 @@ describe('Production Usage', () => {
expect(await browser.eval('window.beforeNav')).toBe(1) expect(await browser.eval('window.beforeNav')).toBe(1)
await check( await check(async () => {
() => browser.elementByCss('img').getComputedCss('background-image'), const result = await browser.eval(
'none' `document.getElementById('static-image').width`
) )
if (result === 0) {
throw new Error('Incorrectly loaded image')
}
return 'result-correct'
}, /result-correct/)
await browser.eval(`(function() { await browser.eval(`(function() {
window.beforeNav = 1 window.beforeNav = 1
...@@ -1332,22 +1338,16 @@ describe('Production Usage', () => { ...@@ -1332,22 +1338,16 @@ describe('Production Usage', () => {
expect(await browser.eval('window.beforeNav')).toBe(1) expect(await browser.eval('window.beforeNav')).toBe(1)
await check( await check(async () => {
() => const result = await browser.eval(
browser `document.getElementById('static-image').width`
.elementByCss('#static-image') )
.getComputedCss('background-image'), if (result === 0) {
'none' throw new Error('Incorrectly loaded image')
) }
for (let i = 0; i < 5; i++) { return 'result-correct'
expect( }, /result-correct/)
await browser
.elementByCss('#static-image')
.getComputedCss('background-image')
).toBe('none')
await waitFor(500)
}
}) })
dynamicImportTests(context, (p, q) => renderViaHTTP(context.appPort, p, q)) dynamicImportTests(context, (p, q) => renderViaHTTP(context.appPort, p, q))
......
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