Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix onLoad prop in next/future/image #41374

Merged
merged 6 commits into from Oct 13, 2022
Merged

Fix onLoad prop in next/future/image #41374

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2a8c0fa
Fix `onLoad` prop in `next/future/image`
styfle Oct 12, 2022
2e883e0
Fix lint
styfle Oct 12, 2022
ba320a5
Merge branch 'canary' into fix-onload-next-future-image
styfle Oct 12, 2022
b61c197
onLoadRef
styfle Oct 13, 2022
d0938ee
optional chaining
styfle Oct 13, 2022
1b49bd3
rename test
styfle Oct 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 deletions packages/next/client/future/image.tsx
View file
Open in desktop
Expand Up @@ -357,10 +357,10 @@ const ImageElement = ({
if (!img) {
return
}
if (onError) {
// If the image has an error before react hydrates, then the error is lost.
if (onLoad || onError) {
// If the image loads or errors before react hydrates, then the event is lost.
// The workaround is to wait until the image is mounted which is after hydration,
// then we set the src again to trigger the error handler (if there was an error).
// then we set the src again to trigger the handler (if there was an event).
// eslint-disable-next-line no-self-assign
img.src = img.src
}
Expand Down Expand Up @@ -408,6 +408,7 @@ const ImageElement = ({
onLoadingCompleteRef,
setBlurComplete,
onError,
onLoad,
]
)}
onLoad={(event) => {
Expand Down
41 changes: 32 additions & 9 deletions test/integration/image-future/default/pages/on-load.js
View file
Open in desktop
Expand Up @@ -2,6 +2,7 @@ import { useState } from 'react'
import Image from 'next/future/image'

const Page = () => {
const [idToCount, setIdToCount] = useState({})
const [clicked, setClicked] = useState(false)

const red =
Expand All @@ -10,10 +11,7 @@ const Page = () => {
return (
<div>
<h1>Test onLoad</h1>
<p>
This is the native onLoad which doesn't work as many places as
onLoadingComplete
</p>
<p>This is the native onLoad</p>
<button id="toggle" onClick={() => setClicked(!clicked)}>
Toggle
</button>
Expand All @@ -23,6 +21,8 @@ const Page = () => {
src={clicked ? '/test.jpg' : red}
width="128"
height="128"
idToCount={idToCount}
setIdToCount={setIdToCount}
/>

<ImageWithMessage
Expand All @@ -31,43 +31,66 @@ const Page = () => {
placeholder={clicked ? 'blur' : 'empty'}
width="256"
height="256"
idToCount={idToCount}
setIdToCount={setIdToCount}
/>

<ImageWithMessage
id="3"
src={clicked ? '/test.svg' : red}
width="1200"
height="1200"
idToCount={idToCount}
setIdToCount={setIdToCount}
/>

<ImageWithMessage
id="4"
src={clicked ? '/test.ico' : red}
width={200}
height={200}
idToCount={idToCount}
setIdToCount={setIdToCount}
/>

<ImageWithMessage
id="5"
src={clicked ? '/wide.png' : red}
width="500"
height="500"
src="/wide.png"
width="600"
height="300"
idToCount={idToCount}
setIdToCount={setIdToCount}
/>

<ImageWithMessage
id="6"
src={red}
width="300"
height="300"
idToCount={idToCount}
setIdToCount={setIdToCount}
/>

<div id="footer" />
</div>
)
}

function ImageWithMessage({ id, ...props }) {
function ImageWithMessage({ id, idToCount, setIdToCount, ...props }) {
const [msg, setMsg] = useState('[LOADING]')

return (
<>
<div className="wrap">
<Image
id={`img${id}`}
alt={`img${id}`}
onLoad={(e) => {
setMsg(`loaded ${e.target.id} with native onLoad`)
let count = idToCount[id] || 0
count++
idToCount[id] = count
setIdToCount(idToCount)
setMsg(`loaded ${e.target.id} with native onLoad, count ${count}`)
}}
{...props}
/>
Expand Down
47 changes: 40 additions & 7 deletions test/integration/image-future/default/test/index.test.ts
View file
Open in desktop
Expand Up @@ -303,31 +303,33 @@ function runTests(mode) {
it('should callback native onLoad in most cases', async () => {
let browser = await webdriver(appPort, '/on-load')

await browser.eval('document.getElementById("toggle").click()')

await browser.eval(
`document.getElementById("footer").scrollIntoView({behavior: "smooth"})`
)

await check(
() => browser.eval(`document.getElementById("msg1").textContent`),
'loaded img1 with native onLoad'
'loaded img1 with native onLoad, count 1'
)
await check(
() => browser.eval(`document.getElementById("msg2").textContent`),
'loaded img2 with native onLoad'
'loaded img2 with native onLoad, count 1'
)
await check(
() => browser.eval(`document.getElementById("msg3").textContent`),
'loaded img3 with native onLoad'
'loaded img3 with native onLoad, count 1'
)
await check(
() => browser.eval(`document.getElementById("msg4").textContent`),
'loaded img4 with native onLoad'
'loaded img4 with native onLoad, count 1'
)
await check(
() => browser.eval(`document.getElementById("msg5").textContent`),
'loaded img5 with native onLoad'
'loaded img5 with native onLoad, count 1'
)
await check(
() => browser.eval(`document.getElementById("msg6").textContent`),
'loaded img6 with native onLoad, count 1'
)
await check(
() =>
Expand All @@ -337,6 +339,33 @@ function runTests(mode) {
'future'
)

await browser.eval('document.getElementById("toggle").click()')

await check(
() => browser.eval(`document.getElementById("msg1").textContent`),
'loaded img1 with native onLoad, count 2'
)
await check(
() => browser.eval(`document.getElementById("msg2").textContent`),
'loaded img2 with native onLoad, count 2'
)
await check(
() => browser.eval(`document.getElementById("msg3").textContent`),
'loaded img3 with native onLoad, count 2'
)
await check(
() => browser.eval(`document.getElementById("msg4").textContent`),
'loaded img4 with native onLoad, count 2'
)
await check(
() => browser.eval(`document.getElementById("msg5").textContent`),
'loaded img5 with native onLoad, count 1'
)
await check(
() => browser.eval(`document.getElementById("msg6").textContent`),
'loaded img6 with native onLoad, count 1'
)

await check(
() => browser.eval(`document.getElementById("img1").currentSrc`),
/test(.*)jpg/
Expand All @@ -357,6 +386,10 @@ function runTests(mode) {
() => browser.eval(`document.getElementById("img5").currentSrc`),
/wide.png/
)
await check(
() => browser.eval(`document.getElementById("img6").currentSrc`),
'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mO8ysv7HwAEngHwC+JqOgAAAABJRU5ErkJggg=='
)
})

it('should callback native onError when error occured while loading image', async () => {
Expand Down