/* * Copyright (c) 2022, Florent Castelli * Copyright (c) 2022, Linus Groh * Copyright (c) 2022-2025, Tim Flynn * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace WebContent { class ElementLocator; class WebDriverConnection final : public IPC::ConnectionToServer { C_OBJECT_ABSTRACT(WebDriverConnection) public: static ErrorOr> connect(Web::PageClient& page_client, ByteString const& webdriver_ipc_path); virtual ~WebDriverConnection() = default; void visit_edges(JS::Cell::Visitor&); void page_did_open_dialog(Badge); private: WebDriverConnection(NonnullOwnPtr transport, Web::PageClient& page_client); virtual void die() override { } virtual void close_session() override; virtual void set_page_load_strategy(Web::WebDriver::PageLoadStrategy page_load_strategy) override; virtual void set_user_prompt_handler(Web::WebDriver::UserPromptHandler user_prompt_handler) override; virtual void set_strict_file_interactability(bool strict_file_interactability) override; virtual void set_is_webdriver_active(bool) override; virtual Messages::WebDriverClient::GetTimeoutsResponse get_timeouts() override; virtual Messages::WebDriverClient::SetTimeoutsResponse set_timeouts(JsonValue payload) override; virtual Messages::WebDriverClient::NavigateToResponse navigate_to(JsonValue payload) override; virtual Messages::WebDriverClient::GetCurrentUrlResponse get_current_url() override; virtual Messages::WebDriverClient::BackResponse back() override; virtual Messages::WebDriverClient::ForwardResponse forward() override; virtual Messages::WebDriverClient::RefreshResponse refresh() override; virtual Messages::WebDriverClient::GetTitleResponse get_title() override; virtual Messages::WebDriverClient::GetWindowHandleResponse get_window_handle() override; virtual Messages::WebDriverClient::CloseWindowResponse close_window() override; virtual Messages::WebDriverClient::SwitchToWindowResponse switch_to_window(String handle) override; virtual Messages::WebDriverClient::NewWindowResponse new_window(JsonValue payload) override; virtual Messages::WebDriverClient::SwitchToFrameResponse switch_to_frame(JsonValue payload) override; virtual Messages::WebDriverClient::SwitchToParentFrameResponse switch_to_parent_frame(JsonValue payload) override; virtual Messages::WebDriverClient::GetWindowRectResponse get_window_rect() override; virtual Messages::WebDriverClient::SetWindowRectResponse set_window_rect(JsonValue payload) override; virtual Messages::WebDriverClient::MaximizeWindowResponse maximize_window() override; virtual Messages::WebDriverClient::MinimizeWindowResponse minimize_window() override; virtual Messages::WebDriverClient::FullscreenWindowResponse fullscreen_window() override; virtual Messages::WebDriverClient::ConsumeUserActivationResponse consume_user_activation() override; virtual Messages::WebDriverClient::FindElementResponse find_element(JsonValue payload) override; virtual Messages::WebDriverClient::FindElementsResponse find_elements(JsonValue payload) override; virtual Messages::WebDriverClient::FindElementFromElementResponse find_element_from_element(JsonValue payload, String element_id) override; virtual Messages::WebDriverClient::FindElementsFromElementResponse find_elements_from_element(JsonValue payload, String element_id) override; virtual Messages::WebDriverClient::FindElementFromShadowRootResponse find_element_from_shadow_root(JsonValue payload, String shadow_id) override; virtual Messages::WebDriverClient::FindElementsFromShadowRootResponse find_elements_from_shadow_root(JsonValue payload, String shadow_id) override; virtual Messages::WebDriverClient::GetActiveElementResponse get_active_element() override; virtual Messages::WebDriverClient::GetElementShadowRootResponse get_element_shadow_root(String element_id) override; virtual Messages::WebDriverClient::IsElementSelectedResponse is_element_selected(String element_id) override; virtual Messages::WebDriverClient::GetElementAttributeResponse get_element_attribute(String element_id, String name) override; virtual Messages::WebDriverClient::GetElementPropertyResponse get_element_property(String element_id, String name) override; virtual Messages::WebDriverClient::GetElementCssValueResponse get_element_css_value(String element_id, String name) override; virtual Messages::WebDriverClient::GetElementTextResponse get_element_text(String element_id) override; virtual Messages::WebDriverClient::GetElementTagNameResponse get_element_tag_name(String element_id) override; virtual Messages::WebDriverClient::GetElementRectResponse get_element_rect(String element_id) override; virtual Messages::WebDriverClient::IsElementEnabledResponse is_element_enabled(String element_id) override; virtual Messages::WebDriverClient::GetComputedRoleResponse get_computed_role(String element_id) override; virtual Messages::WebDriverClient::GetComputedLabelResponse get_computed_label(String element_id) override; virtual Messages::WebDriverClient::ElementClickResponse element_click(String element_id) override; virtual Messages::WebDriverClient::ElementClearResponse element_clear(String element_id) override; virtual Messages::WebDriverClient::ElementSendKeysResponse element_send_keys(String element_id, JsonValue payload) override; virtual Messages::WebDriverClient::GetSourceResponse get_source() override; virtual Messages::WebDriverClient::ExecuteScriptResponse execute_script(JsonValue payload) override; virtual Messages::WebDriverClient::ExecuteAsyncScriptResponse execute_async_script(JsonValue payload) override; virtual Messages::WebDriverClient::GetAllCookiesResponse get_all_cookies() override; virtual Messages::WebDriverClient::GetNamedCookieResponse get_named_cookie(String name) override; virtual Messages::WebDriverClient::AddCookieResponse add_cookie(JsonValue payload) override; virtual Messages::WebDriverClient::DeleteCookieResponse delete_cookie(String name) override; virtual Messages::WebDriverClient::DeleteAllCookiesResponse delete_all_cookies() override; virtual Messages::WebDriverClient::PerformActionsResponse perform_actions(JsonValue payload) override; virtual Messages::WebDriverClient::ReleaseActionsResponse release_actions() override; virtual Messages::WebDriverClient::DismissAlertResponse dismiss_alert() override; virtual Messages::WebDriverClient::AcceptAlertResponse accept_alert() override; virtual Messages::WebDriverClient::GetAlertTextResponse get_alert_text() override; virtual Messages::WebDriverClient::SendAlertTextResponse send_alert_text(JsonValue payload) override; virtual Messages::WebDriverClient::TakeScreenshotResponse take_screenshot() override; virtual Messages::WebDriverClient::TakeElementScreenshotResponse take_element_screenshot(String element_id) override; virtual Messages::WebDriverClient::PrintPageResponse print_page(JsonValue payload) override; virtual Messages::WebDriverClient::EnsureTopLevelBrowsingContextIsOpenResponse ensure_top_level_browsing_context_is_open() override; void set_current_browsing_context(Web::HTML::BrowsingContext&); Web::HTML::BrowsingContext& current_browsing_context() { return *m_current_browsing_context; } GC::Ptr current_parent_browsing_context() { return m_current_parent_browsing_context; } void set_current_top_level_browsing_context(Web::HTML::BrowsingContext&); GC::Ptr current_top_level_browsing_context() { return m_current_top_level_browsing_context; } ErrorOr ensure_current_browsing_context_is_open(); ErrorOr ensure_current_top_level_browsing_context_is_open(); Web::WebDriver::Response element_click_impl(StringView element_id); Web::WebDriver::Response element_clear_impl(StringView element_id); Web::WebDriver::Response element_send_keys_impl(StringView element_id, String const& text); Web::WebDriver::Response add_cookie_impl(JsonObject const&); Web::WebDriver::PromptHandlerConfiguration get_the_prompt_handler(Web::WebDriver::PromptType type) const; void handle_any_user_prompts(Function on_dialog_closed); void maximize_the_window(); void iconify_the_window(GC::Ref>); void restore_the_window(GC::Ref>); void wait_for_visibility_state(GC::Ref>, Web::HTML::VisibilityState); using OnNavigationComplete = GC::Ref>; void wait_for_navigation_to_complete(OnNavigationComplete); Gfx::IntPoint calculate_absolute_position_of_element(Web::CSSPixelRect); Gfx::IntRect calculate_absolute_rect_of_element(Web::DOM::Element const& element); using GetStartNode = GC::Ref, Web::WebDriver::Error>()>>; using OnFindComplete = GC::Ref>; void find(Web::WebDriver::LocationStrategy, String, GetStartNode, OnFindComplete); struct ScriptArguments { String script; GC::RootVector arguments; }; ErrorOr extract_the_script_arguments_from_a_request(JS::VM&, JsonValue const& payload); void handle_script_response(Web::WebDriver::ExecutionResult, size_t script_execution_id); void delete_cookies(Optional const& name = {}); // 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-strict-file-interactability bool m_strict_file_interactability { false }; // https://w3c.github.io/webdriver/#dfn-session-script-timeout Web::WebDriver::TimeoutsConfiguration m_timeouts_configuration; // https://w3c.github.io/webdriver/#dfn-current-browsing-context GC::Ptr m_current_browsing_context; // https://w3c.github.io/webdriver/#dfn-current-parent-browsing-context GC::Ptr m_current_parent_browsing_context; // https://w3c.github.io/webdriver/#dfn-current-top-level-browsing-context GC::Ptr m_current_top_level_browsing_context; size_t m_pending_window_rect_requests { 0 }; size_t m_script_execution_id_counter { 0 }; Optional m_current_script_execution_id; friend class ElementLocator; GC::Ptr m_element_locator; GC::Ptr m_action_executor; GC::Ptr m_document_observer; GC::Ptr m_navigation_observer; GC::Ptr m_navigation_timer; }; }