Changeset 280980 in webkit

Timestamp:

Aug 12, 2021, 1:16:51 PM (5 years ago)

Author:

weinig@apple.com

Message:

Allow testing of the final UIView tree on iOS platforms
​https://bugs.webkit.org/show_bug.cgi?id=229016

Reviewed by Tim Horton.

Source/WebKit:

Test: remote-layer-tree/ios/uiview-tree-basic.html

• UIProcess/API/ios/WKWebViewPrivateForTestingIOS.h:
• UIProcess/API/ios/WKWebViewTestingIOS.mm:

(allowListedClassToString):
(dumpUIView):
(-[WKWebView _uiViewTreeAsText]):
Add partner SPI called _uiViewTreeAsText that dumps the WKWebView's
UIView tree as constructed via remote layer creation. It currently
dumps some basic properties of each view and uses an allow list of
class names so changes to implementation details in frameworks below
us, like UIKit, don't cause tests to fail.

Tools:

• TestRunnerShared/UIScriptContext/Bindings/UIScriptController.idl:
• TestRunnerShared/UIScriptContext/UIScriptController.h:

(WTR::UIScriptController::uiViewTreeAsText const):

• WebKitTestRunner/ios/UIScriptControllerIOS.h:
• WebKitTestRunner/ios/UIScriptControllerIOS.mm:

(WTR::UIScriptControllerIOS::uiViewTreeAsText const):
Pipe new _uiViewTreeAsText SPI through to UIScriptController, matching the pattern
established by scrollingTreeAsText.

LayoutTests:

• remote-layer-tree: Added.
• remote-layer-tree/ios: Added.
• remote-layer-tree/ios/uiview-tree-basic-expected.txt: Added.
• remote-layer-tree/ios/uiview-tree-basic.html: Added.

Add basic test case excercising UIView tree dumping to ensure
it is working properly.

• resources/ui-helper.js:

(window.UIHelper.getUIViewTree):
Add helper to use get the UIView tree as text.

• TestExpectations:
• platform/ios/TestExpectations:

Ensure these tests are only run on iOS.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/TestExpectations (modified) (1 diff)
• LayoutTests/platform/ios/TestExpectations (modified) (1 diff)
• LayoutTests/remote-layer-tree (added)
• LayoutTests/remote-layer-tree/ios (added)
• LayoutTests/remote-layer-tree/ios/uiview-tree-basic-expected.txt (added)
• LayoutTests/remote-layer-tree/ios/uiview-tree-basic.html (added)
• LayoutTests/resources/ui-helper.js (modified) (1 diff)
• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/UIProcess/API/ios/WKWebViewPrivateForTestingIOS.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/ios/WKWebViewTestingIOS.mm (modified) (2 diffs)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestRunnerShared/UIScriptContext/Bindings/UIScriptController.idl (modified) (1 diff)
• Tools/TestRunnerShared/UIScriptContext/UIScriptController.h (modified) (1 diff)
• Tools/WebKitTestRunner/ios/UIScriptControllerIOS.h (modified) (1 diff)
• Tools/WebKitTestRunner/ios/UIScriptControllerIOS.mm (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2021-08-12  Sam Weinig  <weinig@apple.com>
+
+        Allow testing of the final UIView tree on iOS platforms
+        https://bugs.webkit.org/show_bug.cgi?id=229016
+
+        Reviewed by Tim Horton.
+
+        * remote-layer-tree: Added.
+        * remote-layer-tree/ios: Added.
+        * remote-layer-tree/ios/uiview-tree-basic-expected.txt: Added.
+        * remote-layer-tree/ios/uiview-tree-basic.html: Added.
+        Add basic test case excercising UIView tree dumping to ensure
+        it is working properly.
+
+        * resources/ui-helper.js:
+        (window.UIHelper.getUIViewTree):
+        Add helper to use get the UIView tree as text.
+
+        * TestExpectations:
+        * platform/ios/TestExpectations:
+        Ensure these tests are only run on iOS.
+
 2021-08-12  Martin Robinson  <mrobinson@webkit.org>
 

trunk/LayoutTests/TestExpectations

@@ -83 +83 @@
 fast/media/ios [ Skip ]
 fast/dom/Range/mac [ Skip ]
+remote-layer-tree/ios [ Skip ]
 inspector/page/setScreenSizeOverride.html [ Skip ]
 

trunk/LayoutTests/platform/ios/TestExpectations

@@ -19 +19 @@
 quicklook [ Pass ]
 system-preview [ Pass ]
+remote-layer-tree/ios [ Pass ]
 swipe [ Pass ]
 http/tests/swipe [ Pass ]

trunk/LayoutTests/resources/ui-helper.js

@@ -1406 +1406 @@
             testRunner.runUIScript(`(() => {
                 return uiController.scrollingTreeAsText;
+            })()`, resolve);
+        });
+    }
+
+    static getUIViewTree()
+    {
+        if (!this.isWebKit2() || !this.isIOSFamily())
+            return Promise.resolve();
+
+        return new Promise(resolve => {
+            testRunner.runUIScript(`(() => {
+                return uiController.uiViewTreeAsText;
             })()`, resolve);
         });

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-08-12  Sam Weinig  <weinig@apple.com>
+
+        Allow testing of the final UIView tree on iOS platforms
+        https://bugs.webkit.org/show_bug.cgi?id=229016
+
+        Reviewed by Tim Horton.
+
+        Test: remote-layer-tree/ios/uiview-tree-basic.html
+
+        * UIProcess/API/ios/WKWebViewPrivateForTestingIOS.h:
+        * UIProcess/API/ios/WKWebViewTestingIOS.mm:
+        (allowListedClassToString):
+        (dumpUIView):
+        (-[WKWebView _uiViewTreeAsText]):
+        Add partner SPI called _uiViewTreeAsText that dumps the WKWebView's
+        UIView tree as constructed via remote layer creation. It currently
+        dumps some basic properties of each view and uses an allow list of
+        class names so changes to implementation details in frameworks below
+        us, like UIKit, don't cause tests to fail.
+
 2021-08-12  Jer Noble  <jer.noble@apple.com>
 

trunk/Source/WebKit/UIProcess/API/ios/WKWebViewPrivateForTestingIOS.h

@@ -44 +44 @@
 @property (nonatomic, readonly) CGRect _inputViewBoundsInWindow;
 @property (nonatomic, readonly) NSString *_scrollingTreeAsText;
+@property (nonatomic, readonly) NSString *_uiViewTreeAsText;
 @property (nonatomic, readonly) NSNumber *_stableStateOverride;
 @property (nonatomic, readonly) CGRect _dragCaretRect;

trunk/Source/WebKit/UIProcess/API/ios/WKWebViewTestingIOS.mm

@@ -42 +42 @@
 #import <WebCore/ColorSerialization.h>
 #import <WebCore/ElementContext.h>
+#import <wtf/SortedArrayMap.h>
+#import <wtf/text/TextStream.h>
 
 @implementation WKWebView (WKTestingIOS)
@@ -228 +230 @@
 }
 
+static String allowListedClassToString(UIView *view)
+{
+    static constexpr ComparableASCIILiteral allowedClassesArray[] = {
+        "UIView",
+        "WKBackdropView",
+        "WKCompositingView",
+        "WKContentView",
+        "WKModelView",
+        "WKRemoteView",
+        "WKScrollView",
+        "WKSeparatedModelView"
+        "WKShapeView",
+        "WKSimpleBackdropView",
+        "WKTransformView",
+        "WKUIRemoteView",
+        "WKWebView",
+        "_UILayerHostView",
+    };
+    static constexpr SortedArraySet allowedClasses { allowedClassesArray };
+
+    String classString { NSStringFromClass(view.class) };
+    if (allowedClasses.contains(classString))
+        return classString;
+    
+    ASSERT(classString != "WKCompositingView");
+    return makeString("<class not in allowed list of classes>");
+}
+
+static void dumpUIView(TextStream& ts, UIView *view)
+{
+    auto rectToString = [] (auto rect) {
+        return makeString("[x: ", rect.origin.x, " y: ", rect.origin.x, " width: ", rect.size.width, " height: ", rect.size.height, "]");
+    };
+
+    auto pointToString = [] (auto point) {
+        return makeString("[x: ", point.x, " y: ", point.x, "]");
+    };
+
+
+    ts << "view [class: " << allowListedClassToString(view) << "]";
+
+    ts.dumpProperty("layer bounds", rectToString(view.layer.bounds));
+    
+    if (view.layer.position.x != 0 || view.layer.position.y != 0)
+        ts.dumpProperty("layer position", pointToString(view.layer.position));
+    
+    if (view.layer.zPosition != 0)
+        ts.dumpProperty("layer zPosition", makeString(view.layer.zPosition));
+    
+    if (view.layer.anchorPoint.x != 0.5 || view.layer.anchorPoint.y != 0.5)
+        ts.dumpProperty("layer anchorPoint", pointToString(view.layer.anchorPoint));
+    
+    if (view.layer.anchorPointZ != 0)
+        ts.dumpProperty("layer anchorPointZ", makeString(view.layer.anchorPointZ));
+
+    if (view.subviews.count > 0) {
+        TextStream::GroupScope scope(ts);
+        ts << "subviews";
+        for (UIView *subview in view.subviews) {
+            TextStream::GroupScope scope(ts);
+            dumpUIView(ts, subview);
+        }
+    }
+}
+
+- (NSString *)_uiViewTreeAsText
+{
+    TextStream ts(TextStream::LineMode::MultipleLine);
+
+    {
+        TextStream::GroupScope scope(ts);
+        ts << "UIView tree root ";
+        dumpUIView(ts, self);
+    }
+
+    return ts.release();
+}
+
 - (NSNumber *)_stableStateOverride
 {

trunk/Tools/ChangeLog

@@ +1 @@
+2021-08-12  Sam Weinig  <weinig@apple.com>
+
+        Allow testing of the final UIView tree on iOS platforms
+        https://bugs.webkit.org/show_bug.cgi?id=229016
+
+        Reviewed by Tim Horton.
+
+        * TestRunnerShared/UIScriptContext/Bindings/UIScriptController.idl:
+        * TestRunnerShared/UIScriptContext/UIScriptController.h:
+        (WTR::UIScriptController::uiViewTreeAsText const):
+        * WebKitTestRunner/ios/UIScriptControllerIOS.h:
+        * WebKitTestRunner/ios/UIScriptControllerIOS.mm:
+        (WTR::UIScriptControllerIOS::uiViewTreeAsText const):
+        Pipe new _uiViewTreeAsText SPI through to UIScriptController, matching the pattern
+        established by scrollingTreeAsText.
+
 2021-08-12  Devin Rousso  <drousso@apple.com>
 

trunk/Tools/TestRunnerShared/UIScriptContext/Bindings/UIScriptController.idl

@@ -333 +333 @@
 
     readonly attribute DOMString scrollingTreeAsText;
+    readonly attribute DOMString uiViewTreeAsText;
 
     boolean mayContainEditableElementsInRect(unsigned long x, unsigned long y, unsigned long width, unsigned long height);

trunk/Tools/TestRunnerShared/UIScriptContext/UIScriptController.h

@@ -147 +147 @@
 
     virtual JSRetainPtr<JSStringRef> scrollingTreeAsText() const { notImplemented(); return nullptr; }
+    virtual JSRetainPtr<JSStringRef> uiViewTreeAsText() const { notImplemented(); return nullptr; }
 
     // Touches

trunk/Tools/WebKitTestRunner/ios/UIScriptControllerIOS.h

@@ -118 +118 @@
     JSObjectRef inputViewBounds() const override;
     JSRetainPtr<JSStringRef> scrollingTreeAsText() const override;
+    JSRetainPtr<JSStringRef> uiViewTreeAsText() const override;
     JSObjectRef propertiesOfLayerWithID(uint64_t layerID) const override;
     void simulateRotation(DeviceOrientation*, JSValueRef) override;

trunk/Tools/WebKitTestRunner/ios/UIScriptControllerIOS.mm

@@ -858 +858 @@
 }
 
+JSRetainPtr<JSStringRef> UIScriptControllerIOS::uiViewTreeAsText() const
+{
+    return adopt(JSStringCreateWithCFString((CFStringRef)[webView() _uiViewTreeAsText]));
+}
+
 JSObjectRef UIScriptControllerIOS::propertiesOfLayerWithID(uint64_t layerID) const
 {