Fix caret paint invalidation issues

third_party/WebKit/Source/core/editing/CaretDisplayItemClientTest.cpp

 // Copyright 2017 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 "core/HTMLNames.h"
 #include "core/editing/FrameSelection.h"
 #include "core/frame/FrameView.h"
 #include "core/layout/LayoutTestHelper.h"
 #include "core/layout/LayoutView.h"
 #include "core/page/FocusController.h"
@@ skipping 32 matching lines @@
     return text;
   }
 
   Element* appendBlock(const String& data) {
     Element* block = document().createElement("div");
     Text* text = document().createTextNode(data);
     block->appendChild(text);
     document().body()->appendChild(block);
     return block;
   }
+
+  void updateAllLifecyclePhases() {
+    // Partial lifecycle updates should not affect caret paint invalidation.
+    document().view()->updateLifecycleToLayoutClean();

[Xianzhu, 2017/03/08 17:07:05]

This is to reproduce the bug situation about partial lifecycle update. The tests
would fail with it without the other changes in this CL.

+    document().view()->updateAllLifecyclePhases();
+    // Partial lifecycle updates should not affect caret paint invalidation.
+    document().view()->updateLifecycleToLayoutClean();
+  }
 };
 
 TEST_F(CaretDisplayItemClientTest, CaretPaintInvalidation) {
   document().body()->setContentEditable("true", ASSERT_NO_EXCEPTION);
   document().page()->focusController().setActive(true);
   document().page()->focusController().setFocused(true);
 
   Text* text = appendTextNode("Hello, World!");
-  document().view()->updateAllLifecyclePhases();
+  updateAllLifecyclePhases();
   const auto* block = toLayoutBlock(document().body()->layoutObject());
 
   // Focus the body. Should invalidate the new caret.
   document().view()->setTracksPaintInvalidations(true);
   document().body()->focus();
-  document().view()->updateAllLifecyclePhases();
+  updateAllLifecyclePhases();
   EXPECT_TRUE(block->shouldPaintCursorCaret());
 
   LayoutRect caretVisualRect = caretDisplayItemClient().visualRect();
   EXPECT_EQ(1, caretVisualRect.width());
   EXPECT_EQ(block->location(), caretVisualRect.location());
 
   const auto* rasterInvalidations =
       &getRasterInvalidationTracking()->trackedRasterInvalidations;
   ASSERT_EQ(1u, rasterInvalidations->size());
   EXPECT_EQ(enclosingIntRect(caretVisualRect), (*rasterInvalidations)[0].rect);
   EXPECT_EQ(block, (*rasterInvalidations)[0].client);
   EXPECT_EQ(PaintInvalidationCaret, (*rasterInvalidations)[0].reason);
 
   std::unique_ptr<JSONArray> objectInvalidations =
       document().view()->trackedObjectPaintInvalidationsAsJSON();
   ASSERT_EQ(1u, objectInvalidations->size());
   String s;
   JSONObject::cast(objectInvalidations->at(0))->get("object")->asString(&s);
   EXPECT_EQ("Caret", s);
   document().view()->setTracksPaintInvalidations(false);
 
   // Move the caret to the end of the text. Should invalidate both the old and
   // new carets.
   document().view()->setTracksPaintInvalidations(true);
   selection().setSelection(
       SelectionInDOMTree::Builder().collapse(Position(text, 5)).build());
-  document().view()->updateAllLifecyclePhases();
+  updateAllLifecyclePhases();
   EXPECT_TRUE(block->shouldPaintCursorCaret());
 
   LayoutRect newCaretVisualRect = caretDisplayItemClient().visualRect();
   EXPECT_EQ(caretVisualRect.size(), newCaretVisualRect.size());
   EXPECT_EQ(caretVisualRect.y(), newCaretVisualRect.y());
   EXPECT_LT(caretVisualRect.x(), newCaretVisualRect.x());
 
   rasterInvalidations =
       &getRasterInvalidationTracking()->trackedRasterInvalidations;
   ASSERT_EQ(2u, rasterInvalidations->size());
   EXPECT_EQ(enclosingIntRect(caretVisualRect), (*rasterInvalidations)[0].rect);
   EXPECT_EQ(block, (*rasterInvalidations)[0].client);
   EXPECT_EQ(PaintInvalidationCaret, (*rasterInvalidations)[0].reason);
   EXPECT_EQ(enclosingIntRect(newCaretVisualRect),
             (*rasterInvalidations)[1].rect);
   EXPECT_EQ(block, (*rasterInvalidations)[1].client);
   EXPECT_EQ(PaintInvalidationCaret, (*rasterInvalidations)[1].reason);
 
   objectInvalidations =
       document().view()->trackedObjectPaintInvalidationsAsJSON();
   ASSERT_EQ(1u, objectInvalidations->size());
   JSONObject::cast(objectInvalidations->at(0))->get("object")->asString(&s);
   EXPECT_EQ("Caret", s);
   document().view()->setTracksPaintInvalidations(false);
 
   // Remove selection. Should invalidate the old caret.
   LayoutRect oldCaretVisualRect = newCaretVisualRect;
   document().view()->setTracksPaintInvalidations(true);
   selection().setSelection(SelectionInDOMTree());
-  document().view()->updateAllLifecyclePhases();
+  updateAllLifecyclePhases();
   EXPECT_FALSE(block->shouldPaintCursorCaret());
   EXPECT_EQ(LayoutRect(), caretDisplayItemClient().visualRect());
 
   rasterInvalidations =
       &getRasterInvalidationTracking()->trackedRasterInvalidations;
   ASSERT_EQ(1u, rasterInvalidations->size());
   EXPECT_EQ(enclosingIntRect(oldCaretVisualRect),
             (*rasterInvalidations)[0].rect);
   EXPECT_EQ(block, (*rasterInvalidations)[0].client);
 
   objectInvalidations =
       document().view()->trackedObjectPaintInvalidationsAsJSON();
   ASSERT_EQ(1u, objectInvalidations->size());
   JSONObject::cast(objectInvalidations->at(0))->get("object")->asString(&s);
   EXPECT_EQ("Caret", s);
   document().view()->setTracksPaintInvalidations(false);
 }
 
 TEST_F(CaretDisplayItemClientTest, CaretMovesBetweenBlocks) {
   document().body()->setContentEditable("true", ASSERT_NO_EXCEPTION);
   document().page()->focusController().setActive(true);
   document().page()->focusController().setFocused(true);
   auto* blockElement1 = appendBlock("Block1");
   auto* blockElement2 = appendBlock("Block2");
-  document().view()->updateAllLifecyclePhases();
+  updateAllLifecyclePhases();
   auto* block1 = toLayoutBlock(blockElement1->layoutObject());
   auto* block2 = toLayoutBlock(blockElement2->layoutObject());
 
   // Focus the body.
   document().body()->focus();
-  document().view()->updateAllLifecyclePhases();
+  updateAllLifecyclePhases();
   LayoutRect caretVisualRect1 = caretDisplayItemClient().visualRect();
   EXPECT_EQ(1, caretVisualRect1.width());
   EXPECT_EQ(block1->visualRect().location(), caretVisualRect1.location());
   EXPECT_TRUE(block1->shouldPaintCursorCaret());
   EXPECT_FALSE(block2->shouldPaintCursorCaret());
 
   // Move the caret into block2. Should invalidate both the old and new carets.
   document().view()->setTracksPaintInvalidations(true);
   selection().setSelection(SelectionInDOMTree::Builder()
                                .collapse(Position(blockElement2, 0))
                                .build());
-  document().view()->updateAllLifecyclePhases();
+  updateAllLifecyclePhases();
 
   LayoutRect caretVisualRect2 = caretDisplayItemClient().visualRect();
   EXPECT_EQ(1, caretVisualRect2.width());
   EXPECT_EQ(block2->visualRect().location(), caretVisualRect2.location());
   EXPECT_FALSE(block1->shouldPaintCursorCaret());
   EXPECT_TRUE(block2->shouldPaintCursorCaret());
 
   const auto* rasterInvalidations =
       &getRasterInvalidationTracking()->trackedRasterInvalidations;
   ASSERT_EQ(2u, rasterInvalidations->size());
   EXPECT_EQ(enclosingIntRect(caretVisualRect1), (*rasterInvalidations)[0].rect);
   EXPECT_EQ(block1, (*rasterInvalidations)[0].client);
   EXPECT_EQ(PaintInvalidationCaret, (*rasterInvalidations)[0].reason);
   EXPECT_EQ(enclosingIntRect(caretVisualRect2), (*rasterInvalidations)[1].rect);
   EXPECT_EQ(block2, (*rasterInvalidations)[1].client);
   EXPECT_EQ(PaintInvalidationCaret, (*rasterInvalidations)[1].reason);
 
   std::unique_ptr<JSONArray> objectInvalidations =
       document().view()->trackedObjectPaintInvalidationsAsJSON();
   ASSERT_EQ(2u, objectInvalidations->size());
   document().view()->setTracksPaintInvalidations(false);
 
   // Move the caret back into block1.
   document().view()->setTracksPaintInvalidations(true);
   selection().setSelection(SelectionInDOMTree::Builder()
                                .collapse(Position(blockElement1, 0))
                                .build());
-  document().view()->updateAllLifecyclePhases();
+  updateAllLifecyclePhases();
 
   EXPECT_EQ(caretVisualRect1, caretDisplayItemClient().visualRect());
   EXPECT_TRUE(block1->shouldPaintCursorCaret());
   EXPECT_FALSE(block2->shouldPaintCursorCaret());
 
   rasterInvalidations =
       &getRasterInvalidationTracking()->trackedRasterInvalidations;
   ASSERT_EQ(2u, rasterInvalidations->size());
   EXPECT_EQ(enclosingIntRect(caretVisualRect1), (*rasterInvalidations)[0].rect);
   EXPECT_EQ(block1, (*rasterInvalidations)[0].client);
   EXPECT_EQ(PaintInvalidationCaret, (*rasterInvalidations)[0].reason);
   EXPECT_EQ(enclosingIntRect(caretVisualRect2), (*rasterInvalidations)[1].rect);
   EXPECT_EQ(block2, (*rasterInvalidations)[1].client);
   EXPECT_EQ(PaintInvalidationCaret, (*rasterInvalidations)[1].reason);
 
   objectInvalidations =
       document().view()->trackedObjectPaintInvalidationsAsJSON();
   ASSERT_EQ(2u, objectInvalidations->size());
   document().view()->setTracksPaintInvalidations(false);
 }
 
 }  // namespace blink