WebDriver+Browser: Implement POST /session/{id}/window/rect

Userland/Applications/Browser/WebDriverConnection.cpp

@@ -79,6 +79,29 @@ Messages::WebDriverSessionClient::GetWindowRectResponse WebDriverConnection::get
     return { {} };
 }
 
+void WebDriverConnection::restore_window()
+{
+    dbgln_if(WEBDRIVER_DEBUG, "WebDriverConnection: restore_window");
+    if (auto browser_window = m_browser_window.strong_ref()) {
+        browser_window->show();
+        browser_window->move_to_front();
+    }
+}
+
+void WebDriverConnection::set_window_size(Gfx::IntSize const& size)
+{
+    dbgln_if(WEBDRIVER_DEBUG, "WebDriverConnection: set_window_size {}", size);
+    if (auto browser_window = m_browser_window.strong_ref())
+        browser_window->resize(size);
+}
+
+void WebDriverConnection::set_window_position(Gfx::IntPoint const& position)
+{
+    dbgln_if(WEBDRIVER_DEBUG, "WebDriverConnection: set_window_position {}", position);
+    if (auto browser_window = m_browser_window.strong_ref())
+        browser_window->move_to(position);
+}
+
 Messages::WebDriverSessionClient::GetAllCookiesResponse WebDriverConnection::get_all_cookies()
 {
     dbgln_if(WEBDRIVER_DEBUG, "WebDriverConnection: get_cookies");

Userland/Applications/Browser/WebDriverConnection.h

@@ -44,6 +44,9 @@ public:
     virtual void back() override;
     virtual void forward() override;
     virtual Messages::WebDriverSessionClient::GetWindowRectResponse get_window_rect() override;
+    virtual void restore_window() override;
+    virtual void set_window_size(Gfx::IntSize const&) override;
+    virtual void set_window_position(Gfx::IntPoint const&) override;
     virtual Messages::WebDriverSessionClient::GetAllCookiesResponse get_all_cookies() override;
     virtual Messages::WebDriverSessionClient::GetNamedCookieResponse get_named_cookie(String const& name) override;
     virtual void add_cookie(Web::Cookie::ParsedCookie const&) override;

Userland/Applications/Browser/WebDriverSessionClient.ipc

@@ -1,6 +1,8 @@
 #include <AK/URL.h>
 #include <AK/Vector.h>
+#include <LibGfx/Point.h>
 #include <LibGfx/Rect.h>
+#include <LibGfx/Size.h>
 #include <LibWeb/Cookie/Cookie.h>
 #include <LibWeb/Cookie/ParsedCookie.h>
 
@@ -14,6 +16,9 @@ endpoint WebDriverSessionClient {
     back() =|
     forward() =|
     get_window_rect() => (Gfx::IntRect rect)
+    restore_window() =|
+    set_window_size(Gfx::IntSize size) =|
+    set_window_position(Gfx::IntPoint position) =|
     get_all_cookies() => (Vector<Web::Cookie::Cookie> cookies)
     get_named_cookie(String name) => (Optional<Web::Cookie::Cookie> cookie)
     add_cookie(Web::Cookie::ParsedCookie cookie) =|

Userland/Services/WebDriver/Client.cpp

@@ -37,6 +37,7 @@ Vector<Client::Route> Client::s_routes = {
     { HTTP::HttpRequest::Method::DELETE, { "session", ":session_id", "window" }, &Client::handle_close_window },
     { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "window", "handles" }, &Client::handle_get_window_handles },
     { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "window", "rect" }, &Client::handle_get_window_rect },
+    { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "window", "rect" }, &Client::handle_set_window_rect },
     { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "element" }, &Client::handle_find_element },
     { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "elements" }, &Client::handle_find_elements },
     { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "element", ":element_id", "element" }, &Client::handle_find_element_from_element },
@@ -554,6 +555,16 @@ ErrorOr<JsonValue, WebDriverError> Client::handle_get_window_rect(Vector<StringV
     return make_json_value(result);
 }
 
+// 11.8.2 Set Window Rect, https://w3c.github.io/webdriver/#dfn-set-window-rect
+// POST /session/{session id}/window/rect
+ErrorOr<JsonValue, WebDriverError> Client::handle_set_window_rect(Vector<StringView> const& parameters, JsonValue const& payload)
+{
+    dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/rect");
+    auto* session = TRY(find_session_with_id(parameters[0]));
+    auto result = TRY(session->set_window_rect(payload));
+    return make_json_value(result);
+}
+
 // 12.3.2 Find Element, https://w3c.github.io/webdriver/#dfn-find-element
 // POST /session/{session id}/element
 ErrorOr<JsonValue, WebDriverError> Client::handle_find_element(Vector<StringView> const& parameters, JsonValue const& payload)

Userland/Services/WebDriver/Client.h

@@ -62,6 +62,7 @@ private:
     ErrorOr<JsonValue, WebDriverError> handle_close_window(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_get_window_handles(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_get_window_rect(Vector<StringView> const&, JsonValue const& payload);
+    ErrorOr<JsonValue, WebDriverError> handle_set_window_rect(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_find_element(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_find_elements(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_find_element_from_element(Vector<StringView> const&, JsonValue const& payload);

Userland/Services/WebDriver/Session.cpp

@@ -10,11 +10,14 @@
 #include "Session.h"
 #include "BrowserConnection.h"
 #include "Client.h"
+#include <AK/NumericLimits.h>
 #include <AK/Time.h>
 #include <LibCore/LocalServer.h>
 #include <LibCore/Stream.h>
 #include <LibCore/System.h>
+#include <LibGfx/Point.h>
 #include <LibGfx/Rect.h>
+#include <LibGfx/Size.h>
 #include <LibWeb/Cookie/Cookie.h>
 #include <LibWeb/Cookie/ParsedCookie.h>
 #include <unistd.h>
@@ -305,6 +308,78 @@ ErrorOr<JsonValue, WebDriverError> Session::get_window_rect()
     return serialize_window_rect(m_browser_connection->get_window_rect());
 }
 
+// 11.8.2 Set Window Rect, https://w3c.github.io/webdriver/#dfn-set-window-rect
+ErrorOr<JsonValue, WebDriverError> Session::set_window_rect(JsonValue const& payload)
+{
+    if (!payload.is_object())
+        return WebDriverError::from_code(ErrorCode::InvalidArgument, "Payload is not a JSON object");
+
+    auto const& properties = payload.as_object();
+
+    auto resolve_property = [](auto name, auto const* property, auto min, auto max) -> ErrorOr<Optional<i32>, WebDriverError> {
+        if (!property)
+            return Optional<i32> {};
+        if (!property->is_number())
+            return WebDriverError::from_code(ErrorCode::InvalidArgument, String::formatted("Property '{}' is not a Number", name));
+
+        auto number = property->template to_number<i64>();
+
+        if (number < min)
+            return WebDriverError::from_code(ErrorCode::InvalidArgument, String::formatted("Property '{}' value {} exceeds the minimum allowed value {}", name, number, min));
+        if (number > max)
+            return WebDriverError::from_code(ErrorCode::InvalidArgument, String::formatted("Property '{}' value {} exceeds the maximum allowed value {}", name, number, max));
+
+        return static_cast<i32>(number);
+    };
+
+    // 1. Let width be the result of getting a property named width from the parameters argument, else let it be null.
+    auto const* width_property = properties.get_ptr("width"sv);
+
+    // 2. Let height be the result of getting a property named height from the parameters argument, else let it be null.
+    auto const* height_property = properties.get_ptr("height"sv);
+
+    // 3. Let x be the result of getting a property named x from the parameters argument, else let it be null.
+    auto const* x_property = properties.get_ptr("x"sv);
+
+    // 4. Let y be the result of getting a property named y from the parameters argument, else let it be null.
+    auto const* y_property = properties.get_ptr("y"sv);
+
+    // 5. If width or height is neither null nor a Number from 0 to 2^31 − 1, return error with error code invalid argument.
+    auto width = TRY(resolve_property("width"sv, width_property, 0, NumericLimits<i32>::max()));
+    auto height = TRY(resolve_property("height"sv, height_property, 0, NumericLimits<i32>::max()));
+
+    // 6. If x or y is neither null nor a Number from −(2^31) to 2^31 − 1, return error with error code invalid argument.
+    auto x = TRY(resolve_property("x"sv, x_property, NumericLimits<i32>::min(), NumericLimits<i32>::max()));
+    auto y = TRY(resolve_property("y"sv, y_property, NumericLimits<i32>::min(), NumericLimits<i32>::max()));
+
+    // 7. If the remote end does not support the Set Window Rect command for the current top-level browsing context for any reason, return error with error code unsupported operation.
+
+    // 8. If the current top-level 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: 9. Handle any user prompts and return its value if it is an error.
+    // FIXME: 10. Fully exit fullscreen.
+
+    // 11. Restore the window.
+    m_browser_connection->async_restore_window();
+
+    // 11. If width and height are not null:
+    if (width.has_value() && height.has_value()) {
+        // a. Set the width, in CSS pixels, of the operating system window containing the current top-level browsing context, including any browser chrome and externally drawn window decorations to a value that is as close as possible to width.
+        // b. Set the height, in CSS pixels, of the operating system window containing the current top-level browsing context, including any browser chrome and externally drawn window decorations to a value that is as close as possible to height.
+        m_browser_connection->async_set_window_size(Gfx::IntSize { *width, *height });
+    }
+
+    // 12. If x and y are not null:
+    if (x.has_value() && y.has_value()) {
+        // a. Run the implementation-specific steps to set the position of the operating system level window containing the current top-level browsing context to the position given by the x and y coordinates.
+        m_browser_connection->async_set_window_position(Gfx::IntPoint { *x, *y });
+    }
+
+    // 14. Return success with data set to the WindowRect object for the current top-level browsing context.
+    return serialize_window_rect(m_browser_connection->get_window_rect());
+}
+
 // https://w3c.github.io/webdriver/#dfn-get-or-create-a-web-element-reference
 static String get_or_create_a_web_element_reference(Session::LocalElement const& element)
 {

Userland/Services/WebDriver/Session.h

@@ -51,6 +51,7 @@ public:
     ErrorOr<void, Variant<WebDriverError, Error>> close_window();
     ErrorOr<JsonValue, WebDriverError> get_window_handles() const;
     ErrorOr<JsonValue, WebDriverError> get_window_rect();
+    ErrorOr<JsonValue, WebDriverError> set_window_rect(JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> find_element(JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> find_elements(JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> find_element_from_element(JsonValue const& payload, StringView parameter_element_id);