WebDriver+Browser: Implement GET /session/{id}/source

Userland/Applications/Browser/BrowserWindow.cpp

@@ -631,6 +631,10 @@ void BrowserWindow::create_new_tab(URL url, bool activate)
         return active_tab().view().get_element_tag_name(element_id);
     };
 
+    new_tab.webdriver_endpoints().on_serialize_source = [this]() {
+        return active_tab().view().serialize_source();
+    };
+
     new_tab.webdriver_endpoints().on_execute_script = [this](String const& body, Vector<String> const& json_arguments, Optional<u64> const& timeout, bool async) {
         return active_tab().view().webdriver_execute_script(body, json_arguments, timeout, async);
     };

Userland/Applications/Browser/WebDriverConnection.cpp

@@ -117,6 +117,18 @@ void WebDriverConnection::minimize_window()
         browser_window->set_minimized(true);
 }
 
+Messages::WebDriverSessionClient::SerializeSourceResponse WebDriverConnection::serialize_source()
+{
+    dbgln_if(WEBDRIVER_DEBUG, "WebDriverConnection: serialize_source");
+    if (auto browser_window = m_browser_window.strong_ref()) {
+        auto& tab = browser_window->active_tab();
+        if (tab.webdriver_endpoints().on_serialize_source)
+            return { tab.webdriver_endpoints().on_serialize_source() };
+    }
+
+    return { {} };
+}
+
 Messages::WebDriverSessionClient::ExecuteScriptResponse WebDriverConnection::execute_script(String const& body, Vector<String> const& json_arguments, Optional<u64> const& timeout, bool async)
 {
     dbgln("WebDriverConnection: execute_script");

Userland/Applications/Browser/WebDriverConnection.h

@@ -49,6 +49,7 @@ public:
     virtual void set_window_position(Gfx::IntPoint const&) override;
     virtual void maximize_window() override;
     virtual void minimize_window() override;
+    virtual Messages::WebDriverSessionClient::SerializeSourceResponse serialize_source() override;
     virtual Messages::WebDriverSessionClient::ExecuteScriptResponse execute_script(String const& body, Vector<String> const& json_arguments, Optional<u64> const& timeout, bool async) override;
     virtual Messages::WebDriverSessionClient::GetAllCookiesResponse get_all_cookies() override;
     virtual Messages::WebDriverSessionClient::GetNamedCookieResponse get_named_cookie(String const& name) override;

Userland/Applications/Browser/WebDriverEndpoints.h

@@ -29,6 +29,7 @@ public:
     Function<String(i32 element_id, String const&)> on_get_computed_value_for_element;
     Function<String(i32 element_id)> on_get_element_text;
     Function<String(i32 element_id)> on_get_element_tag_name;
+    Function<String()> on_serialize_source;
     Function<Messages::WebContentServer::WebdriverExecuteScriptResponse(String const& body, Vector<String> const& json_arguments, Optional<u64> const& timeout, bool async)> on_execute_script;
 };
 

Userland/Applications/Browser/WebDriverSessionClient.ipc

@@ -23,6 +23,7 @@ endpoint WebDriverSessionClient {
     set_window_position(Gfx::IntPoint position) =|
     maximize_window() =|
     minimize_window() =|
+    serialize_source() => (String source)
     execute_script(String body, Vector<String> json_arguments, Optional<u64> timeout, bool async) => (Web::WebDriver::ExecuteScriptResultType result_type, String json_result)
     get_all_cookies() => (Vector<Web::Cookie::Cookie> cookies)
     get_named_cookie(String name) => (Optional<Web::Cookie::Cookie> cookie)

Userland/Services/WebDriver/Client.cpp

@@ -49,6 +49,7 @@ Vector<Client::Route> Client::s_routes = {
     { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "css", ":property_name" }, &Client::handle_get_element_css_value },
     { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "text" }, &Client::handle_get_element_text },
     { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "name" }, &Client::handle_get_element_tag_name },
+    { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "source" }, &Client::handle_get_source },
     { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "execute", "sync" }, &Client::handle_execute_script },
     { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "execute", "async" }, &Client::handle_execute_async_script },
     { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "cookie" }, &Client::handle_get_all_cookies },
@@ -687,6 +688,16 @@ ErrorOr<JsonValue, WebDriverError> Client::handle_get_element_tag_name(Vector<St
     return make_json_value(result);
 }
 
+// 13.1 Get Page Source, https://w3c.github.io/webdriver/#dfn-get-page-source
+// GET /session/{session id}/source
+ErrorOr<JsonValue, WebDriverError> Client::handle_get_source(Vector<StringView> const& parameters, JsonValue const&)
+{
+    dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/source");
+    auto* session = TRY(find_session_with_id(parameters[0]));
+    auto result = TRY(session->get_source());
+    return make_json_value(result);
+}
+
 // 13.2.1 Execute Script, https://w3c.github.io/webdriver/#dfn-execute-script
 // POST /session/{session id}/execute/sync
 ErrorOr<JsonValue, WebDriverError> Client::handle_execute_script(Vector<StringView> const& parameters, JsonValue const& payload)

Userland/Services/WebDriver/Client.h

@@ -74,6 +74,7 @@ private:
     ErrorOr<JsonValue, WebDriverError> handle_get_element_css_value(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_get_element_text(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_get_element_tag_name(Vector<StringView> const&, JsonValue const& payload);
+    ErrorOr<JsonValue, WebDriverError> handle_get_source(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_execute_script(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_execute_async_script(Vector<StringView> const&, JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> handle_get_all_cookies(Vector<StringView> const&, JsonValue const& payload);

Userland/Services/WebDriver/Session.cpp

@@ -900,6 +900,23 @@ ErrorOr<JsonValue, WebDriverError> Session::get_element_tag_name(JsonValue const
     return JsonValue(qualified_name);
 }
 
+// 13.1 Get Page Source, https://w3c.github.io/webdriver/#dfn-get-page-source
+ErrorOr<JsonValue, WebDriverError> Session::get_source()
+{
+    // 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 source be the result of invoking the fragment serializing algorithm on a fictional node whose only child is the document element providing true for the require well-formed flag. If this causes an exception to be thrown, let source be null.
+    // 4. Let source be the result of serializing to string the current browsing context active document, if source is null.
+    // NOTE: Both of the above cases are handled in the remote WebContent process.
+    auto source = m_browser_connection->serialize_source();
+
+    // 5. Return success with data source.
+    return source;
+}
+
 struct ScriptArguments {
     String script;
     JsonArray const& arguments;

Userland/Services/WebDriver/Session.h

@@ -63,6 +63,7 @@ public:
     ErrorOr<JsonValue, WebDriverError> get_element_css_value(JsonValue const& payload, StringView element_id, StringView property_name);
     ErrorOr<JsonValue, WebDriverError> get_element_text(JsonValue const& payload, StringView element_id);
     ErrorOr<JsonValue, WebDriverError> get_element_tag_name(JsonValue const& payload, StringView element_id);
+    ErrorOr<JsonValue, WebDriverError> get_source();
     ErrorOr<JsonValue, WebDriverError> execute_script(JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> execute_async_script(JsonValue const& payload);
     ErrorOr<JsonValue, WebDriverError> get_all_cookies();