Blink: Throttle progressively loaded images.

third_party/WebKit/Source/core/fetch/ImageResourceTest.cpp

 /*
  * Copyright (c) 2013, Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 351 matching lines @@
   Vector<unsigned char> jpeg = jpegImage();
   cachedImage->responseReceived(
       ResourceResponse(KURL(), "image/jpeg", jpeg.size(), nullAtom, String()),
       nullptr);
   cachedImage->appendData(reinterpret_cast<const char*>(jpeg.data()),
                           jpeg.size());
   cachedImage->finish();
   EXPECT_FALSE(cachedImage->errorOccurred());
   ASSERT_TRUE(cachedImage->hasImage());
   EXPECT_FALSE(cachedImage->getImage()->isNull());
-  EXPECT_EQ(2, client->imageChangedCount());
+  EXPECT_EQ(1, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_TRUE(cachedImage->getImage()->isBitmapImage());
 }
 
 TEST(ImageResourceTest, ReloadIfLoFi) {
   KURL testURL(ParsedURLString, "http://www.test.com/cancelTest.html");
   URLTestHelpers::registerMockedURLLoad(testURL, "cancelTest.html",
                                         "text/html");
   ResourceRequest request = ResourceRequest(testURL);
   request.setLoFiState(WebURLRequest::LoFiOn);
@@ skipping 11 matching lines @@
                                     String());
   resourceResponse.addHTTPHeaderField("chrome-proxy", "q=low");
 
   cachedImage->responseReceived(resourceResponse, nullptr);
   cachedImage->appendData(reinterpret_cast<const char*>(jpeg.data()),
                           jpeg.size());
   cachedImage->finish();
   EXPECT_FALSE(cachedImage->errorOccurred());
   ASSERT_TRUE(cachedImage->hasImage());
   EXPECT_FALSE(cachedImage->getImage()->isNull());
-  EXPECT_EQ(2, client->imageChangedCount());
+  EXPECT_EQ(1, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_TRUE(cachedImage->getImage()->isBitmapImage());
   EXPECT_EQ(1, cachedImage->getImage()->width());
   EXPECT_EQ(1, cachedImage->getImage()->height());
 
   cachedImage->reloadIfLoFi(fetcher);
   EXPECT_FALSE(cachedImage->errorOccurred());
   EXPECT_FALSE(cachedImage->resourceBuffer());
   EXPECT_FALSE(cachedImage->hasImage());
-  EXPECT_EQ(3, client->imageChangedCount());
+  EXPECT_EQ(2, client->imageChangedCount());
 
   Vector<unsigned char> jpeg2 = jpegImage2();
   cachedImage->loader()->didReceiveResponse(
       nullptr, WrappedResourceResponse(resourceResponse), nullptr);
   cachedImage->loader()->didReceiveData(
       nullptr, reinterpret_cast<const char*>(jpeg2.data()), jpeg2.size(),
       jpeg2.size(), jpeg2.size());
   cachedImage->loader()->didFinishLoading(nullptr, 0.0, jpeg2.size());
   EXPECT_FALSE(cachedImage->errorOccurred());
   ASSERT_TRUE(cachedImage->hasImage());
@@ skipping 24 matching lines @@
   KURL url(ParsedURLString, "http://127.0.0.1:8000/foo");
   ImageResource* imageResource = ImageResource::create(ResourceRequest(url));
   Persistent<MockImageResourceClient> client =
       new MockImageResourceClient(imageResource);
 
   receiveResponse(imageResource, url, "image/jpeg", jpegImage());
 
   EXPECT_FALSE(imageResource->errorOccurred());
   ASSERT_TRUE(imageResource->hasImage());
   EXPECT_FALSE(imageResource->getImage()->isNull());
-  EXPECT_EQ(2, client->imageChangedCount());
+  EXPECT_EQ(1, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_TRUE(imageResource->getImage()->isBitmapImage());
   EXPECT_EQ(1, imageResource->getImage()->width());
   EXPECT_EQ(1, imageResource->getImage()->height());
 
   imageResource->setRevalidatingRequest(ResourceRequest(url));
   ResourceResponse response;
   response.setURL(url);
   response.setHTTPStatusCode(304);
 
   imageResource->responseReceived(response, nullptr);
 
   EXPECT_FALSE(imageResource->errorOccurred());
   ASSERT_TRUE(imageResource->hasImage());
   EXPECT_FALSE(imageResource->getImage()->isNull());
-  EXPECT_EQ(2, client->imageChangedCount());
+  EXPECT_EQ(1, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_TRUE(imageResource->getImage()->isBitmapImage());
   EXPECT_EQ(1, imageResource->getImage()->width());
   EXPECT_EQ(1, imageResource->getImage()->height());
 }
 
 TEST(ImageResourceTest, SuccessfulRevalidationSvg) {
   KURL url(ParsedURLString, "http://127.0.0.1:8000/foo");
   ImageResource* imageResource = ImageResource::create(ResourceRequest(url));
   Persistent<MockImageResourceClient> client =
@@ skipping 30 matching lines @@
   KURL url(ParsedURLString, "http://127.0.0.1:8000/foo");
   ImageResource* imageResource = ImageResource::create(ResourceRequest(url));
   Persistent<MockImageResourceClient> client =
       new MockImageResourceClient(imageResource);
 
   receiveResponse(imageResource, url, "image/jpeg", jpegImage());
 
   EXPECT_FALSE(imageResource->errorOccurred());
   ASSERT_TRUE(imageResource->hasImage());
   EXPECT_FALSE(imageResource->getImage()->isNull());
-  EXPECT_EQ(2, client->imageChangedCount());
+  EXPECT_EQ(1, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_TRUE(imageResource->getImage()->isBitmapImage());
   EXPECT_EQ(1, imageResource->getImage()->width());
   EXPECT_EQ(1, imageResource->getImage()->height());
 
   imageResource->setRevalidatingRequest(ResourceRequest(url));
   receiveResponse(imageResource, url, "image/jpeg", jpegImage2());
 
   EXPECT_FALSE(imageResource->errorOccurred());
   ASSERT_TRUE(imageResource->hasImage());
   EXPECT_FALSE(imageResource->getImage()->isNull());
-  EXPECT_EQ(4, client->imageChangedCount());
+  EXPECT_EQ(2, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_TRUE(imageResource->getImage()->isBitmapImage());
   EXPECT_EQ(50, imageResource->getImage()->width());
   EXPECT_EQ(50, imageResource->getImage()->height());
 }
 
 TEST(ImageResourceTest, FailedRevalidationJpegToSvg) {
   KURL url(ParsedURLString, "http://127.0.0.1:8000/foo");
   ImageResource* imageResource = ImageResource::create(ResourceRequest(url));
   Persistent<MockImageResourceClient> client =
       new MockImageResourceClient(imageResource);
 
   receiveResponse(imageResource, url, "image/jpeg", jpegImage());
 
   EXPECT_FALSE(imageResource->errorOccurred());
   ASSERT_TRUE(imageResource->hasImage());
   EXPECT_FALSE(imageResource->getImage()->isNull());
-  EXPECT_EQ(2, client->imageChangedCount());
+  EXPECT_EQ(1, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_TRUE(imageResource->getImage()->isBitmapImage());
   EXPECT_EQ(1, imageResource->getImage()->width());
   EXPECT_EQ(1, imageResource->getImage()->height());
 
   imageResource->setRevalidatingRequest(ResourceRequest(url));
   receiveResponse(imageResource, url, "image/svg+xml", svgImage());
 
   EXPECT_FALSE(imageResource->errorOccurred());
   ASSERT_TRUE(imageResource->hasImage());
   EXPECT_FALSE(imageResource->getImage()->isNull());
-  EXPECT_EQ(3, client->imageChangedCount());
+  EXPECT_EQ(2, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_FALSE(imageResource->getImage()->isBitmapImage());
   EXPECT_EQ(200, imageResource->getImage()->width());
   EXPECT_EQ(200, imageResource->getImage()->height());
 }
 
 TEST(ImageResourceTest, FailedRevalidationSvgToJpeg) {
   KURL url(ParsedURLString, "http://127.0.0.1:8000/foo");
   ImageResource* imageResource = ImageResource::create(ResourceRequest(url));
   Persistent<MockImageResourceClient> client =
       new MockImageResourceClient(imageResource);
 
   receiveResponse(imageResource, url, "image/svg+xml", svgImage());
 
   EXPECT_FALSE(imageResource->errorOccurred());
   ASSERT_TRUE(imageResource->hasImage());
   EXPECT_FALSE(imageResource->getImage()->isNull());
   EXPECT_EQ(1, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_FALSE(imageResource->getImage()->isBitmapImage());
   EXPECT_EQ(200, imageResource->getImage()->width());
   EXPECT_EQ(200, imageResource->getImage()->height());
 
   imageResource->setRevalidatingRequest(ResourceRequest(url));
   receiveResponse(imageResource, url, "image/jpeg", jpegImage());
 
   EXPECT_FALSE(imageResource->errorOccurred());
   ASSERT_TRUE(imageResource->hasImage());
   EXPECT_FALSE(imageResource->getImage()->isNull());
-  EXPECT_EQ(3, client->imageChangedCount());
+  EXPECT_EQ(2, client->imageChangedCount());
   EXPECT_TRUE(client->notifyFinishedCalled());
   EXPECT_TRUE(imageResource->getImage()->isBitmapImage());
   EXPECT_EQ(1, imageResource->getImage()->width());
   EXPECT_EQ(1, imageResource->getImage()->height());
 }
 
 TEST(ImageResourceTest, FailedRevalidationSvgToSvg) {
   KURL url(ParsedURLString, "http://127.0.0.1:8000/foo");
   ImageResource* imageResource = ImageResource::create(ResourceRequest(url));
   Persistent<MockImageResourceClient> client =
@@ skipping 71 matching lines @@
   FetchRequest request(testURL, FetchInitiatorInfo());
   ImageResource* cachedImage = ImageResource::fetch(request, fetcher);
   Platform::current()->getURLLoaderMockFactory()->unregisterURL(testURL);
 
   cachedImage->loader()->didReceiveResponse(
       nullptr, WrappedResourceResponse(ResourceResponse(
                    testURL, "image/jpeg", 18, nullAtom, String())),
       nullptr);
   cachedImage->loader()->didReceiveData(nullptr, "notactuallyanimage", 18, 18,
                                         18);
+  cachedImage->finish();

[pdr., 2016/10/05 23:24:25]

Why is this needed?

[vmpstr, 2016/10/05 23:48:17]

Without this, we don't try to decode the image, so we get a status of
Resource::Pending, instead of Resource::DecodeError.

   EXPECT_EQ(Resource::DecodeError, cachedImage->getStatus());
   EXPECT_FALSE(cachedImage->isLoading());
 }
 
+namespace {
+struct MockTime {
+  static double getTime() { return time; }
+  static double time;
+};
+
+double MockTime::time = 10.;
+}  // namespace
+
+TEST(ImageResourceTest, PeriodicFlushTest) {
+  KURL testURL(ParsedURLString, "http://www.test.com/cancelTest.html");
+  URLTestHelpers::registerMockedURLLoad(testURL, "cancelTest.html",
+                                        "text/html");
+  ResourceRequest request = ResourceRequest(testURL);
+  request.setLoFiState(WebURLRequest::LoFiOn);

[pdr., 2016/10/05 23:24:26]

Is this needed?

[vmpstr, 2016/10/05 23:48:17]

Nope :)

+  ImageResource* cachedImage = ImageResource::create(request);
+  cachedImage->setStatus(Resource::Pending);
+
+  Persistent<MockImageResourceClient> client =
+      new MockImageResourceClient(cachedImage);
+
+  // Send the image response.
+  Vector<unsigned char> jpeg = jpegImage2();
+  ResourceResponse resourceResponse(KURL(), "image/jpeg", jpeg.size(), nullAtom,
+                                    String());
+  resourceResponse.addHTTPHeaderField("chrome-proxy", "q=low");
+
+  cachedImage->responseReceived(resourceResponse, nullptr);
+
+  WTF::setTimeFunctionsForTesting(MockTime::getTime);
+
+  size_t meaningfulImageSize = 280;

[pdr., 2016/10/05 23:24:26]

Can you add a comment about where this number came from?

[vmpstr, 2016/10/05 23:48:17]

Done.

+  cachedImage->appendData(reinterpret_cast<const char*>(jpeg.data()),
+                          meaningfulImageSize);
+  size_t bytesSent = meaningfulImageSize;
+
+  EXPECT_FALSE(cachedImage->errorOccurred());
+  EXPECT_FALSE(cachedImage->hasImage());
+  EXPECT_EQ(0, client->imageChangedCount());
+
+  MockTime::time += 1.1;
+  cachedImage->appendData(
+      reinterpret_cast<const char*>(jpeg.data()) + bytesSent, 1);
+  ++bytesSent;
+
+  // Sanity check that we created an image after appending
+  // |meaningfulImageSize| + 1 bytes.
+  EXPECT_FALSE(cachedImage->errorOccurred());
+  ASSERT_TRUE(cachedImage->hasImage());
+  EXPECT_EQ(1, client->imageChangedCount());
+
+  for (int flushCount = 1; flushCount <= 3; ++flushCount) {
+    // For each of the iteration that appends data, we don't expect
+    // |imageChangeCount()| to change, since the time is adjusted by 0.2001
+    // seconds (it's greater than 0.2 to avoid double precision problems).
+    // After 5 appends, we breach the flush interval and the flush count
+    // increases.
+    for (int i = 0; i < 5; ++i) {
+      cachedImage->appendData(
+          reinterpret_cast<const char*>(jpeg.data()) + bytesSent, 1);
+
+      EXPECT_FALSE(cachedImage->errorOccurred());
+      ASSERT_TRUE(cachedImage->hasImage());
+      EXPECT_EQ(flushCount, client->imageChangedCount());
+
+      ++bytesSent;
+      MockTime::time += 0.2001;

[pdr., 2016/10/05 23:24:26]

If this ends up being flaky, we could just increment time by 0.1 within this
loop, and then increment it by a full second after the } (still inside the
flushCount loop).

[vmpstr, 2016/10/05 23:48:17]

I don't think it's flaky, it's just if I start with 10 and add 0.2 5 times, then
it still evaluates as < 11. But yeah, there are other things we could try.

+    }
+  }
+
+  // Increasing time by a large number only causes one extra flush.
+  MockTime::time += 10.f;
+  cachedImage->appendData(
+      reinterpret_cast<const char*>(jpeg.data()) + bytesSent, 1);
+  EXPECT_FALSE(cachedImage->errorOccurred());
+  ASSERT_TRUE(cachedImage->hasImage());
+  EXPECT_FALSE(cachedImage->getImage()->isNull());
+  EXPECT_EQ(4, client->imageChangedCount());
+
+  ++bytesSent;
+  // Append the rest of the data and finish (which causes another flush).
+  cachedImage->appendData(
+      reinterpret_cast<const char*>(jpeg.data()) + bytesSent,
+      jpeg.size() - bytesSent);
+  cachedImage->finish();
+
+  EXPECT_FALSE(cachedImage->errorOccurred());
+  ASSERT_TRUE(cachedImage->hasImage());
+  EXPECT_FALSE(cachedImage->getImage()->isNull());
+  EXPECT_EQ(5, client->imageChangedCount());
+  EXPECT_TRUE(client->notifyFinishedCalled());
+  EXPECT_TRUE(cachedImage->getImage()->isBitmapImage());
+  EXPECT_EQ(50, cachedImage->getImage()->width());
+  EXPECT_EQ(50, cachedImage->getImage()->height());
+}
+
 }  // namespace blink