mirrors/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity.git synced 2025-01-22 17:31:58 -05:00
Code Issues Projects Releases Packages Wiki Activity
serenity/Userland/Services/WebContent/WebDriverConnection.h

82 lines
4.8 KiB
C
Raw Normal View History

WebContent: Add a very-empty WebDriver IPC class to WebContent This just sets up the infrastructure for the WebContent process to house WebDriver IPCs, and adds an IPC for WebContent to create the WebDriver connection. The WebDriverConnection class inside WebContent ultimately will contain most of what is currently in WebDriver::Session (so the copyright attributions are copied here as well). The socket created by WebDriver is currently /tmp/browser_webdriver (formatted with some IDs). This will be moved to the /tmp/webdriver folder, as WebDriver will create multiple sockets to communicate with both Browser and WebContent as the IPCs are iteratively moved to WebContent. That path is unveiled here, though it is unused as of this commit.
2022-11-08 10:03:07 -05:00
/*
* Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
* Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
* Copyright (c) 2022, Tim Flynn <trflynn89@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <LibIPC/ConnectionToServer.h>
WebContent+WebDriver: Move Execute Script to WebContent
2022-11-10 20:55:17 -05:00
#include <LibJS/Forward.h>
#include <LibJS/Heap/MarkedVector.h>
WebContent+WebDriver: Move Find Element to WebContent Note that this does nothing to "fix" how element references are created. We continue to return the element ID because, otherwise, all other element WebDriver endpoints would break. On the bright side, we avoid several IPC round trips now that we perform the entire 'find' operation in the WebContent process; and we are able to work directly on DOM nodes.
2022-11-09 15:02:38 -05:00
#include <LibWeb/Forward.h>
#include <LibWeb/WebDriver/ElementLocationStrategies.h>
WebContent: Add a very-empty WebDriver IPC class to WebContent This just sets up the infrastructure for the WebContent process to house WebDriver IPCs, and adds an IPC for WebContent to create the WebDriver connection. The WebDriverConnection class inside WebContent ultimately will contain most of what is currently in WebDriver::Session (so the copyright attributions are copied here as well). The socket created by WebDriver is currently /tmp/browser_webdriver (formatted with some IDs). This will be moved to the /tmp/webdriver folder, as WebDriver will create multiple sockets to communicate with both Browser and WebContent as the IPCs are iteratively moved to WebContent. That path is unveiled here, though it is unused as of this commit.
2022-11-08 10:03:07 -05:00
#include <LibWeb/WebDriver/Response.h>
#include <WebContent/Forward.h>
#include <WebContent/WebDriverClientEndpoint.h>
#include <WebContent/WebDriverServerEndpoint.h>
namespace WebContent {
class WebDriverConnection final
: public IPC::ConnectionToServer<WebDriverClientEndpoint, WebDriverServerEndpoint> {
C_OBJECT_ABSTRACT(WebDriverConnection)
public:
Browser+WebContent+WebDriver: Move Get/Set Window Rect to WebContent This also lets us more fully implement the "restore the window" method, which requires we block until the document reaches the "visible" state.
2022-11-09 09:56:20 -05:00
static ErrorOr<NonnullRefPtr<WebDriverConnection>> connect(ConnectionFromClient& web_content_client, PageHost& page_host, String const& webdriver_ipc_path);
WebContent: Add a very-empty WebDriver IPC class to WebContent This just sets up the infrastructure for the WebContent process to house WebDriver IPCs, and adds an IPC for WebContent to create the WebDriver connection. The WebDriverConnection class inside WebContent ultimately will contain most of what is currently in WebDriver::Session (so the copyright attributions are copied here as well). The socket created by WebDriver is currently /tmp/browser_webdriver (formatted with some IDs). This will be moved to the /tmp/webdriver folder, as WebDriver will create multiple sockets to communicate with both Browser and WebContent as the IPCs are iteratively moved to WebContent. That path is unveiled here, though it is unused as of this commit.
2022-11-08 10:03:07 -05:00
virtual ~WebDriverConnection() = default;
private:
Browser+WebContent+WebDriver: Move Get/Set Window Rect to WebContent This also lets us more fully implement the "restore the window" method, which requires we block until the document reaches the "visible" state.
2022-11-09 09:56:20 -05:00
WebDriverConnection(NonnullOwnPtr<Core::Stream::LocalSocket> socket, ConnectionFromClient& web_content_client, PageHost& page_host);
WebContent: Add a very-empty WebDriver IPC class to WebContent This just sets up the infrastructure for the WebContent process to house WebDriver IPCs, and adds an IPC for WebContent to create the WebDriver connection. The WebDriverConnection class inside WebContent ultimately will contain most of what is currently in WebDriver::Session (so the copyright attributions are copied here as well). The socket created by WebDriver is currently /tmp/browser_webdriver (formatted with some IDs). This will be moved to the /tmp/webdriver folder, as WebDriver will create multiple sockets to communicate with both Browser and WebContent as the IPCs are iteratively moved to WebContent. That path is unveiled here, though it is unused as of this commit.
2022-11-08 10:03:07 -05:00
virtual void die() override { }
WebContent+WebDriver: Fully implement closing a session There were a couple steps missing to close the remote end. Further, we were not removing the session from the list of active sessions.
2022-11-08 14:14:29 -05:00
virtual void close_session() override;
WebContent+WebDriver: Set the navigator.webdriver flag from WebDriver This moves setting the navigator.webdriver flag from after WebContent creates the WebDriver connection, to its own IPC to be triggered from WebDriver. This is closer to the spec, but mostly serves as an easy test to validate the connection.
2022-11-08 10:42:12 -05:00
virtual void set_is_webdriver_active(bool) override;
WebContent+WebDriver: Move the Navigate To command to WebContent
2022-11-08 12:58:24 -05:00
virtual Messages::WebDriverClient::NavigateToResponse navigate_to(JsonValue const& payload) override;
WebContent+WebDriver: Move the Get Current URL command to WebContent
2022-11-08 13:06:22 -05:00
virtual Messages::WebDriverClient::GetCurrentUrlResponse get_current_url() override;
Browser+WebContent+WebDriver: Move Get/Set Window Rect to WebContent This also lets us more fully implement the "restore the window" method, which requires we block until the document reaches the "visible" state.
2022-11-09 09:56:20 -05:00
virtual Messages::WebDriverClient::GetWindowRectResponse get_window_rect() override;
virtual Messages::WebDriverClient::SetWindowRectResponse set_window_rect(JsonValue const& payload) override;
Browser+WebContent+WebDriver: Move [Max,Min]imize Window to WebContent This also lets us more fully implement the "iconify the window" method, which requires we block until the document reaches the "hidden" state.
2022-11-09 11:00:53 -05:00
virtual Messages::WebDriverClient::MaximizeWindowResponse maximize_window() override;
virtual Messages::WebDriverClient::MinimizeWindowResponse minimize_window() override;
WebContent+WebDriver: Move Find Element to WebContent Note that this does nothing to "fix" how element references are created. We continue to return the element ID because, otherwise, all other element WebDriver endpoints would break. On the bright side, we avoid several IPC round trips now that we perform the entire 'find' operation in the WebContent process; and we are able to work directly on DOM nodes.
2022-11-09 15:02:38 -05:00
virtual Messages::WebDriverClient::FindElementResponse find_element(JsonValue const& payload) override;
WebContent+WebDriver: Move Find Elements to WebContent
2022-11-09 15:08:49 -05:00
virtual Messages::WebDriverClient::FindElementsResponse find_elements(JsonValue const& payload) override;
WebContent+WebDriver: Move Find Element From Element to WebContent
2022-11-09 15:18:28 -05:00
virtual Messages::WebDriverClient::FindElementFromElementResponse find_element_from_element(JsonValue const& payload, String const& element_id) override;
Browser+WebContent+WebDriver: Move Find Elements From Element to WC This also lets us remove the element location strategy and some WebContent IPC from Browser/LibWebView now that they are unused.
2022-11-09 15:25:23 -05:00
virtual Messages::WebDriverClient::FindElementsFromElementResponse find_elements_from_element(JsonValue const& payload, String const& element_id) override;
Browser+WebContent+WebDriver: Move Is Element Selected to WebContent
2022-11-10 08:15:39 -05:00
virtual Messages::WebDriverClient::IsElementSelectedResponse is_element_selected(String const& element_id) override;
Browser+WebContent+WebDriver: Move Get Element Attribute to WebContent In doing so, this also implements a FIXME to handle boolean attributes.
2022-11-10 08:57:37 -05:00
virtual Messages::WebDriverClient::GetElementAttributeResponse get_element_attribute(String const& element_id, String const& name) override;
Browser+WebContent+WebDriver: Move Get Element Property to WebContent
2022-11-10 09:25:53 -05:00
virtual Messages::WebDriverClient::GetElementPropertyResponse get_element_property(String const& element_id, String const& name) override;
Browser+WebContent+WebDriver: Move Get Element CSS Value to WebContent
2022-11-10 10:11:04 -05:00
virtual Messages::WebDriverClient::GetElementCssValueResponse get_element_css_value(String const& element_id, String const& name) override;
Browser+WebContent+WebDriver: Move Get Element Text to WebContent
2022-11-10 10:21:03 -05:00
virtual Messages::WebDriverClient::GetElementTextResponse get_element_text(String const& element_id) override;
Browser+WebContent+WebDriver: Move Get Element Tag Name to WebContent
2022-11-10 10:24:49 -05:00
virtual Messages::WebDriverClient::GetElementTagNameResponse get_element_tag_name(String const& element_id) override;
Browser+WebContent+WebDriver: Move Get Element Rect to WebContent
2022-11-10 10:33:29 -05:00
virtual Messages::WebDriverClient::GetElementRectResponse get_element_rect(String const& element_id) override;
Browser+WebContent+WebDriver: Move Is Element Enabled to WebContent
2022-11-10 10:39:09 -05:00
virtual Messages::WebDriverClient::IsElementEnabledResponse is_element_enabled(String const& element_id) override;
Browser+WebContent+WebDriver: Move Get Page Source to WebContent
2022-11-10 18:00:01 -05:00
virtual Messages::WebDriverClient::GetSourceResponse get_source() override;
WebContent+WebDriver: Move Execute Script to WebContent
2022-11-10 20:55:17 -05:00
virtual Messages::WebDriverClient::ExecuteScriptResponse execute_script(JsonValue const& payload) override;
Browser+WebContent+WebDriver: Move Execute Async Script to WebContent With this, WebDriverEndpoints is unused and removed :^)
2022-11-10 21:00:27 -05:00
virtual Messages::WebDriverClient::ExecuteAsyncScriptResponse execute_async_script(JsonValue const& payload) override;
Browser+WebContent+WebDriver: Move Get All Cookies to WebContent There are a couple changes here from the existing Get All Cookies implementation. 1. Previously, WebDriver actually returned *all* cookies in the cookie jar. The spec dictates that we only return cookies that match the document's URL. Specifically, it calls out that we must run just the first step of RFC 6265 section 5.4 to perform domain matching. This change adds a special mode to our implementation of that section to skip the remaining steps. 2. We now fill in the SameSite cookie attribute when serializing the cookie to JSON (this was a trival FIXME that didn't get picked up when SameSite was implemented).
2022-11-11 09:24:07 -05:00
virtual Messages::WebDriverClient::GetAllCookiesResponse get_all_cookies() override;
Browser+WebContent+WebDriver: Move Get Named Cookie to WebContent Instead of sending *all* cookies over IPC and filtering by name, we now filter by name from the cookie jar and send just the first matching cookie.
2022-11-11 09:55:11 -05:00
virtual Messages::WebDriverClient::GetNamedCookieResponse get_named_cookie(String const& name) override;
Browser+WebContent+WebDriver: Move Add Cookie to WebContent The new implementation is made a bit simpler by way of TRY. It also implements setting the SameSite attribute.
2022-11-11 11:00:45 -05:00
virtual Messages::WebDriverClient::AddCookieResponse add_cookie(JsonValue const& payload) override;
Browser+WebContent+WebDriver: Move Take Screenshot to WebContent
2022-11-10 13:20:44 -05:00
virtual Messages::WebDriverClient::TakeScreenshotResponse take_screenshot() override;
Browser+WebContent+WebDriver: Move Take Element Screenshot to WebContent
2022-11-10 13:33:18 -05:00
virtual Messages::WebDriverClient::TakeElementScreenshotResponse take_element_screenshot(String const& element_id) override;
WebContent+WebDriver: Move the Navigate To command to WebContent
2022-11-08 12:58:24 -05:00
ErrorOr<void, Web::WebDriver::Error> ensure_open_top_level_browsing_context();
Browser+WebContent+WebDriver: Move Get/Set Window Rect to WebContent This also lets us more fully implement the "restore the window" method, which requires we block until the document reaches the "visible" state.
2022-11-09 09:56:20 -05:00
void restore_the_window();
Browser+WebContent+WebDriver: Move [Max,Min]imize Window to WebContent This also lets us more fully implement the "iconify the window" method, which requires we block until the document reaches the "hidden" state.
2022-11-09 11:00:53 -05:00
Gfx::IntRect maximize_the_window();
Gfx::IntRect iconify_the_window();
WebContent+WebDriver: Move Find Element to WebContent Note that this does nothing to "fix" how element references are created. We continue to return the element ID because, otherwise, all other element WebDriver endpoints would break. On the bright side, we avoid several IPC round trips now that we perform the entire 'find' operation in the WebContent process; and we are able to work directly on DOM nodes.
2022-11-09 15:02:38 -05:00
ErrorOr<JsonArray, Web::WebDriver::Error> find(Web::DOM::ParentNode& start_node, Web::WebDriver::LocationStrategy using_, StringView value);
WebContent: Add a very-empty WebDriver IPC class to WebContent This just sets up the infrastructure for the WebContent process to house WebDriver IPCs, and adds an IPC for WebContent to create the WebDriver connection. The WebDriverConnection class inside WebContent ultimately will contain most of what is currently in WebDriver::Session (so the copyright attributions are copied here as well). The socket created by WebDriver is currently /tmp/browser_webdriver (formatted with some IDs). This will be moved to the /tmp/webdriver folder, as WebDriver will create multiple sockets to communicate with both Browser and WebContent as the IPCs are iteratively moved to WebContent. That path is unveiled here, though it is unused as of this commit.
2022-11-08 10:03:07 -05:00
WebContent+WebDriver: Move Execute Script to WebContent
2022-11-10 20:55:17 -05:00
struct ScriptArguments {
String script;
JS::MarkedVector<JS::Value> arguments;
};
ErrorOr<ScriptArguments, Web::WebDriver::Error> extract_the_script_arguments_from_a_request(JsonValue const& payload);
Browser+WebContent+WebDriver: Move Get/Set Window Rect to WebContent This also lets us more fully implement the "restore the window" method, which requires we block until the document reaches the "visible" state.
2022-11-09 09:56:20 -05:00
ConnectionFromClient& m_web_content_client;
WebContent: Add a very-empty WebDriver IPC class to WebContent This just sets up the infrastructure for the WebContent process to house WebDriver IPCs, and adds an IPC for WebContent to create the WebDriver connection. The WebDriverConnection class inside WebContent ultimately will contain most of what is currently in WebDriver::Session (so the copyright attributions are copied here as well). The socket created by WebDriver is currently /tmp/browser_webdriver (formatted with some IDs). This will be moved to the /tmp/webdriver folder, as WebDriver will create multiple sockets to communicate with both Browser and WebContent as the IPCs are iteratively moved to WebContent. That path is unveiled here, though it is unused as of this commit.
2022-11-08 10:03:07 -05:00
PageHost& m_page_host;
};
}
Reference in a new issue Copy permalink