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

171 lines
11 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>
LibWeb+WebContent+WebDriver: Implement the Perform Actions endpoint Similar to script execution, this spins the WebDriver process until the action is complete (rather than spinning the WebContent process, which we've seen result in deadlocks). (cherry picked from commit 709deeb482a6433abbcb194551788bc5409166f4)
2024-09-29 09:40:17 -04:00
* Copyright (c) 2022-2024, Tim Flynn <trflynn89@ladybird.org>
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
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 09:19:34 -05:00
#include <AK/ByteString.h>
WebContent: Don't assume start nodes for finding elements remain valid When timeouts are implemented, the start node used to find elements may not remain valid for the entire duration of the timeout. For example, the active document element may change, or the start node may be removed from the DOM. To handle this, we will need to re-evaluate the start node on each iteration of the find() operation. This patch wraps the steps to do so in a lambda to be executed on each iteration.
2022-11-21 09:51:46 -05:00
#include <AK/Function.h>
WebContent+WebDriver: Move Window commands to WebContent This moves Get Window Handle, Close Window, and Get Window Handles over to WebContent so they may be implemented closer to the spec and be used by Ladybird.
2022-11-14 11:55:10 -05:00
#include <AK/HashMap.h>
LibWeb+WebContent+WebDriver: Port WebDriver parameters to String This changes the parameters parsed from a WebDriver HTTP request to String for transferring over IPC. Conveniently, most locations these were ultimately passed to only need a StringView.
2023-03-05 15:31:49 -05:00
#include <AK/String.h>
WebContent: Add missing LibGfx include
2023-02-25 12:43:09 -05:00
#include <LibGfx/Rect.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 <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>
WebContent+WebDriver: Move Get/Set Timeouts to WebContent
2022-11-11 14:28:57 -05:00
#include <LibWeb/WebDriver/TimeoutsConfiguration.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 <WebContent/Forward.h>
#include <WebContent/WebDriverClientEndpoint.h>
#include <WebContent/WebDriverServerEndpoint.h>
namespace WebContent {
class WebDriverConnection final
: public IPC::ConnectionToServer<WebDriverClientEndpoint, WebDriverServerEndpoint> {
WebContent: Disallow creating WebDriverConnections with existing sockets This reverts commit d2b2d3ad8062d2ce1612f24e4c45d533344a2be3. This is no longer needed once Ladybird will uses local socket files.
2022-12-15 08:44:10 -05:00
C_OBJECT_ABSTRACT(WebDriverConnection)
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
public:
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 09:19:34 -05:00
static ErrorOr<NonnullRefPtr<WebDriverConnection>> connect(Web::PageClient& page_client, ByteString 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;
WebContent: Add a JS visitor to WebDriver's IPC connection We've added a few JS::Handle members to this class over time. Let's avoid creating a new GC root for each of these, and explicitly add a visitation method. (cherry picked from commit 048b51eb54d003af5dc202af1b16bb690b1348f9)
2024-10-17 18:50:36 -04:00
void visit_edges(JS::Cell::Visitor&);
WebContent+WebDriver: Asynchronously wait for navigations to complete Similar to commit c2cf65adac78912883996153fb608dafe389b6e0, we should avoid spinning the event loop from the WebContent-side of the WebDriver connection. This can result in deadlocks if another component in LibWeb also spins the event loop. The AO to await navigations has two event loop spinners - waiting for the navigation to complete and for the document to reach the target readiness state. We now use NavigationObserver and DocumentObserver to be notified when these conditions are met. And we use the same async IPC mechanism as script execution to notify the WebDriver process when all conditions are met (or timed out). (cherry picked from commit bf0bc62654803565a6f39ade63d9172cc48c085a)
2024-10-25 10:28:29 -04:00
void page_did_open_dialog(Badge<PageClient>);
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
private:
LibCore: Move Stream-based sockets into the `Core` namespace
2023-02-08 17:05:44 -05:00
WebDriverConnection(NonnullOwnPtr<Core::LocalSocket> socket, Web::PageClient& page_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
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: Send the parsed capabilities over to WebContent
2022-11-17 16:27:32 -05:00
virtual void set_page_load_strategy(Web::WebDriver::PageLoadStrategy const& page_load_strategy) override;
virtual void set_unhandled_prompt_behavior(Web::WebDriver::UnhandledPromptBehavior const& unhandled_prompt_behavior) override;
virtual void set_strict_file_interactability(bool strict_file_interactability) 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 Get/Set Timeouts to WebContent
2022-11-11 14:28:57 -05:00
virtual Messages::WebDriverClient::GetTimeoutsResponse get_timeouts() override;
virtual Messages::WebDriverClient::SetTimeoutsResponse set_timeouts(JsonValue const& payload) 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 Back, Forward, Refresh to WebContent
2022-11-11 13:46:22 -05:00
virtual Messages::WebDriverClient::BackResponse back() override;
virtual Messages::WebDriverClient::ForwardResponse forward() override;
virtual Messages::WebDriverClient::RefreshResponse refresh() override;
Browser+WebContent+WebDriver: Move Get Title to WebContent
2022-11-11 13:50:43 -05:00
virtual Messages::WebDriverClient::GetTitleResponse get_title() override;
WebContent+WebDriver: Get window handle from WebContent process This change makes window handles on WebDriver process side be consistent with handles returned by /window/new.
2023-03-13 10:45:34 -04:00
virtual Messages::WebDriverClient::GetWindowHandleResponse get_window_handle() override;
WebContent+WebDriver: Move Window commands to WebContent This moves Get Window Handle, Close Window, and Get Window Handles over to WebContent so they may be implemented closer to the spec and be used by Ladybird.
2022-11-14 11:55:10 -05:00
virtual Messages::WebDriverClient::CloseWindowResponse close_window() override;
WebContent+WebDriver: Update the current BC when switching windows We had only implemented this step in the WebDriver process, but we need to update the remote WebContent process as well. (cherry picked from commit 5fc51b2ff95ba30433d7274856213a790ccb610a)
2024-09-14 13:02:44 -04:00
virtual Messages::WebDriverClient::SwitchToWindowResponse switch_to_window(String const& handle) override;
LibWeb+WebContent+WebDriver: Add WebDriver endpoint to open new window
2023-03-14 07:09:50 -04:00
virtual Messages::WebDriverClient::NewWindowResponse new_window(JsonValue const& payload) override;
WebContent+WebDriver: Properly define and invoke stubbed methods (cherry picked from commit 0a482e1a53c7c5fef311abda955557d872402ae0)
2024-09-08 08:14:52 -04:00
virtual Messages::WebDriverClient::SwitchToFrameResponse switch_to_frame(JsonValue const& payload) override;
virtual Messages::WebDriverClient::SwitchToParentFrameResponse switch_to_parent_frame(JsonValue const& payload) 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;
WebDriver: Implement `POST /session/{id}/window/fullscreen` endpoint
2022-11-09 13:09:17 -05:00
virtual Messages::WebDriverClient::FullscreenWindowResponse fullscreen_window() override;
WebDriver+WebContent: Add /session/:id:/window/consume-user-activation This extension to the WebDriver spec is defined in the HTML spec, how fun.
2024-05-29 13:14:42 -04:00
virtual Messages::WebDriverClient::ConsumeUserActivationResponse consume_user_activation() 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;
LibWeb+WebContent+WebDriver: Port WebDriver parameters to String This changes the parameters parsed from a WebDriver HTTP request to String for transferring over IPC. Conveniently, most locations these were ultimately passed to only need a StringView.
2023-03-05 15:31:49 -05:00
virtual Messages::WebDriverClient::FindElementFromElementResponse find_element_from_element(JsonValue const& payload, String const& element_id) override;
virtual Messages::WebDriverClient::FindElementsFromElementResponse find_elements_from_element(JsonValue const& payload, String const& element_id) override;
virtual Messages::WebDriverClient::FindElementFromShadowRootResponse find_element_from_shadow_root(JsonValue const& payload, String const& shadow_id) override;
virtual Messages::WebDriverClient::FindElementsFromShadowRootResponse find_elements_from_shadow_root(JsonValue const& payload, String const& shadow_id) override;
LibWeb+WebContent+WebDriver: Implement Get Active Element Unfortunately, nothing ever calls DOM::Document::set_active_element at the moment, so this will always return ErrorCode::NoSuchElement.
2022-11-14 19:02:23 -05:00
virtual Messages::WebDriverClient::GetActiveElementResponse get_active_element() override;
LibWeb+WebContent+WebDriver: Port WebDriver parameters to String This changes the parameters parsed from a WebDriver HTTP request to String for transferring over IPC. Conveniently, most locations these were ultimately passed to only need a StringView.
2023-03-05 15:31:49 -05:00
virtual Messages::WebDriverClient::GetElementShadowRootResponse get_element_shadow_root(String const& element_id) override;
virtual Messages::WebDriverClient::IsElementSelectedResponse is_element_selected(String const& element_id) override;
virtual Messages::WebDriverClient::GetElementAttributeResponse get_element_attribute(String const& element_id, String const& name) override;
virtual Messages::WebDriverClient::GetElementPropertyResponse get_element_property(String const& element_id, String const& name) override;
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;
virtual Messages::WebDriverClient::IsElementEnabledResponse is_element_enabled(String const& element_id) override;
virtual Messages::WebDriverClient::GetComputedRoleResponse get_computed_role(String const& element_id) override;
virtual Messages::WebDriverClient::GetComputedLabelResponse get_computed_label(String const& element_id) override;
virtual Messages::WebDriverClient::ElementClickResponse element_click(String const& element_id) override;
WebContent+WebDriver: Properly define and invoke stubbed methods (cherry picked from commit 0a482e1a53c7c5fef311abda955557d872402ae0)
2024-09-08 08:14:52 -04:00
virtual Messages::WebDriverClient::ElementClearResponse element_clear(String const& element_id) override;
WebContent+WebDriver: Log all unimplemented WebDriver endpoints It's difficult to know what we need to implement if we silently ignore these endpoints. Let's log the endpoints and their parameters, and clean up the wall of FIXME comments to be easier to grok. (cherry picked from commit b035f0cd3d35e608afdabcd1c5b070dce856b5a3)
2024-09-25 11:26:46 -04:00
virtual Messages::WebDriverClient::ElementSendKeysResponse element_send_keys(String const& element_id, JsonValue const& payload) 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;
LibWeb+WebContent+WebDriver: Port WebDriver parameters to String This changes the parameters parsed from a WebDriver HTTP request to String for transferring over IPC. Conveniently, most locations these were ultimately passed to only need a StringView.
2023-03-05 15:31:49 -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;
LibWeb+WebContent+WebDriver: Port WebDriver parameters to String This changes the parameters parsed from a WebDriver HTTP request to String for transferring over IPC. Conveniently, most locations these were ultimately passed to only need a StringView.
2023-03-05 15:31:49 -05:00
virtual Messages::WebDriverClient::DeleteCookieResponse delete_cookie(String const& name) override;
Browser+WebContent+WebDriver: Move Delete All Cookies to WebContent
2022-11-11 11:27:08 -05:00
virtual Messages::WebDriverClient::DeleteAllCookiesResponse delete_all_cookies() override;
WebContent+WebDriver: Log all unimplemented WebDriver endpoints It's difficult to know what we need to implement if we silently ignore these endpoints. Let's log the endpoints and their parameters, and clean up the wall of FIXME comments to be easier to grok. (cherry picked from commit b035f0cd3d35e608afdabcd1c5b070dce856b5a3)
2024-09-25 11:26:46 -04:00
virtual Messages::WebDriverClient::PerformActionsResponse perform_actions(JsonValue const& payload) override;
LibWeb: Stub out `Release Actions` This allows WPT to open the browser, and it no longer instantly crashes
2023-06-17 11:36:00 -04:00
virtual Messages::WebDriverClient::ReleaseActionsResponse release_actions() override;
LibWeb+WebContent+WebDriver: Implement Dismiss Alert
2022-11-16 07:15:57 -05:00
virtual Messages::WebDriverClient::DismissAlertResponse dismiss_alert() override;
LibWeb+WebContent+WebDriver: Implement Accept Alert
2022-11-16 07:24:22 -05:00
virtual Messages::WebDriverClient::AcceptAlertResponse accept_alert() override;
LibWeb+WebContent+WebDriver: Implement Get Alert Text
2022-11-16 08:26:48 -05:00
virtual Messages::WebDriverClient::GetAlertTextResponse get_alert_text() override;
LibWeb+LibWebView+WebContent+WebDriver: Implement Send Alert Text
2022-11-16 08:57:05 -05:00
virtual Messages::WebDriverClient::SendAlertTextResponse send_alert_text(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;
LibWeb+WebContent+WebDriver: Port WebDriver parameters to String This changes the parameters parsed from a WebDriver HTTP request to String for transferring over IPC. Conveniently, most locations these were ultimately passed to only need a StringView.
2023-03-05 15:31:49 -05:00
virtual Messages::WebDriverClient::TakeElementScreenshotResponse take_element_screenshot(String const& element_id) override;
WebContent+WebDriver: Log all unimplemented WebDriver endpoints It's difficult to know what we need to implement if we silently ignore these endpoints. Let's log the endpoints and their parameters, and clean up the wall of FIXME comments to be easier to grok. (cherry picked from commit b035f0cd3d35e608afdabcd1c5b070dce856b5a3)
2024-09-25 11:26:46 -04:00
virtual Messages::WebDriverClient::PrintPageResponse print_page(JsonValue const& payload) override;
WebContent+WebDriver: Ensure Get Window Handle checks for closed BCs
2023-03-07 11:29:14 -05:00
virtual Messages::WebDriverClient::EnsureTopLevelBrowsingContextIsOpenResponse ensure_top_level_browsing_context_is_open() override;
WebContent: Implement the WebDriver concept of current browsing context When we create a WebDriverConnection object, we currently hand it the page client for which it was opened, and perform all actions on that client. However, some WebDriver endpoints change the browsing context (and therefore page client) on which future commands should be executed. For example, the switch-frame endpoint will switch the current browsing context to a frame/iframe context. This patch implements the current browsing context (and current top- level browsing context) concepts. They are initialized to that of the original page. Most of this patch is making sure we execute actions on the correct context. (cherry picked from commit c4da0228647276821f99887014ed1dae3cea8061; amended to fix conflicts due to serenity not having the renderer-side backing stores from LadybirdBrowser/ladybird#294 and due to serenity not having the redundant logical op introduced in LadybirdBrowser/ladybird#1021)
2024-09-13 17:18:23 -04:00
WebContent: Separately store the WebDriver parent and top-level BCs We are currently trying to access the current parent and top-level browsing contexts from the current BC itself. However, if the current BC is closed, its association to the parent and top-level BCs is lost, and we are no longer able to handle WebDriver endpoints involving those BCs. Instead, let's store the parent and top-level BCs separately, and update them in accordance with the spec. (cherry picked from commit ab3cfd9bbb3d572d2e1ce4337e112d10ac0e94a3)
2024-10-01 13:04:37 -04:00
void set_current_browsing_context(Web::HTML::BrowsingContext&);
WebContent: Implement the WebDriver concept of current browsing context When we create a WebDriverConnection object, we currently hand it the page client for which it was opened, and perform all actions on that client. However, some WebDriver endpoints change the browsing context (and therefore page client) on which future commands should be executed. For example, the switch-frame endpoint will switch the current browsing context to a frame/iframe context. This patch implements the current browsing context (and current top- level browsing context) concepts. They are initialized to that of the original page. Most of this patch is making sure we execute actions on the correct context. (cherry picked from commit c4da0228647276821f99887014ed1dae3cea8061; amended to fix conflicts due to serenity not having the renderer-side backing stores from LadybirdBrowser/ladybird#294 and due to serenity not having the redundant logical op introduced in LadybirdBrowser/ladybird#1021)
2024-09-13 17:18:23 -04:00
Web::HTML::BrowsingContext& current_browsing_context() { return *m_current_browsing_context; }
WebContent: Add a JS visitor to WebDriver's IPC connection We've added a few JS::Handle members to this class over time. Let's avoid creating a new GC root for each of these, and explicitly add a visitation method. (cherry picked from commit 048b51eb54d003af5dc202af1b16bb690b1348f9)
2024-10-17 18:50:36 -04:00
JS::GCPtr<Web::HTML::BrowsingContext> current_parent_browsing_context() { return m_current_parent_browsing_context; }
WebContent: Separately store the WebDriver parent and top-level BCs We are currently trying to access the current parent and top-level browsing contexts from the current BC itself. However, if the current BC is closed, its association to the parent and top-level BCs is lost, and we are no longer able to handle WebDriver endpoints involving those BCs. Instead, let's store the parent and top-level BCs separately, and update them in accordance with the spec. (cherry picked from commit ab3cfd9bbb3d572d2e1ce4337e112d10ac0e94a3)
2024-10-01 13:04:37 -04:00
void set_current_top_level_browsing_context(Web::HTML::BrowsingContext&);
WebContent: Add a JS visitor to WebDriver's IPC connection We've added a few JS::Handle members to this class over time. Let's avoid creating a new GC root for each of these, and explicitly add a visitation method. (cherry picked from commit 048b51eb54d003af5dc202af1b16bb690b1348f9)
2024-10-17 18:50:36 -04:00
JS::GCPtr<Web::HTML::BrowsingContext> current_top_level_browsing_context() { return m_current_top_level_browsing_context; }
WebContent: Implement the WebDriver concept of current browsing context When we create a WebDriverConnection object, we currently hand it the page client for which it was opened, and perform all actions on that client. However, some WebDriver endpoints change the browsing context (and therefore page client) on which future commands should be executed. For example, the switch-frame endpoint will switch the current browsing context to a frame/iframe context. This patch implements the current browsing context (and current top- level browsing context) concepts. They are initialized to that of the original page. Most of this patch is making sure we execute actions on the correct context. (cherry picked from commit c4da0228647276821f99887014ed1dae3cea8061; amended to fix conflicts due to serenity not having the renderer-side backing stores from LadybirdBrowser/ladybird#294 and due to serenity not having the redundant logical op introduced in LadybirdBrowser/ladybird#1021)
2024-09-13 17:18:23 -04:00
ErrorOr<void, Web::WebDriver::Error> ensure_current_browsing_context_is_open();
ErrorOr<void, Web::WebDriver::Error> ensure_current_top_level_browsing_context_is_open();
WebContent+WebDriver: Ensure Get Window Handle checks for closed BCs
2023-03-07 11:29:14 -05:00
LibWebView+WebContent: Begin handling open user dialogs for WebDriver The way in which dialogs should be handled is configurable by the driver capabilities object, which we don't support yet. So this implements just the default mode to dismiss the dialog and return an error if there is one open. In the OOPWV, this means we need to refer to the dialog after it has been open, so we now hold a pointer to whatever dialog is open.
2022-11-16 06:58:14 -05:00
ErrorOr<void, Web::WebDriver::Error> handle_any_user_prompts();
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: Don't assume start nodes for finding elements remain valid When timeouts are implemented, the start node used to find elements may not remain valid for the entire duration of the timeout. For example, the active document element may change, or the start node may be removed from the DOM. To handle this, we will need to re-evaluate the start node on each iteration of the find() operation. This patch wraps the steps to do so in a lambda to be executed on each iteration.
2022-11-21 09:51:46 -05:00
WebContent+WebDriver: Asynchronously wait for navigations to complete Similar to commit c2cf65adac78912883996153fb608dafe389b6e0, we should avoid spinning the event loop from the WebContent-side of the WebDriver connection. This can result in deadlocks if another component in LibWeb also spins the event loop. The AO to await navigations has two event loop spinners - waiting for the navigation to complete and for the document to reach the target readiness state. We now use NavigationObserver and DocumentObserver to be notified when these conditions are met. And we use the same async IPC mechanism as script execution to notify the WebDriver process when all conditions are met (or timed out). (cherry picked from commit bf0bc62654803565a6f39ade63d9172cc48c085a)
2024-10-25 10:28:29 -04:00
using OnNavigationComplete = JS::NonnullGCPtr<JS::HeapFunction<void(Web::WebDriver::Response)>>;
void wait_for_navigation_to_complete(OnNavigationComplete);
WebContent: Wait for navigation to complete in WebDriver Implements https://w3c.github.io/webdriver/#dfn-waiting-for-the-navigation-to-complete.
2023-03-07 18:04:17 -05:00
WebContent: Implement the WebDriver concept of current browsing context When we create a WebDriverConnection object, we currently hand it the page client for which it was opened, and perform all actions on that client. However, some WebDriver endpoints change the browsing context (and therefore page client) on which future commands should be executed. For example, the switch-frame endpoint will switch the current browsing context to a frame/iframe context. This patch implements the current browsing context (and current top- level browsing context) concepts. They are initialized to that of the original page. Most of this patch is making sure we execute actions on the correct context. (cherry picked from commit c4da0228647276821f99887014ed1dae3cea8061; amended to fix conflicts due to serenity not having the renderer-side backing stores from LadybirdBrowser/ladybird#294 and due to serenity not having the redundant logical op introduced in LadybirdBrowser/ladybird#1021)
2024-09-13 17:18:23 -04:00
Gfx::IntPoint calculate_absolute_position_of_element(JS::NonnullGCPtr<Web::Geometry::DOMRect> rect);
Gfx::IntRect calculate_absolute_rect_of_element(Web::DOM::Element const& element);
LibWeb+WebContent: Use NNGCPtr in WebDriver code where appropriate Some of this code is older than widespread use of GCPtr. These functions returning raw pointers has been a point of confusion at times, so lets just indicate that they are non-null. (cherry picked from commit a96a762305423965a9697c2b7038a229d96ac734)
2024-10-17 17:38:34 -04:00
using StartNodeGetter = Function<ErrorOr<JS::NonnullGCPtr<Web::DOM::ParentNode>, Web::WebDriver::Error>()>;
WebContent: Don't assume start nodes for finding elements remain valid When timeouts are implemented, the start node used to find elements may not remain valid for the entire duration of the timeout. For example, the active document element may change, or the start node may be removed from the DOM. To handle this, we will need to re-evaluate the start node on each iteration of the find() operation. This patch wraps the steps to do so in a lambda to be executed on each iteration.
2022-11-21 09:51:46 -05:00
ErrorOr<JsonArray, Web::WebDriver::Error> find(StartNodeGetter&& start_node_getter, 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 {
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 09:19:34 -05:00
ByteString script;
WebContent+WebDriver: Move Execute Script to WebContent
2022-11-10 20:55:17 -05:00
JS::MarkedVector<JS::Value> arguments;
};
WebContent: Create a temporary execution context to parse WebDriver JSON (cherry picked from commit 264b2827cd024752c11f0d955cfdcae4cd1674c7)
2024-09-27 17:42:07 -04:00
ErrorOr<ScriptArguments, Web::WebDriver::Error> extract_the_script_arguments_from_a_request(JS::VM&, JsonValue const& payload);
Browser+WebContent+WebDriver: Move Delete Cookie to WebContent
2022-11-11 11:21:00 -05:00
void delete_cookies(Optional<StringView> const& name = {});
WebContent+WebDriver: Move Execute Script to WebContent
2022-11-10 20:55:17 -05:00
WebContent+WebDriver: Send the parsed capabilities over to WebContent
2022-11-17 16:27:32 -05:00
// https://w3c.github.io/webdriver/#dfn-page-load-strategy
Web::WebDriver::PageLoadStrategy m_page_load_strategy { Web::WebDriver::PageLoadStrategy::Normal };
// https://w3c.github.io/webdriver/#dfn-unhandled-prompt-behavior
Web::WebDriver::UnhandledPromptBehavior m_unhandled_prompt_behavior { Web::WebDriver::UnhandledPromptBehavior::DismissAndNotify };
// https://w3c.github.io/webdriver/#dfn-strict-file-interactability
bool m_strict_file_interactability { false };
WebContent+WebDriver: Move Get/Set Timeouts to WebContent
2022-11-11 14:28:57 -05:00
// https://w3c.github.io/webdriver/#dfn-session-script-timeout
Web::WebDriver::TimeoutsConfiguration m_timeouts_configuration;
WebContent: Implement the WebDriver concept of current browsing context When we create a WebDriverConnection object, we currently hand it the page client for which it was opened, and perform all actions on that client. However, some WebDriver endpoints change the browsing context (and therefore page client) on which future commands should be executed. For example, the switch-frame endpoint will switch the current browsing context to a frame/iframe context. This patch implements the current browsing context (and current top- level browsing context) concepts. They are initialized to that of the original page. Most of this patch is making sure we execute actions on the correct context. (cherry picked from commit c4da0228647276821f99887014ed1dae3cea8061; amended to fix conflicts due to serenity not having the renderer-side backing stores from LadybirdBrowser/ladybird#294 and due to serenity not having the redundant logical op introduced in LadybirdBrowser/ladybird#1021)
2024-09-13 17:18:23 -04:00
// https://w3c.github.io/webdriver/#dfn-current-browsing-context
WebContent: Add a JS visitor to WebDriver's IPC connection We've added a few JS::Handle members to this class over time. Let's avoid creating a new GC root for each of these, and explicitly add a visitation method. (cherry picked from commit 048b51eb54d003af5dc202af1b16bb690b1348f9)
2024-10-17 18:50:36 -04:00
JS::GCPtr<Web::HTML::BrowsingContext> m_current_browsing_context;
LibWeb+WebContent+WebDriver: Implement the Perform Actions endpoint Similar to script execution, this spins the WebDriver process until the action is complete (rather than spinning the WebContent process, which we've seen result in deadlocks). (cherry picked from commit 709deeb482a6433abbcb194551788bc5409166f4)
2024-09-29 09:40:17 -04:00
WebContent: Separately store the WebDriver parent and top-level BCs We are currently trying to access the current parent and top-level browsing contexts from the current BC itself. However, if the current BC is closed, its association to the parent and top-level BCs is lost, and we are no longer able to handle WebDriver endpoints involving those BCs. Instead, let's store the parent and top-level BCs separately, and update them in accordance with the spec. (cherry picked from commit ab3cfd9bbb3d572d2e1ce4337e112d10ac0e94a3)
2024-10-01 13:04:37 -04:00
// https://w3c.github.io/webdriver/#dfn-current-parent-browsing-context
WebContent: Add a JS visitor to WebDriver's IPC connection We've added a few JS::Handle members to this class over time. Let's avoid creating a new GC root for each of these, and explicitly add a visitation method. (cherry picked from commit 048b51eb54d003af5dc202af1b16bb690b1348f9)
2024-10-17 18:50:36 -04:00
JS::GCPtr<Web::HTML::BrowsingContext> m_current_parent_browsing_context;
WebContent: Separately store the WebDriver parent and top-level BCs We are currently trying to access the current parent and top-level browsing contexts from the current BC itself. However, if the current BC is closed, its association to the parent and top-level BCs is lost, and we are no longer able to handle WebDriver endpoints involving those BCs. Instead, let's store the parent and top-level BCs separately, and update them in accordance with the spec. (cherry picked from commit ab3cfd9bbb3d572d2e1ce4337e112d10ac0e94a3)
2024-10-01 13:04:37 -04:00
// https://w3c.github.io/webdriver/#dfn-current-top-level-browsing-context
WebContent: Add a JS visitor to WebDriver's IPC connection We've added a few JS::Handle members to this class over time. Let's avoid creating a new GC root for each of these, and explicitly add a visitation method. (cherry picked from commit 048b51eb54d003af5dc202af1b16bb690b1348f9)
2024-10-17 18:50:36 -04:00
JS::GCPtr<Web::HTML::BrowsingContext> m_current_top_level_browsing_context;
WebContent: Separately store the WebDriver parent and top-level BCs We are currently trying to access the current parent and top-level browsing contexts from the current BC itself. However, if the current BC is closed, its association to the parent and top-level BCs is lost, and we are no longer able to handle WebDriver endpoints involving those BCs. Instead, let's store the parent and top-level BCs separately, and update them in accordance with the spec. (cherry picked from commit ab3cfd9bbb3d572d2e1ce4337e112d10ac0e94a3)
2024-10-01 13:04:37 -04:00
WebContent: Add a JS visitor to WebDriver's IPC connection We've added a few JS::Handle members to this class over time. Let's avoid creating a new GC root for each of these, and explicitly add a visitation method. (cherry picked from commit 048b51eb54d003af5dc202af1b16bb690b1348f9)
2024-10-17 18:50:36 -04:00
JS::GCPtr<JS::Cell> m_action_executor;
WebContent+WebDriver: Asynchronously wait for navigations to complete Similar to commit c2cf65adac78912883996153fb608dafe389b6e0, we should avoid spinning the event loop from the WebContent-side of the WebDriver connection. This can result in deadlocks if another component in LibWeb also spins the event loop. The AO to await navigations has two event loop spinners - waiting for the navigation to complete and for the document to reach the target readiness state. We now use NavigationObserver and DocumentObserver to be notified when these conditions are met. And we use the same async IPC mechanism as script execution to notify the WebDriver process when all conditions are met (or timed out). (cherry picked from commit bf0bc62654803565a6f39ade63d9172cc48c085a)
2024-10-25 10:28:29 -04:00
JS::GCPtr<Web::DOM::DocumentObserver> m_document_observer;
JS::GCPtr<Web::HTML::NavigationObserver> m_navigation_observer;
JS::GCPtr<Web::WebDriver::HeapTimer> m_navigation_timer;
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
};
}
Reference in a new issue Copy permalink