WebDriverConnection.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. /*
  2. * Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
  3. * Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2022-2024, Tim Flynn <trflynn89@ladybird.org>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #pragma once
  9. #include <AK/ByteString.h>
  10. #include <AK/Function.h>
  11. #include <AK/HashMap.h>
  12. #include <AK/String.h>
  13. #include <LibGfx/Rect.h>
  14. #include <LibIPC/ConnectionToServer.h>
  15. #include <LibJS/Forward.h>
  16. #include <LibJS/Heap/MarkedVector.h>
  17. #include <LibWeb/Forward.h>
  18. #include <LibWeb/WebDriver/ElementLocationStrategies.h>
  19. #include <LibWeb/WebDriver/Response.h>
  20. #include <LibWeb/WebDriver/TimeoutsConfiguration.h>
  21. #include <WebContent/Forward.h>
  22. #include <WebContent/WebDriverClientEndpoint.h>
  23. #include <WebContent/WebDriverServerEndpoint.h>
  24. namespace WebContent {
  25. class WebDriverConnection final
  26. : public IPC::ConnectionToServer<WebDriverClientEndpoint, WebDriverServerEndpoint> {
  27. C_OBJECT_ABSTRACT(WebDriverConnection)
  28. public:
  29. static ErrorOr<NonnullRefPtr<WebDriverConnection>> connect(Web::PageClient& page_client, ByteString const& webdriver_ipc_path);
  30. virtual ~WebDriverConnection() = default;
  31. void visit_edges(JS::Cell::Visitor&);
  32. private:
  33. WebDriverConnection(NonnullOwnPtr<Core::LocalSocket> socket, Web::PageClient& page_client);
  34. virtual void die() override { }
  35. virtual void close_session() override;
  36. virtual void set_page_load_strategy(Web::WebDriver::PageLoadStrategy const& page_load_strategy) override;
  37. virtual void set_unhandled_prompt_behavior(Web::WebDriver::UnhandledPromptBehavior const& unhandled_prompt_behavior) override;
  38. virtual void set_strict_file_interactability(bool strict_file_interactability) override;
  39. virtual void set_is_webdriver_active(bool) override;
  40. virtual Messages::WebDriverClient::GetTimeoutsResponse get_timeouts() override;
  41. virtual Messages::WebDriverClient::SetTimeoutsResponse set_timeouts(JsonValue const& payload) override;
  42. virtual Messages::WebDriverClient::NavigateToResponse navigate_to(JsonValue const& payload) override;
  43. virtual Messages::WebDriverClient::GetCurrentUrlResponse get_current_url() override;
  44. virtual Messages::WebDriverClient::BackResponse back() override;
  45. virtual Messages::WebDriverClient::ForwardResponse forward() override;
  46. virtual Messages::WebDriverClient::RefreshResponse refresh() override;
  47. virtual Messages::WebDriverClient::GetTitleResponse get_title() override;
  48. virtual Messages::WebDriverClient::GetWindowHandleResponse get_window_handle() override;
  49. virtual Messages::WebDriverClient::CloseWindowResponse close_window() override;
  50. virtual Messages::WebDriverClient::SwitchToWindowResponse switch_to_window(String const& handle) override;
  51. virtual Messages::WebDriverClient::NewWindowResponse new_window(JsonValue const& payload) override;
  52. virtual Messages::WebDriverClient::SwitchToFrameResponse switch_to_frame(JsonValue const& payload) override;
  53. virtual Messages::WebDriverClient::SwitchToParentFrameResponse switch_to_parent_frame(JsonValue const& payload) override;
  54. virtual Messages::WebDriverClient::GetWindowRectResponse get_window_rect() override;
  55. virtual Messages::WebDriverClient::SetWindowRectResponse set_window_rect(JsonValue const& payload) override;
  56. virtual Messages::WebDriverClient::MaximizeWindowResponse maximize_window() override;
  57. virtual Messages::WebDriverClient::MinimizeWindowResponse minimize_window() override;
  58. virtual Messages::WebDriverClient::FullscreenWindowResponse fullscreen_window() override;
  59. virtual Messages::WebDriverClient::ConsumeUserActivationResponse consume_user_activation() override;
  60. virtual Messages::WebDriverClient::FindElementResponse find_element(JsonValue const& payload) override;
  61. virtual Messages::WebDriverClient::FindElementsResponse find_elements(JsonValue const& payload) override;
  62. virtual Messages::WebDriverClient::FindElementFromElementResponse find_element_from_element(JsonValue const& payload, String const& element_id) override;
  63. virtual Messages::WebDriverClient::FindElementsFromElementResponse find_elements_from_element(JsonValue const& payload, String const& element_id) override;
  64. virtual Messages::WebDriverClient::FindElementFromShadowRootResponse find_element_from_shadow_root(JsonValue const& payload, String const& shadow_id) override;
  65. virtual Messages::WebDriverClient::FindElementsFromShadowRootResponse find_elements_from_shadow_root(JsonValue const& payload, String const& shadow_id) override;
  66. virtual Messages::WebDriverClient::GetActiveElementResponse get_active_element() override;
  67. virtual Messages::WebDriverClient::GetElementShadowRootResponse get_element_shadow_root(String const& element_id) override;
  68. virtual Messages::WebDriverClient::IsElementSelectedResponse is_element_selected(String const& element_id) override;
  69. virtual Messages::WebDriverClient::GetElementAttributeResponse get_element_attribute(String const& element_id, String const& name) override;
  70. virtual Messages::WebDriverClient::GetElementPropertyResponse get_element_property(String const& element_id, String const& name) override;
  71. virtual Messages::WebDriverClient::GetElementCssValueResponse get_element_css_value(String const& element_id, String const& name) override;
  72. virtual Messages::WebDriverClient::GetElementTextResponse get_element_text(String const& element_id) override;
  73. virtual Messages::WebDriverClient::GetElementTagNameResponse get_element_tag_name(String const& element_id) override;
  74. virtual Messages::WebDriverClient::GetElementRectResponse get_element_rect(String const& element_id) override;
  75. virtual Messages::WebDriverClient::IsElementEnabledResponse is_element_enabled(String const& element_id) override;
  76. virtual Messages::WebDriverClient::GetComputedRoleResponse get_computed_role(String const& element_id) override;
  77. virtual Messages::WebDriverClient::GetComputedLabelResponse get_computed_label(String const& element_id) override;
  78. virtual Messages::WebDriverClient::ElementClickResponse element_click(String const& element_id) override;
  79. virtual Messages::WebDriverClient::ElementClearResponse element_clear(String const& element_id) override;
  80. virtual Messages::WebDriverClient::ElementSendKeysResponse element_send_keys(String const& element_id, JsonValue const& payload) override;
  81. virtual Messages::WebDriverClient::GetSourceResponse get_source() override;
  82. virtual Messages::WebDriverClient::ExecuteScriptResponse execute_script(JsonValue const& payload) override;
  83. virtual Messages::WebDriverClient::ExecuteAsyncScriptResponse execute_async_script(JsonValue const& payload) override;
  84. virtual Messages::WebDriverClient::GetAllCookiesResponse get_all_cookies() override;
  85. virtual Messages::WebDriverClient::GetNamedCookieResponse get_named_cookie(String const& name) override;
  86. virtual Messages::WebDriverClient::AddCookieResponse add_cookie(JsonValue const& payload) override;
  87. virtual Messages::WebDriverClient::DeleteCookieResponse delete_cookie(String const& name) override;
  88. virtual Messages::WebDriverClient::DeleteAllCookiesResponse delete_all_cookies() override;
  89. virtual Messages::WebDriverClient::PerformActionsResponse perform_actions(JsonValue const& payload) override;
  90. virtual Messages::WebDriverClient::ReleaseActionsResponse release_actions() override;
  91. virtual Messages::WebDriverClient::DismissAlertResponse dismiss_alert() override;
  92. virtual Messages::WebDriverClient::AcceptAlertResponse accept_alert() override;
  93. virtual Messages::WebDriverClient::GetAlertTextResponse get_alert_text() override;
  94. virtual Messages::WebDriverClient::SendAlertTextResponse send_alert_text(JsonValue const& payload) override;
  95. virtual Messages::WebDriverClient::TakeScreenshotResponse take_screenshot() override;
  96. virtual Messages::WebDriverClient::TakeElementScreenshotResponse take_element_screenshot(String const& element_id) override;
  97. virtual Messages::WebDriverClient::PrintPageResponse print_page(JsonValue const& payload) override;
  98. virtual Messages::WebDriverClient::EnsureTopLevelBrowsingContextIsOpenResponse ensure_top_level_browsing_context_is_open() override;
  99. void set_current_browsing_context(Web::HTML::BrowsingContext&);
  100. Web::HTML::BrowsingContext& current_browsing_context() { return *m_current_browsing_context; }
  101. JS::GCPtr<Web::HTML::BrowsingContext> current_parent_browsing_context() { return m_current_parent_browsing_context; }
  102. void set_current_top_level_browsing_context(Web::HTML::BrowsingContext&);
  103. JS::GCPtr<Web::HTML::BrowsingContext> current_top_level_browsing_context() { return m_current_top_level_browsing_context; }
  104. ErrorOr<void, Web::WebDriver::Error> ensure_current_browsing_context_is_open();
  105. ErrorOr<void, Web::WebDriver::Error> ensure_current_top_level_browsing_context_is_open();
  106. ErrorOr<void, Web::WebDriver::Error> handle_any_user_prompts();
  107. void restore_the_window();
  108. Gfx::IntRect maximize_the_window();
  109. Gfx::IntRect iconify_the_window();
  110. ErrorOr<void, Web::WebDriver::Error> wait_for_navigation_to_complete();
  111. Gfx::IntPoint calculate_absolute_position_of_element(JS::NonnullGCPtr<Web::Geometry::DOMRect> rect);
  112. Gfx::IntRect calculate_absolute_rect_of_element(Web::DOM::Element const& element);
  113. using StartNodeGetter = Function<ErrorOr<JS::NonnullGCPtr<Web::DOM::ParentNode>, Web::WebDriver::Error>()>;
  114. ErrorOr<JsonArray, Web::WebDriver::Error> find(StartNodeGetter&& start_node_getter, Web::WebDriver::LocationStrategy using_, StringView value);
  115. struct ScriptArguments {
  116. ByteString script;
  117. JS::MarkedVector<JS::Value> arguments;
  118. };
  119. ErrorOr<ScriptArguments, Web::WebDriver::Error> extract_the_script_arguments_from_a_request(JS::VM&, JsonValue const& payload);
  120. void delete_cookies(Optional<StringView> const& name = {});
  121. // https://w3c.github.io/webdriver/#dfn-page-load-strategy
  122. Web::WebDriver::PageLoadStrategy m_page_load_strategy { Web::WebDriver::PageLoadStrategy::Normal };
  123. // https://w3c.github.io/webdriver/#dfn-unhandled-prompt-behavior
  124. Web::WebDriver::UnhandledPromptBehavior m_unhandled_prompt_behavior { Web::WebDriver::UnhandledPromptBehavior::DismissAndNotify };
  125. // https://w3c.github.io/webdriver/#dfn-strict-file-interactability
  126. bool m_strict_file_interactability { false };
  127. // https://w3c.github.io/webdriver/#dfn-session-script-timeout
  128. Web::WebDriver::TimeoutsConfiguration m_timeouts_configuration;
  129. // https://w3c.github.io/webdriver/#dfn-current-browsing-context
  130. JS::GCPtr<Web::HTML::BrowsingContext> m_current_browsing_context;
  131. // https://w3c.github.io/webdriver/#dfn-current-parent-browsing-context
  132. JS::GCPtr<Web::HTML::BrowsingContext> m_current_parent_browsing_context;
  133. // https://w3c.github.io/webdriver/#dfn-current-top-level-browsing-context
  134. JS::GCPtr<Web::HTML::BrowsingContext> m_current_top_level_browsing_context;
  135. JS::GCPtr<JS::Cell> m_action_executor;
  136. };
  137. }