Bug 1944122. Make sure the first (vector) part of a multipart images gets load complete. r=emilio

In bug 1862059 we ensured that every (vector) part of a multipart image got load complete before it was made the current part. This missed the first part because it was never the next part, it just become the current part immediately. This was good enough to fix all cases except where the multipart image reached a finite end point (which would then send the final part load complete and hit the same duplicate final part load complete bug).

Differential Revision: https://phabricator.services.mozilla.com/D241816
This commit is contained in:
Timothy Nikkel
2025-04-03 02:03:41 +00:00
parent c55933b247
commit 5d3111722f
5 changed files with 79 additions and 36 deletions

View File

@@ -18,6 +18,44 @@ namespace image {
// Helpers
///////////////////////////////////////////////////////////////////////////////
static void FinishPotentialVectorImage(Image* aImage) {
if (!aImage || aImage->GetType() != imgIContainer::TYPE_VECTOR) {
return;
}
// We only want to transition to or away from a part once it has reached
// load complete status, because if we don't then the progress tracker will
// send a fake load event with the lastpart bit set whenever an observer is
// removed without having the load complete progress. That fake load event
// with the lastpart bit set will get out of the multipart image and to the
// imgRequestProxy and further, which will make it look like we got the last
// part of the multipart image and confuse things. If we get here then we
// are still waiting for the load event for this image but we've gotten
// OnDataAvailable for the part after aImage. That means we must have
// gotten OnStopRequest for aImage; OnStopRequest calls
// OnImageDataComplete. For raster images that are part of a multipart
// image OnImageDataComplete will synchronously fire the load event
// because we synchronously perform the metadata decode in that function,
// because parts of multipart images have the transient flag set. So for
// raster images we are assured that the load event has happened by this
// point for aImage. For vector images there is no such luck because
// OnImageDataComplete needs to wait for the load event in the underlying
// svg document, which we can't force to happen synchronously. So we just
// send a fake load event for aImage. This shouldn't confuse anyone because
// the progress tracker won't send out another load event when the real load
// event comes because it's already in the progress. And nobody should be
// caring about load events on the current part of multipart images since
// they might be sent multiple times or might not be sent at all depending
// on timing. So this should be okay.
RefPtr<ProgressTracker> tracker = aImage->GetProgressTracker();
if (tracker && !(tracker->GetProgress() & FLAG_LOAD_COMPLETE)) {
Progress loadProgress =
LoadCompleteProgress(/* aLastPart = */ false, /* aError = */ false,
/* aStatus = */ NS_OK);
tracker->SyncNotifyProgress(loadProgress | FLAG_SIZE_AVAILABLE);
}
}
class NextPartObserver : public IProgressObserver {
public:
MOZ_DECLARE_REFCOUNTED_TYPENAME(NextPartObserver)
@@ -42,42 +80,9 @@ class NextPartObserver : public IProgressObserver {
mImage->RequestDecodeForSize(gfx::IntSize(0, 0),
imgIContainer::FLAG_SYNC_DECODE);
if (mImage && mImage->GetType() == imgIContainer::TYPE_VECTOR) {
// We don't want to make a pending part the current part until it has had
// it's load event because when we transition from the current part to the
// next part we remove the multipart image as an observer of the current
// part and the progress tracker will send a fake load event with the
// lastpart bit set whenever an observer is removed without having the
// load complete progress. That fake load event with the lastpart bit set
// will get out of the multipart image and to the imgRequestProxy and
// further, which will make it look like we got the last part of the
// multipart image and confuse things. If we get here then we are still
// waiting to make mNextPart the current part, but we've gotten
// OnDataAvailable for the part after mNextPart. That means we must have
// gotten OnStopRequest for mNextPart; OnStopRequest calls
// OnImageDataComplete. For raster images that are part of a multipart
// image OnImageDataComplete will synchronously fire the load event
// because we synchronously perform the metadata decode in that function,
// because parts of multipart images have the transient flag set. So for
// raster images we are assured that the load event has happened by this
// point for mNextPart. For vector images there is no such luck because
// OnImageDataComplete needs to wait for the load event in the underlying
// svg document, which we can't force to happen synchronously. So we just
// send a fake load event for mNextPart. We are the only listener for it
// right now so it won't confuse anyone. When the real load event comes,
// progress tracker won't send it out because it's already in the
// progress. And nobody should be caring about load events on the current
// part of multipart images since they might be sent multiple times or
// might not be sent at all depending on timing. So this should be okay.
RefPtr<ProgressTracker> tracker = mImage->GetProgressTracker();
if (tracker && !(tracker->GetProgress() & FLAG_LOAD_COMPLETE)) {
Progress loadProgress =
LoadCompleteProgress(/* aLastPart = */ false, /* aError = */ false,
/* aStatus = */ NS_OK);
tracker->SyncNotifyProgress(loadProgress | FLAG_SIZE_AVAILABLE);
}
}
// Vector images need special handling to make sure they are in a complete
// state.
FinishPotentialVectorImage(mImage);
// RequestDecodeForSize() should've sent synchronous notifications that
// would have caused us to call FinishObserving() (and null out mImage)
@@ -245,6 +250,12 @@ void MultipartImage::FinishTransition() {
return;
}
// Vector images need special handling to make sure they are in a complete
// state. (Only the first part can require this, subsequent parts have
// FinishPotentialVectorImage called on them before they become the current
// part.)
FinishPotentialVectorImage(InnerImage());
// Stop observing the current part.
{
RefPtr<ProgressTracker> currentPartTracker =

View File

@@ -0,0 +1,15 @@
<html class="reftest-wait">
<img src="1944122-1.svg"></img>
<script>
let numTimes = 200;
function doTest() {
numTimes--;
if (numTimes > 0) {
window.requestAnimationFrame(doTest);
} else {
document.documentElement.className = "";
}
}
window.addEventListener("MozReftestInvalidate", doTest);
</script>
</html>

View File

@@ -0,0 +1,13 @@
--BOUNDARYOMG
Content-Type: image/svg+xml; charset=utf-8
<svg width="256" height="256" xmlns="http://www.w3.org/2000/svg" fill="#F00"></svg>--BOUNDARYOMG
Content-Type: image/svg+xml; charset=utf-8
<svg width="256" height="256" xmlns="http://www.w3.org/2000/svg" fill="#F00"></svg>--BOUNDARYOMG
Content-Type: image/svg+xml; charset=utf-8
<svg width="256" height="256" xmlns="http://www.w3.org/2000/svg" fill="#F00"></svg>--BOUNDARYOMG
Content-Type: image/svg+xml; charset=utf-8
<svg width="256" height="256" xmlns="http://www.w3.org/2000/svg" fill="#F00"></svg>--BOUNDARYOMG--

View File

@@ -0,0 +1,3 @@
HTTP 200 OK
Content-Type: multipart/x-mixed-replace;boundary=BOUNDARYOMG
Cache-Control: no-cache

View File

@@ -85,3 +85,4 @@ load 1885209-1.html
load 1898606.jpg
load 1910211-1.avif
load 1943715-1.png
HTTP load 1944122-1.html