third_party/blink/renderer/core/exported/web_meaningful_layouts_test.cc

// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/renderer/core/dom/document.h"
#include "third_party/blink/renderer/core/testing/sim/sim_compositor.h"
#include "third_party/blink/renderer/core/testing/sim/sim_request.h"
#include "third_party/blink/renderer/core/testing/sim/sim_test.h"
#include "third_party/blink/renderer/platform/testing/unit_test_helpers.h"

namespace blink {

class WebMeaningfulLayoutsTest : public SimTest {};

TEST_F(WebMeaningfulLayoutsTest, VisuallyNonEmptyTextCharacters) {
  SimRequest main_resource("https://example.com/index.html", "text/html");

  LoadURL("https://example.com/index.html");

  // Write 201 characters.
  const char* ten_characters = "0123456789";
  for (int i = 0; i < 20; ++i)
    main_resource.Write(ten_characters);
  main_resource.Write("!");

  main_resource.Finish();

  Compositor().BeginFrame();

  EXPECT_EQ(1, WebViewClient().VisuallyNonEmptyLayoutCount());
}

TEST_F(WebMeaningfulLayoutsTest, VisuallyNonEmptyTextCharactersEventually) {
  SimRequest main_resource("https://example.com/index.html", "text/html");

  LoadURL("https://example.com/index.html");

  // Write 200 characters.
  const char* ten_characters = "0123456789";
  for (int i = 0; i < 20; ++i)
    main_resource.Write(ten_characters);

  // Pump a frame mid-load.
  Compositor().BeginFrame();

  EXPECT_EQ(0, WebViewClient().VisuallyNonEmptyLayoutCount());

  // Write more than 200 characters.
  main_resource.Write("!");

  main_resource.Finish();

  // setting visually non-empty happens when the parsing finishes,
  // not as the character count goes over 200.
  Compositor().BeginFrame();

  EXPECT_EQ(1, WebViewClient().VisuallyNonEmptyLayoutCount());
}

// TODO(dglazkov): Write pixel-count and canvas-based VisuallyNonEmpty tests

TEST_F(WebMeaningfulLayoutsTest, VisuallyNonEmptyMissingPump) {
  SimRequest main_resource("https://example.com/index.html", "text/html");

  LoadURL("https://example.com/index.html");

  // Write <200 characters.
  main_resource.Write("less than 200 characters.");

  Compositor().BeginFrame();

  main_resource.Finish();

  // Even though the layout state is clean ...
  EXPECT_TRUE(GetDocument().Lifecycle().GetState() >=
              DocumentLifecycle::kLayoutClean);

  // We should still generate a request for another (possibly last) frame.
  EXPECT_TRUE(Compositor().NeedsBeginFrame());

  // ... which we (the scheduler) happily provide.
  Compositor().BeginFrame();

  // ... which correctly signals the VisuallyNonEmpty.
  EXPECT_EQ(1, WebViewClient().VisuallyNonEmptyLayoutCount());
}

TEST_F(WebMeaningfulLayoutsTest, FinishedParsing) {
  SimRequest main_resource("https://example.com/index.html", "text/html");

  LoadURL("https://example.com/index.html");

  main_resource.Complete("content");

  Compositor().BeginFrame();

  EXPECT_EQ(1, WebViewClient().FinishedParsingLayoutCount());
}

TEST_F(WebMeaningfulLayoutsTest, FinishedLoading) {
  SimRequest main_resource("https://example.com/index.html", "text/html");

  LoadURL("https://example.com/index.html");

  main_resource.Complete("content");

  Compositor().BeginFrame();

  EXPECT_EQ(1, WebViewClient().FinishedLoadingLayoutCount());
}

TEST_F(WebMeaningfulLayoutsTest, FinishedParsingThenLoading) {
  SimRequest main_resource("https://example.com/index.html", "text/html");
  SimSubresourceRequest image_resource("https://example.com/cat.png",
                                       "image/png");

  LoadURL("https://example.com/index.html");

  main_resource.Complete("<img src=cat.png>");

  Compositor().BeginFrame();

  EXPECT_EQ(1, WebViewClient().FinishedParsingLayoutCount());
  EXPECT_EQ(0, WebViewClient().FinishedLoadingLayoutCount());

  image_resource.Complete("image data");

  // Pump the message loop to process the image loading task.
  test::RunPendingTasks();

  Compositor().BeginFrame();

  EXPECT_EQ(1, WebViewClient().FinishedParsingLayoutCount());
  EXPECT_EQ(1, WebViewClient().FinishedLoadingLayoutCount());
}

TEST_F(WebMeaningfulLayoutsTest, WithIFrames) {
  SimRequest main_resource("https://example.com/index.html", "text/html");
  SimRequest iframe_resource("https://example.com/iframe.html", "text/html");

  LoadURL("https://example.com/index.html");

  main_resource.Complete("<iframe src=iframe.html></iframe>");

  Compositor().BeginFrame();

  EXPECT_EQ(1, WebViewClient().VisuallyNonEmptyLayoutCount());
  EXPECT_EQ(1, WebViewClient().FinishedParsingLayoutCount());
  EXPECT_EQ(0, WebViewClient().FinishedLoadingLayoutCount());

  iframe_resource.Complete("iframe data");

  // Pump the message loop to process the iframe loading task.
  test::RunPendingTasks();

  Compositor().BeginFrame();

  EXPECT_EQ(1, WebViewClient().VisuallyNonEmptyLayoutCount());
  EXPECT_EQ(1, WebViewClient().FinishedParsingLayoutCount());
  EXPECT_EQ(1, WebViewClient().FinishedLoadingLayoutCount());
}

// NoOverflowInIncrementVisuallyNonEmptyPixelCount tests fail if the number of
// pixels is calculated in 32-bit integer, because 65536 * 65536 would become 0
// if it was calculated in 32-bit and thus it would be considered as empty.
TEST_F(WebMeaningfulLayoutsTest,
       NoOverflowInIncrementVisuallyNonEmptyPixelCount) {
  SimRequest main_resource("https://example.com/test.html", "text/html");
  SimSubresourceRequest svg_resource("https://example.com/test.svg",
                                     "image/svg+xml");

  LoadURL("https://example.com/test.html");

  main_resource.Write("<DOCTYPE html><body><img src=\"test.svg\">");
  // Run pending tasks to initiate the request to test.svg.
  test::RunPendingTasks();
  EXPECT_EQ(0, WebViewClient().VisuallyNonEmptyLayoutCount());

  // We serve the SVG file and check visuallyNonEmptyLayoutCount() before
  // mainResource.finish() because finishing the main resource causes
  // |FrameView::m_isVisuallyNonEmpty| to be true and
  // visuallyNonEmptyLayoutCount() to be 1 irrespective of the SVG sizes.
  svg_resource.Start();
  svg_resource.Write(
      "<svg xmlns=\"http://www.w3.org/2000/svg\" height=\"65536\" "
      "width=\"65536\"></svg>");
  svg_resource.Finish();
  Compositor().BeginFrame();
  EXPECT_EQ(1, WebViewClient().VisuallyNonEmptyLayoutCount());

  main_resource.Finish();
}

// A pending stylesheet in the head is render-blocking and will be considered
// a pending stylesheet if a layout is triggered before it loads.
TEST_F(WebMeaningfulLayoutsTest, LayoutWithPendingRenderBlockingStylesheet) {
  SimRequest main_resource("https://example.com/index.html", "text/html");
  SimSubresourceRequest style_resource("https://example.com/style.css",
                                       "text/css");

  LoadURL("https://example.com/index.html");

  main_resource.Complete(
      "<html><head>"
      "<link rel=\"stylesheet\" href=\"style.css\">"
      "</head><body></body></html>");

  GetDocument().UpdateStyleAndLayoutTree();
  EXPECT_FALSE(GetDocument().IsRenderingReady());

  style_resource.Complete("");
  EXPECT_TRUE(GetDocument().IsRenderingReady());
}

// A pending stylesheet in the body is not render-blocking and should not
// be considered a pending stylesheet if a layout is triggered before it loads.
TEST_F(WebMeaningfulLayoutsTest, LayoutWithPendingScriptBlockingStylesheet) {
  SimRequest main_resource("https://example.com/index.html", "text/html");
  SimSubresourceRequest style_resource("https://example.com/style.css",
                                       "text/css");

  LoadURL("https://example.com/index.html");

  main_resource.Complete(
      "<html><head></head><body>"
      "<link rel=\"stylesheet\" href=\"style.css\">"
      "</body></html>");

  GetDocument().UpdateStyleAndLayoutTreeIgnorePendingStylesheets();
  EXPECT_FALSE(GetDocument().DidLayoutWithPendingStylesheets());

  style_resource.Complete("");
}

// A pending import in the head is render-blocking and will be treated like
// a pending stylesheet if a layout is triggered before it loads.
TEST_F(WebMeaningfulLayoutsTest, LayoutWithPendingImportInHead) {
  SimRequest main_resource("https://example.com/index.html", "text/html");
  SimSubresourceRequest import_resource("https://example.com/import.html",
                                        "text/html");

  LoadURL("https://example.com/index.html");

  main_resource.Complete(
      "<html><head>"
      "<link rel=\"import\" href=\"import.html\">"
      "</head><body></body></html>");

  GetDocument().UpdateStyleAndLayoutTree();
  EXPECT_FALSE(GetDocument().IsRenderingReady());

  import_resource.Complete("");
  // Pump the HTMLImportTreeRoot::RecalcTimerFired task.
  test::RunPendingTasks();
  EXPECT_TRUE(GetDocument().IsRenderingReady());
}

// A pending import in the body is render-blocking and will be treated like
// a pending stylesheet if a layout is triggered before it loads.
TEST_F(WebMeaningfulLayoutsTest, LayoutWithPendingImportInBody) {
  SimRequest main_resource("https://example.com/index.html", "text/html");
  SimSubresourceRequest import_resource("https://example.com/import.html",
                                        "text/html");

  LoadURL("https://example.com/index.html");

  main_resource.Complete(
      "<html><head></head><body>"
      "<link rel=\"import\" href=\"import.html\">"
      "</body></html>");

  GetDocument().UpdateStyleAndLayoutTree();
  EXPECT_FALSE(GetDocument().IsRenderingReady());

  import_resource.Complete("");
  // Pump the HTMLImportTreeRoot::RecalcTimerFired task.
  test::RunPendingTasks();
  EXPECT_TRUE(GetDocument().IsRenderingReady());
}

}  // namespace blink