Browser+WebContent+WebDriver: Move Get Element Rect to WebContent

Author: https://github.com/trflynn89
Commit: https://github.com/SerenityOS/serenity/commit/30d6a73d0e
Pull-request: https://github.com/SerenityOS/serenity/pull/16007

Userland/Applications/Browser/BrowserWindow.cpp

@@ -611,10 +611,6 @@ void BrowserWindow::create_new_tab(URL url, bool activate)
         active_tab().view().scroll_element_into_view(element_id);
     };
 
-    new_tab.webdriver_endpoints().on_get_element_rect = [this](i32 element_id) {
-        return active_tab().view().get_element_rect(element_id);
-    };
-
     new_tab.webdriver_endpoints().on_is_element_enabled = [this](i32 element_id) {
         return active_tab().view().is_element_enabled(element_id);
     };

Userland/Applications/Browser/WebDriverConnection.cpp

@@ -146,17 +146,6 @@ void WebDriverConnection::scroll_element_into_view(i32 element_id)
     }
 }
 
-Messages::WebDriverSessionClient::GetElementRectResponse WebDriverConnection::get_element_rect(i32 element_id)
-{
-    dbgln("WebDriverConnection: get_element_rect {}", element_id);
-    if (auto browser_window = m_browser_window.strong_ref()) {
-        auto& tab = browser_window->active_tab();
-        if (tab.webdriver_endpoints().on_get_element_rect)
-            return { tab.webdriver_endpoints().on_get_element_rect(element_id) };
-    }
-    return { {} };
-}
-
 Messages::WebDriverSessionClient::IsElementEnabledResponse WebDriverConnection::is_element_enabled(i32 element_id)
 {
     dbgln("WebDriverConnection: is_element_enabled {}", element_id);

Userland/Applications/Browser/WebDriverConnection.h

@@ -49,7 +49,6 @@ public:
     virtual void add_cookie(Web::Cookie::ParsedCookie const&) override;
     virtual void update_cookie(Web::Cookie::Cookie const&) override;
     virtual void scroll_element_into_view(i32 element_id) override;
-    virtual Messages::WebDriverSessionClient::GetElementRectResponse get_element_rect(i32 element_id) override;
     virtual Messages::WebDriverSessionClient::IsElementEnabledResponse is_element_enabled(i32 element_id) override;
     virtual Messages::WebDriverSessionClient::TakeScreenshotResponse take_screenshot() override;
     virtual Messages::WebDriverSessionClient::TakeElementScreenshotResponse take_element_screenshot(i32 element_id) override;

Userland/Applications/Browser/WebDriverEndpoints.h

@@ -24,7 +24,6 @@ public:
     ~WebDriverEndpoints() = default;
 
     Function<void(i32 element_id)> on_scroll_element_into_view;
-    Function<Gfx::IntRect(i32 element_id)> on_get_element_rect;
     Function<bool(i32 element_id)> on_is_element_enabled;
     Function<Gfx::ShareableBitmap(i32 element_id)> on_take_element_screenshot;
     Function<String()> on_serialize_source;

Userland/Applications/Browser/WebDriverSessionClient.ipc

@@ -25,7 +25,6 @@ endpoint WebDriverSessionClient {
     add_cookie(Web::Cookie::ParsedCookie cookie) =|
     update_cookie(Web::Cookie::Cookie cookie) =|
     scroll_element_into_view(i32 element_id) => ()
-    get_element_rect(i32 element_id) => (Gfx::IntRect rect)
     is_element_enabled(i32 element_id) => (bool enabled)
     take_screenshot() => (Gfx::ShareableBitmap data)
     take_element_screenshot(i32 element_id) => (Gfx::ShareableBitmap data)

Userland/Libraries/LibWebView/OutOfProcessWebView.cpp

@@ -559,11 +559,6 @@ void OutOfProcessWebView::scroll_element_into_view(i32 element_id)
     return client().scroll_element_into_view(element_id);
 }
 
-Gfx::IntRect OutOfProcessWebView::get_element_rect(i32 element_id)
-{
-    return client().get_element_rect(element_id);
-}
-
 bool OutOfProcessWebView::is_element_enabled(i32 element_id)
 {
     return client().is_element_enabled(element_id);

Userland/Libraries/LibWebView/OutOfProcessWebView.h

@@ -64,7 +64,6 @@ public:
     OrderedHashMap<String, String> get_session_storage_entries();
 
     void scroll_element_into_view(i32 element_id);
-    Gfx::IntRect get_element_rect(i32 element_id);
     bool is_element_enabled(i32 element_id);
 
     void set_content_filters(Vector<String>);

Userland/Services/WebContent/ConnectionFromClient.cpp

@@ -525,15 +525,6 @@ static Gfx::IntRect calculate_absolute_rect_of_element(Web::Page const& page, We
     };
 }
 
-Messages::WebContentServer::GetElementRectResponse ConnectionFromClient::get_element_rect(i32 element_id)
-{
-    auto element = find_element_by_id(element_id);
-    if (!element.has_value())
-        return { {} };
-
-    return { calculate_absolute_rect_of_element(page(), *element) };
-}
-
 Messages::WebContentServer::IsElementEnabledResponse ConnectionFromClient::is_element_enabled(i32 element_id)
 {
     auto element = find_element_by_id(element_id);

Userland/Services/WebContent/ConnectionFromClient.h

@@ -84,7 +84,6 @@ private:
     virtual void js_console_request_messages(i32) override;
 
     virtual void scroll_element_into_view(i32 element_id) override;
-    virtual Messages::WebContentServer::GetElementRectResponse get_element_rect(i32 element_id) override;
     virtual Messages::WebContentServer::IsElementEnabledResponse is_element_enabled(i32 element_id) override;
     virtual Messages::WebContentServer::TakeElementScreenshotResponse take_element_screenshot(i32 element_id) override;
     virtual Messages::WebContentServer::TakeDocumentScreenshotResponse take_document_screenshot() override;

Userland/Services/WebContent/WebContentServer.ipc

@@ -43,7 +43,6 @@ endpoint WebContentServer
     js_console_request_messages(i32 start_index) =|
 
     scroll_element_into_view(i32 element_id) => ()
-    get_element_rect(i32 element_id) => (Gfx::IntRect rect)
     is_element_enabled(i32 element_id) => (bool enabled)
     take_element_screenshot(i32 element_id) => (Gfx::ShareableBitmap data)
     take_document_screenshot() => (Gfx::ShareableBitmap data)

Userland/Services/WebContent/WebDriverClient.ipc

@@ -19,4 +19,5 @@ endpoint WebDriverClient {
     get_element_css_value(String element_id, String name) => (Web::WebDriver::Response response)
     get_element_text(String element_id) => (Web::WebDriver::Response response)
     get_element_tag_name(String element_id) => (Web::WebDriver::Response response)
+    get_element_rect(String element_id) => (Web::WebDriver::Response response)
 }

Userland/Services/WebContent/WebDriverConnection.cpp

@@ -17,6 +17,7 @@
 #include <LibWeb/CSS/StyleValue.h>
 #include <LibWeb/DOM/Document.h>
 #include <LibWeb/DOM/Element.h>
+#include <LibWeb/Geometry/DOMRect.h>
 #include <LibWeb/HTML/AttributeNames.h>
 #include <LibWeb/HTML/BrowsingContext.h>
 #include <LibWeb/HTML/HTMLInputElement.h>
@@ -58,6 +59,37 @@ static Gfx::IntRect compute_window_rect(Web::Page const& page)
     };
 }
 
+// https://w3c.github.io/webdriver/#dfn-calculate-the-absolute-position
+static Gfx::IntPoint calculate_absolute_position_of_element(Web::Page const& page, JS::NonnullGCPtr<Web::Geometry::DOMRect> rect)
+{
+    // 1. Let rect be the value returned by calling getBoundingClientRect().
+
+    // 2. Let window be the associated window of current top-level browsing context.
+    auto const* window = page.top_level_browsing_context().active_window();
+
+    // 3. Let x be (scrollX of window + rect’s x coordinate).
+    auto x = (window ? static_cast<int>(window->scroll_x()) : 0) + static_cast<int>(rect->x());
+
+    // 4. Let y be (scrollY of window + rect’s y coordinate).
+    auto y = (window ? static_cast<int>(window->scroll_y()) : 0) + static_cast<int>(rect->y());
+
+    // 5. Return a pair of (x, y).
+    return { x, y };
+}
+
+static Gfx::IntRect calculate_absolute_rect_of_element(Web::Page const& page, Web::DOM::Element const& element)
+{
+    auto bounding_rect = element.get_bounding_client_rect();
+    auto coordinates = calculate_absolute_position_of_element(page, bounding_rect);
+
+    return {
+        coordinates.x(),
+        coordinates.y(),
+        static_cast<int>(bounding_rect->width()),
+        static_cast<int>(bounding_rect->height())
+    };
+}
+
 // https://w3c.github.io/webdriver/#dfn-get-or-create-a-web-element-reference
 static String get_or_create_a_web_element_reference(Web::DOM::Node const& element)
 {
@@ -626,6 +658,36 @@ Messages::WebDriverClient::GetElementTagNameResponse WebDriverConnection::get_el
     return make_success_response(move(qualified_name));
 }
 
+// 12.4.7 Get Element Rect, https://w3c.github.io/webdriver/#dfn-get-element-rect
+Messages::WebDriverClient::GetElementRectResponse WebDriverConnection::get_element_rect(String const& element_id)
+{
+    // 1. If the current browsing context is no longer open, return error with error code no such window.
+    TRY(ensure_open_top_level_browsing_context());
+
+    // FIXME: 2. Handle any user prompts and return its value if it is an error.
+
+    // 3. Let element be the result of trying to get a known connected element with url variable element id.
+    auto* element = TRY(get_known_connected_element(element_id));
+
+    // 4. Calculate the absolute position of element and let it be coordinates.
+    // 5. Let rect be element’s bounding rectangle.
+    auto rect = calculate_absolute_rect_of_element(m_page_host.page(), *element);
+
+    // 6. Let body be a new JSON Object initialized with:
+    // "x"
+    //     The first value of coordinates.
+    // "y"
+    //     The second value of coordinates.
+    // "width"
+    //     Value of rect’s width dimension.
+    // "height"
+    //     Value of rect’s height dimension.
+    auto body = serialize_rect(rect);
+
+    // 7. Return success with data body.
+    return body;
+}
+
 // https://w3c.github.io/webdriver/#dfn-no-longer-open
 ErrorOr<void, Web::WebDriver::Error> WebDriverConnection::ensure_open_top_level_browsing_context()
 {

Userland/Services/WebContent/WebDriverConnection.h

@@ -49,6 +49,7 @@ private:
     virtual Messages::WebDriverClient::GetElementCssValueResponse get_element_css_value(String const& element_id, String const& name) override;
     virtual Messages::WebDriverClient::GetElementTextResponse get_element_text(String const& element_id) override;
     virtual Messages::WebDriverClient::GetElementTagNameResponse get_element_tag_name(String const& element_id) override;
+    virtual Messages::WebDriverClient::GetElementRectResponse get_element_rect(String const& element_id) override;
 
     ErrorOr<void, Web::WebDriver::Error> ensure_open_top_level_browsing_context();
     void restore_the_window();

Userland/Services/WebDriver/Client.cpp

@@ -708,8 +708,7 @@ Web::WebDriver::Response Client::handle_get_element_rect(Vector<StringView> cons
 {
     dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/rect");
     auto* session = TRY(find_session_with_id(parameters[0]));
-    auto result = TRY(session->get_element_rect(parameters[1]));
-    return make_json_value(result);
+    return session->web_content_connection().get_element_rect(parameters[1]);
 }
 
 // 12.4.8 Is Element Enabled, https://w3c.github.io/webdriver/#dfn-is-element-enabled

Userland/Services/WebDriver/Session.cpp

@@ -300,17 +300,6 @@ Web::WebDriver::Response Session::get_window_handles() const
     return JsonValue { handles };
 }
 
-static JsonValue serialize_rect(Gfx::IntRect const& rect)
-{
-    JsonObject serialized_rect = {};
-    serialized_rect.set("x", rect.x());
-    serialized_rect.set("y", rect.y());
-    serialized_rect.set("width", rect.width());
-    serialized_rect.set("height", rect.height());
-
-    return serialized_rect;
-}
-
 // https://w3c.github.io/webdriver/#dfn-get-a-known-connected-element
 static ErrorOr<i32, Web::WebDriver::Error> get_known_connected_element(StringView element_id)
 {
@@ -323,36 +312,6 @@ static ErrorOr<i32, Web::WebDriver::Error> get_known_connected_element(StringVie
     return maybe_element_id.release_value();
 }
 
-// 12.4.7 Get Element Rect, https://w3c.github.io/webdriver/#dfn-get-element-rect
-Web::WebDriver::Response Session::get_element_rect(StringView parameter_element_id)
-{
-    // 1. If the current browsing context is no longer open, return error with error code no such window.
-    TRY(check_for_open_top_level_browsing_context_or_return_error());
-
-    // FIXME: 2. Handle any user prompts and return its value if it is an error.
-
-    // 3. Let element be the result of trying to get a known connected element with url variable element id.
-    auto element_id = TRY(get_known_connected_element(parameter_element_id));
-
-    // 4. Calculate the absolute position of element and let it be coordinates.
-    // 5. Let rect be element’s bounding rectangle.
-    auto rect = m_browser_connection->get_element_rect(element_id);
-
-    // 6. Let body be a new JSON Object initialized with:
-    // "x"
-    //     The first value of coordinates.
-    // "y"
-    //     The second value of coordinates.
-    // "width"
-    //     Value of rect’s width dimension.
-    // "height"
-    //     Value of rect’s height dimension.
-    auto body = serialize_rect(rect);
-
-    // 7. Return success with data body.
-    return body;
-}
-
 // 12.4.8 Is Element Enabled, https://w3c.github.io/webdriver/#dfn-is-element-enabled
 Web::WebDriver::Response Session::is_element_enabled(StringView parameter_element_id)
 {

Userland/Services/WebDriver/Session.h

@@ -58,7 +58,6 @@ public:
     Web::WebDriver::Response get_window_handle();
     ErrorOr<void, Variant<Web::WebDriver::Error, Error>> close_window();
     Web::WebDriver::Response get_window_handles() const;
-    Web::WebDriver::Response get_element_rect(StringView element_id);
     Web::WebDriver::Response is_element_enabled(StringView element_id);
     Web::WebDriver::Response get_source();
     Web::WebDriver::Response execute_script(JsonValue const& payload);