Changeset 287849 in webkit

Timestamp:

Jan 10, 2022, 11:19:54 AM (5 years ago)

Author:

Wenson Hsieh

Message:

Modal container observer fails detection when rendered text is inserted after the container
​https://bugs.webkit.org/show_bug.cgi?id=234752
rdar://87200177

Reviewed by Tim Horton.

Source/WebCore:

Teach ModalContainerObserver to detect modal containers whose text content is set by script after the container
element itself has already been inserted into the document and laid out. See below for more details.

Test: ModalContainerObservation.DetectModalContainerAfterSettingText

• page/ModalContainerObserver.cpp:

(WebCore::searchForMatch):

Change this to return two bools: one indicating whether a match was found (i.e. the original return value),
and another indicating whether any rendered text was discovered in the process of searching. In the case where
the viewport-constrained element did not contain any rendered text at all, we avoid adding the element to the
m_elementsToIgnoreWhenSearching set, thereby allowing us to search it again in the future.

(WebCore::ModalContainerObserver::updateModalContainerIfNeeded):
(WebCore::containsMatchingText): Deleted.

Tools:

Add a new API test to exercise the change.

• TestWebKitAPI/Tests/WebKitCocoa/ModalContainerObservation.mm:

(TestWebKitAPI::TEST):

Location:

trunk

Files:

• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/page/ModalContainerObserver.cpp (modified) (3 diffs)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/ModalContainerObservation.mm (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2022-01-10  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        Modal container observer fails detection when rendered text is inserted after the container
+        https://bugs.webkit.org/show_bug.cgi?id=234752
+        rdar://87200177
+
+        Reviewed by Tim Horton.
+
+        Teach ModalContainerObserver to detect modal containers whose text content is set by script after the container
+        element itself has already been inserted into the document and laid out. See below for more details.
+
+        Test: ModalContainerObservation.DetectModalContainerAfterSettingText
+
+        * page/ModalContainerObserver.cpp:
+        (WebCore::searchForMatch):
+
+        Change this to return two `bool`s: one indicating whether a match was found (i.e. the original return value),
+        and another indicating whether any rendered text was discovered in the process of searching. In the case where
+        the viewport-constrained element did not contain any rendered text at all, we avoid adding the element to the
+        `m_elementsToIgnoreWhenSearching` set, thereby allowing us to search it again in the future.
+
+        (WebCore::ModalContainerObserver::updateModalContainerIfNeeded):
+        (WebCore::containsMatchingText): Deleted.
+
 2022-01-10  Alex Christensen  <achristensen@webkit.org>
 

trunk/Source/WebCore/page/ModalContainerObserver.cpp

@@ -148 +148 @@
 }
 
-static bool containsMatchingText(RenderLayerModelObject& renderer, const AtomString& searchTerm)
-{
+struct TextSearchResult {
+    bool foundMatch { false };
+    bool containsAnyText { false };
+};
+
+static TextSearchResult searchForMatch(RenderLayerModelObject& renderer, const AtomString& searchTerm)
+{
+    TextSearchResult result;
     for (auto& textRenderer : descendantsOfType<RenderText>(renderer)) {
-        if (RefPtr textNode = textRenderer.textNode(); textNode && matchesSearchTerm(*textNode, searchTerm))
-            return !isInsideNavigationElement(*textNode);
-    }
-    return false;
+        result.containsAnyText = true;
+        if (RefPtr textNode = textRenderer.textNode(); textNode && matchesSearchTerm(*textNode, searchTerm)) {
+            result.foundMatch = !isInsideNavigationElement(*textNode);
+            return result;
+        }
+    }
+    return result;
 }
 
@@ -214 +223 @@
             continue;
 
-        if (!m_elementsToIgnoreWhenSearching.add(*element).isNewEntry)
+        if (m_elementsToIgnoreWhenSearching.contains(*element))
             continue;
 
-        if (containsMatchingText(renderer, searchTerm)) {
+        auto [foundMatch, containsAnyText] = searchForMatch(renderer, searchTerm);
+
+        if (containsAnyText)
+            m_elementsToIgnoreWhenSearching.add(*element);
+
+        if (foundMatch) {
             setContainer(*element);
             return;
@@ -231 +245 @@
                 continue;
 
-            if (containsMatchingText(*renderView, searchTerm)) {
+            if (searchForMatch(*renderView, searchTerm).foundMatch) {
                 setContainer(*element, &frameOwner);
                 return;

trunk/Tools/ChangeLog

@@ +1 @@
+2022-01-10  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        Modal container observer fails detection when rendered text is inserted after the container
+        https://bugs.webkit.org/show_bug.cgi?id=234752
+        rdar://87200177
+
+        Reviewed by Tim Horton.
+
+        Add a new API test to exercise the change.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/ModalContainerObservation.mm:
+        (TestWebKitAPI::TEST):
+
 2022-01-10  Alex Christensen  <achristensen@webkit.org>
 

trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/ModalContainerObservation.mm

@@ -318 +318 @@
 }
 
+TEST(ModalContainerObservation, DetectModalContainerAfterSettingText)
+{
+    auto webView = createModalContainerWebView();
+    [webView loadBundlePage:@"modal-container-custom"];
+    [webView objectByEvaluatingJavaScript:@"show(`<div id='content'></div>`)"];
+    [webView waitForNextPresentationUpdate];
+    [webView evaluate:@"document.getElementById('content').innerHTML = `hello world <a href='#'>no</a>`" andDecidePolicy:_WKModalContainerDecisionHideAndIgnore];
+    EXPECT_FALSE([[webView contentsAsString] containsString:@"hello world"]);
+    EXPECT_EQ([webView lastModalContainerInfo].availableTypes, _WKModalContainerControlTypeNegative);
+}
+
 } // namespace TestWebKitAPI